CloudFront / Client / update_public_key

update_public_key#

CloudFront.Client.update_public_key(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.update_public_key(
    PublicKeyConfig={
        'CallerReference': 'string',
        'Name': 'string',
        'EncodedKey': 'string',
        'Comment': 'string'
    },
    Id='string',
    IfMatch='string'
)
Parameters:

  • PublicKeyConfig (dict) –

    [REQUIRED]

    A public key configuration.

    • CallerReference (string) – [REQUIRED]

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

    • Name (string) – [REQUIRED]

      A name to help identify the public key.

    • EncodedKey (string) – [REQUIRED]

      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.

  • Id (string) –

    [REQUIRED]

    The identifier of the public key that you are updating.

  • IfMatch (string) – The value of the ETag header that you received when retrieving the public key to update. For example: E2QWRUHAPOMQZL.

Return type:

dict

Returns:

Response Syntax

{
    'PublicKey': {
        'Id': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'PublicKeyConfig': {
            'CallerReference': 'string',
            'Name': 'string',
            'EncodedKey': 'string',
            'Comment': 'string'
        }
    },
    'ETag': 'string'
}

Response Structure

  • (dict) –

    • PublicKey (dict) –

      The public key.

      • Id (string) –

        The identifier of the public key.

      • CreatedTime (datetime) –

        The date and time when the public key was uploaded.

      • PublicKeyConfig (dict) –

        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.

Exceptions