Skip to content

list_flow_executions async

list_flow_executions(
    flow_identifier: FlowIdentifier,
    *,
    config_overrides: Optional[AsyncBedrockAgentRuntimeClientConfig] = None,
    flow_alias_identifier: Optional[FlowAliasIdentifier] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListFlowExecutionsResponse

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.

Parameters:

  • flow_identifier (FlowIdentifier) –

    The unique identifier of the flow to list executions for.

  • flow_alias_identifier (Optional[FlowAliasIdentifier], default: None ) –

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

  • max_results (Optional[MaxResults], default: None ) –

    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.

  • next_token (Optional[NextToken], default: None ) –

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

Raises:

  • AccessDeniedException –

    The request is denied because of missing access permissions. Check your permissions and retry your request.

  • InternalServerException –

    An internal server error occurred. Retry your request.

  • ResourceNotFoundException –

    The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

  • ThrottlingException –

    The number of requests exceeds the limit. Resubmit your request later.

  • ValidationException –

    Input validation failed. Check your request parameters and retry the request.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_bedrock_agent_runtime/_services/async_bedrock_agent_runtime.py
async def list_flow_executions(
    self,
    flow_identifier: "capo_bedrock_agent_runtime.types.flow_identifier.FlowIdentifier",
    *,
    config_overrides: Optional[AsyncBedrockAgentRuntimeClientConfig] = None,
    flow_alias_identifier: Optional[
        "capo_bedrock_agent_runtime.types.flow_alias_identifier.FlowAliasIdentifier"
    ] = None,
    max_results: Optional[
        "capo_bedrock_agent_runtime.types.max_results.MaxResults"
    ] = None,
    next_token: Optional[
        "capo_bedrock_agent_runtime.types.next_token.NextToken"
    ] = None,
) -> "capo_bedrock_agent_runtime.types.list_flow_executions_response.ListFlowExecutionsResponse":
    """<p>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).</p> <note> <p>Flow executions is in preview release for Amazon Bedrock and is subject to change.</p> </note>

    Args:
        flow_identifier: <p>The unique identifier of the flow to list executions for.</p>
        flow_alias_identifier: <p>The unique identifier of the flow alias to list executions for.</p>
        max_results: <p>The maximum number of flow executions to return in a single response. If more executions exist than the specified <code>maxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p>
        next_token: <p>A token to retrieve the next set of results. This value is returned in the response if more results are available.</p>

    Raises:
        capo_bedrock_agent_runtime.errors.access_denied_exception.AccessDeniedException: <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
        capo_bedrock_agent_runtime.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
        capo_bedrock_agent_runtime.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
        capo_bedrock_agent_runtime.errors.throttling_exception.ThrottlingException: <p>The number of requests exceeds the limit. Resubmit your request later.</p>
        capo_bedrock_agent_runtime.errors.validation_exception.ValidationException: <p>Input validation failed. Check your request parameters and retry the request.</p>
        capo_bedrock_agent_runtime.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_bedrock_agent_runtime.types.list_flow_executions_request.ListFlowExecutionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_bedrock_agent_runtime.types.list_flow_executions_response.ListFlowExecutionsResponse"
    ]:
        import capo_bedrock_agent_runtime._operations.amazon_bedrock_agent_run_time_service.list_flow_executions

        (
            output,
            http_response,
        ) = await capo_bedrock_agent_runtime._operations.amazon_bedrock_agent_run_time_service.list_flow_executions.async_list_flow_executions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListFlowExecutions")
    )
    input_: capo_bedrock_agent_runtime.types.list_flow_executions_request.ListFlowExecutionsRequest = {
        "flow_identifier": flow_identifier
    }
    if flow_alias_identifier is not None:
        input_["flow_alias_identifier"] = flow_alias_identifier
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output