Skip to content

Lambda  >  Operations  >  update_alias

update_alias

Operation

update_alias async 

update_alias(input: UpdateAliasInput, plugins: list[Plugin] | None = None) -> UpdateAliasOutput

Updates the configuration of a Lambda function alias.

Parameters:

Name Type Description Default
input UpdateAliasInput

An instance of UpdateAliasInput.

 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
UpdateAliasOutput

An instance of UpdateAliasOutput.

Input

UpdateAliasInput dataclass

Dataclass for UpdateAliasInput structure.

Attributes

description class-attribute instance-attribute 
description: str | None = None

A description of the alias.

function_name class-attribute instance-attribute 
function_name: str | None = None

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

function_version class-attribute instance-attribute 
function_version: str | None = None

The function version that the alias invokes.

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

The name of the alias.

revision_id class-attribute instance-attribute 
revision_id: str | None = None

Only update the alias if the revision ID matches the ID that's specified. Use this option to avoid modifying an alias that has changed since you last read it.

routing_config class-attribute instance-attribute 
routing_config: AliasRoutingConfiguration | None = None

The routing configuration of the alias.

Output

UpdateAliasOutput dataclass

Provides configuration information about a Lambda function alias.

Attributes

alias_arn class-attribute instance-attribute 
alias_arn: str | None = None

The Amazon Resource Name (ARN) of the alias.

description class-attribute instance-attribute 
description: str | None = None

A description of the alias.

function_version class-attribute instance-attribute 
function_version: str | None = None

The function version that the alias invokes.

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

The name of the alias.

revision_id class-attribute instance-attribute 
revision_id: str | None = None

A unique identifier that changes when you update the alias.

routing_config class-attribute instance-attribute 
routing_config: AliasRoutingConfiguration | None = None

The routing configuration of the alias.