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

ListDatastores

Retrieves a list of data stores.

Request Syntax


GET /datastores?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of results to return in this request.

The default value is 100.

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

nextToken

The token for the next set of results.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "datastoreSummaries": [ 
      { 
         "creationTime": number,
         "datastoreName": "string",
         "datastorePartitions": { 
            "partitions": [ 
               { 
                  "attributePartition": { 
                     "attributeName": "string"
                  },
                  "timestampPartition": { 
                     "attributeName": "string",
                     "timestampFormat": "string"
                  }
               }
            ]
         },
         "datastoreStorage": { 
            "customerManagedS3": { 
               "bucket": "string",
               "keyPrefix": "string",
               "roleArn": "string"
            },
            "iotSiteWiseMultiLayerStorage": { 
               "customerManagedS3Storage": { 
                  "bucket": "string",
                  "keyPrefix": "string"
               }
            },
            "serviceManagedS3": { 
            }
         },
         "fileFormatType": "string",
         "lastMessageArrivalTime": number,
         "lastUpdateTime": 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.

datastoreSummaries

A list of DatastoreSummary objects.

Type: Array of DatastoreSummary 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

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400