[ aws . servicecatalog ]
describe-product-as-admin
Описание
Получает информацию о заданном продукте. Данная операция выполняется с правами администратора.
См. также: AWS API Documentation
Синтаксис
describe-product-as-admin
[--accept-language <value>]
[--id <value>]
[--name <value>]
[--source-portfolio-id <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 (строка)
--source-portfolio-id (строка)
Уникальный идентификатор общего портфеля, с которым связан указанный продукт.
Вы можете указать этот параметр для получения общих параметров тегов, связанных с продуктом. Если этот параметр указан и если обмен тегами включен в общий портфель, API возвращает как локальные, так и общие параметры тегов, связанные с продуктом. В противном случае будут возвращены только локальные параметры тегов.
--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое отображается как двоичный блок, 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-product-as-admin пример отображает подробную информацию о заданном продукте с использованием прав администратора.
aws servicecatalog describe-product-as-admin \
--id prod-abcdcek6yhbxi
Вывод:
{
"TagOptions": [],
"ProductViewDetail": {
"ProductARN": "arn:aws:catalog:us-west-2:687558542028:product/prod-abcdcek6yhbxi",
"ProductViewSummary": {
"SupportEmail": "test@amazon.com",
"Type": "CLOUD_FORMATION_TEMPLATE",
"Distributor": "test-distributor",
"ShortDescription": "test-description",
"Owner": "test-owner",
"Id": "prodview-wi3l2j4abc6vc",
"SupportDescription": "test-support",
"ProductId": "prod-abcdcek6yhbxi",
"HasDefaultPath": false,
"Name": "test-product3",
"SupportUrl": "https://aws.amazon.com"
},
"CreatedTime": 1577136715.0,
"Status": "CREATED"
},
"ProvisioningArtifactSummaries": [
{
"CreatedTime": 1577136715.0,
"Description": "test-version-description",
"ProvisioningArtifactMetadata": {
"SourceProvisioningArtifactId": "pa-abcdxkkiv5fcm"
},
"Name": "test-version-name-3",
"Id": "pa-abcdxkkiv5fcm"
}
],
"Tags": [
{
"Value": "iad",
"Key": "region"
}
]
}
Вывод
ProductViewDetail -> (структура)
Информация о представлении продукта.
ProductViewSummary -> (структура)
Сводная информация о представлении продукта.
Id -> (строка)
ProductId -> (строка)
Name -> (строка)
Owner -> (строка)
ShortDescription -> (строка)
Type -> (строка)
MARKETPLACE, продукт был создан Amazon Web Services Marketplace.Distributor -> (строка)
HasDefaultPath -> (булево)
SupportEmail -> (строка)
SupportDescription -> (строка)
SupportUrl -> (строка)
Status -> (строка)
Статус продукта.
-
AVAILABLE- Продукт готов к использованию. -
CREATING- Начато создание продукта; продукт не готов к использованию. -
FAILED- Произошла ошибка.
ProductARN -> (строка)
CreatedTime -> (временная метка)
SourceConnection -> (структура)
Ответ верхнего уровня ProductViewDetail, содержащий информацию о подключении продукта. Service Catalog возвращает это поле для CreateProduct, UpdateProduct, DescribeProductAsAdmin и SearchProductAsAdmin API. Этот ответ содержит те же поля, что и запрос ConnectionParameters, с добавлением ответа LastSync.
Type -> (строка)
SourceConnection — Codestar.ConnectionParameters -> (структура)
Подробности подключения на основе Type подключения.
CodeStar -> (структура)
Предоставляет ConnectionType данные.
ConnectionArn -> (строка)
Repository -> (строка)
Branch -> (строка)
ArtifactPath -> (строка)
LastSync -> (структура)
Предоставляет информацию о синхронизации подключения продукта и содержит следующие подполя.
LastSyncTimeLastSyncStatusLastSyncStatusMessageLastSuccessfulSyncTimeLastSuccessfulSyncProvisioningArtifactID
LastSyncTime -> (временная метка)
LastSyncStatus -> (строка)
SUCCEEDED или FAILED.LastSyncStatusMessage -> (строка)
LastSuccessfulSyncTime -> (временная метка)
LastSuccessfulSyncProvisioningArtifactId -> (строка)
ProvisioningArtifactSummaries -> (список)
Информация о артефактах подготовки (также известных как версии) для указанного продукта.
(структура)
Сводная информация об артефакте подготовки (также известном как версия) для продукта.
Id -> (строка)
Name -> (строка)
Description -> (строка)
CreatedTime -> (временная метка)
ProvisioningArtifactMetadata -> (карта)
Метаданные для артефакта подготовки. Используется с продуктами Amazon Web Services Marketplace.
ключ -> (строка)
значение -> (строка)
Tags -> (список)
Информация о тегах, связанных с продуктом.
(структура)
Информация о теге. Тег — это пара «ключ-значение». Теги распространяются на ресурсы, созданные при подготовке продукта.
Key -> (строка)
Value -> (строка)
TagOptions -> (список)
Информация о TagOptions, связанных с продуктом.
(структура)
Информация о TagOption.
Key -> (строка)
Value -> (строка)
Active -> (булево)
Id -> (строка)
Owner -> (строка)
Budgets -> (список)
Информация о связанных бюджетах.
(структура)
Информация о бюджете.
BudgetName -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.