IAM / Client / create_account_alias

create_account_alias#

IAM.Client.create_account_alias(**kwargs)#

Creates an alias for your Amazon Web Services account. 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.

See also: AWS API Documentation

Request Syntax

response = client.create_account_alias(
    AccountAlias='string'
)
Parameters:

AccountAlias (string) –

[REQUIRED]

The account alias to create.

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.

Returns:

None

Exceptions

  • IAM.Client.exceptions.ConcurrentModificationException

  • IAM.Client.exceptions.EntityAlreadyExistsException

  • IAM.Client.exceptions.LimitExceededException

  • IAM.Client.exceptions.ServiceFailureException

Examples

The following command associates the alias examplecorp to your AWS account.

response = client.create_account_alias(
    AccountAlias='examplecorp',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}