Spec-Zone.ru › AWS CLI v2

[ aws . servicecatalog ]

describe-provisioning-parameters

Описание

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

Если выходные данные содержат ключ TagOption со списком значений, равным пустому списку, существует конфликт TagOption для этого ключа. Конечный пользователь не может предпринять действия для исправления конфликта, и запуск не блокируется. В последующих вызовах ProvisionProduct не включайте конфликтующие ключи TagOption в качестве тегов, иначе возникает ошибка «Проверка параметров завершилась неудачей: Не хватает обязательного параметра в Tags[N ]:Value ». Пометьте развернутый продукт значением sc-tagoption-conflict-portfolioId-productId.

См. также: AWS API Documentation

Синтаксис

  describe-provisioning-parameters
[--accept-language <value>]
[--product-id <value>]
[--product-name <value>]
[--provisioning-artifact-id <value>]
[--provisioning-artifact-name <value>]
[--path-id <value>]
[--path-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]

Параметры

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

Код языка.

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

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

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

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

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

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

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

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

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

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

Идентификатор пути продукта. Это значение необязательно, если у продукта есть путь по умолчанию, и обязательно, если у продукта более одного пути. Чтобы перечислить пути продукта, используйте ListLaunchPaths . Вы должны указать имя или ID продукта, но не оба.

--path-name (строка)

Имя пути. Вы должны указать имя или ID пути, но не оба.

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

Вывод

ProvisioningArtifactParameters -> (список)

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

(структура)

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

ParameterKey -> (строка)

Ключ параметра.

DefaultValue -> (строка)

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

ParameterType -> (строка)

Тип параметра.

IsNoEcho -> (логическое значение)

Если это значение true, значение этого параметра скрыто от просмотра при получении параметра. Этот параметр используется для скрытия конфиденциальной информации.

Description -> (строка)

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

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

Ограничения, установленные администратором на параметр.

AllowedValues -> (список)

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

(строка)

AllowedPattern -> (строка)

Регулярное выражение, представляющее шаблоны, разрешенные для типов String. Шаблон должен соответствовать всему предоставленному значению параметра.

ConstraintDescription -> (строка)

Строка, объясняющая ограничение при нарушении ограничения. Например, без описания ограничения, параметр с разрешенным шаблоном [A-Za-z0-9]+ отображает следующую ошибку при указании пользователем недопустимого значения:

Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+

Добавив описание ограничения, такое как должен содержать только буквы (большие и маленькие) и цифры, вы можете отобразить следующее настраиваемое сообщение об ошибке:

Malformed input-Parameter MyParameter must only contain uppercase and lowercase letters and numbers.

MaxLength -> (строка)

Целое значение, определяющее максимальное количество символов, разрешенных для типов String.

MinLength -> (строка)

Целое значение, определяющее минимальное количество символов, разрешенных для типов String.

MaxValue -> (строка)

Числовое значение, определяющее максимальное числовое значение, разрешенное для типов Number.

MinValue -> (строка)

Числовое значение, определяющее минимальное числовое значение, разрешенное для типов Number.

ConstraintSummaries -> (список)

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

(структура)

Сводная информация об ограничении.

Type -> (строка)

Тип ограничения.

  • LAUNCH
  • NOTIFICATION
  • STACKSET
  • TEMPLATE

Description -> (строка)

Описание ограничения.

UsageInstructions -> (список)

Любые дополнительные метаданные, относящиеся к развертыванию продукта. Например, см. поле Version шаблона CloudFormation.

(структура)

Дополнительная информация, предоставленная администратором.

Type -> (строка)

Тип инструкции по использованию для значения.

Value -> (строка)

Значение инструкции по использованию для этого типа.

TagOptions -> (список)

Информация о TagOptions, связанных с ресурсом.

(структура)

Сводная информация о TagOption.

Key -> (строка)

Ключ TagOption.

Values -> (список)

Значение TagOption.

(строка)

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

Объект, содержащий информацию о настройках, таких как регионы и учетные записи, для артефакта развертывания.

StackSetAccounts -> (список)

Одна или несколько учетных записей Amazon Web Services, где экземпляры стека развертываются из набора стеков. Эти учетные записи могут быть ограничены в ProvisioningPreferences$StackSetAccounts и UpdateProvisioningPreferences$StackSetAccounts .

Применимо только к типу продукта, развертываемого в CFN_STACKSET.

(строка)

StackSetRegions -> (список)

Одна или несколько областей Amazon Web Services, где экземпляры стека развертываются из набора стеков. Эти области могут быть ограничены в ProvisioningPreferences$StackSetRegions и UpdateProvisioningPreferences$StackSetRegions .

Применимо только к типу продукта, развертываемого в CFN_STACKSET.

(строка)

ProvisioningArtifactOutputs -> (список)

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

(структура)

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

Key -> (строка)

Ключ вывода артефакта развертывания.

Description -> (строка)

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

ProvisioningArtifactOutputKeys -> (список)

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

(структура)

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

Key -> (строка)

Ключ вывода артефакта развертывания.

Description -> (строка)

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

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

Spec-Zone.ru

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