Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iotsitewise ]

put-storage-configuration

Description

Configures storage settings for IoT SiteWise.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  put-storage-configuration
--storage-type <value>
[--multi-layer-storage <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--storage-type (string)

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

  • SITEWISE_DEFAULT_STORAGE – IoT SiteWise replicates your data into a service managed database.
  • MULTI_LAYER_STORAGE – IoT SiteWise replicates your data into a service managed database and saves a copy of your raw data and metadata in an Amazon S3 object that you specified.

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"
  }
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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 type of storage that you specified for your data. The storage type can be one of the following values:

  • SITEWISE_DEFAULT_STORAGE – IoT SiteWise replicates your data into a service managed database.
  • MULTI_LAYER_STORAGE – IoT SiteWise replicates your data into a service managed database and saves a copy of your raw data and metadata in an Amazon S3 object that you specified.

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.

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.