Skip to content

stop_flow_execution 

stop_flow_execution(
    flow_identifier: FlowIdentifier,
    flow_alias_identifier: FlowAliasIdentifier,
    execution_identifier: FlowExecutionIdentifier,
    *,
    config_overrides: Optional[BedrockAgentRuntimeClientConfig] = None,
) -> StopFlowExecutionResponse

Stops an Amazon Bedrock flow's execution. This operation prevents further processing of the flow and changes the execution status to Aborted.

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 to stop.

Raises:

  • AccessDeniedException –

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

  • BadGatewayException –

    There was an issue with a dependency due to a server issue. Retry your request.

  • ConflictException –

    There was a conflict performing an operation. Resolve the conflict and retry your request.

  • DependencyFailedException –

    There was an issue with a dependency. Check the resource configurations and retry the 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/bedrock_agent_runtime.py 
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
def stop_flow_execution(
    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",
    *,
    config_overrides: Optional[BedrockAgentRuntimeClientConfig] = None,
) -> "capo_bedrock_agent_runtime.types.stop_flow_execution_response.StopFlowExecutionResponse":
    """<p>Stops an Amazon Bedrock flow's execution. This operation prevents further processing of the flow and changes the execution status to <code>Aborted</code>.</p>

    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 to stop.</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.bad_gateway_exception.BadGatewayException: <p>There was an issue with a dependency due to a server issue. Retry your request.</p>
        capo_bedrock_agent_runtime.errors.conflict_exception.ConflictException: <p>There was a conflict performing an operation. Resolve the conflict and retry your request.</p>
        capo_bedrock_agent_runtime.errors.dependency_failed_exception.DependencyFailedException: <p>There was an issue with a dependency. Check the resource configurations and retry the 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.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock_agent_runtime.types.stop_flow_execution_request.StopFlowExecutionRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agent_runtime.types.stop_flow_execution_response.StopFlowExecutionResponse"
    ]:
        import capo_bedrock_agent_runtime._operations.amazon_bedrock_agent_run_time_service.stop_flow_execution

        output, http_response = (
            capo_bedrock_agent_runtime._operations.amazon_bedrock_agent_run_time_service.stop_flow_execution.stop_flow_execution(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopFlowExecution")
    )
    input_: capo_bedrock_agent_runtime.types.stop_flow_execution_request.StopFlowExecutionRequest = {
        "flow_identifier": flow_identifier,
        "flow_alias_identifier": flow_alias_identifier,
        "execution_identifier": execution_identifier,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output