DescribeDatastore
Important
End of support notice: On December 15, 2025, AWS will end support for AWS IoT Analytics. After December 15, 2025, you will no longer be able to access the AWS IoT Analytics console or AWS IoT Analytics resources. For more information, see AWS IoT Analytics end of support.
Retrieves information about a data store.
Request Syntax
GET /datastores/datastoreName
?includeStatistics=includeStatistics
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- datastoreName
-
The name of the data store
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
(^(?!_{2}))(^[a-zA-Z0-9_]+$)
Required: Yes
- includeStatistics
-
If true, additional statistical information about the data store is included in the response. This feature can't be used with a data store whose S3 storage is customer-managed.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"datastore": {
"arn": "string",
"creationTime": number,
"datastorePartitions": {
"partitions": [
{
"attributePartition": {
"attributeName": "string"
},
"timestampPartition": {
"attributeName": "string",
"timestampFormat": "string"
}
}
]
},
"fileFormatConfiguration": {
"jsonConfiguration": {
},
"parquetConfiguration": {
"schemaDefinition": {
"columns": [
{
"name": "string",
"type": "string"
}
]
}
}
},
"lastMessageArrivalTime": number,
"lastUpdateTime": number,
"name": "string",
"retentionPeriod": {
"numberOfDays": number,
"unlimited": boolean
},
"status": "string",
"storage": {
"customerManagedS3": {
"bucket": "string",
"keyPrefix": "string",
"roleArn": "string"
},
"iotSiteWiseMultiLayerStorage": {
"customerManagedS3Storage": {
"bucket": "string",
"keyPrefix": "string"
}
},
"serviceManagedS3": {
}
}
},
"statistics": {
"size": {
"estimatedOn": number,
"estimatedSizeInBytes": number
}
}
}
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.
- datastore
-
Information about the data store.
Type: Datastore object
- statistics
-
Additional statistical information about the data store. Included if the
includeStatistics
parameter is set totrue
in the request.Type: DatastoreStatistics object
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: