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

update-key-registration

Description

Updates a customer managed key in a Amazon QuickSight account.

See also: AWS API Documentation

Synopsis

  update-key-registration
--aws-account-id <value>
--key-registration <value>
[--cli-input-json <value>]
[--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>]

Options

--aws-account-id (string)

The ID of the Amazon Web Services account that contains the customer managed key registration that you want to update.

--key-registration (list)

A list of RegisteredCustomerManagedKey objects to be updated to the Amazon QuickSight account.

(structure)

A customer managed key structure that contains the information listed below:

• KeyArn - The ARN of a KMS key that is registered to a Amazon QuickSight account for encryption and decryption use.
• DefaultKey - Indicates whether the current key is set as the default key for encryption and decryption use.

KeyArn -> (string)

The ARN of the KMS key that is registered to a Amazon QuickSight account for encryption and decryption use.

DefaultKey -> (boolean)

Indicates whether a RegisteredCustomerManagedKey is set as the default key for encryption and decryption use.

Shorthand Syntax:

KeyArn=string,DefaultKey=boolean ...

JSON Syntax:

[
  {
    "KeyArn": "string",
    "DefaultKey": true|false
  }
  ...
]

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

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.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

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.

--cli-connect-timeout (int)

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.

Output

FailedKeyRegistration -> (list)

A list of all customer managed key registrations that failed to update.

(structure)

An entry that appears when a KeyRegistration update to Amazon QuickSight fails.

KeyArn -> (string)

The ARN of the KMS key that failed to update.

Message -> (string)

A message that provides information about why a FailedKeyRegistrationEntry error occurred.

StatusCode -> (integer)

The HTTP status of a FailedKeyRegistrationEntry error.

SenderFault -> (boolean)

A boolean that indicates whether a FailedKeyRegistrationEntry resulted from user error. If the value of this property is True , the error was caused by user error. If the value of this property is False , the error occurred on the backend. If your job continues fail and with a False SenderFault value, contact Amazon Web Services Support.

SuccessfulKeyRegistration -> (list)

A list of all customer managed key registrations that were successfully updated.

(structure)

A success entry that occurs when a KeyRegistration job is successfully applied to the Amazon QuickSight account.

KeyArn -> (string)

The ARN of the KMS key that is associated with the SuccessfulKeyRegistrationEntry entry.

StatusCode -> (integer)

The HTTP status of a SuccessfulKeyRegistrationEntry entry.

RequestId -> (string)

The Amazon Web Services request ID for this operation.