NovaActService / Paginator / ListWorkflowDefinitions

ListWorkflowDefinitions

class NovaActService.Paginator.ListWorkflowDefinitions

paginator = client.get_paginator('list_workflow_definitions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from NovaActService.Client.list_workflow_definitions().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• sortOrder (string) – The sort order for the returned workflow definitions (ascending or descending).

• 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

{
    'workflowDefinitionSummaries': [
        {
            'workflowDefinitionArn': 'string',
            'workflowDefinitionName': 'string',
            'createdAt': datetime(2015, 1, 1),
            'status': 'ACTIVE'|'DELETING'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • workflowDefinitionSummaries (list) –

    A list of summary information for workflow definitions.

    • (dict) –

      Summary information about a workflow definition, used in list operations.

      • workflowDefinitionArn (string) –

        The Amazon Resource Name (ARN) of the workflow definition.

      • workflowDefinitionName (string) –

        The name of the workflow definition.

      • createdAt (datetime) –

        The timestamp when the workflow definition was created.

      • status (string) –

        The current status of the workflow definition.

  • NextToken (string) –

    A token to resume pagination.