Used to update the settings of a data store.
Important
The UpdateDatastore operation in AWS IoT Analytics is no longer available to new customers. Existing customers of AWS IoT Analytics can continue
to use the service as normal.
Learn more
Request Syntax
PUT /datastores/datastoreName HTTP/1.1
Content-type: application/json
{
"datastoreStorage": {
"customerManagedS3": {
"bucket": "string",
"keyPrefix": "string",
"roleArn": "string"
},
"iotSiteWiseMultiLayerStorage": {
"customerManagedS3Storage": {
"bucket": "string",
"keyPrefix": "string"
}
},
"serviceManagedS3": {
}
},
"fileFormatConfiguration": {
"jsonConfiguration": {
},
"parquetConfiguration": {
"schemaDefinition": {
"columns": [
{
"name": "string",
"type": "string"
}
]
}
}
},
"retentionPeriod": {
"numberOfDays": number,
"unlimited": boolean
}
}URI Request Parameters
The request uses the following URI parameters.
- datastoreName
-
The name of the data store to be updated.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
(^(?!_{2}))(^[a-zA-Z0-9_]+$)Required: Yes
Request Body
The request accepts the following data in JSON format.
- datastoreStorage
-
Where data in a data store is stored.. You can choose
serviceManagedS3storage,customerManagedS3storage, oriotSiteWiseMultiLayerStoragestorage. The default isserviceManagedS3. You can't change the choice of Amazon S3 storage after your data store is created.Type: DatastoreStorage object
Required: No
- fileFormatConfiguration
-
Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON and Parquet
. The default file format is JSON. You can specify only one format.
You can't change the file format after you create the data store.
Type: FileFormatConfiguration object
Required: No
- retentionPeriod
-
How long, in days, message data is kept for the data store. The retention period can't be updated if the data store's Amazon S3 storage is customer-managed.
Type: RetentionPeriod object
Required: No
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
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:
