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

ListIngestions

Lists the history of SPICE ingestions for a dataset.

Request Syntax


GET /accounts/AwsAccountId/data-sets/DataSetId/ingestions?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The AWS 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

MaxResults

The maximum number of results to be returned per request.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

The token for the next set of results, or null if there are no more results.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "Ingestions": [ 
      { 
         "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,
            "TotalRowsInDataset": number
         }
      }
   ],
   "NextToken": "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.

Ingestions

A list of the ingestions.

Type: Array of Ingestion objects

NextToken

The token for the next set of results, or null if there are no more results.

Type: String

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 credentials.

HTTP Status Code: 401

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidNextTokenException

The NextToken value isn't valid.

HTTP Status Code: 400

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

Examples

Example

This example illustrates one usage of ListIngestions.

Sample Request


GET /accounts/*AwsAccountId*/data-sets/*DataSetID*/ingestions?next-token=*NextToken*;max-results=*MaxResults*" HTTP/1.1