Spec-Zone.ru › AWS CLI v2

[ aws . sqs ]

list-message-move-tasks

Описание

Получает последние задачи перемещения сообщений (до 10) в рамках определённой исходной очереди.

Примечание

  • Данное действие в настоящее время ограничено поддержкой повторной отправки сообщений только из очередей «Мёртвых писем» (DLQ). В этом контексте исходная очередь является очередью «Мёртвых писем» (DLQ), а целевая очередь может быть исходной очередью (из которой сообщения были перенаправлены в очередь «Мёртвых писем») или пользовательской целевой очередью.
  • В любой момент времени поддерживается только одна активная задача перемещения сообщений на очередь.

См. также: Документация API AWS

Синтаксис

  list-message-move-tasks
--source-arn <value>
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--source-arn (строка)

ARN очереди, для которой необходимо получить задачи перемещения сообщений.

--max-results (целое число)

Максимальное количество результатов для включения в ответ. По умолчанию значение равно 1, что обеспечивает получение последней задачи перемещения сообщения. Максимальное значение — 10.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные через JSON. Невозможно передавать произвольные двоичные значения с помощью значения JSON, поскольку строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. При отсутствии значения или значении input, выводит пример JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, при предоставлении yaml-input будет выведен пример YAML-ввода, который можно использовать с --cli-input-yaml. При предоставлении значения output, валидирует входные данные команды и возвращает пример JSON-вывода для данной команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI и не гарантирует обратную совместимость в сгенерированном JSON-скелете.

Глобальные параметры

--debug (булево)

Включает отладочную запись в журнал.

--endpoint-url (строка)

Переопределяет URL по умолчанию команды заданным URL.

--no-verify-ssl (булево)

По умолчанию AWS CLI использует SSL при взаимодействии с сервисами AWS. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (булево)

Отключает автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

  • json
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определённого профиля из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

  • вкл
  • выкл
  • авто

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружаться, если этот аргумент предоставлен.

--ca-bundle (строка)

Набор сертификатов CA для использования при проверке сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и не будет ограничено по времени. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и не будет ограничено по времени. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде строки, закодированной в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, отображающего двоичный блок, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (булево)

Отключение пейджера CLI для вывода.

--cli-auto-prompt (булево)

Автоматическое запросить параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключение автоматического запроса параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. См. руководство по началу работы в руководстве пользователя AWS CLI для получения дополнительной информации.

Если не указано иное, все примеры используют правила цитирования UNIX-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в руководстве пользователя AWS CLI.

Для получения списка задач перемещения сообщений

Следующий list-message-move-tasks пример выводит 2 последние задачи перемещения сообщений в указанной очереди.

aws sqs list-message-move-tasks \
    --source-arn arn:aws:sqs:us-west-2:80398EXAMPLE:MyQueue \
    --max-results 2

Вывод:

{
    "Results": [
        {
            "TaskHandle": "AQEB6nR4...HzlvZQ==",
            "Status": "RUNNING",
            "SourceArn": "arn:aws:sqs:us-west-2:80398EXAMPLE:MyQueue1",
            "DestinationArn": "arn:aws:sqs:us-west-2:80398EXAMPLE:MyQueue2",
            "MaxNumberOfMessagesPerSecond": 50,
            "ApproximateNumberOfMessagesMoved": 203,
            "ApproximateNumberOfMessagesToMove": 30,
            "StartedTimestamp": 1442428276921
         },

         {
            "Status": "COMPLETED",
            "SourceArn": "arn:aws:sqs:us-west-2:80398EXAMPLE:MyQueue1",
            "DestinationArn": "arn:aws:sqs:us-west-2:80398EXAMPLE:MyQueue2",
            "ApproximateNumberOfMessagesMoved": 29,
            "ApproximateNumberOfMessagesToMove": 0,
            "StartedTimestamp": 1342428272093
         }
    ]
}

Для получения дополнительной информации см. Разрешения API Amazon SQS: Действия и ссылка на ресурсы в руководстве разработчика.

Вывод

Результаты -> (список)

Список задач перемещения сообщений и их атрибутов.

(структура)

Содержит детали задачи перемещения сообщений.

TaskHandle -> (строка)

Идентификатор, связанный с задачей перемещения сообщения. Когда это поле возвращается в ответе действия ListMessageMoveTasks, оно заполняется только для задач в состоянии RUNNING.

Статус -> (строка)

Статус задачи перемещения сообщения. Возможные значения: RUNNING, COMPLETED, CANCELLING, CANCELLED и FAILED.

SourceArn -> (строка)

ARN очереди, содержащей сообщения, которые необходимо переместить в другую очередь.

DestinationArn -> (строка)

ARN целевой очереди, если она была указана в запросе StartMessageMoveTask. Если DestinationArn не указан в запросе StartMessageMoveTask, значение этого поля будет NULL.

MaxNumberOfMessagesPerSecond -> (целое число)

Количество сообщений, которые необходимо переместить в секунду (скорость перемещения сообщений), если оно было указано в запросе StartMessageMoveTask. Если MaxNumberOfMessagesPerSecond не указан в запросе StartMessageMoveTask, значение этого поля будет NULL.

ApproximateNumberOfMessagesMoved -> (длинное целое число)

Приблизительное количество уже перемещенных сообщений в целевую очередь.

ApproximateNumberOfMessagesToMove -> (длинное целое число)

Количество сообщений, которые необходимо переместить из исходной очереди. Это число определяется на момент запуска задачи перемещения сообщений и включается только после того, как задача перемещения сообщений выбрана для запуска.

FailureReason -> (строка)

Причина ошибки задачи (включается только если статус задачи — FAILED).

StartedTimestamp -> (длинное целое число)

Отметка времени запуска задачи перемещения сообщения.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API