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

ListDatasetContents

Lists information about dataset contents that have been created.

Request Syntax


GET /datasets/datasetName/contents?maxResults=maxResults&nextToken=nextToken&scheduledBefore=scheduledBefore&scheduledOnOrAfter=scheduledOnOrAfter HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

datasetName

The name of the dataset whose contents information you want to list.

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

Pattern: (^(?!_{2}))(^[a-zA-Z0-9_]+$)

Required: Yes

maxResults

The maximum number of results to return in this request.

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

nextToken

The token for the next set of results.

scheduledBefore

A filter to limit results to those dataset contents whose creation is scheduled before the given time. See the field triggers.schedule in the CreateDataset request. (timestamp)

scheduledOnOrAfter

A filter to limit results to those dataset contents whose creation is scheduled on or after the given time. See the field triggers.schedule in the CreateDataset request. (timestamp)

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "datasetContentSummaries": [ 
      { 
         "completionTime": number,
         "creationTime": number,
         "scheduleTime": number,
         "status": { 
            "reason": "string",
            "state": "string"
         },
         "version": "string"
      }
   ],
   "nextToken": "string"
}

Response Elements

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

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

datasetContentSummaries

Summary information about dataset contents that have been created.

Type: Array of DatasetContentSummary objects

nextToken

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

Type: String

Errors

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

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ResourceNotFoundException

A resource with the specified name could not be found.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400