Skip to content

List Flow Executions

bedrockagentruntime_list_flow_executions R Documentation

Lists all executions of a flow

Description

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

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

Usage

bedrockagentruntime_list_flow_executions(flowAliasIdentifier,
  flowIdentifier, maxResults, nextToken)

Arguments

flowAliasIdentifier

The unique identifier of the flow alias to list executions for.

flowIdentifier

[required] The unique identifier of the flow to list executions for.

maxResults

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

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

Value

A list with the following syntax:

list(
  flowExecutionSummaries = list(
    list(
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      endedAt = as.POSIXct(
        "2015-01-01"
      ),
      executionArn = "string",
      flowAliasIdentifier = "string",
      flowIdentifier = "string",
      flowVersion = "string",
      status = "Running"|"Succeeded"|"Failed"|"TimedOut"|"Aborted"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_flow_executions(
  flowAliasIdentifier = "string",
  flowIdentifier = "string",
  maxResults = 123,
  nextToken = "string"
)