Retrieves information about the storage configuration for IoT SiteWise.
See also: AWS API Documentation
describe-storage-configuration [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton <value>] [--debug] [--endpoint-url <value>] [--no-verify-ssl] [--no-paginate] [--output <value>] [--query <value>] [--profile <value>] [--region <value>] [--version <value>] [--color <value>] [--no-sign-request] [--ca-bundle <value>] [--cli-read-timeout <value>] [--cli-connect-timeout <value>] [--cli-binary-format <value>] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt]
Reads arguments from the JSON string provided. The JSON string follows the format provided by
--generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value
input, prints a sample input JSON that can be used as an argument for
--cli-input-json. Similarly, if provided
yaml-input it will print a sample input YAML that can be used with
--cli-input-yaml. If provided with the value
output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Turn on debug logging.
Override command’s default URL with the given URL.
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
Disable automatic pagination.
The formatting style for command output.
A JMESPath query to use in filtering the response data.
Use a specific profile from your credential file.
The region to use. Overrides config/env settings.
Display the version of this tool.
Turn on/off color output.
Do not sign requests. Credentials will not be loaded if this argument is provided.
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob
fileb:// will always be treated as binary and use the file contents directly regardless of the
cli-binary-format setting. When using
file:// the file contents will need to properly formatted for the configured
Disable cli pager for output.
Automatically prompt for CLI input parameters.
Disable automatically prompt for CLI input parameters.
storageType -> (string)
The storage tier that you specified for your data. The
storageTypeparameter can be one of the following values:
SITEWISE_DEFAULT_STORAGE– IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.
MULTI_LAYER_STORAGE– IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.
multiLayerStorage -> (structure)
Contains information about the storage destination.
customerManagedS3Storage -> (structure)
Contains information about a customer managed Amazon S3 bucket.
s3ResourceArn -> (string)
roleArn -> (string)The ARN of the Identity and Access Management role that allows IoT SiteWise to send data to Amazon S3.
disassociatedDataStorage -> (string)
Contains the storage configuration for time series (data streams) that aren’t associated with asset properties. The
disassociatedDataStoragecan be one of the following values:
ENABLED– IoT SiteWise accepts time series that aren’t associated with asset properties.
disassociatedDataStorageis enabled, you can’t disable it.
DISABLED– IoT SiteWise doesn’t accept time series (data streams) that aren’t associated with asset properties.
For more information, see Data streams in the IoT SiteWise User Guide .
retentionPeriod -> (structure)
The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.
numberOfDays -> (integer)
The number of days that your data is kept.
NoteIf you specified a value for this parameter, the
unlimitedparameter must be
unlimited -> (boolean)
If true, your data is kept indefinitely.
NoteIf configured to
true, you must not specify a value for the
configurationStatus -> (structure)
Contains current status information for the configuration.
state -> (string)The current state of the configuration.
error -> (structure)
Contains associated error information, if any.
code -> (string)The error code.
message -> (string)The error message.
lastUpdateDate -> (timestamp)
The date the storage configuration was last updated, in Unix epoch time.
warmTier -> (string)
A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.
warmTierRetentionPeriod -> (structure)
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.
numberOfDays -> (integer)The number of days the data is stored in the warm tier.
unlimited -> (boolean)If set to true, the data is stored indefinitely in the warm tier.