Spec-Zone.ru › AWS CLI v2

[ aws . snowball ]

describe-addresses

Описание

Возвращает указанное количество ADDRESS объектов. Вызов этого API в одном из регионов США вернёт адреса из списка всех адресов, связанных с этой учётной записью во всех регионах США.

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

describe-addresses — это постраничная операция. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query с постраничным ответом, аргумент --query должен извлечь данные из результатов следующих выражений запроса: Addresses

Синтаксис

  describe-addresses
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

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

--starting-token (строка)

Маркер для указания, с какой точки начать постраничный вывод. Это NextToken из предыдущего усечённого ответа.

Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы при запросе к службе AWS. Это не влияет на количество элементов, возвращённых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов службы AWS, возвращая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов службы AWS.

Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя AWS Command Line Interface.

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

Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя AWS Command Line Interface.

--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 (строка)

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

  • on
  • off
  • auto

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

Вывод

Адреса -> (список)

Адреса доставки устройств Snow, созданные для этой учётной записи.

(структура)

Адрес, по которому вы хотите отправить устройство(а) Snow, связанное(ые) с определённой задачей. Адреса проверяются при создании. Указанный вами адрес должен находиться в обслуживаемой области вашего региона. Хотя отдельные элементы Address не требуются, если адрес некорректен или не поддерживается, генерируется исключение.

AddressId -> (строка)

Уникальный идентификатор адреса.

Name -> (строка)

Имя лица, получающего устройство Snow по указанному адресу.

Company -> (строка)

Имя компании, получающей устройство Snow по указанному адресу.

Street1 -> (строка)

Первая строка почтового адреса, по которому будет доставлено устройство Snow.

Street2 -> (строка)

Вторая строка почтового адреса, по которому будет доставлено устройство Snow.

Street3 -> (строка)

Третья строка почтового адреса, по которому будет доставлено устройство Snow.

City -> (строка)

Город по указанному адресу.

StateOrProvince -> (строка)

Штат или провинция по указанному адресу.

PrefectureOrDistrict -> (строка)

Это поле больше не используется и его значение игнорируется.

Landmark -> (строка)

Это поле больше не используется и его значение игнорируется.

Country -> (строка)

Страна по указанному адресу.

PostalCode -> (строка)

Почтовый индекс по указанному адресу.

PhoneNumber -> (строка)

Номер телефона, связанный с адресом.

IsRestricted -> (логическое значение)

Если создаваемый адрес является основным, установите это значение в true. Это поле не поддерживается в большинстве регионов.

Type -> (строка)

Различает адрес доставки и адрес получения в учётной записи клиента. Указывается при создании задачи.

NextToken -> (строка)

HTTP-запросы бессостоятельны. Если вы используете автоматически сгенерированное значение NextToken в вашем следующем вызове DescribeAddresses, ваш список возвращённых адресов начнется с этой точки в массиве.

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

Spec-Zone.ru

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