Spec-Zone.ru › AWS CLI v2

[ aws . datazone ]

обновить-среду

Описание

Обновляет указанную среду в Amazon DataZone.

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

Синтаксис

  update-environment
[--blueprint-version <value>]
[--description <value>]
--domain-identifier <value>
[--glossary-terms <value>]
--identifier <value>
[--name <value>]
[--user-parameters <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]

Параметры

--blueprint-version (строка)

Версия чертежа, на которую должна быть обновлена среда. Для этого параметра можно указать только следующую строку: latest .

--description (строка)

Описание, которое необходимо обновить в рамках действия UpdateEnvironment.

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

Идентификатор домена, в котором среда должна быть обновлена.

--glossary-terms (список)

Термины глоссария, которые необходимо обновить в рамках действия UpdateEnvironment.

(строка)

Синтаксис:

"string" "string" ...

--identifier (строка)

Идентификатор среды, которая должна быть обновлена.

--name (строка)

Имя, которое необходимо обновить в рамках действия UpdateEnvironment.

--user-parameters (список)

Параметры пользователя среды.

(структура)

Подробности параметров профиля среды.

name -> (строка)

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

value -> (строка)

Значение параметра профиля среды.

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

name=string,value=string ...

Синтаксис JSON:

[
  {
    "name": "string",
    "value": "string"
  }
  ...
]

--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-auto-prompt (логическое значение)

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

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

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

Вывод

awsAccountId -> (строка)

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

awsAccountRegion -> (строка)

Регион Amazon Web Services, в котором среда обновляется.

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

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

createdBy -> (строка)

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

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

Свойства развертывания, которые необходимо обновить в рамках действия UpdateEnvironment.

endTimeoutMinutes -> (целое число)

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

startTimeoutMinutes -> (целое число)

Время ожидания начала развертывания шаблона среды.

description -> (строка)

Описание, которое необходимо обновить в рамках действия UpdateEnvironment.

domainId -> (строка)

Идентификатор домена, в котором необходимо обновить среду.

environmentActions -> (список)

Действия среды, которые необходимо обновить в рамках действия UpdateEnvironment.

(структура)

Настраиваемое действие среды Amazon DataZone.

auth -> (строка)

Тип аутентификации настраиваемого действия среды Amazon DataZone.

parameters -> (список)

Параметры настраиваемого действия в среде Amazon DataZone.

(структура)

Подробности параметров для настраиваемого действия среды.

key -> (строка)

Ключ параметра настраиваемого действия.

value -> (строка)

Значение параметра настраиваемого действия.

type -> (строка)

Тип настраиваемого действия в среде Amazon DataZone.

environmentBlueprintId -> (строка)

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

environmentConfigurationId -> (строка)

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

environmentProfileId -> (строка)

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

glossaryTerms -> (список)

Термины глоссария, которые необходимо обновить в рамках действия UpdateEnvironment.

(строка)

id -> (строка)

Идентификатор среды, которую нужно обновить.

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

Последнее развертывание среды.

deploymentId -> (строка)

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

deploymentStatus -> (строка)

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

deploymentType -> (строка)

Тип последнего развертывания среды.

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

Причина сбоя последнего развертывания среды.

code -> (строка)

Код ошибки причины сбоя развертывания среды.

message -> (строка)

Сообщение об ошибке причины сбоя развертывания среды.

isDeploymentComplete -> (булево)

Указывает, завершено ли последнее развертывание среды.

messages -> (список)

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

(строка)

name -> (строка)

Имя, которое необходимо обновить в рамках действия UpdateEnvironment.

projectId -> (строка)

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

provider -> (строка)

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

provisionedResources -> (список)

Ресурсы, которые необходимо обновить в рамках действия UpdateEnvironment.

(структура)

Подробности выделенного ресурса в этой среде Amazon DataZone.

name -> (строка)

Название выделенного ресурса в этой среде Amazon DataZone.

provider -> (строка)

Поставщик выделенного ресурса в этой среде Amazon DataZone.

type -> (строка)

Тип выделенного ресурса в этой среде Amazon DataZone.

value -> (строка)

Значение выделенного ресурса в этой среде Amazon DataZone.

provisioningProperties -> (структура помеченного объединения)

Свойства подготовки, которые необходимо обновить в рамках действия UpdateEnvironment.

Примечание

Это структура помеченного объединения. Можно установить только один из следующих ключей верхнего уровня: cloudFormation.

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

Свойства Cloud Formation, включенные в состав свойств подготовки шаблона среды.

templateUrl -> (строка)

URL шаблона свойств подготовки Cloud Formation шаблона среды.

status -> (строка)

Статус, который необходимо обновить в рамках действия UpdateEnvironment.

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

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

userParameters -> (список)

Пользовательские параметры, которые необходимо обновить в рамках действия UpdateEnvironment.

(структура)

Подробности пользовательских параметров шаблона среды.

defaultValue -> (строка)

Значение параметра по умолчанию.

description -> (строка)

Описание параметра.

fieldType -> (строка)

Тип поля параметра.

isEditable -> (булево)

Указывает, можно ли редактировать параметр.

isOptional -> (булево)

Указывает, является ли пользовательский параметр необязательным.

keyName -> (строка)

Имя ключа параметра.

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

Spec-Zone.ru

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