AgentsforBedrockRuntime / Paginator / ListFlowExecutions

ListFlowExecutions

class AgentsforBedrockRuntime.Paginator.ListFlowExecutions

paginator = client.get_paginator('list_flow_executions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from AgentsforBedrockRuntime.Client.list_flow_executions().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• flowIdentifier (string) –

  [REQUIRED]

  The unique identifier of the flow to list executions for.

• flowAliasIdentifier (string) – The unique identifier of the flow alias to list executions for.

• 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

{
    'flowExecutionSummaries': [
        {
            'executionArn': 'string',
            'flowAliasIdentifier': 'string',
            'flowIdentifier': 'string',
            'flowVersion': 'string',
            'status': 'Running'|'Succeeded'|'Failed'|'TimedOut'|'Aborted',
            'createdAt': datetime(2015, 1, 1),
            'endedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • flowExecutionSummaries (list) –

    A list of flow execution summaries. Each summary includes the execution ARN, flow identifier, flow alias identifier, flow version, status, and timestamps.

    • (dict) –

      Contains summary information about a flow execution, including its status, timestamps, and identifiers.

      Note

      Flow executions is in preview release for Amazon Bedrock and is subject to change.

      • executionArn (string) –

        The Amazon Resource Name (ARN) that uniquely identifies the flow execution.

      • flowAliasIdentifier (string) –

        The unique identifier of the flow alias used for the execution.

      • flowIdentifier (string) –

        The unique identifier of the flow.

      • flowVersion (string) –

        The version of the flow used for the execution.

      • status (string) –

        The current status of the flow execution.

        Flow executions time out after 24 hours.

      • createdAt (datetime) –

        The timestamp when the flow execution was created.

      • endedAt (datetime) –

        The timestamp when the flow execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.

  • NextToken (string) –

    A token to resume pagination.