Skip to content

list_flow_execution_events async

list_flow_execution_events(
    flow_identifier: FlowIdentifier,
    flow_alias_identifier: FlowAliasIdentifier,
    execution_identifier: FlowExecutionIdentifier,
    event_type: FlowExecutionEventType,
    *,
    config_overrides: Optional[AsyncBedrockAgentRuntimeClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListFlowExecutionEventsResponse

Lists events that occurred during a flow execution. Events provide detailed information about the execution progress, including node inputs and outputs, flow inputs and outputs, condition results, and failure events.

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

Parameters:

  • flow_identifier (FlowIdentifier) –

    The unique identifier of the flow.

  • flow_alias_identifier (FlowAliasIdentifier) –

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

  • execution_identifier (FlowExecutionIdentifier) –

    The unique identifier of the flow execution.

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

    The maximum number of events to return in a single response. If more events 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.

  • event_type (FlowExecutionEventType) –

    The type of events to retrieve. Specify Node for node-level events or Flow for flow-level events.

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_execution_events(
    self,
    flow_identifier: "capo_bedrock_agent_runtime.types.flow_identifier.FlowIdentifier",
    flow_alias_identifier: "capo_bedrock_agent_runtime.types.flow_alias_identifier.FlowAliasIdentifier",
    execution_identifier: "capo_bedrock_agent_runtime.types.flow_execution_identifier.FlowExecutionIdentifier",
    event_type: "capo_bedrock_agent_runtime.types.flow_execution_event_type.FlowExecutionEventType",
    *,
    config_overrides: Optional[AsyncBedrockAgentRuntimeClientConfig] = 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_execution_events_response.ListFlowExecutionEventsResponse":
    """<p>Lists events that occurred during a flow execution. Events provide detailed information about the execution progress, including node inputs and outputs, flow inputs and outputs, condition results, and failure events.</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.</p>
        flow_alias_identifier: <p>The unique identifier of the flow alias used for the execution.</p>
        execution_identifier: <p>The unique identifier of the flow execution.</p>
        max_results: <p>The maximum number of events to return in a single response. If more events exist than the specified maxResults 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>
        event_type: <p>The type of events to retrieve. Specify <code>Node</code> for node-level events or <code>Flow</code> for flow-level events.</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_execution_events_request.ListFlowExecutionEventsRequest]",
    ) -> AsyncOperationResponse[
        "capo_bedrock_agent_runtime.types.list_flow_execution_events_response.ListFlowExecutionEventsResponse"
    ]:
        import capo_bedrock_agent_runtime._operations.amazon_bedrock_agent_run_time_service.list_flow_execution_events

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

    def _redact_output(
        output: "capo_bedrock_agent_runtime.types.list_flow_execution_events_response.ListFlowExecutionEventsResponse",
    ) -> dict[str, Any]:
        import capo_bedrock_agent_runtime.types.list_flow_execution_events_response

        return capo_bedrock_agent_runtime.types.list_flow_execution_events_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListFlowExecutionEvents", redact_output=_redact_output),
    )
    input_: capo_bedrock_agent_runtime.types.list_flow_execution_events_request.ListFlowExecutionEventsRequest = {
        "flow_identifier": flow_identifier,
        "flow_alias_identifier": flow_alias_identifier,
        "execution_identifier": execution_identifier,
        "event_type": event_type,
    }
    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