Spec-Zone.ru › AWS CLI v2

[ aws . proton ]

list-environments

Описание

Список сред с детальными сводными данными.

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

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

Синтаксис

  list-environments
[--environment-templates <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]

Параметры

--environment-templates (список)

Массив версий шаблона среды.

(структура)

Фильтр поиска шаблонов сред.

majorVersion -> (строка)

Включите majorVersion, чтобы отфильтровать поиск по основной версии.

templateName -> (строка)

Включите templateName, чтобы отфильтровать поиск по имени шаблона.

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

majorVersion=string,templateName=string ...

Синтаксис JSON:

[
  {
    "majorVersion": "string",
    "templateName": "string"
  }
  ...
]

--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 для вывода.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

environments -> (список)

Массив сводных данных о деталях среды.

(структура)

Сводные данные о ресурсе среды Proton. Среда Proton — это набор ресурсов, общих для сервисов Proton.

arn -> (строка)

Amazon Resource Name (ARN) среды.

componentRoleArn -> (строка)

Amazon Resource Name (ARN) роли службы IAM, которую Proton использует при непосредственном предоставлении компонентов, определенных в этой среде. Она определяет область инфраструктуры, которую может предоставить компонент.

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

Дополнительную информацию о компонентах см. в Руководстве пользователя Proton.

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

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

deploymentStatus -> (строка)

Статус развертывания среды.

deploymentStatusMessage -> (строка)

Сообщение о статусе развертывания среды.

description -> (строка)

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

environmentAccountConnectionId -> (строка)

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

environmentAccountId -> (строка)

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

lastAttemptedDeploymentId -> (строка)

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

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

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

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

Время последнего успешного развертывания среды.

lastSucceededDeploymentId -> (строка)

Идентификатор последнего успешного развертывания этой среды.

name -> (строка)

Имя среды.

protonServiceRoleArn -> (строка)

Amazon Resource Name (ARN) роли службы Proton, которая позволяет Proton выполнять вызовы других служб от вашего имени.

provisioning -> (строка)

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

templateMajorVersion -> (строка)

Основная версия шаблона среды.

templateMinorVersion -> (строка)

Дополнительная версия шаблона среды.

templateName -> (строка)

Имя шаблона среды.

nextToken -> (строка)

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

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

Spec-Zone.ru

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