Spec-Zone.ru › AWS CLI v2

[ aws . resource-explorer-2 ]

get-index

Описание

Получает сведения об индексе Amazon Web Services Resource Explorer в регионе Amazon Web Services, в котором вы вызвали операцию.

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

Синтаксис

  get-index
[--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.

Пример 1: Получение сведений об агрегаторе индекса Resource Explorer

Следующий get-index пример отображает сведения об индексе Resource Explorer в указанном регионе AWS. Поскольку указанный регион содержит индекс агрегатора для учетной записи, вывод отображает регионы, которые дублируют данные в индекс этого региона.

aws resource-explorer-2 get-index \
    --region us-east-1

Вывод:

{
    "Arn": "arn:aws:resource-explorer-2:us-east-1:123456789012:index/EXAMPLE8-90ab-cdef-fedc-EXAMPLE11111",
    "CreatedAt": "2022-07-12T18:59:10.503000+00:00",
    "LastUpdatedAt": "2022-07-13T18:41:58.799000+00:00",
    "ReplicatingFrom": [
        "ap-south-1",
        "us-west-2"
    ],
    "State": "ACTIVE",
    "Tags": {},
    "Type": "AGGREGATOR"
}

Пример 2: Получение сведений о локальном индексе Resource Explorer

Следующий get-index пример отображает сведения об индексе Resource Explorer в указанном регионе AWS. Поскольку указанный регион содержит локальный индекс, вывод отображает регион, в который он дублирует данные из индекса этого региона.

aws resource-explorer-2 get-index \
    --region us-west-2

Вывод:

{
    "Arn": "arn:aws:resource-explorer-2:us-west-2:123456789012:index/EXAMPLE8-90ab-cdef-fedc-EXAMPLE22222",
    "CreatedAt": "2022-07-12T18:59:10.503000+00:00",
    "LastUpdatedAt": "2022-07-13T18:41:58.799000+00:00",
    "ReplicatingTo": [
        "us-west-2"
    ],
    "State": "ACTIVE",
    "Tags": {},
    "Type": "LOCAL"
}

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

Вывод

Arn -> (строка)

Amazon Resource Name (ARN) индекса.

CreatedAt -> (метка времени)

Дата и время первоначального создания индекса.

LastUpdatedAt -> (метка времени)

Дата и время последнего обновления индекса.

ReplicatingFrom -> (список)

Это значение ответа присутствует только если этот индекс Type=AGGREGATOR.

Список Amazon Web Services регионов, которые дублируют свое содержимое в индекс в этом регионе.

(строка)

ReplicatingTo -> (список)

Это значение ответа присутствует только если этот индекс Type=LOCAL.

Регион Amazon Web Services, содержащий агрегатор индекса, если он существует. Если агрегатор индекса существует, то регион, в котором вы вызвали эту операцию, дублирует информацию об индексе в регион, указанный в этом значении ответа.

(строка)

State -> (строка)

Текущее состояние индекса в этом Amazon Web Services регионе.

Tags -> (карта)

Пары ключ-значение тегов, прикрепленные к индексу.

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

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

Type -> (строка)

Тип индекса в этом регионе. Для получения информации об индексе агрегатора и различиях с локальным индексом см. Включение межрегионального поиска путем создания агрегаторного индекса.

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

Spec-Zone.ru

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