SFN / Client / list_state_machine_versions

list_state_machine_versions#

SFN.Client.list_state_machine_versions(**kwargs)#

Lists versions for the specified state machine Amazon Resource Name (ARN).

The results are sorted in descending order of the version creation time.

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:

  • PublishStateMachineVersion

  • DeleteStateMachineVersion

See also: AWS API Documentation

Request Syntax

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

  • stateMachineArn (string) –

    [REQUIRED]

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

  • 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

{
    'stateMachineVersions': [
        {
            'stateMachineVersionArn': 'string',
            'creationDate': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • stateMachineVersions (list) –

      Versions for the state machine.

      • (dict) –

        Contains details about a specific state machine version.

        • stateMachineVersionArn (string) –

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

        • creationDate (datetime) –

          The creation date of a state machine 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.

Exceptions

  • SFN.Client.exceptions.ValidationException

  • SFN.Client.exceptions.InvalidArn

  • SFN.Client.exceptions.InvalidToken