Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

TestFunction

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.

Request Syntax

POST /2020-05-31/function/Name/test HTTP/1.1
If-Match: IfMatch
<?xml version="1.0" encoding="UTF-8"?>
<TestFunctionRequest xmlns="http://cloudfront.amazonaws.com/doc/2020-05-31/">
   <EventObject>blob</EventObject>
   <Stage>string</Stage>
</TestFunctionRequest>

URI Request Parameters

The request uses the following URI parameters.

Request Body

The request accepts the following data in XML format.

Response Syntax

HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<TestResult>
   <ComputeUtilization>string</ComputeUtilization>
   <FunctionErrorMessage>string</FunctionErrorMessage>
   <FunctionExecutionLogs>
      <member>string</member>
   </FunctionExecutionLogs>
   <FunctionOutput>string</FunctionOutput>
   <FunctionSummary>
      <FunctionConfig>
         <Comment>string</Comment>
         <KeyValueStoreAssociations>
            <Items>
               <KeyValueStoreAssociation>
                  <KeyValueStoreARN>string</KeyValueStoreARN>
               </KeyValueStoreAssociation>
            </Items>
            <Quantity>integer</Quantity>
         </KeyValueStoreAssociations>
         <Runtime>string</Runtime>
      </FunctionConfig>
      <FunctionMetadata>
         <CreatedTime>timestamp</CreatedTime>
         <FunctionARN>string</FunctionARN>
         <LastModifiedTime>timestamp</LastModifiedTime>
         <Stage>string</Stage>
      </FunctionMetadata>
      <Name>string</Name>
      <Status>string</Status>
   </FunctionSummary>
</TestResult>

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in XML format by the service.

Errors

For information about the errors that are common to all actions, see Common Errors.

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: