delete_account_alias `async` ¶

delete_account_alias(
    account_alias: accountAliasType,
    *,
    config_overrides: Optional[AsyncIAMClientConfig] = None,
) -> None

Deletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the Amazon Web Services Sign-In User Guide.

Parameters:

account_alias (accountAliasType) –

The name of the account alias to delete.

This parameter allows (through its regex pattern) a string of characters consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row.

Raises:

ConcurrentModificationException –

The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
LimitExceededException –

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
NoSuchEntityException –

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
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 delete an account alias The following command removes the alias mycompany from the current AWS account:

>>> await client.delete_account_alias(account_alias='mycompany')

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

async def delete_account_alias(
    self,
    account_alias: "capo_iam.types.account_alias_type.accountAliasType",
    *,
    config_overrides: Optional[AsyncIAMClientConfig] = None,
) -> None:
    """<p> Deletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services account alias, see <a href="https://docs.aws.amazon.com/signin/latest/userguide/CreateAccountAlias.html">Creating, deleting, and listing an Amazon Web Services account alias</a> in the <i>Amazon Web Services Sign-In User Guide</i>.</p>

    Args:
        account_alias: <p>The name of the account alias to delete.</p> <p>This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of characters consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row.</p>

    Raises:
        capo_iam.errors.concurrent_modification_exception.ConcurrentModificationException: <p>The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.</p>
        capo_iam.errors.limit_exceeded_exception.LimitExceededException: <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.</p>
        capo_iam.errors.no_such_entity_exception.NoSuchEntityException: <p>The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.</p>
        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 delete an account alias
        The following command removes the alias mycompany from the current AWS account:

        >>> await client.delete_account_alias(account_alias='mycompany')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iam.types.delete_account_alias_request.DeleteAccountAliasRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_iam._operations.aws_identity_management_v20100508.delete_account_alias

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteAccountAlias")
    )
    input_: capo_iam.types.delete_account_alias_request.DeleteAccountAliasRequest = {
        "account_alias": account_alias
    }

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

delete_account_alias async ¶

delete_account_alias `async` ¶