list_account_aliases `async` ¶

list_account_aliases(
    *,
    config_overrides: Optional[AsyncIAMClientConfig] = None,
    marker: Optional[markerType] = None,
    max_items: Optional[maxItemsType] = None,
) -> ListAccountAliasesResponse

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:

marker (Optional[markerType], default: 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 (Optional[maxItemsType], default: 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.

Raises:

ServiceFailureException –

The request processing has failed because of an unknown error, exception or failure.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

To list account aliases The following command lists the aliases for the current account.

>>> await client.list_account_aliases()

Source code in docs_src/capo_iam/_services/async_iam.py

async def list_account_aliases(
    self,
    *,
    config_overrides: Optional[AsyncIAMClientConfig] = None,
    marker: Optional["capo_iam.types.marker_type.markerType"] = None,
    max_items: Optional["capo_iam.types.max_items_type.maxItemsType"] = None,
) -> "capo_iam.types.list_account_aliases_response.ListAccountAliasesResponse":
    """<p>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 <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/console_account-alias.html#CreateAccountAlias">Creating, deleting, and listing an Amazon Web Services account alias</a> in the <i>IAM User Guide</i>.</p>

    Args:
        marker: <p>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 <code>Marker</code> element in the response that you received to indicate where the next call should start.</p>
        max_items: <p>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 <code>IsTruncated</code> response element is <code>true</code>.</p> <p>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 <code>IsTruncated</code> response element returns <code>true</code>, and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from.</p>

    Raises:
        capo_iam.errors.service_failure_exception.ServiceFailureException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_iam.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To list account aliases
        The following command lists the aliases for the current account.

        >>> await client.list_account_aliases()
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iam.types.list_account_aliases_request.ListAccountAliasesRequest]",
    ) -> AsyncOperationResponse[
        "capo_iam.types.list_account_aliases_response.ListAccountAliasesResponse"
    ]:
        import capo_iam._operations.aws_identity_management_v20100508.list_account_aliases

        (
            output,
            http_response,
        ) = await capo_iam._operations.aws_identity_management_v20100508.list_account_aliases.async_list_account_aliases(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAccountAliases")
    )
    input_: capo_iam.types.list_account_aliases_request.ListAccountAliasesRequest = {}
    if marker is not None:
        input_["marker"] = marker
    if max_items is not None:
        input_["max_items"] = max_items

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

list_account_aliases async ¶

list_account_aliases `async` ¶