CloudFront / Client / describe_function

describe_function

CloudFront.Client.describe_function(**kwargs)

Gets configuration information and metadata about a CloudFront function, but not the function’s code. To get a function’s code, use GetFunction.

To get configuration information and metadata about a function, you must provide the function’s name and stage. To get these values, you can use ListFunctions.

See also: AWS API Documentation

Request Syntax

response = client.describe_function(
    Name='string',
    Stage='DEVELOPMENT'|'LIVE'
)

Parameters:

• Name (string) –

  [REQUIRED]

  The name of the function that you are getting information about.

• Stage (string) – The function’s stage, either DEVELOPMENT or LIVE.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • FunctionSummary (dict) –

    Contains configuration information and metadata about a CloudFront function.

    • Name (string) –

      The name of the CloudFront function.

    • Status (string) –

      The status of the CloudFront function.

    • FunctionConfig (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.

    • FunctionMetadata (dict) –

      Contains metadata about a CloudFront function.

      • FunctionARN (string) –

        The Amazon Resource Name (ARN) of the function. The ARN uniquely identifies the function.

      • Stage (string) –

        The stage that the function is in, either DEVELOPMENT or LIVE.

        When a function is in the DEVELOPMENT stage, you can test the function with TestFunction, and update it with UpdateFunction.

        When a function is in the LIVE stage, you can attach the function to a distribution’s cache behavior, using the function’s ARN.

      • CreatedTime (datetime) –

        The date and time when the function was created.

      • LastModifiedTime (datetime) –

        The date and time when the function was most recently updated.

  • ETag (string) –

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

Exceptions

• CloudFront.Client.exceptions.NoSuchFunctionExists

• CloudFront.Client.exceptions.UnsupportedOperation