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)

Request to update public key information.

Shorthand Syntax:

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

JSON Syntax:

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

--id (string)

ID of the public key to be updated.

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

Return the results of updating the public key.

Id -> (string)

A unique ID assigned to a public key you've added to CloudFront.

CreatedTime -> (timestamp)

A time you added a public key to CloudFront.

PublicKeyConfig -> (structure)

A complex data type for a public key you add to CloudFront to use with features like field-level encryption.

CallerReference -> (string)

A unique number that ensures that the request can't be replayed.

Name -> (string)

The name for a public key you add to CloudFront to use with features like field-level encryption.

EncodedKey -> (string)

The encoded public key that you want to add to CloudFront to use with features like field-level encryption.

Comment -> (string)

An optional comment about a public key.

ETag -> (string)

The current version of the update public key result. For example: E2QWRUHAPOMQZL .