Spec-Zone.ru › AWS CLI v2

[ aws . datazone ]

обновить-профиль-проекта

Описание

Обновляет профиль проекта.

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

Синтаксис

  update-project-profile
[--description <value>]
--domain-identifier <value>
[--domain-unit-identifier <value>]
[--environment-configurations <value>]
--identifier <value>
[--name <value>]
[--status <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]

Параметры

--description (строка)

Описание профиля проекта.

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

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

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

Идентификатор единицы домена, в котором необходимо обновить профиль проекта.

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

Настройки окружения профиля проекта.

(структура)

Настройки окружения.

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

Учетная запись Amazon Web Services окружения.

Примечание

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

awsAccountId -> (строка)

Идентификатор учетной записи проекта.

awsAccountIdPath -> (строка)

Путь идентификатора учетной записи проекта.

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

Регион Amazon Web Services окружения.

Примечание

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

regionName -> (строка)

Название региона Amazon Web Services.

regionNamePath -> (строка)

Путь имени региона.

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

Параметры конфигурации окружения.

parameterOverrides -> (список)

Переопределения параметров.

(структура)

Параметр конфигурации окружения.

isEditable -> (булево)

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

name -> (строка)

Имя параметра конфигурации окружения.

value -> (строка)

Значение параметра конфигурации окружения.

resolvedParameters -> (список)

Разрешенные параметры конфигурации окружения.

(структура)

Параметр конфигурации окружения.

isEditable -> (булево)

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

name -> (строка)

Имя параметра конфигурации окружения.

value -> (строка)

Значение параметра конфигурации окружения.

ssmPath -> (строка)

Параметры конфигурации окружения по пути SSM.

deploymentMode -> (строка)

Режим развертывания окружения.

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

Порядок развертывания окружения.

description -> (строка)

Описание окружения.

environmentBlueprintId -> (строка)

Идентификатор шаблона окружения.

id -> (строка)

Идентификатор окружения.

name -> (строка)

Имя окружения.

Синтаксис JSON:

[
  {
    "awsAccount": {
      "awsAccountId": "string",
      "awsAccountIdPath": "string"
    },
    "awsRegion": {
      "regionName": "string",
      "regionNamePath": "string"
    },
    "configurationParameters": {
      "parameterOverrides": [
        {
          "isEditable": true|false,
          "name": "string",
          "value": "string"
        }
        ...
      ],
      "resolvedParameters": [
        {
          "isEditable": true|false,
          "name": "string",
          "value": "string"
        }
        ...
      ],
      "ssmPath": "string"
    },
    "deploymentMode": "ON_CREATE"|"ON_DEMAND",
    "deploymentOrder": integer,
    "description": "string",
    "environmentBlueprintId": "string",
    "id": "string",
    "name": "string"
  }
  ...
]

--identifier (строка)

Идентификатор профиля проекта, который необходимо обновить.

--name (строка)

Имя профиля проекта.

--status (строка)

Статус профиля проекта.

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

  • ENABLED
  • DISABLED

--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.

Вывод

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

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

createdBy -> (строка)

Пользователь, создавший профиль проекта.

description -> (строка)

Описание профиля проекта.

domainId -> (строка)

Идентификатор домена, в котором проект будет обновлён.

domainUnitId -> (строка)

Идентификатор единицы домена профиля проекта для обновления.

environmentConfigurations -> (список)

Настройки окружения профиля проекта.

(структура)

Настройки окружения.

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

Учетная запись Amazon Web Services окружения.

Примечание

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

awsAccountId -> (строка)

Идентификатор учетной записи проекта.

awsAccountIdPath -> (строка)

Путь идентификатора учетной записи проекта.

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

Регион Amazon Web Services окружения.

Примечание

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

regionName -> (строка)

Название региона Amazon Web Services.

regionNamePath -> (строка)

Путь имени региона.

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

Параметры конфигурации окружения.

parameterOverrides -> (список)

Переопределения параметров.

(структура)

Параметр конфигурации окружения.

isEditable -> (булево)

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

name -> (строка)

Имя параметра конфигурации окружения.

value -> (строка)

Значение параметра конфигурации окружения.

resolvedParameters -> (список)

Разрешенные параметры конфигурации окружения.

(структура)

Параметр конфигурации окружения.

isEditable -> (булево)

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

name -> (строка)

Имя параметра конфигурации окружения.

value -> (строка)

Значение параметра конфигурации окружения.

ssmPath -> (строка)

Параметры конфигурации окружения по пути SSM.

deploymentMode -> (строка)

Режим развертывания окружения.

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

Порядок развертывания окружения.

description -> (строка)

Описание окружения.

environmentBlueprintId -> (строка)

Идентификатор шаблона окружения.

id -> (строка)

Идентификатор окружения.

name -> (строка)

Имя окружения.

id -> (строка)

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

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

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

name -> (строка)

Имя профиля проекта.

status -> (строка)

Статус профиля проекта.

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

Spec-Zone.ru

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