DescribeStorageConfiguration - AWS IoT SiteWise
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

DescribeStorageConfiguration

Retrieves information about the storage configuration for AWS IoT SiteWise.

Request Syntax

GET /configuration/account/storage HTTP/1.1

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "configurationStatus": { 
      "error": { 
         "code": "string",
         "message": "string"
      },
      "state": "string"
   },
   "disassociatedDataStorage": "string",
   "lastUpdateDate": number,
   "multiLayerStorage": { 
      "customerManagedS3Storage": { 
         "roleArn": "string",
         "s3ResourceArn": "string"
      }
   },
   "retentionPeriod": { 
      "numberOfDays": number,
      "unlimited": boolean
   },
   "storageType": "string",
   "warmTier": "string",
   "warmTierRetentionPeriod": { 
      "numberOfDays": number,
      "unlimited": boolean
   }
}

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.

configurationStatus

Contains current status information for the configuration.

Type: ConfigurationStatus object

disassociatedDataStorage

Contains the storage configuration for time series (data streams) that aren't associated with asset properties. The disassociatedDataStorage can be one of the following values:

  • ENABLED – AWS IoT SiteWise accepts time series that aren't associated with asset properties.

    Important

    After the disassociatedDataStorage is enabled, you can't disable it.

  • DISABLED – AWS IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.

For more information, see Data streams in the AWS IoT SiteWise User Guide.

Type: String

Valid Values: ENABLED | DISABLED

lastUpdateDate

The date the storage configuration was last updated, in Unix epoch time.

Type: Timestamp

multiLayerStorage

Contains information about the storage destination.

Type: MultiLayerStorage object

retentionPeriod

The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.

Type: RetentionPeriod object

storageType

The storage tier that you specified for your data. The storageType parameter can be one of the following values:

  • SITEWISE_DEFAULT_STORAGE – AWS IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.

  • MULTI_LAYER_STORAGE – AWS IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.

Type: String

Valid Values: SITEWISE_DEFAULT_STORAGE | MULTI_LAYER_STORAGE

warmTier

A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.

Type: String

Valid Values: ENABLED | DISABLED

warmTierRetentionPeriod

Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.

Type: WarmTierRetentionPeriod object

Errors

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

ConflictingOperationException

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

HTTP Status Code: 409

InternalFailureException

AWS IoT SiteWise can't process your request right now. Try again later.

HTTP Status Code: 500

InvalidRequestException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

HTTP Status Code: 400

LimitExceededException

You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

For more information, see Quotas in the AWS IoT SiteWise User Guide.

HTTP Status Code: 410

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the AWS IoT SiteWise User Guide.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: