QuickSight / Client / create_ingestion

create_ingestion#

QuickSight.Client.create_ingestion(**kwargs)#

Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time.

Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

See also: AWS API Documentation

Request Syntax

response = client.create_ingestion(
    DataSetId='string',
    IngestionId='string',
    AwsAccountId='string',
    IngestionType='INCREMENTAL_REFRESH'|'FULL_REFRESH'
)
Parameters:

  • DataSetId (string) –

    [REQUIRED]

    The ID of the dataset used in the ingestion.

  • IngestionId (string) –

    [REQUIRED]

    An ID for the ingestion.

  • AwsAccountId (string) –

    [REQUIRED]

    The Amazon Web Services account ID.

  • IngestionType (string) – The type of ingestion that you want to create.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'IngestionId': 'string',
    'IngestionStatus': 'INITIALIZED'|'QUEUED'|'RUNNING'|'FAILED'|'COMPLETED'|'CANCELLED',
    '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.

    • IngestionStatus (string) –

      The ingestion status.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • Status (integer) –

      The HTTP status of the request.

Exceptions

  • QuickSight.Client.exceptions.AccessDeniedException

  • QuickSight.Client.exceptions.InvalidParameterValueException

  • QuickSight.Client.exceptions.ResourceNotFoundException

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.LimitExceededException

  • QuickSight.Client.exceptions.ResourceExistsException

  • QuickSight.Client.exceptions.InternalFailureException