[ aws . iotsitewise ]

put-default-encryption-configuration

Description

Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the IoT SiteWise User Guide .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  put-default-encryption-configuration
--encryption-type <value>
[--kms-key-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--encryption-type (string)

The type of encryption used for the encryption configuration.

Possible values:

• SITEWISE_DEFAULT_ENCRYPTION

• KMS_BASED_ENCRYPTION

--kms-key-id (string)

The Key ID of the customer managed key used for KMS encryption. This is required if you use KMS_BASED_ENCRYPTION .

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

See ‘aws help’ for descriptions of global parameters.

Output

encryptionType -> (string)

The type of encryption used for the encryption configuration.

kmsKeyArn -> (string)

The Key ARN of the KMS key used for KMS encryption if you use KMS_BASED_ENCRYPTION .

configurationStatus -> (structure)

The status of the account configuration. This contains the ConfigurationState . If there is an error, it also contains the ErrorDetails .

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.