CloudFront / Client / get_public_key_config

get_public_key_config#

CloudFront.Client.get_public_key_config(**kwargs)#

Gets a public key configuration.

See also: AWS API Documentation

Request Syntax

response = client.get_public_key_config(
    Id='string'
)
Parameters:

Id (string) –

[REQUIRED]

The identifier of the public key whose configuration you are getting.

Return type:

dict

Returns:

Response Syntax

{
    'PublicKeyConfig': {
        'CallerReference': 'string',
        'Name': 'string',
        'EncodedKey': 'string',
        'Comment': 'string'
    },
    'ETag': 'string'
}

Response Structure

  • (dict) –

    • PublicKeyConfig (dict) –

      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.

    • ETag (string) –

      The identifier for this version of the public key configuration.

Exceptions

  • CloudFront.Client.exceptions.AccessDenied

  • CloudFront.Client.exceptions.NoSuchPublicKey