Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListDatasets

List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.

Request Syntax


{
   "Filter": { 
      "CreationTimeAfter": number,
      "CreationTimeBefore": number,
      "DatasetType": "string",
      "Status": "string"
   },
   "FlywheelArn": "string",
   "MaxResults": number,
   "NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Filter

Filters the datasets to be returned in the response.

Type: DatasetFilter object

Required: No

FlywheelArn

The Amazon Resource Number (ARN) of the flywheel.

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:flywheel/[a-zA-Z0-9](-*[a-zA-Z0-9])*

Required: No

MaxResults

Maximum number of results to return in a response. The default is 100.

Type: Integer

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

Required: No

NextToken

Identifies the next page of results to return.

Type: String

Length Constraints: Minimum length of 1.

Required: No

Response Syntax


{
   "DatasetPropertiesList": [ 
      { 
         "CreationTime": number,
         "DatasetArn": "string",
         "DatasetName": "string",
         "DatasetS3Uri": "string",
         "DatasetType": "string",
         "Description": "string",
         "EndTime": number,
         "Message": "string",
         "NumberOfDocuments": number,
         "Status": "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.

DatasetPropertiesList

The dataset properties list.

Type: Array of DatasetProperties objects

NextToken

Identifies the next page of results to return.

Type: String

Length Constraints: Minimum length of 1.

Errors

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

InternalServerException

An internal server error occurred. Retry your request.

HTTP Status Code: 500

InvalidFilterException

The filter specified for the operation is invalid. Specify a different filter.

HTTP Status Code: 400

InvalidRequestException

The request is invalid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource ARN was not found. Check the ARN and try your request again.

HTTP Status Code: 400

TooManyRequestsException

The number of requests exceeds the limit. Resubmit your request later.

HTTP Status Code: 400