DescribeIngestion -

DescribeIngestion

Describes a SPICE ingestion.

Request Syntax

GET /accounts/AwsAccountId/data-sets/DataSetId/ingestions/IngestionId HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

AwsAccountId

The AWS account ID.

Length Constraints: Fixed length of 12.

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

DataSetId

The ID of the dataset used in the ingestion.

IngestionId

An ID for the ingestion.

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

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 Status Content-type: application/json { "Ingestion": { "Arn": "string", "CreatedTime": number, "ErrorInfo": { "Message": "string", "Type": "string" }, "IngestionId": "string", "IngestionSizeInBytes": number, "IngestionStatus": "string", "IngestionTimeInSeconds": number, "QueueInfo": { "QueuedIngestion": "string", "WaitingOnIngestion": "string" }, "RequestSource": "string", "RequestType": "string", "RowInfo": { "RowsDropped": number, "RowsIngested": number } }, "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.

Ingestion

Information about the ingestion.

Type: Ingestion object

RequestId

The AWS 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 access keys.

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

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

Example

Sample Request

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: