получение-конфигурации-индексации
Описание
Получает конфигурацию индексации.
Требуется разрешение на доступ к действию GetIndexingConfiguration.
См. также: Документация API AWS
Синтаксис
get-indexing-configuration
[--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]
Параметры
--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 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.
Получение конфигурации индексации вещей
Следующий get-indexing-configuration пример получает текущие данные конфигурации для индексации флота AWS IoT.
aws iot get-indexing-configuration
Вывод:
{
"thingIndexingConfiguration": {
"thingIndexingMode": "OFF",
"thingConnectivityIndexingMode": "OFF"
},
"thingGroupIndexingConfiguration": {
"thingGroupIndexingMode": "OFF"
}
}
Для получения дополнительной информации см. Управление индексацией вещей в руководстве разработчика AWS IoT.
Вывод
thingIndexingConfiguration -> (структура)
Конфигурация индексации вещей.
thingIndexingMode -> (строка)
Режим индексации вещей. Допустимые значения:
- REGISTRY — Ваш индекс вещей содержит только данные реестра.
- REGISTRY_AND_SHADOW — Ваш индекс вещей содержит данные реестра и тени.
- ВЫКЛ — Индексация вещей отключена.
thingConnectivityIndexingMode -> (строка)
Режим индексации подключения к вещам. Допустимые значения:
- STATUS — Ваш индекс вещей содержит статус подключения. Чтобы включить индексацию подключения к вещам, thingIndexMode не должен быть установлен на ВЫКЛ.
- ВЫКЛ — Индексация статуса подключения к вещам отключена.
deviceDefenderIndexingMode -> (строка)
Режим индексации Device Defender. Допустимые значения:
- VIOLATIONS — Ваш индекс вещей содержит нарушения Device Defender. Чтобы включить индексацию Device Defender, deviceDefenderIndexingMode не должен быть установлен на ВЫКЛ.
- ВЫКЛ — Индексация Device Defender отключена.
Для получения дополнительной информации о нарушениях Device Defender см. Device Defender Detect.
namedShadowIndexingMode -> (строка)
Режим индексации теней с именами. Допустимые значения:
- ВКЛ — Ваш индекс вещей содержит тени с именами. Чтобы включить индексацию теней с именами, namedShadowIndexingMode не должен быть установлен на ВЫКЛ.
- ВЫКЛ — Индексация теней с именами отключена.
Для получения дополнительной информации о тенях см. сервис теней IoT Device Shadow.
managedFields -> (список)
Содержит поля, которые индексируются и типы которых уже известны службе индексации флота. Это необязательное поле. Для получения дополнительной информации см. Управляемые поля в руководстве разработчика Amazon Web Services IoT Core.
Примечание
Вы не можете изменить управляемые поля, обновив конфигурацию индексации флота.(структура)
Описание имени и типа данных поля.
name -> (строка)
type -> (строка)
customFields -> (список)
Содержит имена пользовательских полей и их тип данных.
(структура)
Описание имени и типа данных поля.
name -> (строка)
type -> (строка)
filter -> (структура)
Предоставляет дополнительные варианты выбора для теней с именами и данных геолокации.
Чтобы добавить тени с именами в конфигурацию индексации флота, установите namedShadowIndexingMode в ВКЛ и укажите имена теней в фильтре namedShadowNames.
Чтобы добавить данные геолокации в конфигурацию индексации флота:
- Если вы храните данные геолокации в классе/не имеющей имени тени, установите
thingIndexingModeвREGISTRY_AND_SHADOWи укажите данные геолокации в фильтреgeoLocations. - Если вы храните данные геолокации в тени с именем, установите
namedShadowIndexingModeвON, добавьте имя тени в фильтрnamedShadowNamesи укажите данные геолокации в фильтреgeoLocations. Для получения дополнительной информации см. Управление индексацией флота.
namedShadowNames -> (список)
Имена теней, которые вы выбираете для индексации. Максимальное количество имен теней для индексации по умолчанию составляет 10. Чтобы увеличить лимит, см. квоты Amazon Web Services IoT Device Management в справке Amazon Web Services General.
(строка)
geoLocations -> (список)
Список геолокационных целей, которые вы выбираете для индексации. Максимальное количество геолокационных целей для индексации по умолчанию составляет 1. Чтобы увеличить лимит, см. квоты Amazon Web Services IoT Device Management в справке Amazon Web Services General.
(структура)
Геолокационная цель, которую вы выбираете для индексации. Каждая геолокационная цель содержит пару name и order, которая определяет поля геолокационной цели.
name -> (строка)
namedShadow.order -> (строка)
LatLon.thingGroupIndexingConfiguration -> (структура)
Конфигурация индекса.
thingGroupIndexingMode -> (строка)
managedFields -> (список)
Содержит поля, которые индексируются и типы которых уже известны службе индексации флота. Это необязательное поле. Для получения дополнительной информации см. Управляемые поля в руководстве разработчика Amazon Web Services IoT Core.
Примечание
Вы не можете изменить управляемые поля, обновив конфигурацию индексации флота.(структура)
Описание имени и типа данных поля.
name -> (строка)
type -> (строка)
customFields -> (список)
Список полей групп вещей для индексации. Этот список не может содержать управляемых полей. Используйте API GetIndexingConfiguration, чтобы получить список управляемых полей.
Содержит имена пользовательских полей и их тип данных.
(структура)
Описание имени и типа данных поля.
name -> (строка)
type -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.