Spec-Zone.ru › AWS CLI v2

[ aws . ssm ]

get-inventory

Описание

Запрос информации об инвентаризации. Включает состояние управляемых узлов, например, Stopped или Terminated .

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

get-inventory — это постраничная операция. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную обработку, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничный запрос, аргумент --query должен извлекать данные из результатов следующих выражений запроса: Entities

Синтаксис

  get-inventory
[--filters <value>]
[--aggregators <value>]
[--result-attributes <value>]
[--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]

Параметры

--filters (список)

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

(структура)

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

Ключ -> (строка)

Имя ключа фильтра.

Значения -> (список)

Значения фильтра инвентаризации. Пример: фильтр инвентаризации, где идентификаторы управляемых узлов указаны в качестве значений Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal .

(строка)

Тип -> (строка)

Тип фильтра.

Примечание

Фильтр Exists должен использоваться с агрегаторами. Дополнительную информацию см. в разделе Агрегирование данных инвентаризации в Руководстве пользователя Amazon Web Services Systems Manager.

Сокращенная запись:

Key=string,Values=string,string,Type=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Values": ["string", ...],
    "Type": "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"|"Exists"
  }
  ...
]

--aggregators (список)

Возвращает количество типов инвентаризации, основанное на одном или нескольких выражениях. Например, если вы агрегируете, используя выражение, использующее тип AWS:InstanceInformation.PlatformType, вы можете увидеть количество управляемых узлов Windows и Linux в вашем инвентаризированном парке.

(структура)

Указывает тип инвентаризации и атрибут для выполнения агрегации.

Выражение -> (строка)

Тип инвентаризации и имя атрибута для агрегации.

Агрегаторы -> (список)

Вложенные агрегаторы для дальнейшей детализации агрегации для типа инвентаризации.

(структура)

Указывает тип инвентаризации и атрибут для выполнения агрегации.

Выражение -> (строка)

Тип инвентаризации и имя атрибута для агрегации.

Группы -> (список)

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

(структура)

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

Имя -> (строка)

Имя группы.

Фильтры -> (список)

Фильтры определяют критерии для группы. Поле matchingCount отображает количество ресурсов, соответствующих критериям. Поле notMatchingCount отображает количество ресурсов, не соответствующих критериям.

(структура)

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

Ключ -> (строка)

Имя ключа фильтра.

Значения -> (список)

Значения фильтра инвентаризации. Пример: фильтр инвентаризации, где идентификаторы управляемых узлов указаны в качестве значений Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal .

(строка)

Тип -> (строка)

Тип фильтра.

Примечание

Фильтр Exists должен использоваться с агрегаторами. Дополнительную информацию см. в разделе Агрегирование данных инвентаризации в Руководстве пользователя Amazon Web Services Systems Manager.

Группы -> (список)

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

(структура)

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

Имя -> (строка)

Имя группы.

Фильтры -> (список)

Фильтры определяют критерии для группы. Поле matchingCount отображает количество ресурсов, соответствующих критериям. Поле notMatchingCount отображает количество ресурсов, не соответствующих критериям.

(структура)

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

Ключ -> (строка)

Имя ключа фильтра.

Значения -> (список)

Значения фильтра инвентаризации. Пример: фильтр инвентаризации, где идентификаторы управляемых узлов указаны в качестве значений Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal .

(строка)

Тип -> (строка)

Тип фильтра.

Примечание

Фильтр Exists должен использоваться с агрегаторами. Дополнительную информацию см. в разделе Агрегирование данных инвентаризации в Руководстве пользователя Amazon Web Services Systems Manager.

Синтаксис JSON:

[
  {
    "Expression": "string",
    "Aggregators": [
      {
        "Expression": "string",
        "Aggregators": ,
        "Groups": [
          {
            "Name": "string",
            "Filters": [
              {
                "Key": "string",
                "Values": ["string", ...],
                "Type": "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"|"Exists"
              }
              ...
            ]
          }
          ...
        ]
      }
      ...
    ],
    "Groups": [
      {
        "Name": "string",
        "Filters": [
          {
            "Key": "string",
            "Values": ["string", ...],
            "Type": "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"|"Exists"
          }
          ...
        ]
      }
      ...
    ]
  }
  ...
]

--result-attributes (список)

Список типов элементов инвентаризации, которые нужно вернуть.

(структура)

Атрибут результата элемента инвентаризации.

TypeName -> (строка)

Имя типа элемента инвентаризации. Допустимое значение: AWS:InstanceInformation. Значение по умолчанию: AWS:InstanceInformation.

Сокращенная запись:

TypeName=string ...

Синтаксис JSON:

[
  {
    "TypeName": "string"
  }
  ...
]

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

Примеры

Примечание

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

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

Просмотр вашего инвентаризационного списка

В этом примере извлекается пользовательские метаданные для вашего инвентарного списка.

Команда:

aws ssm get-inventory

Вывод:

{
  "Entities": [
      {
          "Data": {
              "AWS:InstanceInformation": {
                  "Content": [
                      {
                          "ComputerName": "ip-172-31-44-222.us-west-2.compute.internal",
                          "InstanceId": "i-0cb2b964d3e14fd9f",
                          "IpAddress": "172.31.44.222",
                          "AgentType": "amazon-ssm-agent",
                          "ResourceType": "EC2Instance",
                          "AgentVersion": "2.0.672.0",
                          "PlatformVersion": "2016.09",
                          "PlatformName": "Amazon Linux AMI",
                          "PlatformType": "Linux"
                      }
                  ],
                  "TypeName": "AWS:InstanceInformation",
                  "SchemaVersion": "1.0",
                  "CaptureTime": "2017-02-20T18:03:58Z"
              }
          },
          "Id": "i-0cb2b964d3e14fd9f"
      }
  ]
}

Вывод

Сущности -> (список)

Коллекция сущностей инвентаризации, например, коллекция инвентаризации управляемых узлов.

(структура)

Результаты запроса инвентаризации.

Id -> (строка)

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

Данные -> (словарь)

Раздел данных в JSON-результате сущности инвентаризации.

ключ -> (строка)

значение -> (структура)

Элемент результата инвентаризации.

Тип -> (строка)

Название типа элемента результата инвентаризации.

Версия схемы -> (строка)

Версия схемы для элемента результата инвентаризации.

Время захвата -> (строка)

Время захвата данных элемента инвентаризации.

Хэш содержимого -> (строка)

MD5-хэш содержимого типа элемента инвентаризации. Хэш содержимого используется для определения необходимости обновления информации инвентаризации. API PutInventory не обновляет содержимое типа элемента инвентаризации, если хэш MD5 не изменился с момента последнего обновления.

Содержимое -> (список)

Содержит все данные инвентаризации типа элемента. Результаты включают имена и значения атрибутов.

(словарь)

ключ -> (строка)

значение -> (строка)

Маркер следующей страницы -> (строка)

Маркер, используемый при запросе следующего набора элементов. Если дополнительных элементов нет, строка пустая.

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

Spec-Zone.ru

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