- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CancelIngestionCommand
Cancels an ongoing ingestion of data into SPICE.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { QuickSightClient, CancelIngestionCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
// const { QuickSightClient, CancelIngestionCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
const client = new QuickSightClient(config);
const input = { // CancelIngestionRequest
AwsAccountId: "STRING_VALUE", // required
DataSetId: "STRING_VALUE", // required
IngestionId: "STRING_VALUE", // required
};
const command = new CancelIngestionCommand(input);
const response = await client.send(command);
// { // CancelIngestionResponse
// Arn: "STRING_VALUE",
// IngestionId: "STRING_VALUE",
// RequestId: "STRING_VALUE",
// Status: Number("int"),
// };
CancelIngestionCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
AwsAccountId Required | string | undefined | The Amazon Web Services account ID. |
DataSetId Required | string | undefined | The ID of the dataset used in the ingestion. |
IngestionId Required | string | undefined | An ID for the ingestion. |
CancelIngestionCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Arn | string | undefined | The Amazon Resource Name (ARN) for the data ingestion. |
IngestionId | string | undefined | An ID for the ingestion. |
RequestId | string | undefined | The Amazon Web Services request ID for this operation. |
Status | number | undefined | The HTTP status of the request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials. |
InternalFailureException | server | An internal failure occurred. |
InvalidParameterValueException | client | One or more parameters has a value that isn't valid. |
ResourceExistsException | client | The resource specified already exists. |
ResourceNotFoundException | client | One or more resources can't be found. |
ThrottlingException | client | Access is throttled. |
QuickSightServiceException | Base exception class for all service exceptions from QuickSight service. |