Spec-Zone.ru › AWS CLI v2

[ aws . servicecatalog ]

update-provisioning-artifact

Описание

Обновляет указанный артефакт развертывания (также известный как версия) для указанного продукта.

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

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

Синтаксис

  update-provisioning-artifact
[--accept-language <value>]
--product-id <value>
--provisioning-artifact-id <value>
[--name <value>]
[--description <value>]
[--active | --no-active]
[--guidance <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]

Параметры

--accept-language (строка)

Код языка.

  • jp - Японский
  • zh - Китайский

--product-id (строка)

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

--provisioning-artifact-id (строка)

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

--name (строка)

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

--description (строка)

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

--active | --no-active (булево)

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

Неактивные артефакты развертывания невидимы для конечных пользователей. Конечные пользователи не могут запускать или обновлять развернутый продукт из неактивного артефакта развертывания.

--guidance (строка)

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

Значение DEFAULT указывает, что версия продукта активна.

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

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

  • DEFAULT
  • DEPRECATED

--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 (boolean)

Включить отладовую регистрацию.

--endpoint-url (string)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с сервисами AWS. Для каждого SSL соединения AWS CLI будет проверять SSL сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL сертификатов.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команд.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

Используемая область. Переопределяет настройки конфигурации/окружения.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/отключить вывод цвета.

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.

--ca-bundle (string)

Файл сертификатов CA для проверки SSL сертификатов. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время соединения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — 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 (boolean)

Отключить пагинацию CLI для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах используются правила цитирования, подобные Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

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

Следующий update-provisioning-artifact пример обновляет имя и описание указанного артефакта подготовки, используя файл JSON для передачи параметров.

aws servicecatalog update-provisioning-artifact \
    --cli-input-json file://update-provisioning-artifact-input.json

Содержание update-provisioning-artifact-input.json:

{
    "ProductId": "prod-abcdfz3syn2rg",
    "ProvisioningArtifactId": "pa-pcz347abcdcfm",
    "Name": "updated name",
    "Description": "updated description"
}

Вывод:

{
    "Info": {
        "TemplateUrl": "https://awsdocs.s3.amazonaws.com/servicecatalog/myexampledevelopment-environment.template"
    },
    "Status": "AVAILABLE",
    "ProvisioningArtifactDetail": {
        "Active": true,
        "Description": "updated description",
        "Id": "pa-pcz347abcdcfm",
        "Name": "updated name",
        "Type": "CLOUD_FORMATION_TEMPLATE",
        "CreatedTime": 1562097906.0
    }
}

Вывод

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

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

Id -> (строка)

Идентификатор компонента подготовки.

Name -> (строка)

Название компонента подготовки.

Description -> (строка)

Описание компонента подготовки.

Type -> (строка)

Тип компонента подготовки.

  • CLOUD_FORMATION_TEMPLATE - Шаблон CloudFormation
  • TERRAFORM_OPEN_SOURCE - Файл конфигурации Terraform Open Source
  • TERRAFORM_CLOUD - Файл конфигурации Terraform Cloud
  • EXTERNAL - Внешний файл конфигурации

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

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

Active -> (логическое)

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

Guidance -> (строка)

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

SourceRevision -> (строка)

Указывает ревизию внешнего артефакта, который использовался для автоматической синхронизации продукта Service Catalog и создания компонента подготовки. Service Catalog включает этот параметр ответа в качестве общего поля к существующему типу ProvisioningArtifactDetail, который возвращается в ответ на API CreateProduct, UpdateProduct, DescribeProductAsAdmin, DescribeProvisioningArtifact, ListProvisioningArtifact и UpdateProvisioningArticat.

Это поле существует только для продуктов, синхронизированных через Repo.

Info -> (массив)

URL шаблона CloudFormation в Amazon S3 или GitHub в формате JSON.

key -> (строка)

value -> (строка)

Status -> (строка)

Статус текущего запроса.

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

Spec-Zone.ru

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