Spec-Zone.ru › AWS CLI v2

[ aws . location ]

Индексация мест поиска по позиции

Описание

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

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

Синтаксис

  search-place-index-for-position
--index-name <value>
--position <value>
[--max-results <value>]
[--language <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 (строка)

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

--position (список)

Указывает долготу и широту позиции для запроса.

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

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

(двойное)

Синтаксис:

double double ...

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

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

Значение по умолчанию: 50

--language (строка)

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

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

Например, используем греческий язык. Вы ищете местоположение около Афин, Греция, с параметром language, установленным на en. Вероятнее всего, city в результатах будет возвращено как Athens.

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

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

--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
  • 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-auto-prompt (булево)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запроса параметров ввода CLI.

Вывод

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

Содержит сводку запроса. Выводит входные значения для Position , Language , MaxResults и DataSource индекса места.

Позиция -> (список)

Указанная в запросе позиция.

(двойное)

МаксРезультатов -> (целое)

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

Значение по умолчанию: 50

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

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

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

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

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

Примечание

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

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

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

Примечание

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

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

Spec-Zone.ru

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