QuickSight / Client / cancel_ingestion

cancel_ingestion#

QuickSight.Client.cancel_ingestion(**kwargs)#

Cancels an ongoing ingestion of data into SPICE.

See also: AWS API Documentation

Request Syntax

response = client.cancel_ingestion(
    AwsAccountId='string',
    DataSetId='string',
    IngestionId='string'
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The Amazon Web Services account ID.

  • DataSetId (string) –

    [REQUIRED]

    The ID of the dataset used in the ingestion.

  • IngestionId (string) –

    [REQUIRED]

    An ID for the ingestion.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'IngestionId': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) –

    • Arn (string) –

      The Amazon Resource Name (ARN) for the data ingestion.

    • IngestionId (string) –

      An ID for the ingestion.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • Status (integer) –

      The HTTP status of the request.

Exceptions