Spec-Zone.ru › AWS CLI v2

[ aws . sqs ]

изменение видимости тайм-аута сообщения в пакетном режиме

Описание

Изменяет тайм-аут видимости нескольких сообщений. Это пакетная версия команды `` ChangeMessageVisibility .`` Результат выполнения действия для каждого сообщения сообщается индивидуально в ответе. Вы можете отправить до 10 запросов `` ChangeMessageVisibility `` в каждом пакетном запросе.

Предупреждение

Поскольку пакетный запрос может привести к сочетанию успешных и неуспешных действий, вам необходимо проверять ошибки пакетного запроса, даже если вызов возвращает HTTP-код состояния 200.

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

Синтаксис

  change-message-visibility-batch
--queue-url <value>
--entries <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]

Параметры

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

URL очереди Amazon SQS, видимость тайм-аута сообщений которой изменяется.

URL и имена очередей чувствительны к регистру.

--entries (список)

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

(структура)

Оборачивает дескриптор получения и идентификатор записи для каждого сообщения в `` ChangeMessageVisibilityBatch .``

Id -> (строка)

Идентификатор, используемый для передачи результата для данного дескриптора получения.

Примечание

Идентификаторы в пакетном запросе должны быть уникальными внутри одного запроса.

Этот идентификатор может содержать до 80 символов. Допускаются следующие символы: буквенно-цифровые символы, дефисы (-) и символы подчеркивания (_).

ReceiptHandle -> (строка)

Дескриптор получения.

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

Новое значение тайм-аута видимости сообщения (в секундах).

Сокращенный синтаксис:

Id=string,ReceiptHandle=string,VisibilityTimeout=integer ...

Синтаксис JSON:

[
  {
    "Id": "string",
    "ReceiptHandle": "string",
    "VisibilityTimeout": integer
  }
  ...
]

--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
  • text
  • table
  • yaml
  • yaml-stream

--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-auto-prompt (булево)

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

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

Отключить автоматический запрос параметров CLI.

Примеры

Примечание

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

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

Изменение тайм-аутов видимости нескольких сообщений в пакетном режиме

В этом примере тайм-ауты видимости 2 указанных сообщений изменяются на 10 часов (10 часов * 60 минут * 60 секунд).

Команда:

aws sqs change-message-visibility-batch --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue --entries file://change-message-visibility-batch.json

Файл ввода (change-message-visibility-batch.json):

[
  {
    "Id": "FirstMessage",
        "ReceiptHandle": "AQEBhz2q...Jf3kaw==",
        "VisibilityTimeout": 36000
  },
  {
    "Id": "SecondMessage",
        "ReceiptHandle": "AQEBkTUH...HifSnw==",
        "VisibilityTimeout": 36000
  }
]

Вывод:

{
  "Successful": [
    {
      "Id": "SecondMessage"
    },
    {
      "Id": "FirstMessage"
    }
  ]
}

Вывод

Успешные -> (список)

Список элементов `` ChangeMessageVisibilityBatchResultEntry ``.

(структура)

Оборачивает Id записи в `` ChangeMessageVisibilityBatch .``

Id -> (строка)

Представляет сообщение, тайм-аут видимости которого был успешно изменен.

Неудачные -> (список)

Список элементов `` BatchResultErrorEntry ``.

(структура)

Предоставляет подробное описание результата действия для каждой записи в запросе.

Id -> (строка)

Идентификатор записи в пакетном запросе.

SenderFault -> (булево)

Указывает, произошла ли ошибка из-за вызывающего абонента пакетного API-действия.

Code -> (строка)

Код ошибки, объясняющий, почему действие завершилось неудачно для этой записи.

Message -> (строка)

Сообщение, объясняющее, почему действие завершилось неудачно для этой записи.

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

Spec-Zone.ru

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