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

update-public-key

Description

Update public key information. Note that the only value you can change is the comment.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-public-key
--public-key-config <value>
--id <value>
[--if-match <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--public-key-config (structure)

A public key configuration.

CallerReference -> (string)

A string included in the request to help make sure that the request can’t be replayed.

Name -> (string)

A name to help identify the public key.

EncodedKey -> (string)

The public key that you can use with signed URLs and signed cookies , or with field-level encryption .

Comment -> (string)

A comment to describe the public key. The comment cannot be longer than 128 characters.

Shorthand Syntax:

CallerReference=string,Name=string,EncodedKey=string,Comment=string

JSON Syntax:

{
  "CallerReference": "string",
  "Name": "string",
  "EncodedKey": "string",
  "Comment": "string"
}

--id (string)

The identifier of the public key that you are updating.

--if-match (string)

The value of the ETag header that you received when retrieving the public key to update. For example: E2QWRUHAPOMQZL .

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

PublicKey -> (structure)

The public key.

Id -> (string)

The identifier of the public key.

CreatedTime -> (timestamp)

The date and time when the public key was uploaded.

PublicKeyConfig -> (structure)

Configuration information about a public key that you can use with signed URLs and signed cookies , or with field-level encryption .

CallerReference -> (string)

A string included in the request to help make sure that the request can’t be replayed.

Name -> (string)

A name to help identify the public key.

EncodedKey -> (string)

The public key that you can use with signed URLs and signed cookies , or with field-level encryption .

Comment -> (string)

A comment to describe the public key. The comment cannot be longer than 128 characters.

ETag -> (string)

The identifier of the current version of the public key.