create_alias¶
Operation¶
async
¶
create_alias(input: CreateAliasInput, plugins: list[Plugin] | None = None) -> CreateAliasOutput
Creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version.
You can also map an alias to split invocation requests between two
versions. Use the RoutingConfig parameter to specify a second version
and the percentage of invocation requests that it receives.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateAliasInput
|
An instance of |
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 |
|---|---|
CreateAliasOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for CreateAliasInput structure.
Attributes¶
class-attribute
instance-attribute
¶
description: str | None = None
A description of the alias.
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.
class-attribute
instance-attribute
¶
function_version: str | None = None
The function version that the alias invokes.
class-attribute
instance-attribute
¶
routing_config: AliasRoutingConfiguration | None = None
The routing configuration of the alias.
Output¶
dataclass
¶
Provides configuration information about a Lambda function alias.
Attributes¶
class-attribute
instance-attribute
¶
alias_arn: str | None = None
The Amazon Resource Name (ARN) of the alias.
class-attribute
instance-attribute
¶
description: str | None = None
A description of the alias.
class-attribute
instance-attribute
¶
function_version: str | None = None
The function version that the alias invokes.
class-attribute
instance-attribute
¶
revision_id: str | None = None
A unique identifier that changes when you update the alias.
class-attribute
instance-attribute
¶
routing_config: AliasRoutingConfiguration | None = None
The routing configuration of the alias.