Spec-Zone.ru › AWS CLI v2

[ aws . proton ]

получить-среду

Описание

Получить подробные данные для среды.

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

Синтаксис

  get-environment
--name <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]

Параметры

--name (строка)

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

--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
  • текст
  • таблица
  • 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.

Вывод

среда -> (структура)

Подробные данные запрошенной среды.

arn -> (строка)

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

codebuildRoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM-сервиса, которая позволяет Proton снабжать инфраструктурой с использованием CodeBuild-based provisioning от вашего имени.

componentRoleArn -> (строка)

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

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

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

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

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

deploymentStatus -> (строка)

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

deploymentStatusMessage -> (строка)

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

description -> (строка)

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

environmentAccountConnectionId -> (строка)

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

environmentAccountId -> (строка)

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

lastAttemptedDeploymentId -> (строка)

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

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

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

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

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

lastSucceededDeploymentId -> (строка)

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

name -> (строка)

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

protonServiceRoleArn -> (строка)

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

provisioning -> (строка)

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

provisioningRepository -> (структура)

Связанный репозиторий, используемый для размещения ваших шаблонов инфраструктуры для самостоятельного снабжения. Связанный репозиторий — это репозиторий, зарегистрированный в Proton. Дополнительную информацию см. в разделе CreateRepository.

arn -> (строка)

Amazon Resource Name (ARN) связанного репозитория.

branch -> (строка)

Ветка репозитория.

name -> (строка)

Имя репозитория.

provider -> (строка)

Поставщик репозитория.

spec -> (строка)

Спецификация среды.

templateMajorVersion -> (строка)

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

templateMinorVersion -> (строка)

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

templateName -> (строка)

Amazon Resource Name (ARN) шаблона среды.

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

Spec-Zone.ru

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