Skip to content

CloudFront  >  Operations  >  describe_function

describe_function

Operation

describe_function async 

describe_function(input: DescribeFunctionInput, plugins: list[Plugin] | None = None) -> DescribeFunctionOutput

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.

Parameters:

Name Type Description Default
input DescribeFunctionInput

An instance of DescribeFunctionInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
DescribeFunctionOutput

An instance of DescribeFunctionOutput.

Input

DescribeFunctionInput dataclass

Bases: _SerdeShape

Dataclass for DescribeFunctionInput structure.

Attributes

name class-attribute instance-attribute 
name: str | None = ...

The name of the function that you are getting information about.

stage class-attribute instance-attribute 
stage: str | None = ...

The function's stage, either DEVELOPMENT or LIVE.

Output

DescribeFunctionOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeFunctionOutput structure.

Attributes

e_tag class-attribute instance-attribute 
e_tag: str | None = ...

The version identifier for the current version of the CloudFront function.

function_summary class-attribute instance-attribute 
function_summary: FunctionSummary | None = ...

Contains configuration information and metadata about a CloudFront function.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.