Spec-Zone.ru › AWS CLI v2

[ aws . cloudsearch ]

Удалить поле индекса

Описание

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

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

Синтаксис

  delete-index-field
--domain-name <value>
--index-field-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]

Параметры

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

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

--index-field-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
  • таблица
  • 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 -> (структура)

Статус удаления поля индекса.

Параметры -> (структура)

Конфигурационная информация для поля в индексе, включая его имя, тип и параметры. Поддерживаемые параметры зависят от `` 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 -> (строка)

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

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

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

FacetEnabled -> (булево)

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

SearchEnabled -> (булево)

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

ReturnEnabled -> (булево)

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

SortEnabled -> (булево)

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

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

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

DefaultValue -> (строка)

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

SourceField -> (строка)

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

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

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

ReturnEnabled -> (булево)

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

SortEnabled -> (булево)

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

HighlightEnabled -> (булево)

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

AnalysisScheme -> (строка)

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

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

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

DefaultValue -> (строка)

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

SourceField -> (строка)

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

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

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

FacetEnabled -> (булево)

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

SearchEnabled -> (булево)

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

ReturnEnabled -> (булево)

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

SortEnabled -> (булево)

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

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

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

DefaultValue -> (строка)

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

SourceField -> (строка)

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

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

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

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)

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

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

Spec-Zone.ru

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