Spec-Zone.ru › AWS CLI v2

[ aws . clouddirectory ]

create-index

Описание

Создаёт объект индекса. Дополнительную информацию см. в разделе Индексирование и поиск.

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

Синтаксис

  create-index
--directory-arn <value>
--ordered-indexed-attribute-list <value>
--is-unique | --no-is-unique
[--parent-reference <value>]
[--link-name <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]

Параметры

--directory-arn (строка)

ARN каталога, в котором должен быть создан индекс.

--ordered-indexed-attribute-list (список)

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

(структура)

Уникальный идентификатор атрибута.

SchemaArn -> (строка)

Amazon Resource Name (ARN) схемы, содержащей фасет и атрибут.

FacetName -> (строка)

Имя фасета, в котором существует атрибут.

Name -> (строка)

Имя атрибута.

Краткая форма синтаксиса:

SchemaArn=string,FacetName=string,Name=string ...

Синтаксис JSON:

[
  {
    "SchemaArn": "string",
    "FacetName": "string",
    "Name": "string"
  }
  ...
]

--is-unique | --no-is-unique (булево)

Указывает, имеет ли атрибут, который индексируется, уникальные значения или нет.

--parent-reference (структура)

Ссылка на родительский объект, содержащий объект индекса.

Selector -> (строка)

Селектор пути позволяет легко выбрать объект по ссылкам родитель/потомок, ведущим к нему от корня каталога. Используйте имена ссылок из каждой ссылки родитель/потомок для построения пути. Селекторы пути начинаются с косой черты (/) и имена ссылок разделены косыми чертами. Более подробную информацию о путях см. в разделе Доступ к объектам. Вы можете идентифицировать объект одним из следующих способов:

  • $ObjectIdentifier - Идентификатор объекта — это непрозрачная строка, предоставляемая Amazon Cloud Directory. При создании объектов система предоставит вам идентификатор созданного объекта. Идентификатор объекта неизменяем, и любые два объекта никогда не будут использовать один и тот же идентификатор объекта. Для идентификации объекта с ObjectIdentifier ObjectIdentifier должен быть заключен в двойные кавычки.
  • /some/path - Идентифицирует объект на основе пути
  • #SomeBatchReference - Идентифицирует объект в вызове пакетной обработки

Краткая форма синтаксиса:

Selector=string

Синтаксис JSON:

{
  "Selector": "string"
}

--link-name (строка)

Имя ссылки между родительским объектом и объектом индекса.

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла аутентификации.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию данного инструмента.

--color (строка)

Включить/выключить вывод цвета.

  • on
  • off
  • auto

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

Вывод

ObjectIdentifier -> (строка)

ObjectIdentifier созданного этим действием индекса.

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

Spec-Zone.ru

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