ListStateMachines

class SFN.Paginator.ListStateMachines

paginator = client.get_paginator('list_state_machines')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SFN.Client.list_state_machines().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

• MaxItems (integer) --

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) --

  The size of each page.

• StartingToken (string) --

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'stateMachines': [
        {
            'stateMachineArn': 'string',
            'name': 'string',
            'type': 'STANDARD'|'EXPRESS',
            'creationDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --
  • stateMachines (list) --
    • (dict) --

      Contains details about the state machine.

      • stateMachineArn (string) --

        The Amazon Resource Name (ARN) that identifies the state machine.

      • name (string) --

        The name of the state machine.

        A name must not contain:

        • white space
        • brackets < > { } [ ]
        • wildcard characters ? *
        • special characters " # % \ ^ | ~ ` $ & , ; : /
        • control characters ( U+0000-001F , U+007F-009F )

        To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

      • type (string) --
      • creationDate (datetime) --

        The date the state machine is created.

  • NextToken (string) --

    A token to resume pagination.