stop_flow_execution¶
Operation¶
stop_flow_execution
¶
stop_flow_execution(request: StopFlowExecutionInput | StopFlowExecutionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StopFlowExecutionInputDict]) -> StopFlowExecutionOutput
Stops an Amazon Bedrock flow's execution. This operation prevents
further processing of the flow and changes the execution status to
Aborted.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
StopFlowExecutionInput | StopFlowExecutionInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[StopFlowExecutionInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
StopFlowExecutionOutput
|
An instance of |
stop_flow_execution
async
¶
stop_flow_execution(request: StopFlowExecutionInput | StopFlowExecutionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StopFlowExecutionInputDict]) -> StopFlowExecutionOutput
Stops an Amazon Bedrock flow's execution. This operation prevents
further processing of the flow and changes the execution status to
Aborted.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
StopFlowExecutionInput | StopFlowExecutionInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[StopFlowExecutionInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
StopFlowExecutionOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
StopFlowExecutionInputDict
¶
StopFlowExecutionInput
dataclass
¶
Bases: _SerdeShape
Dataclass for StopFlowExecutionInput structure.
Attributes¶
execution_identifier
class-attribute
instance-attribute
¶
execution_identifier: str | None = ...
The unique identifier of the flow execution to stop.
Output¶
StopFlowExecutionOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for StopFlowExecutionOutput structure.
Attributes¶
execution_arn
class-attribute
instance-attribute
¶
execution_arn: str | None = ...
The Amazon Resource Name (ARN) that uniquely identifies the flow execution that was stopped.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.