[ aws . resource-explorer-2 ]
list-indexes
Описание
Возвращает список всех индексов в регионах Amazon Web Services, которые в настоящее время собирают информацию о ресурсах для Amazon Web Services Resource Explorer.
См. также: Документацию API AWS
list-indexes — это постраничная операция. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в постраничном ответе аргумент --query должен извлекать данные из результатов следующих выражений запроса: Indexes
Синтаксис
list-indexes
[--regions <value>]
[--type <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]
Параметры
--regions (список)
Если указано, ограничивает ответ только информацией об индексе в указанном списке регионов Amazon Web Services.
(строка)
Синтаксис:
"string" "string" ...
--type (строка)
Если указано, ограничивает вывод только индексами указанного типа, либо LOCAL, либо AGGREGATOR.
Используйте этот параметр, чтобы найти агрегаторский индекс для вашей учетной записи.
Возможные значения:
LOCALAGGREGATOR
--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, где Resource Explorer имеет индексы
Следующий пример list-indexes отображает индексы для всех регионов, где Resource Explorer имеет индекс. Ответ указывает тип каждого индекса, его регион AWS и его ARN.
aws resource-explorer-2 list-indexes
Вывод:
{
"Indexes": [
{
"Arn": "arn:aws:resource-explorer-2:us-west-2:123456789012:index/EXAMPLE8-90ab-cdef-fedc-EXAMPLE11111",
"Region": "us-west-2",
"Type": "AGGREGATOR"
},
{
"Arn": "arn:aws:resource-explorer-2:us-east-1:123456789012:index/EXAMPLE8-90ab-cdef-fedc-EXAMPLE22222",
"Region": "us-east-1",
"Type": "LOCAL"
},
{
"Arn": "arn:aws:resource-explorer-2:us-east-2:123456789012:index/EXAMPLE8-90ab-cdef-fedc-EXAMPLE33333",
"Region": "us-east-2",
"Type": "LOCAL"
},
{
"Arn": "arn:aws:resource-explorer-2:us-west-1:123456789012:index/EXAMPLE8-90ab-cdef-fedc-EXAMPLE44444",
"Region": "us-west-1",
"Type": "LOCAL"
}
]
}
Для получения дополнительной информации об индексах см. раздел Проверка, в каких регионах AWS включен Resource Explorer в Руководстве пользователя AWS Resource Explorer.
Вывод
Индексы -> (список)
Структура, содержащая сведения и статус каждого индекса.
(структура)
Индекс — это хранилище данных, используемое Amazon Web Services Resource Explorer для хранения информации о ваших ресурсах Amazon Web Services, которые обнаруживаются службой. Создание индекса в регионе Amazon Web Services включает Resource Explorer и позволяет ему обнаруживать ваши ресурсы.
По умолчанию индекс является локальным, что означает, что он содержит информацию только о ресурсах в том же регионе, что и индекс. Однако вы можете повысить индекс одного региона в учетной записи, вызвав UpdateIndexType, чтобы преобразовать его в агрегаторский индекс. Агрегаторский индекс получает дублированную копию информации индекса из всех других регионов, где включен Resource Explorer. Это позволяет операциям поиска в этом регионе возвращать результаты из всех регионов в учетной записи, где Resource Explorer включен.
Arn -> (строка)
Регион -> (строка)
Тип -> (строка)
Тип индекса. Он может иметь одно из следующих значений:
-
LOCAL— Индекс содержит информацию о ресурсах только из того же региона Amazon Web Services. -
AGGREGATOR— Resource Explorer дублирует копии индексированной информации о ресурсах во всех других регионах Amazon Web Services в агрегаторский индекс. Это позволяет результатам поиска в регионе с агрегаторским индексом включать ресурсы из всех регионов в учетной записи, где Resource Explorer включен.
NextToken -> (строка)
NextToken в последующем вызове операции для получения следующей части вывода. Повторяйте это, пока элемент ответа NextToken не вернет null. Токены постраничного вывода истекают через 24 часа.
© Copyright 2025, Amazon Web Services. Created using Sphinx.