describe-index-fields

Описание

Получает информацию о полях индекса, настроенных для домена поиска. Можно ограничить получение информации конкретными полями по имени. По умолчанию отображаются все поля и включаются любые ожидающие изменения в конфигурации. Установите опцию Deployed в значение true, чтобы отобразить активную конфигурацию и исключить ожидающие изменения. Для получения дополнительной информации см. Получение информации о домене в руководстве разработчика Amazon CloudSearch.

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

Синтаксис

  describe-index-fields
--domain-name <value>
[--field-names <value>]
[--deployed | --no-deployed]
[--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 (строка)

Имя домена, который нужно описать.

--field-names (список)

Список полей индекса, которые нужно описать. Если не указано, информация возвращается для всех настроенных полей индекса.

(строка)

Синтаксис:

"string" "string" ...

--deployed | --no-deployed (логическое значение)

Отображать ли развернутую конфигурацию (true) или включать ожидающие изменения (false). По умолчанию значение false.

--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
таблица
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.

Вывод

IndexFields -> (список)

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

(структура)

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

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

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

IndexFieldName -> (строка)

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

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

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

IndexFieldType -> (строка)

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

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

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

DefaultValue -> (длинное целое число)

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

SourceField -> (строка)

Имя исходного поля для сопоставления с полем.

FacetEnabled -> (булево)

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

SearchEnabled -> (булево)

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

ReturnEnabled -> (булево)

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

SortEnabled -> (булево)

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

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

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

DefaultValue -> (двойное)

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 -> (длинное целое число)

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

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)

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

END_OF_DOCUMENT_MARKER