Skip to content

create_account_alias

Operation

create_account_alias

create_account_alias(request: CreateAccountAliasInput | CreateAccountAliasInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateAccountAliasInputDict]) -> CreateAccountAliasOutput

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.

Parameters:

Name Type Description Default
request CreateAccountAliasInput | CreateAccountAliasInputDict | 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[CreateAccountAliasInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateAccountAliasOutput

An instance of CreateAccountAliasOutput.

create_account_alias async

create_account_alias(request: CreateAccountAliasInput | CreateAccountAliasInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateAccountAliasInputDict]) -> CreateAccountAliasOutput

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.

Parameters:

Name Type Description Default
request CreateAccountAliasInput | CreateAccountAliasInputDict | 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[CreateAccountAliasInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateAccountAliasOutput

An instance of CreateAccountAliasOutput.

Input

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

CreateAccountAliasInputDict

Bases: TypedDict

Dictionary form of CreateAccountAliasInput.

Attributes

account_alias instance-attribute
account_alias: Required[str]

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.

CreateAccountAliasInput dataclass

Bases: _SerdeShape

Dataclass for CreateAccountAliasInput structure.

Attributes

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

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.

Output

CreateAccountAliasOutput dataclass

Bases: _SerdeShape

Dataclass for CreateAccountAliasOutput structure.

Attributes

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.