ListDatastores
List data stores.
Request Syntax
GET /datastore?datastoreStatus=datastoreStatus&maxResults=maxResults&nextToken=nextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- datastoreStatus
-
The data store status.
Valid Values:
CREATING | CREATE_FAILED | ACTIVE | DELETING | DELETED - maxResults
-
Valid Range: Minimum value of 1. Maximum value of 50.
Valid Range: Minimum value of 1. Maximum value of 50.
- nextToken
-
The pagination token used to request the list of data stores on the next page.
Length Constraints: Minimum length of 1. Maximum length of 8192.
Pattern:
\p{ASCII}{0,8192}
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"datastoreSummaries": [
{
"createdAt": number,
"datastoreArn": "string",
"datastoreId": "string",
"datastoreName": "string",
"datastoreStatus": "string",
"updatedAt": number
}
],
"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.
- datastoreSummaries
-
The list of summaries of data stores.
Type: Array of DatastoreSummary objects
- nextToken
-
The pagination token used to retrieve the list of data stores on the next page.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 8192.
Pattern:
\p{ASCII}{0,8192}
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The user does not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
An unexpected error occurred during processing of the request.
HTTP Status Code: 500
- ThrottlingException
-
The request was denied due to throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints set by the service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
