get-inventory-schema
Описание
Возвращает список имён типов инвентаризации для учётной записи или список имён атрибутов для определённого типа элемента инвентаризации.
См. также: Документацию API AWS
get-inventory-schema — это постоперация с постраничной передачей. Для получения всего набора результатов может потребоваться несколько вызовов API. Вы можете отключить постраничную передачу, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной передачей аргумент --query должен извлекать данные из результатов следующих выражений запроса: Schemas
Синтаксис
get-inventory-schema
[--type-name <value>]
[--aggregator | --no-aggregator]
[--sub-type | --no-sub-type]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <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]
Параметры
--type-name (строка)
--aggregator | --no-aggregator (булево)
AWS:InstanceInformation, потому что он поддерживает агрегацию на основе атрибутов PlatformName, PlatformType и PlatformVersion.--sub-type | --no-sub-type (булево)
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, указанному в --generate-cli-skeleton. Если на командной строке заданы другие аргументы, значения этих аргументов переопределят значения, предоставленные в формате JSON. Невозможно передавать произвольные двоичные значения, используя значение, предоставленное в формате JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания точки начала постраничной передачи. Это NextToken из ранее урезанного ответа.
Примеры использования см. в разделе «Постраничная передача» в руководстве пользователя AWS Command Line Interface.
--page-size (целое число)
Размер каждой страницы, которую нужно получить в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, возвращающему меньше элементов в каждом вызове. Это может помочь предотвратить таймауты вызовов AWS-сервиса.
Примеры использования см. в разделе «Постраничная передача» в руководстве пользователя 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-auto-prompt (булево)
Автоматически запрашивать параметры входных данных CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запросы параметров входных данных CLI.
Примеры
Примечание
Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы с AWS CLI.
Если не указано иное, все примеры используют правила кавычек, характерные для Unix. Эти примеры потребуется адаптировать к правилам кавычек вашего терминала. Подробности см. в разделе «Использование кавычек со строками» в руководстве пользователя AWS CLI.
Для просмотра схемы инвентаризации
Этот пример возвращает список имён типов инвентаризации для учётной записи.
Команда:
aws ssm get-inventory-schema
Вывод:
{
"Schemas": [
{
"TypeName": "AWS:AWSComponent",
"Version": "1.0",
"Attributes": [
{
"Name": "Name",
"DataType": "STRING"
},
{
"Name": "ApplicationType",
"DataType": "STRING"
},
{
"Name": "Publisher",
"DataType": "STRING"
},
{
"Name": "Version",
"DataType": "STRING"
},
{
"Name": "InstalledTime",
"DataType": "STRING"
},
{
"Name": "Architecture",
"DataType": "STRING"
},
{
"Name": "URL",
"DataType": "STRING"
}
]
},
...
],
"NextToken": "--token string truncated--"
}
Для просмотра схемы инвентаризации для определённого типа инвентаризации
Этот пример возвращает схему инвентаризации для типа инвентаризации AWS:AWSComponent.
Команда:
aws ssm get-inventory-schema --type-name "AWS:AWSComponent"
Вывод
Схемы -> (список)
Схемы инвентаризации, возвращённые запросом.
(структура)
Определение схемы элемента инвентаризации. Пользователи могут использовать его для составления фильтров запросов инвентаризации.
TypeName -> (строка)
AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network и AWS:WindowsUpdate.Версия -> (строка)
Атрибуты -> (список)
Атрибуты схемы инвентаризации. Это содержит тип данных и имя атрибута.
(структура)
Атрибуты — это записи в содержимом элемента инвентаризации. Он содержит имя и значение.
Имя -> (строка)
Тип данных -> (строка)
Имя для отображения -> (строка)
NextToken -> (строка)