Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

CreateIngestion

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 Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

Request Syntax


PUT /accounts/AwsAccountId/data-sets/DataSetId/ingestions/IngestionId HTTP/1.1
Content-type: application/json

{
   "IngestionType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The Amazon account ID.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

DataSetId

The ID of the dataset used in the ingestion.

Required: Yes

IngestionId

An ID for the ingestion.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9-_]+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

IngestionType

The type of ingestion that you want to create.

Type: String

Valid Values: INCREMENTAL_REFRESH | FULL_REFRESH

Required: No

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "Arn": "string",
   "IngestionId": "string",
   "IngestionStatus": "string",
   "RequestId": "string"
}

Response Elements

If the action is successful, the service sends back the following HTTP response.

Status: The HTTP status of the request.

The following data is returned in JSON format by the service.

Arn

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

Type: String

IngestionId

An ID for the ingestion.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9-_]+$

IngestionStatus

The ingestion status.

Type: String

RequestId

The Amazon request ID for this operation.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

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.

HTTP Status Code: 401

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

HTTP Status Code: 400

LimitExceededException

A limit is exceeded.

HTTP Status Code: 409

ResourceExistsException

The resource specified already exists.

HTTP Status Code: 409

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

HTTP Status Code: 429

Examples

Example

This example illustrates one usage of CreateIngestion.

Sample Request


PUT /accounts/*AwsAccountId*/data-sets/*DataSetID*/ingestions/*IngestionID* HTTP/1.1