Skip to content

Lambda  >  Operations  >  list_aliases

list_aliases

Operation

list_aliases async

list_aliases(input: ListAliasesInput, plugins: list[Plugin] | None = None) -> ListAliasesOutput

Returns a list of aliases for a Lambda function.

Parameters:

Name Type Description Default
input ListAliasesInput

An instance of ListAliasesInput.

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
ListAliasesOutput

An instance of ListAliasesOutput.

Input

ListAliasesInput dataclass

Dataclass for ListAliasesInput structure.

Attributes

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

Specify a function version to only list aliases that invoke that version.

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

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

max_items class-attribute instance-attribute
max_items: int | None = None

Limit the number of aliases returned.

Output

ListAliasesOutput dataclass

Dataclass for ListAliasesOutput structure.

Attributes

aliases class-attribute instance-attribute
aliases: list[AliasConfiguration] | None = None

A list of aliases.

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

The pagination token that's included if more results are available.