Spec-Zone.ru › AWS CLI v2

[ aws . resource-explorer-2 ]

создать-индекс

Описание

Включает Amazon Web Services Resource Explorer в регионе Amazon Web Services, в котором вы вызвали эту операцию, создавая индекс. Resource Explorer начинает обнаруживать ресурсы в этом регионе и хранит подробности о ресурсах в индексе, чтобы их можно было запросить с помощью операции Search. Вы можете создать только один индекс в одном регионе.

Примечание

Эта операция создаёт только локальный индекс. Чтобы преобразовать локальный индекс в одном регионе Amazon Web Services в индекс агрегатора для учётной записи Amazon Web Services, используйте операцию UpdateIndexType. Дополнительную информацию см. в разделе «Включение поиска по областям, создав индекс агрегатора» в руководстве пользователя Amazon Web Services Resource Explorer.

Дополнительную информацию о том, что происходит при включении Resource Explorer в регионе Amazon Web Services, см. в разделе «Включение Resource Explorer для индексации ваших ресурсов в регионе Amazon Web Services» в руководстве пользователя Amazon Web Services Resource Explorer.

Если это первый регион Amazon Web Services, в котором вы создали индекс для Resource Explorer, эта операция также создаёт связанную с сервисом роль в вашей учётной записи Amazon Web Services, которая позволяет Resource Explorer перечислять ваши ресурсы для заполнения индекса.

  • Действие : resource-explorer-2:CreateIndex Ресурс : ARN индекса (в том виде, как он будет существовать после завершения операции) в регионе и учётной записи Amazon Web Services, в которой вы пытаетесь создать индекс. Используйте символ подстановки (* ) в конце строки, чтобы соответствовать будущему UUID. Например, следующий Resource элемент ограничивает роль или пользователя созданием индекса только в регионе us-east-2 указанной учётной записи. "Resource": "arn:aws:resource-explorer-2:us-west-2:*<account-id>* :index/*" В качестве альтернативы вы можете использовать "Resource": "*", чтобы разрешить роли или пользователю создавать индекс в любом регионе.
  • Действие : iam:CreateServiceLinkedRole Ресурс : Нет конкретного ресурса (*). Это разрешение требуется только при первом создании индекса для включения Resource Explorer в учётной записи. Resource Explorer использует это для создания роли, связанной с сервисом, необходимой для индексации ресурсов в вашей учётной записи. Resource Explorer использует одну и ту же связанную с сервисом роль для всех дополнительных индексов, которые вы создаёте впоследствии.

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

Синтаксис

  create-index
[--client-token <value>]
[--tags <value>]
[--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]

Параметры

--client-token (строка)

Это значение помогает обеспечить идемпотентность. Resource Explorer использует это значение для предотвращения случайного создания дублирующих версий. Рекомендуется генерировать значение типа UUID, чтобы обеспечить уникальность вашего индекса.

--tags (массив)

Указанные теги прикрепляются только к индексу, созданному в этом регионе Amazon Web Services. Эти теги не прикрепляются ни к одному из ресурсов, перечисленных в индексе.

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

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

Краткая запись:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--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 в руководстве пользователя AWS CLI.

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

Чтобы включить Resource Explorer в регионе AWS, создав индекс

Следующий create-index пример создаёт локальный индекс в регионе AWS, в котором вызывается операция. AWS CLI автоматически генерирует случайное client-token значение параметра и включает его в вызов AWS, если вы не указали значение.

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

Вывод:

{
    "Arn": "arn:aws:resource-explorer-2:us-east-1:123456789012:index/EXAMPLE8-90ab-cdef-fedc-EXAMPLE22222c",
    "CreatedAt": "2022-11-01T20:00:59.149Z",
    "State": "CREATING"
}

После создания локального индекса вы можете преобразовать его в индекс агрегатора для учётной записи, выполнив команду update-index-type.

Дополнительную информацию см. в разделе «Включение Resource Explorer в регионе AWS для индексации ресурсов» в руководстве пользователя AWS Resource Explorer.

Вывод

Arn -> (строка)

ARN нового локального индекса для региона. Вы можете использовать этот ARN в политиках IAM для авторизации следующих операций: DeleteIndex | GetIndex | UpdateIndexType | CreateView

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

Дата и время создания индекса.

Состояние -> (строка)

Указывает текущее состояние индекса. Вы можете отслеживать изменения состояния для асинхронных операций, вызывая операцию GetIndex.

Примечание

Состояние может оставаться в состоянии CREATING или UPDATING несколько часов, пока Resource Explorer не обнаружит информацию о ваших ресурсах и не заполнит индекс.

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

Spec-Zone.ru

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