CloudFront / Client / describe_connection_function

describe_connection_function

CloudFront.Client.describe_connection_function(**kwargs)

Describes a connection function.

See also: AWS API Documentation

Request Syntax

response = client.describe_connection_function(
    Identifier='string',
    Stage='DEVELOPMENT'|'LIVE'
)
Parameters:
  • Identifier (string) –

    [REQUIRED]

    The connection function’s identifier.

  • Stage (string) – The connection function’s stage.

Return type:

dict

Returns:

Response Syntax

{
    'ConnectionFunctionSummary': {
        'Name': 'string',
        'Id': 'string',
        'ConnectionFunctionConfig': {
            'Comment': 'string',
            'Runtime': 'cloudfront-js-1.0'|'cloudfront-js-2.0',
            'KeyValueStoreAssociations': {
                'Quantity': 123,
                'Items': [
                    {
                        'KeyValueStoreARN': 'string'
                    },
                ]
            }
        },
        'ConnectionFunctionArn': 'string',
        'Status': 'string',
        'Stage': 'DEVELOPMENT'|'LIVE',
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1)
    },
    'ETag': 'string'
}

Response Structure

  • (dict) –

    • ConnectionFunctionSummary (dict) –

      The connection function’s summary.

      • Name (string) –

        The connection function name.

      • Id (string) –

        The connection function ID.

      • ConnectionFunctionConfig (dict) –

        Contains configuration information about a CloudFront function.

        • Comment (string) –

          A comment to describe the function.

        • Runtime (string) –

          The function’s runtime environment version.

        • KeyValueStoreAssociations (dict) –

          The configuration for the key value store associations.

          • Quantity (integer) –

            The quantity of key value store associations.

          • Items (list) –

            The items of the key value store association.

            • (dict) –

              The key value store association.

              • KeyValueStoreARN (string) –

                The Amazon Resource Name (ARN) of the key value store association.

      • ConnectionFunctionArn (string) –

        The connection function Amazon Resource Name (ARN).

      • Status (string) –

        The connection function status.

      • Stage (string) –

        The connection function stage.

      • CreatedTime (datetime) –

        The connection function created time.

      • LastModifiedTime (datetime) –

        The connection function last modified time.

    • ETag (string) –

      The version identifier for the current version of the connection function.

Exceptions

  • CloudFront.Client.exceptions.AccessDenied

  • CloudFront.Client.exceptions.EntityNotFound

  • CloudFront.Client.exceptions.UnsupportedOperation

  • CloudFront.Client.exceptions.InvalidArgument