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
See also: AWS API Documentation
test-function --name <value> --if-match <value> [--stage <value>] --event-object <value> [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton <value>] [--debug] [--endpoint-url <value>] [--no-verify-ssl] [--no-paginate] [--output <value>] [--query <value>] [--profile <value>] [--region <value>] [--version <value>] [--color <value>] [--no-sign-request] [--ca-bundle <value>] [--cli-read-timeout <value>] [--cli-connect-timeout <value>] [--cli-binary-format <value>] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt]
The name of the function that you are testing.
The current version (
ETagvalue) of the function that you are testing, which you can get using
The stage of the function that you are testing, either
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 .
Reads arguments from the JSON string provided. The JSON string follows the format provided by
--generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value
input, prints a sample input JSON that can be used as an argument for
--cli-input-json. Similarly, if provided
yaml-input it will print a sample input YAML that can be used with
--cli-input-yaml. If provided with the value
output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Turn on debug logging.
Override command’s default URL with the given URL.
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
Disable automatic pagination.
The formatting style for command output.
A JMESPath query to use in filtering the response data.
Use a specific profile from your credential file.
The region to use. Overrides config/env settings.
Display the version of this tool.
Turn on/off color output.
Do not sign requests. Credentials will not be loaded if this argument is provided.
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob
fileb:// will always be treated as binary and use the file contents directly regardless of the
cli-binary-format setting. When using
file:// the file contents will need to properly formatted for the configured
Disable cli pager for output.
Automatically prompt for CLI input parameters.
Disable automatically prompt for CLI input parameters.
TestResult -> (structure)
An object that represents the result of running the function with the provided event object.
FunctionSummary -> (structure)
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 -> (structure)
Contains configuration information about a CloudFront function.
Comment -> (string)A comment to describe the function.
Runtime -> (string)The function’s runtime environment version.
KeyValueStoreAssociations -> (structure)
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.
The Key Value Store association.
KeyValueStoreARN -> (string)The Amazon Resource Name (ARN) of the Key Value Store association.
FunctionMetadata -> (structure)
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
When a function is in the
DEVELOPMENTstage, you can test the function with
TestFunction, and update it with
When a function is in the
LIVEstage, you can attach the function to a distribution’s cache behavior, using the function’s ARN.
CreatedTime -> (timestamp)The date and time when the function was created.
LastModifiedTime -> (timestamp)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.
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 .