Spec-Zone.ru › AWS CLI v2

[ aws . location ]

получить-местоположение

Описание

Находит местоположение по его уникальному идентификатору. Другие операции поиска возвращают PlaceId.

Примечание

Идентификатор места (PlaceId) действителен только если все следующие параметры совпадают в исходном запросе поиска и в вызове GetPlace.

  • Учетная запись клиента Amazon Web Services
  • Регион Amazon Web Services
  • Поставщик данных, указанный в ресурсе индекса мест

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

Синтаксис

  get-place
--index-name <value>
--place-id <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 (строка)

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

--place-id (строка)

Идентификатор места, которое нужно найти.

--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
  • текст
  • таблица
  • 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.

Вывод

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

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

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

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

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

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

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

Одна геометрия точки указывает местоположение для места с координатами 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.

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

Spec-Zone.ru

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