Spec-Zone.ru › AWS CLI v2

[ aws . servicecatalog ]

update-product

Описание

Обновляет указанный продукт.

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

Синтаксис

  update-product
[--accept-language <value>]
--id <value>
[--name <value>]
[--owner <value>]
[--description <value>]
[--distributor <value>]
[--support-description <value>]
[--support-email <value>]
[--support-url <value>]
[--add-tags <value>]
[--remove-tags <value>]
[--source-connection <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 - Китайский

--id (строка)

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

--name (строка)

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

--owner (строка)

Обновленный владелец продукта.

--description (строка)

Обновленное описание продукта.

--distributor (строка)

Обновленный дистрибьютор продукта.

--support-description (строка)

Обновленное описание поддержки продукта.

--support-email (строка)

Обновленный адрес электронной почты поддержки продукта.

--support-url (строка)

Обновленный URL поддержки продукта.

--add-tags (список)

Теги для добавления к продукту.

(структура)

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

Ключ -> (строка)

Ключ тега.

Значение -> (строка)

Значение для этого ключа.

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--remove-tags (список)

Теги для удаления из продукта.

(строка)

Синтаксис:

"string" "string" ...

--source-connection (структура)

Указывает данные подключения для обновленного продукта и синхронизирует продукт с источником артефактов подключения. Это автоматически управляет артефактами продукта на основе изменений в источнике. Параметр SourceConnection состоит из следующих подполей.

  • Type
  • ConnectionParamters

Тип -> (строка)

Единственный поддерживаемый тип SourceConnection — Codestar.

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

Данные подключения на основе подключения Type.

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

Предоставляет ConnectionType данные.

ConnectionArn -> (строка)

ARN CodeStar, который является подключением между Service Catalog и внешним хранилищем.

Repository -> (строка)

Конкретное хранилище, где находится артефакт продукта, который необходимо синхронизировать, в формате «Аккаунт/Репозиторий».

Branch -> (строка)

Конкретная ветвь, где находится артефакт.

ArtifactPath -> (строка)

Абсолютный путь, где находится артефакт в репозитории и ветви, в формате «папка/файл.json».

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

Type=string,ConnectionParameters={CodeStar={ConnectionArn=string,Repository=string,Branch=string,ArtifactPath=string}}

Синтаксис JSON:

{
  "Type": "CODESTAR",
  "ConnectionParameters": {
    "CodeStar": {
      "ConnectionArn": "string",
      "Repository": "string",
      "Branch": "string",
      "ArtifactPath": "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.

Примеры

Примечание

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

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

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

В следующем update-product примере обновляются имя и владелец указанного продукта.

aws servicecatalog update-product \
    --id prod-os6abc7drqlt2 \
    --name "New product name" \
    --owner "Updated product owner"

Вывод:

{
    "Tags": [
        {
            "Value": "iad",
            "Key": "region"
        }
    ],
    "ProductViewDetail": {
        "ProductViewSummary": {
            "Owner": "Updated product owner",
            "ProductId": "prod-os6abc7drqlt2",
            "Distributor": "test-distributor",
            "SupportUrl": "https://aws.amazon.com",
            "Name": "New product name",
            "ShortDescription": "test-description",
            "HasDefaultPath": false,
            "Id": "prodview-6abcdgrfhvidy",
            "SupportDescription": "test-support",
            "SupportEmail": "test@amazon.com",
            "Type": "CLOUD_FORMATION_TEMPLATE"
        },
        "Status": "CREATED",
        "ProductARN": "arn:aws:catalog:us-west-2:123456789012:product/prod-os6abc7drqlt2",
        "CreatedTime": 1577136255.0
    }
}

Вывод

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

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

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

Сводная информация о представлении продукта.

Id -> (строка)

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

ProductId -> (строка)

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

Name -> (строка)

Название продукта.

Owner -> (строка)

Владелец продукта. Обратитесь к администратору продукта для получения значения этого параметра.

ShortDescription -> (строка)

Краткое описание продукта.

Type -> (строка)

Тип продукта. Обратитесь к администратору продукта для получения значения этого параметра. Если это значение равно MARKETPLACE , продукт был создан Amazon Web Services Marketplace.

Distributor -> (строка)

Дистрибутор продукта. Обратитесь к администратору продукта для получения значения этого параметра.

HasDefaultPath -> (булево)

Указывает, имеет ли продукт путь по умолчанию. Если у продукта нет пути по умолчанию, вызовите ListLaunchPaths, чтобы различить пути. В противном случае ListLaunchPaths не требуется, и вывод ProductViewSummary можно использовать непосредственно с DescribeProvisioningParameters.

SupportEmail -> (строка)

Адрес электронной почты для получения поддержки данного продукта.

SupportDescription -> (строка)

Описание поддержки этого продукта.

SupportUrl -> (строка)

Ссылка для получения поддержки этого продукта.

Status -> (строка)

Состояние продукта.

  • AVAILABLE - Продукт готов к использованию.
  • CREATING - Начало создания продукта; продукт не готов к использованию.
  • FAILED - Действие завершилось ошибкой.

ProductARN -> (строка)

ARN продукта.

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

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

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

Ответ верхнего уровня ProductViewDetail, содержащий подробности о подключении продукта. Service Catalog возвращает это поле для API CreateProduct, UpdateProduct, DescribeProductAsAdmin и SearchProductAsAdmin. Этот ответ содержит те же поля, что и запрос ConnectionParameters, с добавлением ответа LastSync.

Type -> (строка)

Единственный поддерживаемый тип SourceConnection - Codestar.

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

Подробности подключения на основе подключения Type.

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

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

ConnectionArn -> (строка)

ARN CodeStar, представляющий подключение между Service Catalog и внешним хранилищем.

Repository -> (строка)

Конкретное хранилище, в котором находится артефакт продукта для синхронизации, отформатированное как «Аккаунт/Хранилище».

Branch -> (строка)

Конкретная ветвь, в которой находится артефакт.

ArtifactPath -> (строка)

Абсолютный путь к артефакту в хранилище и ветви, отформатированный как «папка/файл.json».

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

Предоставляет сведения о синхронизации подключения продукта и содержит следующие подполя.

  • LastSyncTime
  • LastSyncStatus
  • LastSyncStatusMessage
  • LastSuccessfulSyncTime
  • LastSuccessfulSyncProvisioningArtifactID

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

Время последней попытки синхронизации из хранилища в продукт Service Catalog.

LastSyncStatus -> (строка)

Текущее состояние синхронизации. Ответы включают SUCCEEDED или FAILED.

LastSyncStatusMessage -> (строка)

Сообщение о состоянии синхронизации.

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

Время последней успешной синхронизации артефакта из исходного хранилища в продукт Service Catalog.

LastSuccessfulSyncProvisioningArtifactId -> (строка)

ProvisioningArtifactID ProvisioningArtifact, созданного из последней успешной синхронизации.

Tags -> (список)

Информация о тегах, связанных с продуктом.

(структура)

Информация о теге. Тег — это пара «ключ-значение». Теги распространяются на ресурсы, созданные при подготовке продукта.

Key -> (строка)

Ключ тега.

Value -> (строка)

Значение для этого ключа.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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