QuickSight / Client / describe_ingestion

describe_ingestion#

QuickSight.Client.describe_ingestion(**kwargs)#

Describes a SPICE ingestion.

See also: AWS API Documentation

Request Syntax

response = client.describe_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

{
    'Ingestion': {
        'Arn': 'string',
        'IngestionId': 'string',
        'IngestionStatus': 'INITIALIZED'|'QUEUED'|'RUNNING'|'FAILED'|'COMPLETED'|'CANCELLED',
        'ErrorInfo': {
            'Type': 'FAILURE_TO_ASSUME_ROLE'|'INGESTION_SUPERSEDED'|'INGESTION_CANCELED'|'DATA_SET_DELETED'|'DATA_SET_NOT_SPICE'|'S3_UPLOADED_FILE_DELETED'|'S3_MANIFEST_ERROR'|'DATA_TOLERANCE_EXCEPTION'|'SPICE_TABLE_NOT_FOUND'|'DATA_SET_SIZE_LIMIT_EXCEEDED'|'ROW_SIZE_LIMIT_EXCEEDED'|'ACCOUNT_CAPACITY_LIMIT_EXCEEDED'|'CUSTOMER_ERROR'|'DATA_SOURCE_NOT_FOUND'|'IAM_ROLE_NOT_AVAILABLE'|'CONNECTION_FAILURE'|'SQL_TABLE_NOT_FOUND'|'PERMISSION_DENIED'|'SSL_CERTIFICATE_VALIDATION_FAILURE'|'OAUTH_TOKEN_FAILURE'|'SOURCE_API_LIMIT_EXCEEDED_FAILURE'|'PASSWORD_AUTHENTICATION_FAILURE'|'SQL_SCHEMA_MISMATCH_ERROR'|'INVALID_DATE_FORMAT'|'INVALID_DATAPREP_SYNTAX'|'SOURCE_RESOURCE_LIMIT_EXCEEDED'|'SQL_INVALID_PARAMETER_VALUE'|'QUERY_TIMEOUT'|'SQL_NUMERIC_OVERFLOW'|'UNRESOLVABLE_HOST'|'UNROUTABLE_HOST'|'SQL_EXCEPTION'|'S3_FILE_INACCESSIBLE'|'IOT_FILE_NOT_FOUND'|'IOT_DATA_SET_FILE_EMPTY'|'INVALID_DATA_SOURCE_CONFIG'|'DATA_SOURCE_AUTH_FAILED'|'DATA_SOURCE_CONNECTION_FAILED'|'FAILURE_TO_PROCESS_JSON_FILE'|'INTERNAL_SERVICE_ERROR'|'REFRESH_SUPPRESSED_BY_EDIT'|'PERMISSION_NOT_FOUND'|'ELASTICSEARCH_CURSOR_NOT_ENABLED'|'CURSOR_NOT_ENABLED'|'DUPLICATE_COLUMN_NAMES_FOUND',
            'Message': 'string'
        },
        'RowInfo': {
            'RowsIngested': 123,
            'RowsDropped': 123,
            'TotalRowsInDataset': 123
        },
        'QueueInfo': {
            'WaitingOnIngestion': 'string',
            'QueuedIngestion': 'string'
        },
        'CreatedTime': datetime(2015, 1, 1),
        'IngestionTimeInSeconds': 123,
        'IngestionSizeInBytes': 123,
        'RequestSource': 'MANUAL'|'SCHEDULED',
        'RequestType': 'INITIAL_INGESTION'|'EDIT'|'INCREMENTAL_REFRESH'|'FULL_REFRESH'
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) –

    • Ingestion (dict) –

      Information about the ingestion.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the resource.

      • IngestionId (string) –

        Ingestion ID.

      • IngestionStatus (string) –

        Ingestion status.

      • ErrorInfo (dict) –

        Error information for this ingestion.

        • Type (string) –

          Error type.

        • Message (string) –

          Error message.

      • RowInfo (dict) –

        Information about rows for a data set SPICE ingestion.

        • RowsIngested (integer) –

          The number of rows that were ingested.

        • RowsDropped (integer) –

          The number of rows that were not ingested.

        • TotalRowsInDataset (integer) –

          The total number of rows in the dataset.

      • QueueInfo (dict) –

        Information about a queued dataset SPICE ingestion.

        • WaitingOnIngestion (string) –

          The ID of the queued ingestion.

        • QueuedIngestion (string) –

          The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing ingestion to complete.

      • CreatedTime (datetime) –

        The time that this ingestion started.

      • IngestionTimeInSeconds (integer) –

        The time that this ingestion took, measured in seconds.

      • IngestionSizeInBytes (integer) –

        The size of the data ingested, in bytes.

      • RequestSource (string) –

        Event source for this ingestion.

      • RequestType (string) –

        Type of this ingestion.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • Status (integer) –

      The HTTP status of the request.

Exceptions