CloudFront / Client / test_function

test_function#

CloudFront.Client.test_function(**kwargs)#

Tests a CloudFront function.

To test a function, you provide an event object that represents an HTTP request or response that your CloudFront distribution could receive in production. CloudFront runs the function, passing it the event object that you provided, and returns the function’s result (the modified event object) in the response. The response also contains function logs and error messages, if any exist. For more information about testing functions, see Testing functions in the Amazon CloudFront Developer Guide.

To test a function, you provide the function’s name and version ( ETag value) along with the event object. To get the function’s name and version, you can use ListFunctions and DescribeFunction.

See also: AWS API Documentation

Request Syntax

response = client.test_function(
    Name='string',
    IfMatch='string',
    Stage='DEVELOPMENT'|'LIVE',
    EventObject=b'bytes'
)
Parameters:

  • Name (string) –

    [REQUIRED]

    The name of the function that you are testing.

  • IfMatch (string) –

    [REQUIRED]

    The current version ( ETag value) of the function that you are testing, which you can get using DescribeFunction.

  • Stage (string) – The stage of the function that you are testing, either DEVELOPMENT or LIVE.

  • EventObject (bytes) –

    [REQUIRED]

    The event object to test the function with. For more information about the structure of the event object, see Testing functions in the Amazon CloudFront Developer Guide.

Return type:

dict

Returns:

Response Syntax

{
    'TestResult': {
        '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)
            }
        },
        'ComputeUtilization': 'string',
        'FunctionExecutionLogs': [
            'string',
        ],
        'FunctionErrorMessage': 'string',
        'FunctionOutput': 'string'
    }
}

Response Structure

  • (dict) –

    • TestResult (dict) –

      An object that represents the result of running the function with the provided event object.

      • FunctionSummary (dict) –

        Contains configuration information and metadata about the CloudFront function that was tested.

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

      • ComputeUtilization (string) –

        The amount of time that the function took to run as a percentage of the maximum allowed time. For example, a compute utilization of 35 means that the function completed in 35% of the maximum allowed time.

      • FunctionExecutionLogs (list) –

        Contains the log lines that the function wrote (if any) when running the test.

        • (string) –

      • FunctionErrorMessage (string) –

        If the result of testing the function was an error, this field contains the error message.

      • FunctionOutput (string) –

        The event object returned by the function. For more information about the structure of the event object, see Event object structure in the Amazon CloudFront Developer Guide.

Exceptions