SFN / Client / list_state_machine_aliases

list_state_machine_aliases#

SFN.Client.list_state_machine_aliases(**kwargs)#

Lists aliases for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first.

To list aliases that reference a state machine version, you can specify the version ARN in the stateMachineArn parameter.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Related operations:

  • CreateStateMachineAlias

  • DescribeStateMachineAlias

  • UpdateStateMachineAlias

  • DeleteStateMachineAlias

See also: AWS API Documentation

Request Syntax

response = client.list_state_machine_aliases(
    stateMachineArn='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • stateMachineArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the state machine for which you want to list aliases.

    If you specify a state machine version ARN, this API returns a list of aliases for that version.

  • nextToken (string) – If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

  • maxResults (integer) –

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

Return type:

dict

Returns:

Response Syntax

{
    'stateMachineAliases': [
        {
            'stateMachineAliasArn': 'string',
            'creationDate': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • stateMachineAliases (list) –

      Aliases for the state machine.

      • (dict) –

        Contains details about a specific state machine alias.

        • stateMachineAliasArn (string) –

          The Amazon Resource Name (ARN) that identifies a state machine alias. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, stateMachineARN:PROD.

        • creationDate (datetime) –

          The creation date of a state machine alias.

    • nextToken (string) –

      If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Exceptions

  • SFN.Client.exceptions.InvalidArn

  • SFN.Client.exceptions.InvalidToken

  • SFN.Client.exceptions.ResourceNotFound

  • SFN.Client.exceptions.StateMachineDoesNotExist

  • SFN.Client.exceptions.StateMachineDeleting