Spec-Zone.ru › AWS CLI v2

[ aws . datazone ]

list-environments

Описание

Отображает среды Amazon DataZone.

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

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

Синтаксис

  list-environments
[--aws-account-id <value>]
[--aws-account-region <value>]
--domain-identifier <value>
[--environment-blueprint-identifier <value>]
[--environment-profile-identifier <value>]
[--name <value>]
--project-identifier <value>
[--provider <value>]
[--status <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]

Параметры

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

Идентификатор учётной записи Amazon Web Services, в которой вы хотите перечислить среды.

--aws-account-region (строка)

Регион Amazon Web Services, в котором вы хотите перечислить среды.

--domain-identifier (строка)

Идентификатор домена Amazon DataZone.

--environment-blueprint-identifier (строка)

Идентификатор шаблона Amazon DataZone.

--environment-profile-identifier (строка)

Идентификатор профиля среды.

--name (строка)

Название среды.

--project-identifier (строка)

Идентификатор проекта Amazon DataZone.

--provider (строка)

Поставщик среды.

--status (строка)

Состояние сред, которые вы хотите перечислить.

Возможные значения:

  • ACTIVE
  • CREATING
  • UPDATING
  • DELETING
  • CREATE_FAILED
  • UPDATE_FAILED
  • DELETE_FAILED
  • VALIDATION_FAILED
  • SUSPENDED
  • DISABLED
  • EXPIRED
  • DELETED
  • INACCESSIBLE

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

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

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

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

Вывод

items -> (список)

Результаты действия ListEnvironments.

(структура)

Подробности среды.

awsAccountId -> (строка)

Идентификатор учётной записи Amazon Web Services, в которой существует среда.

awsAccountRegion -> (строка)

Регион Amazon Web Services, в котором существует среда.

createdAt -> (временная метка)

Временная метка создания среды.

createdBy -> (строка)

Пользователь Amazon DataZone, создавший среду.

description -> (строка)

Описание среды.

domainId -> (строка)

Идентификатор домена Amazon DataZone, в котором существует среда.

environmentConfigurationId -> (строка)

Идентификатор конфигурации, с которой создаётся среда.

environmentProfileId -> (строка)

Идентификатор профиля среды, с которым была создана среда.

id -> (строка)

Идентификатор среды.

name -> (строка)

Название среды.

projectId -> (строка)

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

provider -> (строка)

Поставщик среды.

status -> (строка)

Состояние среды.

updatedAt -> (временная метка)

Временная метка обновления среды.

nextToken -> (строка)

Если количество сред больше значения по умолчанию для параметра MaxResults, или если вы явно задали значение для параметра MaxResults, которое меньше количества сред, ответ включает маркер постраничности, называемый NextToken. Вы можете указать это значение NextToken в последующем вызове ListEnvironments для перечисления следующего набора сред.

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

Spec-Zone.ru

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