Skip to content

list_aliases

Operation

list_aliases

list_aliases(request: ListAliasesInput | ListAliasesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListAliasesInputDict]) -> ListAliasesOutput

Returns a list of aliases for a Lambda Event Function.

Parameters:

Name Type Description Default
request ListAliasesInput | ListAliasesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListAliasesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListAliasesOutput

An instance of ListAliasesOutput.

list_aliases async

list_aliases(request: ListAliasesInput | ListAliasesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListAliasesInputDict]) -> ListAliasesOutput

Returns a list of aliases for a Lambda Event Function.

Parameters:

Name Type Description Default
request ListAliasesInput | ListAliasesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListAliasesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListAliasesOutput

An instance of ListAliasesOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListAliasesInputDict

Bases: TypedDict

Dictionary form of ListAliasesInput.

Attributes

function_name instance-attribute
function_name: Required[str]

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 instance-attribute
function_version: str | None

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

marker instance-attribute
marker: str | None

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

max_items instance-attribute
max_items: int | None

Limit the number of aliases returned.

ListAliasesInput dataclass

Bases: _SerdeShape

Dataclass for ListAliasesInput structure.

Attributes

function_name class-attribute instance-attribute
function_name: str | 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 = ...

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

marker class-attribute instance-attribute
marker: str | 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 = ...

Limit the number of aliases returned.

Output

ListAliasesOutput dataclass

Bases: _SerdeShape

Dataclass for ListAliasesOutput structure.

Attributes

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

A list of aliases.

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

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

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.