AgentsforBedrockRuntime / Client / list_flow_executions

list_flow_executions

AgentsforBedrockRuntime.Client.list_flow_executions(**kwargs)

Lists all executions of a flow. Results can be paginated and include summary information about each execution, such as status, start and end times, and the execution’s Amazon Resource Name (ARN).

Note

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

See also: AWS API Documentation

Request Syntax

response = client.list_flow_executions(
    flowAliasIdentifier='string',
    flowIdentifier='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

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

  • flowIdentifier (string) –

    [REQUIRED]

    The unique identifier of the flow to list executions for.

  • maxResults (integer) – The maximum number of flow executions to return in a single response. If more executions exist than the specified maxResults value, a token is included in the response so that the remaining results can be retrieved.

  • nextToken (string) – A token to retrieve the next set of results. This value is returned in the response if more results are available.

Return type:

dict

Returns:

Response Syntax

{
    'flowExecutionSummaries': [
        {
            'createdAt': datetime(2015, 1, 1),
            'endedAt': datetime(2015, 1, 1),
            'executionArn': 'string',
            'flowAliasIdentifier': 'string',
            'flowIdentifier': 'string',
            'flowVersion': 'string',
            'status': 'Running'|'Succeeded'|'Failed'|'TimedOut'|'Aborted'
        },
    ],
    '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.

        • 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.

        • 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.

    • nextToken (string) –

      A token to retrieve the next set of results. This value is returned if more results are available.

Exceptions