DescribeFunction
Gets configuration information and metadata about a CloudFront function, but not the
function's code. To get a function's code, use GetFunction.
To get configuration information and metadata about a function, you must provide the
function's name and stage. To get these values, you can use
ListFunctions.
Request Syntax
GET /2020-05-31/function/Name/describe?Stage=Stage HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<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>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.
- FunctionSummary
-
Root level tag for the FunctionSummary parameters.
Required: Yes
- FunctionConfig
-
Contains configuration information about a CloudFront function.
Type: FunctionConfig object
- FunctionMetadata
-
Contains metadata about a CloudFront function.
Type: FunctionMetadata object
- Name
-
The name of the CloudFront function.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9-_]{1,64} - Status
-
The status of the CloudFront function.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- NoSuchFunctionExists
-
The function does not exist.
HTTP Status Code: 404
- UnsupportedOperation
-
This operation is not supported in this AWS Region.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
