SFN / Client / delete_state_machine_alias

delete_state_machine_alias#

SFN.Client.delete_state_machine_alias(**kwargs)#

Deletes a state machine alias.

After you delete a state machine alias, you can’t use it to start executions. When you delete a state machine alias, Step Functions doesn’t delete the state machine versions that alias references.

Related operations:

  • CreateStateMachineAlias

  • DescribeStateMachineAlias

  • ListStateMachineAliases

  • UpdateStateMachineAlias

See also: AWS API Documentation

Request Syntax

response = client.delete_state_machine_alias(
    stateMachineAliasArn='string'
)
Parameters:

stateMachineAliasArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the state machine alias to delete.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • SFN.Client.exceptions.ValidationException

  • SFN.Client.exceptions.InvalidArn

  • SFN.Client.exceptions.ResourceNotFound

  • SFN.Client.exceptions.ConflictException