LexModelsV2 / Client / delete_bot_alias

delete_bot_alias

LexModelsV2.Client.delete_bot_alias(**kwargs)

Deletes the specified bot alias.

See also: AWS API Documentation

Request Syntax

response = client.delete_bot_alias(
    botAliasId='string',
    botId='string',
    skipResourceInUseCheck=True|False
)

Parameters:

• botAliasId (string) –

  [REQUIRED]

  The unique identifier of the bot alias to delete.

• botId (string) –

  [REQUIRED]

  The unique identifier of the bot associated with the alias to delete.

• skipResourceInUseCheck (boolean) – By default, Amazon Lex checks if any other resource, such as a bot network, is using the bot alias before it is deleted and throws a ResourceInUseException exception if the alias is being used by another resource. Set this parameter to true to skip this check and remove the alias even if it is being used by another resource.

Return type:

dict

Returns:

Response Syntax

{
    'botAliasId': 'string',
    'botId': 'string',
    'botAliasStatus': 'Creating'|'Available'|'Deleting'|'Failed'
}

Response Structure

• (dict) –

  • botAliasId (string) –

    The unique identifier of the bot alias to delete.

  • botId (string) –

    The unique identifier of the bot that contains the alias to delete.

  • botAliasStatus (string) –

    The current status of the alias. The status is Deleting while the alias is in the process of being deleted. Once the alias is deleted, it will no longer appear in the list of aliases returned by the ListBotAliases operation.

Exceptions

• LexModelsV2.Client.exceptions.ThrottlingException

• LexModelsV2.Client.exceptions.ServiceQuotaExceededException

• LexModelsV2.Client.exceptions.ValidationException

• LexModelsV2.Client.exceptions.ConflictException

• LexModelsV2.Client.exceptions.PreconditionFailedException

• LexModelsV2.Client.exceptions.InternalServerException