Spec-Zone.ru › AWS CLI v2

[ aws . servicecatalog ]

describe-provisioned-product

Описание

Получает информацию о заданном предоставленном продукте.

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

Синтаксис

  describe-provisioned-product
[--accept-language <value>]
[--id <value>]
[--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 - Китайский

--id (строка)

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

Если вы не укажете имя или идентификатор, или укажете и имя, и идентификатор, произойдёт InvalidParametersException.

--name (строка)

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

Если вы не укажете имя или идентификатор, или укажете и имя, и идентификатор, произойдёт InvalidParametersException.

--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
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

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

Примеры

Примечание

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

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

Для описания выделенного продукта

Следующий describe-provisioned-product пример отображает подробную информацию о заданном выделенном продукте.

aws servicecatalog describe-provisioned-product \
    --id pp-dpom27bm4abcd

Вывод:

{
    "ProvisionedProductDetail": {
        "Status": "ERROR",
        "CreatedTime": 1577222793.358,
        "Arn": "arn:aws:servicecatalog:us-west-2:123456789012:stack/mytestppname3/pp-dpom27bm4abcd",
        "Id": "pp-dpom27bm4abcd",
        "StatusMessage": "AmazonCloudFormationException  Parameters: [KeyName] must have values (Service: AmazonCloudFormation; Status Code: 400; Error Code: ValidationError; Request ID: 5528602a-a9ef-427c-825c-f82c31b814f5)",
        "IdempotencyToken": "527c5358-2a1a-4b9e-b1b9-7293b0ddff42",
        "LastRecordId": "rec-tfuawdjovzxge",
        "Type": "CFN_STACK",
        "Name": "mytestppname3"
    },
    "CloudWatchDashboards": []
}

Вывод

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

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

Name -> (строка)

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

Arn -> (строка)

ARN выделенного продукта.

Type -> (строка)

Тип выделенного продукта. Допустимые значения: CFN_STACK , CFN_STACKSET , TERRAFORM_OPEN_SOURCE , TERRAFORM_CLOUD и EXTERNAL.

Id -> (строка)

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

Status -> (строка)

Текущий статус выделенного продукта.

  • AVAILABLE - Стабильное состояние, готовое к выполнению любых операций. Последняя операция прошла успешно и завершена.
  • UNDER_CHANGE - Переходное состояние. Результаты выполненных операций могут быть некорректными. Дождитесь статуса AVAILABLE перед выполнением операций.
  • TAINTED - Стабильное состояние, готовое к выполнению любых операций. Стек завершил запрашиваемую операцию, но результат может отличаться от ожидаемого. Например, запрос на обновление до новой версии завершился неудачей, и стек откатился к текущей версии.
  • ERROR - Возникла непредвиденная ошибка. Выделенный продукт существует, но стек не запущен. Например, CloudFormation получил некорректное значение параметра и не смог запустить стек.
  • PLAN_IN_PROGRESS - Переходное состояние. Операции планирования были выполнены для выделения нового продукта, но ресурсы еще не созданы. После проверки списка ресурсов, которые необходимо создать, выполните план. Дождитесь статуса AVAILABLE перед выполнением операций.

StatusMessage -> (строка)

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

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

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

IdempotencyToken -> (строка)

Уникальный идентификатор, который вы предоставляете для обеспечения идемпотентности. Если несколько запросов различаются только по значению маркера идемпотентности, для каждого повторяющегося запроса возвращается тот же ответ.

LastRecordId -> (строка)

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

LastProvisioningRecordId -> (строка)

Идентификатор записи последнего запроса, выполненного для этого выделенного продукта следующих типов:

  • ProvisionProduct
  • UpdateProvisionedProduct
  • ExecuteProvisionedProductPlan
  • TerminateProvisionedProduct

LastSuccessfulProvisioningRecordId -> (строка)

Идентификатор записи последнего успешного запроса, выполненного для этого выделенного продукта следующих типов:

  • ProvisionProduct
  • UpdateProvisionedProduct
  • ExecuteProvisionedProductPlan
  • TerminateProvisionedProduct

ProductId -> (строка)

Идентификатор продукта. Например, prod-abcdzk7xy33qa.

ProvisioningArtifactId -> (строка)

Идентификатор артефакта выделения. Например, pa-4abcdjnxjj6ne.

LaunchRoleArn -> (строка)

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

CloudWatchDashboards -> (список)

Любые панели мониторинга CloudWatch, созданные при выделении продукта.

(структура)

Информация о панели мониторинга CloudWatch.

Name -> (строка)

Имя панели мониторинга CloudWatch.

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

Spec-Zone.ru

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