AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginTestFunction and EndTestFunction.

Namespace: Amazon.CloudFront
Assembly: AWSSDK.CloudFront.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<TestFunctionResponse> TestFunctionAsync(
         TestFunctionRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CloudFront.Model.TestFunctionRequest

Container for the necessary parameters to execute the TestFunction service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the TestFunction service method, as returned by CloudFront.

Exceptions

ExceptionCondition
InvalidArgumentException An argument is invalid.
InvalidIfMatchVersionException The If-Match version is missing or not valid.
NoSuchFunctionExistsException The function does not exist.
TestFunctionFailedException The CloudFront function failed.
UnsupportedOperationException This operation is not supported in this region.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also