Skip to content

CloudFront  >  Operations  >  update_response_headers_policy

update_response_headers_policy

Operation

update_response_headers_policy async 

update_response_headers_policy(input: UpdateResponseHeadersPolicyInput, plugins: list[Plugin] | None = None) -> UpdateResponseHeadersPolicyOutput

Updates a response headers policy.

When you update a response headers policy, the entire policy is replaced. You cannot update some policy fields independent of others. To update a response headers policy configuration:

  1. Use GetResponseHeadersPolicyConfig to get the current policy's configuration.

  2. Modify the fields in the response headers policy configuration that you want to update.

  3. Call UpdateResponseHeadersPolicy, providing the entire response headers policy configuration, including the fields that you modified and those that you didn't.

Parameters:

Name Type Description Default
input UpdateResponseHeadersPolicyInput

An instance of UpdateResponseHeadersPolicyInput.

 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
UpdateResponseHeadersPolicyOutput

An instance of UpdateResponseHeadersPolicyOutput.

Input

UpdateResponseHeadersPolicyInput dataclass

Bases: _SerdeShape

Dataclass for UpdateResponseHeadersPolicyInput structure.

Attributes

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

The identifier for the response headers policy that you are updating.

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

The version of the response headers policy that you are updating.

The version is returned in the cache policy's ETag field in the response to GetResponseHeadersPolicyConfig.

response_headers_policy_config class-attribute instance-attribute 
response_headers_policy_config: ResponseHeadersPolicyConfig | None = ...

A response headers policy configuration.

Output

UpdateResponseHeadersPolicyOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateResponseHeadersPolicyOutput structure.

Attributes

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

The current version of the response headers policy.

response_headers_policy class-attribute instance-attribute 
response_headers_policy: ResponseHeadersPolicy | None = ...

A response headers policy.

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.