v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141341,3811.0 MB

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.

put/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}

Path parameters

DataSetIdstring required

The ID of the dataset used in the ingestion.

IngestionIdstring required

An ID for the ingestion.

AwsAccountIdstring required

The Amazon Web Services account ID.

Request body

IngestionType'INCREMENTAL_REFRESH' | 'FULL_REFRESH'

This defines the type of ingestion user wants to trigger. This is part of create ingestion request.

Response

Success

Arnstring

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

IngestionIdstring

An ID for the ingestion.

IngestionStatus'INITIALIZED' | 'QUEUED' | 'RUNNING' | 'FAILED' | 'COMPLETED' | 'CANCELLED'

The ingestion status.

RequestIdstring

The Amazon Web Services request ID for this operation.

Statusinteger

The HTTP status of the request.