[ aws . servicecatalog ]
поиск-продуктов-как-админ
Описание
Получает информацию о продуктах для указанного портфеля или всех продуктов.
См. также: Документацию API AWS
search-products-as-admin это постраничная операция. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлечь данные из результатов следующих выражений запроса: ProductViewDetails
Синтаксис
search-products-as-admin
[--accept-language <value>]
[--portfolio-id <value>]
[--filters <value>]
[--sort-by <value>]
[--sort-order <value>]
[--page-size <value>]
[--product-source <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--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- Китайский
--portfolio-id (строка)
--filters (массив)
Фильтры поиска. Если фильтры поиска не указаны, вывод включает все продукты, к которым у администратора есть доступ.
ключ -> (строка)
значение -> (список)
Сокращенный синтаксис:
KeyName1=string,string,KeyName2=string,string
Where valid key names are:
FullTextSearch
Owner
ProductType
SourceProductId
Синтаксис JSON:
{"FullTextSearch"|"Owner"|"ProductType"|"SourceProductId": ["string", ...]
...}
--sort-by (строка)
Поле сортировки. Если значение не указано, результаты не сортируются.
Возможные значения:
TitleVersionCountCreationDate
--sort-order (строка)
Порядок сортировки. Если значение не указано, результаты не сортируются.
Возможные значения:
ASCENDINGDESCENDING
--page-size (целое число)
Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Уменьшение размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания AWS-сервисных вызовов.
Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.
--product-source (строка)
Уровень доступа источника продукта.
Возможные значения:
ACCOUNT
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения перекроют значения, предоставленные JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного JSON, так как строка будет интерпретирована буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания места начала постраничного вывода. Это NextToken из ранее урезанного ответа.
Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.
--max-items (целое число)
Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода, укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.
--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 для вывода.
--cli-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запроса параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. См. руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.
Если не указано иное, во всех примерах используются правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. использование кавычек со строками в Руководстве пользователя AWS CLI.
Для поиска продуктов с правами администратора
Следующий пример поиска продуктов с правами администратора, используя идентификатор портфеля в качестве фильтра.
aws servicecatalog search-products-as-admin \
--portfolio-id port-5abcd3e5st4ei
Вывод:
{
"ProductViewDetails": [
{
"ProductViewSummary": {
"Name": "my product",
"Owner": "owner name",
"Type": "CLOUD_FORMATION_TEMPLATE",
"ProductId": "prod-abcdfz3syn2rg",
"HasDefaultPath": false,
"Id": "prodview-abcdmyuzv2dlu",
"ShortDescription": "description"
},
"ProductARN": "arn:aws:catalog:us-west-2:123456789012:product/prod-abcdfz3syn2rg",
"CreatedTime": 1562097906.0,
"Status": "CREATED"
}
]
}
Вывод
ProductViewDetails -> (список)
Информация о представлении продукта.
(структура)
Информация о представлении продукта.
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 возвращает это поле для API CreateProduct , UpdateProduct , DescribeProductAsAdmin и SearchProductAsAdmin. Этот ответ содержит те же поля, что и запрос ConnectionParameters, с добавлением ответа LastSync.
Type -> (строка)
SourceConnection — Codestar.ConnectionParameters -> (структура)
Подробности подключения на основе Type подключения.
CodeStar -> (структура)
Предоставляет детали ConnectionType.
ConnectionArn -> (строка)
Repository -> (строка)
Branch -> (строка)
ArtifactPath -> (строка)
LastSync -> (структура)
Предоставляет сведения о синхронизации подключения продукта и содержит следующие подполя.
LastSyncTimeLastSyncStatusLastSyncStatusMessageLastSuccessfulSyncTimeLastSuccessfulSyncProvisioningArtifactID
LastSyncTime -> (временная метка)
LastSyncStatus -> (строка)
SUCCEEDED или FAILED.LastSyncStatusMessage -> (строка)
LastSuccessfulSyncTime -> (временная метка)
LastSuccessfulSyncProvisioningArtifactId -> (строка)
NextPageToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.