Transfer / Paginator / ListWorkflows

ListWorkflows

class Transfer.Paginator.ListWorkflows

paginator = client.get_paginator('list_workflows')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Transfer.Client.list_workflows().

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

{
    'Workflows': [
        {
            'WorkflowId': 'string',
            'Description': 'string',
            'Arn': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • Workflows (list) –

    Returns the Arn, WorkflowId, and Description for each workflow.

    • (dict) –

      Contains the identifier, text description, and Amazon Resource Name (ARN) for the workflow.

      • WorkflowId (string) –

        A unique identifier for the workflow.

      • Description (string) –

        Specifies the text description for the workflow.

      • Arn (string) –

        Specifies the unique Amazon Resource Name (ARN) for the workflow.