SWF / Paginator / ListWorkflowTypes

ListWorkflowTypes

class SWF.Paginator.ListWorkflowTypes

paginator = client.get_paginator('list_workflow_types')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SWF.Client.list_workflow_types().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    domain='string',
    name='string',
    registrationStatus='REGISTERED'|'DEPRECATED',
    reverseOrder=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• domain (string) –

  [REQUIRED]

  The name of the domain in which the workflow types have been registered.

• name (string) – If specified, lists the workflow type with this name.

• registrationStatus (string) –

  [REQUIRED]

  Specifies the registration status of the workflow types to list.

• reverseOrder (boolean) – When set to true, returns the results in reverse order. By default the results are returned in ascending alphabetical order of the name of the workflow types.

• 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

{
    'typeInfos': [
        {
            'workflowType': {
                'name': 'string',
                'version': 'string'
            },
            'status': 'REGISTERED'|'DEPRECATED',
            'description': 'string',
            'creationDate': datetime(2015, 1, 1),
            'deprecationDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Contains a paginated list of information structures about workflow types.

  • typeInfos (list) –

    The list of workflow type information.

    • (dict) –

      Contains information about a workflow type.

      • workflowType (dict) –

        The workflow type this information is about.

        • name (string) –

          The name of the workflow type.

          Note

          The combination of workflow type name and version must be unique with in a domain.

        • version (string) –

          The version of the workflow type.

          Note

          The combination of workflow type name and version must be unique with in a domain.

      • status (string) –

        The current status of the workflow type.

      • description (string) –

        The description of the type registered through RegisterWorkflowType.

      • creationDate (datetime) –

        The date when this type was registered.

      • deprecationDate (datetime) –

        If the type is in deprecated state, then it is set to the date when the type was deprecated.

  • NextToken (string) –

    A token to resume pagination.