Lambda / Client / pause_durable_execution
pause_durable_execution¶
- Lambda.Client.pause_durable_execution(**kwargs)¶
Pauses a running durable execution. While an execution is paused, Lambda doesn’t invoke your function, but pending operations such as waits and callbacks continue to complete.
If an invocation is in progress, the execution status changes to
PAUSINGuntil the invocation reaches its next checkpoint, and then changes toPAUSED. This operation returns a successful response while the execution status is stillRUNNING, and the status changes when Lambda processes the request. For more information about pausing executions, see Pausing and resuming durable executions.See also: AWS API Documentation
Request Syntax
response = client.pause_durable_execution( DurableExecutionArn='string', ClientToken='string', Reason='string', ExecutionTimeoutPaused=True|False )
- Parameters:
DurableExecutionArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the durable execution.
ClientToken (string) –
A unique, case-sensitive identifier that you provide so that the request completes no more than one time. If you repeat a request with the same client token and parameters within 15 minutes, Lambda doesn’t pause the execution again and returns a successful response instead of an error.
This field is autopopulated if not provided.
Reason (string) – A description of why you’re pausing the execution. Lambda records the reason in the execution history.
ExecutionTimeoutPaused (boolean) – Specifies whether to pause the execution timeout while the execution is paused. If
true, Lambda extends the execution timeout by the time the execution spends paused. An execution with a paused timeout still times out 366 days after it started. The default value istrue.
- Return type:
dict
- Returns:
Response Syntax
{}Response Structure
(dict) –
Exceptions