AgentsforBedrockRuntime / Client / stop_flow_execution
stop_flow_execution¶
- AgentsforBedrockRuntime.Client.stop_flow_execution(**kwargs)¶
Stops an Amazon Bedrock flow’s asynchronous execution. This operation prevents further processing of the flow and changes the execution status to
Aborted
.See also: AWS API Documentation
Request Syntax
response = client.stop_flow_execution( executionIdentifier='string', flowAliasIdentifier='string', flowIdentifier='string' )
- Parameters:
executionIdentifier (string) –
[REQUIRED]
The unique identifier of the async execution to stop.
flowAliasIdentifier (string) –
[REQUIRED]
The unique identifier of the flow alias used for the execution.
flowIdentifier (string) –
[REQUIRED]
The unique identifier of the flow.
- Return type:
dict
- Returns:
Response Syntax
{ 'executionArn': 'string', 'status': 'Running'|'Succeeded'|'Failed'|'TimedOut'|'Aborted' }
Response Structure
(dict) –
executionArn (string) –
The Amazon Resource Name (ARN) that uniquely identifies the async execution that was stopped.
status (string) –
The updated status of the async execution after the stop request. This will typically be ABORTED if the execution was successfully stopped.
Exceptions
AgentsforBedrockRuntime.Client.exceptions.ResourceNotFoundException
AgentsforBedrockRuntime.Client.exceptions.ValidationException
AgentsforBedrockRuntime.Client.exceptions.InternalServerException
AgentsforBedrockRuntime.Client.exceptions.DependencyFailedException
AgentsforBedrockRuntime.Client.exceptions.BadGatewayException
AgentsforBedrockRuntime.Client.exceptions.ThrottlingException
AgentsforBedrockRuntime.Client.exceptions.AccessDeniedException