Skip to content

CloudFront  >  Operations  >  update_function

update_function

Operation

update_function async 

update_function(input: UpdateFunctionInput, plugins: list[Plugin] | None = None) -> UpdateFunctionOutput

Updates a CloudFront function.

You can update a function's code or the comment that describes the function. You cannot update a function's name.

To update a function, you provide the function's name and version (ETag value) along with the updated function code. To get the name and version, you can use ListFunctions and DescribeFunction.

Parameters:

Name Type Description Default
input UpdateFunctionInput

An instance of UpdateFunctionInput.

 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
UpdateFunctionOutput

An instance of UpdateFunctionOutput.

Input

UpdateFunctionInput dataclass

Bases: _SerdeShape

Dataclass for UpdateFunctionInput structure.

Attributes

function_code class-attribute instance-attribute 
function_code: bytes | None = ...

The function code. For more information about writing a CloudFront function, see Writing function code for CloudFront Functions in the Amazon CloudFront Developer Guide.

function_config class-attribute instance-attribute 
function_config: FunctionConfig | None = ...

Configuration information about the function.

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

The current version (ETag value) of the function that you are updating, which you can get using DescribeFunction.

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

The name of the function that you are updating.

Output

UpdateFunctionOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateFunctionOutput 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.