Skip to content

stop_durable_execution

Operation

stop_durable_execution

stop_durable_execution(request: StopDurableExecutionInput | StopDurableExecutionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StopDurableExecutionInputDict]) -> StopDurableExecutionOutput

Stops a running durable execution. The execution transitions to STOPPED status and cannot be resumed. Any in-progress operations are terminated.

Parameters:

Name Type Description Default
request StopDurableExecutionInput | StopDurableExecutionInputDict | 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[StopDurableExecutionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StopDurableExecutionOutput

An instance of StopDurableExecutionOutput.

stop_durable_execution async

stop_durable_execution(request: StopDurableExecutionInput | StopDurableExecutionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StopDurableExecutionInputDict]) -> StopDurableExecutionOutput

Stops a running durable execution. The execution transitions to STOPPED status and cannot be resumed. Any in-progress operations are terminated.

Parameters:

Name Type Description Default
request StopDurableExecutionInput | StopDurableExecutionInputDict | 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[StopDurableExecutionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StopDurableExecutionOutput

An instance of StopDurableExecutionOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

StopDurableExecutionInputDict

Bases: TypedDict

Dictionary form of StopDurableExecutionInput.

Attributes

durable_execution_arn instance-attribute
durable_execution_arn: Required[str]

The Amazon Resource Name (ARN) of the durable execution.

error instance-attribute
error: ErrorObject | ErrorObjectDict | None

Optional error details explaining why the execution is being stopped. The combined size of all error fields is limited to 1 MB.

StopDurableExecutionInput dataclass

Bases: _SerdeShape

Dataclass for StopDurableExecutionInput structure.

Attributes

durable_execution_arn class-attribute instance-attribute
durable_execution_arn: str | None = ...

The Amazon Resource Name (ARN) of the durable execution.

error class-attribute instance-attribute
error: ErrorObject | None = ...

Optional error details explaining why the execution is being stopped. The combined size of all error fields is limited to 1 MB.

Output

StopDurableExecutionOutput dataclass

Bases: _SerdeShape

Dataclass for StopDurableExecutionOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.

stop_timestamp instance-attribute
stop_timestamp: datetime

The timestamp when the execution was stopped (ISO 8601 format).