cancel_message_move_task¶
Operation¶
cancel_message_move_task
¶
cancel_message_move_task(request: CancelMessageMoveTaskInput | CancelMessageMoveTaskInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CancelMessageMoveTaskInputDict]) -> CancelMessageMoveTaskOutput
Cancels a specified message movement task. A message movement can only be cancelled when the current status is RUNNING. Cancelling a message movement task does not revert the messages that have already been moved. It can only stop the messages that have not been moved yet.
Note
-
This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue.
-
Only one active message movement task is supported per queue at any given time.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CancelMessageMoveTaskInput | CancelMessageMoveTaskInputDict | 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[CancelMessageMoveTaskInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CancelMessageMoveTaskOutput
|
An instance of |
cancel_message_move_task
async
¶
cancel_message_move_task(request: CancelMessageMoveTaskInput | CancelMessageMoveTaskInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CancelMessageMoveTaskInputDict]) -> CancelMessageMoveTaskOutput
Cancels a specified message movement task. A message movement can only be cancelled when the current status is RUNNING. Cancelling a message movement task does not revert the messages that have already been moved. It can only stop the messages that have not been moved yet.
Note
-
This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue.
-
Only one active message movement task is supported per queue at any given time.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CancelMessageMoveTaskInput | CancelMessageMoveTaskInputDict | 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[CancelMessageMoveTaskInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CancelMessageMoveTaskOutput
|
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.
Output¶
CancelMessageMoveTaskOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CancelMessageMoveTaskOutput structure.
Attributes¶
approximate_number_of_messages_moved
class-attribute
instance-attribute
¶
approximate_number_of_messages_moved: int = ...
The approximate number of messages already moved to the destination queue.
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.