# DescribeFunction
<a name="API_DescribeFunction"></a>

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
<a name="API_DescribeFunction_RequestSyntax"></a>

```
GET /2020-05-31/function/Name/describe?Stage=Stage HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeFunction_RequestParameters"></a>

The request uses the following URI parameters.

 ** [Name](#API_DescribeFunction_RequestSyntax) **   <a name="cloudfront-DescribeFunction-request-uri-Name"></a>
The name of the function that you are getting information about.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-_]{1,64}`   
Required: Yes

 ** [Stage](#API_DescribeFunction_RequestSyntax) **   <a name="cloudfront-DescribeFunction-request-uri-Stage"></a>
The function's stage, either `DEVELOPMENT` or `LIVE`.  
Valid Values: `DEVELOPMENT | LIVE` 

## Request Body
<a name="API_DescribeFunction_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeFunction_ResponseSyntax"></a>

```
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
<a name="API_DescribeFunction_ResponseElements"></a>

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](#API_DescribeFunction_ResponseSyntax) **   <a name="cloudfront-DescribeFunction-response-FunctionSummary"></a>
Root level tag for the FunctionSummary parameters.  
Required: Yes

 ** [FunctionConfig](#API_DescribeFunction_ResponseSyntax) **   <a name="cloudfront-DescribeFunction-response-FunctionConfig"></a>
Contains configuration information about a CloudFront function.  
Type: [FunctionConfig](API_FunctionConfig.md) object

 ** [FunctionMetadata](#API_DescribeFunction_ResponseSyntax) **   <a name="cloudfront-DescribeFunction-response-FunctionMetadata"></a>
Contains metadata about a CloudFront function.  
Type: [FunctionMetadata](API_FunctionMetadata.md) object

 ** [Name](#API_DescribeFunction_ResponseSyntax) **   <a name="cloudfront-DescribeFunction-response-Name"></a>
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](#API_DescribeFunction_ResponseSyntax) **   <a name="cloudfront-DescribeFunction-response-Status"></a>
The status of the CloudFront function.  
Type: String

## Errors
<a name="API_DescribeFunction_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_DescribeFunction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudfront-2020-05-31/DescribeFunction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudfront-2020-05-31/DescribeFunction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudfront-2020-05-31/DescribeFunction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudfront-2020-05-31/DescribeFunction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudfront-2020-05-31/DescribeFunction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudfront-2020-05-31/DescribeFunction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudfront-2020-05-31/DescribeFunction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudfront-2020-05-31/DescribeFunction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudfront-2020-05-31/DescribeFunction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudfront-2020-05-31/DescribeFunction)