Skip to content

list_message_move_tasks

Operation

list_message_move_tasks

list_message_move_tasks(request: ListMessageMoveTasksInput | ListMessageMoveTasksInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListMessageMoveTasksInputDict]) -> ListMessageMoveTasksOutput

Gets the most recent message movement tasks (up to 10) under a specific source queue.

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 ListMessageMoveTasksInput | ListMessageMoveTasksInputDict | 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[ListMessageMoveTasksInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListMessageMoveTasksOutput

An instance of ListMessageMoveTasksOutput.

list_message_move_tasks async

list_message_move_tasks(request: ListMessageMoveTasksInput | ListMessageMoveTasksInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListMessageMoveTasksInputDict]) -> ListMessageMoveTasksOutput

Gets the most recent message movement tasks (up to 10) under a specific source queue.

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 ListMessageMoveTasksInput | ListMessageMoveTasksInputDict | 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[ListMessageMoveTasksInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListMessageMoveTasksOutput

An instance of ListMessageMoveTasksOutput.

Input

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

ListMessageMoveTasksInputDict

Bases: TypedDict

Dictionary form of ListMessageMoveTasksInput.

Attributes

max_results instance-attribute
max_results: int | None

The maximum number of results to include in the response. The default is 1, which provides the most recent message movement task. The upper limit is 10.

source_arn instance-attribute
source_arn: Required[str]

The ARN of the queue whose message movement tasks are to be listed.

ListMessageMoveTasksInput dataclass

Bases: _SerdeShape

Dataclass for ListMessageMoveTasksInput structure.

Attributes

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of results to include in the response. The default is 1, which provides the most recent message movement task. The upper limit is 10.

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

The ARN of the queue whose message movement tasks are to be listed.

Output

ListMessageMoveTasksOutput dataclass

Bases: _SerdeShape

Dataclass for ListMessageMoveTasksOutput 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.

results class-attribute instance-attribute
results: list[ListMessageMoveTasksResultEntry] | None = ...

A list of message movement tasks and their attributes.