put-storage-configuration¶

Description¶

Configures storage settings for IoT SiteWise.

Synopsis¶

  put-storage-configuration
--storage-type <value>
[--multi-layer-storage <value>]
[--disassociated-data-storage <value>]
[--retention-period <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--storage-type (string)

The storage tier that you specified for your data. The storageType parameter 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 cold tier. The cold tier is a customer-managed Amazon S3 bucket.

Possible values:

SITEWISE_DEFAULT_STORAGE

MULTI_LAYER_STORAGE

--multi-layer-storage (structure)

Identifies a storage destination. If you specified MULTI_LAYER_STORAGE for the storage type, you must specify a MultiLayerStorage object.

customerManagedS3Storage -> (structure)

Contains information about a customer managed Amazon S3 bucket.

s3ResourceArn -> (string)

The ARN of the Amazon S3 object. For more information about how to find the ARN for an Amazon S3 object, see Amazon S3 resources in the Amazon Simple Storage Service User Guide .

roleArn -> (string)

The ARN of the Identity and Access Management role that allows IoT SiteWise to send data to Amazon S3.

Shorthand Syntax:

customerManagedS3Storage={s3ResourceArn=string,roleArn=string}

JSON Syntax:

{
  "customerManagedS3Storage": {
    "s3ResourceArn": "string",
    "roleArn": "string"
  }
}

--disassociated-data-storage (string)

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 – IoT SiteWise accepts time series that aren’t associated with asset properties.

Warning

After the disassociatedDataStorage is 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 .

Possible values:

ENABLED

DISABLED

--retention-period (structure)

How many 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.

Note

If you specified a value for this parameter, the unlimited parameter must be false .

unlimited -> (boolean)

If true, your data is kept indefinitely.

Note

If configured to true , you must not specify a value for the numberOfDays parameter.

Shorthand Syntax:

numberOfDays=integer,unlimited=boolean

JSON Syntax:

{
  "numberOfDays": integer,
  "unlimited": true|false
}

--cli-input-json | --cli-input-yaml (string) 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 --cli-input-yaml.

--generate-cli-skeleton (string) 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.

See ‘aws help’ for descriptions of global parameters.

Output¶

storageType -> (string)

The storage tier that you specified for your data. The storageType parameter 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 cold 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)

The ARN of the Amazon S3 object. For more information about how to find the ARN for an Amazon S3 object, see Amazon S3 resources in the Amazon Simple Storage Service User Guide .

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 disassociatedDataStorage can be one of the following values:

ENABLED – IoT SiteWise accepts time series that aren’t associated with asset properties.

Warning

After the disassociatedDataStorage is 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)

How many 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.

Note

If you specified a value for this parameter, the unlimited parameter must be false .

unlimited -> (boolean)

If true, your data is kept indefinitely.

Note

If configured to true , you must not specify a value for the numberOfDays parameter.

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.

Table of Contents

Feedback

User Guide