define-index-field

Описание

Настраивает `` IndexField`` для домена поиска. Используется для создания новых полей и изменения существующих. Вы должны указать имя домена, который вы настраиваете, и конфигурацию поля индекса. Конфигурация поля индекса определяет уникальное имя, тип поля индекса и параметры, которые вы хотите настроить для поля. Параметры, которые вы можете указать, зависят от `` IndexFieldType`` . Если поле существует, новая конфигурация заменит старую. Дополнительную информацию см. в руководстве разработчика Amazon CloudSearch.

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

Синтаксис

  define-index-field
--domain-name <value>
--name <value>
--type <value>
[--default-value <value>]
[--facet-enabled <value>]
[--search-enabled <value>]
[--return-enabled <value>]
[--sort-enabled <value>]
[--source-field <value>]
[--highlight-enabled <value>]
[--analysis-scheme <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]

Параметры

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

Строка, представляющая имя домена. Имена доменов уникальны для доменов, принадлежащих учетной записи в регионе AWS. Имена доменов начинаются с буквы или цифры и могут содержать следующие символы: a-z (строчные буквы), 0-9 и - (дефис).

--name (строка)

Строка, представляющая имя поля индекса. CloudSearch поддерживает обычные поля индекса, а также динамические поля. Имя динамического поля определяет шаблон, который начинается или заканчивается подстановкой. Любые поля документов, которые не соответствуют обычному полю индекса, но соответствуют шаблону динамического поля, настраиваются с параметрами индексирования динамического поля.

Имена обычных полей начинаются с буквы и могут содержать следующие символы: a-z (строчные буквы), 0-9 и _ (нижнее подчеркивание). Имена динамических полей должны начинаться или заканчиваться подстановкой (*). Подстановка также может быть единственным символом в имени динамического поля. Несколько подстановок и подстановки, вставленные в строку, не поддерживаются.

Имя score зарезервировано и не может использоваться в качестве имени поля. Для ссылки на ID документа можно использовать имя _id .

--type (строка)

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

--facet-enabled (булево)

Возвращать ли информацию о фацетах для поля.

--search-enabled (булево)

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

--return-enabled (булево)

Могут ли содержимое поля быть возвращены в результатах поиска.

--sort-enabled (булево)

Можно ли использовать поле для сортировки результатов поиска.

--source-field (строка)

Имя поля источника для сопоставления с полем.

--highlight-enabled (булево)

Можно ли возвращать выделения для поля.

--analysis-scheme (строка)

Имя схемы анализа для поля text.

--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-скелете.

--default-value (строка) Значение, используемое для поля, если поле не указано для документа. Это может быть важно, если вы используете поле в выражении, и это поле отсутствует в каждом документе.

Глобальные параметры

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

Вывод

IndexField -> (структура)

Значение IndexField и его текущий статус.

Options -> (структура)

Конфигурационная информация для поля в индексе, включая его имя, тип и параметры. Поддерживаемые параметры зависят от `` IndexFieldType``.

IndexFieldName -> (строка)

Строка, представляющая имя поля индекса. CloudSearch поддерживает обычные поля индекса, а также динамические поля. Имя динамического поля определяет шаблон, начинающийся или заканчивающийся подстановочным знаком. Любые поля документов, которые не соответствуют обычному полю индекса, но соответствуют шаблону динамического поля, настраиваются с помощью параметров индексирования динамического поля.

Имена обычных полей начинаются с буквы и могут содержать следующие символы: a-z (строчные), 0-9 и _ (подчеркивание). Имена динамических полей должны начинаться или заканчиваться подстановочным знаком (*). Подстановочный знак также может быть единственным символом в имени динамического поля. Несколько подстановочных знаков и подстановочные знаки, встроенные в строку, не поддерживаются.

Имя score зарезервировано и не может использоваться в качестве имени поля. Для ссылки на идентификатор документа можно использовать имя _id .

IndexFieldType -> (строка)

Тип поля. Допустимые варианты для поля зависят от типа поля. Дополнительную информацию о поддерживаемых типах полей см. в разделе «Настройка полей индекса» в руководстве разработчика Amazon CloudSearch.

IntOptions -> (структура)

Параметры для поля 64-битного целого числа со знаком. Присутствует, если IndexFieldType указывает, что поле имеет тип int . Все параметры включены по умолчанию.

DefaultValue -> (long)

Значение, используемое для поля, если оно не указано для документа. Это может быть важно, если вы используете поле в выражении, и это поле отсутствует во всех документах.

SourceField -> (строка)

Имя поля источника для сопоставления с полем.

FacetEnabled -> (булево)

Возвращать ли информацию о фацетах для поля.

SearchEnabled -> (булево)

Является ли содержимое поля поисковым.

ReturnEnabled -> (булево)

Можно ли возвращать содержимое поля в результатах поиска.

SortEnabled -> (булево)

Можно ли использовать поле для сортировки результатов поиска.

DoubleOptions -> (структура)

Параметры для поля с плавающей точкой двойной точности 64-бит. Присутствует, если IndexFieldType указывает, что поле имеет тип double . Все параметры включены по умолчанию.

DefaultValue -> (double)

SourceField -> (строка)

Имя поля источника для сопоставления с полем.

FacetEnabled -> (булево)

Возвращать ли информацию о фацетах для поля.

SearchEnabled -> (булево)

Является ли содержимое поля поисковым.

ReturnEnabled -> (булево)

Можно ли возвращать содержимое поля в результатах поиска.

SortEnabled -> (булево)

Можно ли использовать поле для сортировки результатов поиска.

LiteralOptions -> (структура)

Параметры для литерального поля. Присутствует, если IndexFieldType указывает, что поле имеет тип literal . Все параметры включены по умолчанию.

DefaultValue -> (строка)

Значение, используемое для поля, если оно не указано для документа.

SourceField -> (строка)

FacetEnabled -> (булево)

Возвращать ли информацию о фацетах для поля.

SearchEnabled -> (булево)

Является ли содержимое поля поисковым.

ReturnEnabled -> (булево)

Можно ли возвращать содержимое поля в результатах поиска.

SortEnabled -> (булево)

Можно ли использовать поле для сортировки результатов поиска.

TextOptions -> (структура)

Параметры для текстового поля. Присутствует, если IndexFieldType указывает, что поле имеет тип text . Поле text всегда поисковое. Все параметры включены по умолчанию.

DefaultValue -> (строка)

Значение, используемое для поля, если оно не указано для документа.

SourceField -> (строка)

ReturnEnabled -> (булево)

Можно ли возвращать содержимое поля в результатах поиска.

SortEnabled -> (булево)

Можно ли использовать поле для сортировки результатов поиска.

HighlightEnabled -> (булево)

Возвращать ли выделения для поля.

AnalysisScheme -> (строка)

Имя схемы анализа для поля text.

DateOptions -> (структура)

Параметры для поля даты. Даты и время указываются в UTC (Координированное универсальное время) в соответствии с IETF RFC3339: yyyy-mm-ddT00:00:00Z. Присутствует, если IndexFieldType указывает, что поле имеет тип date . Все параметры включены по умолчанию.

DefaultValue -> (строка)

Значение, используемое для поля, если оно не указано для документа.

SourceField -> (строка)

FacetEnabled -> (булево)

Возвращать ли информацию о фацетах для поля.

SearchEnabled -> (булево)

Является ли содержимое поля поисковым.

ReturnEnabled -> (булево)

Можно ли возвращать содержимое поля в результатах поиска.

SortEnabled -> (булево)

Можно ли использовать поле для сортировки результатов поиска.

LatLonOptions -> (структура)

Параметры для поля latlon. Поле latlon содержит расположение, хранящееся как пара значений широты и долготы. Присутствует, если IndexFieldType указывает, что поле имеет тип latlon . Все параметры включены по умолчанию.

DefaultValue -> (строка)

Значение, используемое для поля, если оно не указано для документа.

SourceField -> (строка)

FacetEnabled -> (булево)

Возвращать ли информацию о фацетах для поля.

SearchEnabled -> (булево)

Является ли содержимое поля поисковым.

ReturnEnabled -> (булево)

Можно ли возвращать содержимое поля в результатах поиска.

SortEnabled -> (булево)

Можно ли использовать поле для сортировки результатов поиска.

IntArrayOptions -> (структура)

Параметры для поля, содержащего массив 64-битных целых чисел со знаком. Присутствует, если IndexFieldType указывает, что поле имеет тип int-array . Все параметры включены по умолчанию.

DefaultValue -> (long)

Значение, используемое для поля, если оно не указано для документа.

SourceFields -> (строка)

Список полей источника для сопоставления с полем.

FacetEnabled -> (булево)

Возвращать ли информацию о фацетах для поля.

SearchEnabled -> (булево)

Является ли содержимое поля поисковым.

ReturnEnabled -> (булево)

Можно ли возвращать содержимое поля в результатах поиска.

DoubleArrayOptions -> (структура)

Параметры поля, содержащего массив значений с двойной точностью 64-битного с плавающей запятой. Присутствует, если IndexFieldType указывает, что поле имеет тип double-array . Все параметры включены по умолчанию.

DefaultValue -> (double)

Значение по умолчанию для поля, если поле не указано для документа.

SourceFields -> (string)

Список исходных полей, которые нужно сопоставить с полем.

FacetEnabled -> (boolean)

Возвращать ли информацию о фацетах для поля.

SearchEnabled -> (boolean)

Доступны ли для поиска содержимое поля.

ReturnEnabled -> (boolean)

Возвращать ли содержимое поля в результатах поиска.

LiteralArrayOptions -> (structure)

Параметры поля, содержащего массив литеральных строк. Присутствует, если IndexFieldType указывает, что поле имеет тип literal-array . Все параметры включены по умолчанию.

DefaultValue -> (string)

Значение по умолчанию для поля, если поле не указано для документа.

SourceFields -> (string)

Список исходных полей, которые нужно сопоставить с полем.

FacetEnabled -> (boolean)

Возвращать ли информацию о фацетах для поля.

SearchEnabled -> (boolean)

Доступны ли для поиска содержимое поля.

ReturnEnabled -> (boolean)

Возвращать ли содержимое поля в результатах поиска.

TextArrayOptions -> (structure)

Параметры поля, содержащего массив текстовых строк. Присутствует, если IndexFieldType указывает, что поле имеет тип text-array . Поле text-array всегда доступно для поиска. Все параметры включены по умолчанию.

DefaultValue -> (string)

Значение по умолчанию для поля, если поле не указано для документа.

SourceFields -> (string)

Список исходных полей, которые нужно сопоставить с полем.

ReturnEnabled -> (boolean)

Возвращать ли содержимое поля в результатах поиска.

HighlightEnabled -> (boolean)

Возвращать ли выделение для поля.

AnalysisScheme -> (string)

Имя схемы анализа для поля text-array.

DateArrayOptions -> (structure)

Параметры поля, содержащего массив дат. Присутствует, если IndexFieldType указывает, что поле имеет тип date-array . Все параметры включены по умолчанию.

DefaultValue -> (string)

Значение по умолчанию для поля, если поле не указано для документа.

SourceFields -> (string)

Список исходных полей, которые нужно сопоставить с полем.

FacetEnabled -> (boolean)

Возвращать ли информацию о фацетах для поля.

SearchEnabled -> (boolean)

Доступны ли для поиска содержимое поля.

ReturnEnabled -> (boolean)

Возвращать ли содержимое поля в результатах поиска.

Status -> (structure)

Статус параметра конфигурации домена.

CreationDate -> (timestamp)

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

UpdateDate -> (timestamp)

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

UpdateVersion -> (integer)

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

State -> (string)

Состояние обработки изменения параметра. Возможные значения:

RequiresIndexDocuments : последнее значение параметра не будет развернуто до тех пор, пока не будет вызван IndexDocuments и индексация не будет завершена.
Processing : последнее значение параметра находится в процессе активации.
Active : последнее значение параметра полностью развернуто.
FailedToValidate : значение параметра несовместимо с данными домена и не может быть использовано для индексации данных. Необходимо либо изменить значение параметра, либо обновить или удалить несовместимые документы.

PendingDeletion -> (boolean)

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