Skip to content
AWS for Query.Farm

aws.sqs.list_message_move_tasks

Example SQL Queries

SELECT * FROM
aws.sqs.list_message_move_tasks
WHERE
"source_arn" = 'VALUE';

Description

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

  • 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.

Table Definition

Column NameColumn Data Type
source_arn Required Input Column

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

VARCHAR
max_results Input Column

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.

BIGINT
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
results

A list of message movement tasks and their attributes.

STRUCT(
    "task_handle" VARCHAR,
    "status" VARCHAR,
    "source_arn" VARCHAR,
    "destination_arn" VARCHAR,
    "max_number_of_messages_per_second" BIGINT,
    "approximate_number_of_messages_moved" BIGINT,
    "approximate_number_of_messages_to_move" BIGINT,
    "failure_reason" VARCHAR,
    "started_timestamp" BIGINT
)[]
Show child fields
results[]
Show child fields
results[].approximate_number_of_messages_moved

The approximate number of messages already moved to the destination queue.

results[].approximate_number_of_messages_to_move

The number of messages to be moved from the source queue. This number is obtained at the time of starting the message movement task and is only included after the message movement task is selected to start.

results[].destination_arn

The ARN of the destination queue if it has been specified in the StartMessageMoveTask request. If a DestinationArn has not been specified in the StartMessageMoveTask request, this field value will be NULL.

results[].failure_reason

The task failure reason (only included if the task status is FAILED).

results[].max_number_of_messages_per_second

The number of messages to be moved per second (the message movement rate), if it has been specified in the StartMessageMoveTask request. If a MaxNumberOfMessagesPerSecond has not been specified in the StartMessageMoveTask request, this field value will be NULL.

results[].source_arn

The ARN of the queue that contains the messages to be moved to another queue.

results[].started_timestamp

The timestamp of starting the message movement task.

results[].status

The status of the message movement task. Possible values are: RUNNING, COMPLETED, CANCELLING, CANCELLED, and FAILED.

results[].task_handle

An identifier associated with a message movement task. When this field is returned in the response of the ListMessageMoveTasks action, it is only populated for tasks that are in RUNNING status.