Spec-Zone.ru › AWS CLI v2

[ aws . location ]

Поиск по индексу мест

Описание

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

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

Примечание

Вы можете искать места вблизи заданной позиции, используя BiasPosition, или фильтровать результаты в пределах прямоугольника, используя FilterBBox. Одновременное предоставление обоих параметров приводит к ошибке.

Результаты поиска возвращаются в порядке убывания релевантности.

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

Синтаксис

  search-place-index-for-text
--index-name <value>
--text <value>
[--bias-position <value>]
[--filter-b-box <value>]
[--filter-countries <value>]
[--max-results <value>]
[--language <value>]
[--filter-categories <value>]
[--key <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]

Параметры

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

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

--text (строка)

Адрес, название, город или регион, которые необходимо использовать в поиске в формате свободного текста. Например, 123 Any Street.

--bias-position (список)

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

При предоставлении этого параметра он должен содержать пару чисел. Первое число представляет собой координату X или долготу; второе число представляет собой координату Y или широту.

Например, [-123.1174, 49.2847] представляет позицию с долготой -123.1174 и широтой 49.2847.

Примечание

BiasPosition и FilterBBox являются взаимоисключающими. Указание обоих параметров приводит к ошибке.

(двойное значение)

Синтаксис:

double double ...

--filter-b-box (список)

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

При предоставлении этого параметра он должен содержать четыре последовательных числа в двух парах. Первая пара чисел представляет собой координаты X и Y (долготу и широту соответственно) юго-западного угла прямоугольника; вторая пара чисел представляет собой координаты X и Y (долготу и широту соответственно) северо-восточного угла прямоугольника.

Например, [-12.7935, -37.4835, -12.0684, -36.9542] представляет прямоугольник, где юго-западный угол имеет долготу -12.7935 и широту -37.4835, а северо-восточный угол имеет долготу -12.0684 и широту -36.9542.

Примечание

FilterBBox и BiasPosition являются взаимоисключающими. Указание обоих параметров приводит к ошибке.

(двойное значение)

Синтаксис:

double double ...

--filter-countries (список)

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

  • Допустимые значения включают трехзначные коды стран ISO 3166. Например, Австралия использует три заглавные буквы: AUS.

(строка)

Синтаксис:

"string" "string" ...

--max-results (целое число)

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

По умолчанию: 50

--language (строка)

Предпочитаемый язык для возврата результатов. Значение должно быть допустимым тегом языка BCP 47, например, en для английского.

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

Например, используем греческий язык. Вы ищете Athens, Greece с параметром language, установленным на en. Найденный результат, скорее всего, будет возвращен как Athens.

Если вы установите параметр language на значение el для греческого, то найденный результат будет более вероятно возвращен как Αθήνα.

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

--filter-categories (список)

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

Для получения дополнительной информации об использовании категорий, включая список категорий Amazon Location, см. категории и фильтрацию в руководстве разработчика Amazon Location Service.

(строка)

Синтаксис:

"string" "string" ...

--key (строка)

Необязательный ключ API для авторизации запроса.

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

Вывод

Резюме -> (структура)

Содержит резюме запроса. Выводит входные значения для BiasPosition , FilterBBox , FilterCountries , Language , MaxResults и Text . Также включает индекс местоположения и ограничивающую рамку, ResultBBox , которые окружают результаты поиска.

Текст -> (строка)

Текст поиска, указанный в запросе.

СмещениеПозиции -> (список)

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

Этот параметр содержит пару чисел. Первое число представляет собой координату X или долготу; второе число представляет собой координату Y или широту.

Например, [-123.1174, 49.2847] представляет позицию с долготой -123.1174 и широтой 49.2847 .

(двойное)

ФильтроватьОграничительнуюРамку -> (список)

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

(двойное)

ФильтроватьСтраны -> (список)

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

(строка)

МаксимальноеКоличествоРезультатов -> (целое)

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

РезультатыОграничительнуюРамку -> (список)

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

Примечание

Если в запросе указан необязательный параметр FilterBBox , ResultBBox содержится в FilterBBox .

(двойное)

ИсточникДанных -> (строка)

Провайдер геопространственных данных, связанный с ресурсом индекса мест, указанным в запросе. Значения могут быть следующими:

  • Esri
  • Grab
  • Here

Дополнительную информацию о поставщиках данных см. в разделе поставщики данных Amazon Location Service .

Язык -> (строка)

Предпочитаемый язык для возврата результатов. Соответствует языку в запросе. Значение является допустимым тегом языка BCP 47, например, en для английского языка.

ФильтроватьКатегории -> (список)

Необязательный фильтр категорий, указанный в запросе.

(строка)

Результаты -> (список)

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

Не все свойства ответа включены во все ответы. Некоторые свойства могут возвращаться только определенными поставщиками данных.

(структура)

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

Место -> (структура)

Подробности о результате поиска, такие как адрес и позиция.

Метка -> (строка)

Полное имя и адрес точки интереса, например город, регион или страна. Например, 123 Any Street, Any Town, USA .

Геометрия -> (структура)

Places использует геометрию точки для указания местоположения или места.

Точка -> (список)

Одиночная геометрия точки указывает местоположение места с использованием координат WGS 84:

  • x — Указывает координату x или долготу.
  • y — Указывает координату y или широту.

(двойное)

НомерАдреса -> (строка)

Цифровая часть адреса, например номер дома.

Улица -> (строка)

Название улицы или дороги для идентификации местоположения. Например, Main Street .

Район -> (строка)

Название района. Например, Downtown .

Муниципалитет -> (строка)

Название местного района, например города или поселка. Например, Toronto .

ПодРегион -> (строка)

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

Регион -> (строка)

Название области или географического района, например название провинции или штата. Например, British Columbia .

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

Страна/регион, указанный с использованием трехзначного кода страны/региона ISO 3166. Например, CAN .

ПочтовыйИндекс -> (строка)

Группа цифр и букв в формате, специфичном для страны, которая сопровождает адрес для идентификации местоположения.

Интерполировано -> (логическое)

True , если результат интерполирован из других известных мест.

False , если место является известным местом.

Не возвращается, если партнер не предоставляет информацию.

Например, возвращает False для адресного местоположения, найденного в данных партнера, но возвращает True , если адрес отсутствует в данных партнера, а его местоположение вычисляется путем интерполяции между другими известными адресами.

ЧасовойПояс -> (структура)

Часовой пояс, в котором находится Place . Возвращается только при использовании HERE или Grab в качестве выбранного партнера.

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

Название часового пояса в соответствии со стандартом часового пояса IANA. Например, America/Los_Angeles .

Смещение -> (целое число)

Смещение часового пояса в секундах от UTC.

ТипЕдиницы -> (строка)

Для адресов с UnitNumber , тип единицы. Например, Apartment .

Примечание

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

НомерЕдиницы -> (строка)

Для адресов с несколькими единицами, идентификатор единицы. Может содержать цифры и буквы, например 3B или Unit 123 .

Примечание

Возвращается только для индекса места, использующего Esri или Grab в качестве поставщика данных. Не возвращается для SearchPlaceIndexForPosition .

Категории -> (список)

Категории Amazon Location, описывающие это место.

Дополнительную информацию об использовании категорий, включая список категорий Amazon Location, см. в разделе Категории и фильтрация в руководстве по разработке Amazon Location Service .

(строка)

ДополнительныеКатегории -> (список)

Категории от поставщика данных, описывающие место, которые не сопоставлены ни с одной категорией Amazon Location.

(строка)

ПодМуниципалитет -> (строка)

Область, которая является частью более крупного муниципалитета. Например, Blissville — это подмуниципалитет в округе Квин в Нью-Йорке.

Примечание

Это свойство поддерживается Esri и OpenData. Свойство Esri — district , а свойство OpenData — borough .

Расстояние -> (двойное)

Расстояние в метрах дуги большого круга между указанной позицией смещения и результатом. Distance будет возвращено только в том случае, если в запросе была указана позиция смещения.

Примечание

Дуга большого круга — это кратчайший путь по сфере, в данном случае Земля. Это возвращает кратчайшее расстояние между двумя точками.

Релевантность -> (двойное)

Относительная уверенность в совпадении результата среди возвращенных результатов. Например, если совпадают больше полей адреса (включая номер дома, улицу, город, страну/регион и почтовый индекс), релевантность ближе к 1.

Возвращается только тогда, когда выбранный партнер — Esri или Grab.

ИдентификаторМеста -> (строка)

Уникальный идентификатор места. Его можно использовать с операцией GetPlace , чтобы найти место позже.

Примечание

Для операций SearchPlaceIndexForText идентификатор PlaceId возвращается только индексами мест, которые используют HERE или Grab в качестве поставщика данных.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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