Skip to content

list_account_aliases

Operation

list_account_aliases

list_account_aliases(request: ListAccountAliasesInput | ListAccountAliasesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListAccountAliasesInputDict]) -> ListAccountAliasesOutput

Lists the account alias associated with the Amazon Web Services account (Note: you can have only one). For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the IAM User Guide.

Parameters:

Name Type Description Default
request ListAccountAliasesInput | ListAccountAliasesInputDict | 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[ListAccountAliasesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListAccountAliasesOutput

An instance of ListAccountAliasesOutput.

list_account_aliases async

list_account_aliases(request: ListAccountAliasesInput | ListAccountAliasesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListAccountAliasesInputDict]) -> ListAccountAliasesOutput

Lists the account alias associated with the Amazon Web Services account (Note: you can have only one). For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the IAM User Guide.

Parameters:

Name Type Description Default
request ListAccountAliasesInput | ListAccountAliasesInputDict | 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[ListAccountAliasesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListAccountAliasesOutput

An instance of ListAccountAliasesOutput.

Input

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

ListAccountAliasesInputDict

Bases: TypedDict

Dictionary form of ListAccountAliasesInput.

Attributes

marker instance-attribute
marker: str | None

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

max_items instance-attribute
max_items: int | None

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

ListAccountAliasesInput dataclass

Bases: _SerdeShape

Dataclass for ListAccountAliasesInput structure.

Attributes

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

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

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

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

Output

ListAccountAliasesOutput dataclass

Bases: _SerdeShape

Contains the response to a successful ListAccountAliases request.

Attributes

account_aliases instance-attribute
account_aliases: list[str]

A list of aliases associated with the account. Amazon Web Services supports only one alias per account.

is_truncated class-attribute instance-attribute
is_truncated: bool = ...

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

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

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

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.