Spec-Zone.ru › AWS CLI v2

[ aws . account ]

list-regions

Описание

Выводит все регионы для данного аккаунта и их соответствующий статус включения. Допускается фильтрация этого списка по параметру region-opt-status-contains.

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

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

Синтаксис

  list-regions
[--account-id <value>]
[--region-opt-status-contains <value>]
[--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]

Параметры

--account-id (строка)

Указывает 12-значный идентификатор учетной записи Amazon Web Services, к которой вы хотите получить доступ или произвести изменения с помощью этой операции. Если этот параметр не указан, используется учетная запись Amazon Web Services, используемой для вызова операции. Для использования этого параметра вызывающий должен быть идентитетом в учетной записи управления организацией или делегированным администратором. Указанный идентификатор учетной записи должен быть учетной записью-членом в той же организации. Организация должна иметь все функции включенными, а также должна иметь включенный доверенный доступ к службе управления учетными записями, а также, необязательно, назначенного делегированного администратора.

Примечание

Учетная запись управления не может указать свой AccountId. Она должна вызвать операцию в автономном контексте, не включая параметр AccountId.

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

--region-opt-status-contains (список)

Список статусов регионов (Включение, Включен, Отключение, Отключен, Включен_по_умолчанию), используемый для фильтрации списка регионов для данной учетной записи. Например, передача значения ENABLING вернёт только список регионов со статусом региона ENABLING.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  ENABLED
  ENABLING
  DISABLING
  DISABLED
  ENABLED_BY_DEFAULT

--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
  • текст
  • таблица
  • 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-auto-prompt (булево)

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

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

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

Вывод

NextToken -> (строка)

Если есть больше данных для возврата, это поле будет заполнено. Его следует передать в параметр запроса next-token запроса list-regions.

Regions -> (список)

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

(структура)

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

RegionName -> (строка)

Код региона данного региона (например, us-east-1).

RegionOptStatus -> (строка)

Один из возможных статусов региона (Включен, Включение, Отключен, Отключение, Включен_по_умолчанию).

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

Spec-Zone.ru

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