AgentsforBedrock / Paginator / ListFlows

ListFlows

class AgentsforBedrock.Paginator.ListFlows

paginator = client.get_paginator('list_flows')

paginate(**kwargs)

Creates an iterator that will paginate through responses from AgentsforBedrock.Client.list_flows().

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

{
    'flowSummaries': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'id': 'string',
            'name': 'string',
            'status': 'Failed'|'Prepared'|'Preparing'|'NotPrepared',
            'updatedAt': datetime(2015, 1, 1),
            'version': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • flowSummaries (list) –

    A list, each member of which contains information about a flow.

    • (dict) –

      Contains the definition of a flow.

      • arn (string) –

        The Amazon Resource Name (ARN) of the flow.

      • createdAt (datetime) –

        The time at which the flow was created.

      • description (string) –

        A description of the flow.

      • id (string) –

        The unique identifier of the flow.

      • name (string) –

        The name of the flow.

      • status (string) –

        The status of the flow. The following statuses are possible:

        • NotPrepared – The flow has been created or updated, but hasn’t been prepared. If you just created the flow, you can’t test it. If you updated the flow, the DRAFT version won’t contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.

        • Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.

        • Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.

        • Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.

      • updatedAt (datetime) –

        The time at which the flow was last updated.

      • version (string) –

        The latest version of the flow.

  • NextToken (string) –

    A token to resume pagination.