CloudFront / Client / test_connection_function

test_connection_function

CloudFront.Client.test_connection_function(**kwargs)

Tests a connection function.

See also: AWS API Documentation

Request Syntax

response = client.test_connection_function(
    Id='string',
    IfMatch='string',
    Stage='DEVELOPMENT'|'LIVE',
    ConnectionObject=b'bytes'
)

Parameters:

• Id (string) –

  [REQUIRED]

  The connection function ID.

• IfMatch (string) –

  [REQUIRED]

  The current version ( ETag value) of the connection function.

• Stage (string) – The connection function stage.

• ConnectionObject (bytes) –

  [REQUIRED]

  The connection object.

Return type:

dict

Returns:

Response Syntax

{
    'ConnectionFunctionTestResult': {
        '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)
        },
        'ComputeUtilization': 'string',
        'ConnectionFunctionExecutionLogs': [
            'string',
        ],
        'ConnectionFunctionErrorMessage': 'string',
        'ConnectionFunctionOutput': 'string'
    }
}

Response Structure

• (dict) –

  • ConnectionFunctionTestResult (dict) –

    The connection function test result.

    • ConnectionFunctionSummary (dict) –

      The connection function 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.

    • ComputeUtilization (string) –

      The connection function compute utilization.

    • ConnectionFunctionExecutionLogs (list) –

      The connection function execution logs.

      • (string) –

    • ConnectionFunctionErrorMessage (string) –

      The connection function error message.

    • ConnectionFunctionOutput (string) –

      The connection function output.

Exceptions

• CloudFront.Client.exceptions.TestFunctionFailed

• CloudFront.Client.exceptions.PreconditionFailed

• CloudFront.Client.exceptions.EntityNotFound

• CloudFront.Client.exceptions.UnsupportedOperation

• CloudFront.Client.exceptions.InvalidArgument

• CloudFront.Client.exceptions.InvalidIfMatchVersion