geocode
Описание
Действие Geocode позволяет получить координаты, адреса и другую информацию о местах.
См. также: Документацию API AWS
Синтаксис
geocode
[--query-text <value>]
[--query-components <value>]
[--max-results <value>]
[--bias-position <value>]
[--filter <value>]
[--additional-features <value>]
[--language <value>]
[--political-view <value>]
[--intended-use <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]
Параметры
--query-text (строка)
--query-components (структура)
Структурированный запрос произвольного текста позволяет искать места по имени или текстовому представлению определённых свойств места.
Страна -> (строка)
Регион -> (строка)
Регион или штат, в котором должны отображаться результаты.
Пример: North Rhine-Westphalia .
Подрегион -> (строка)
Населённый пункт -> (строка)
Город или населенный пункт, в котором должны отображаться результаты.
Пример: Vancouver .
Район -> (строка)
Улица -> (строка)
Номер дома -> (строка)
Почтовый индекс -> (строка)
Краткий синтаксис:
Country=string,Region=string,SubRegion=string,Locality=string,District=string,Street=string,AddressNumber=string,PostalCode=string
Синтаксис JSON:
{
"Country": "string",
"Region": "string",
"SubRegion": "string",
"Locality": "string",
"District": "string",
"Street": "string",
"AddressNumber": "string",
"PostalCode": "string"
}
--max-results (целое число)
--bias-position (список)
Положение в долготе и широте, к которому должны быть близки результаты. Обычно результаты мест, возвращаемые запросом, ранжируются выше, чем ближе они к этому положению. Сохраняется в [lng, lat] в формате WSG84.
Примечание
ПоляBiasPosition , FilterBoundingBox и FilterCircle взаимоисключающие.(двойное значение)
Синтаксис:
double double ...
--filter (структура)
Структура, содержащая набор свойств включения/исключения, которыми результаты должны обладать, чтобы быть возвращены в качестве результата.
Включаемые страны -> (список)
Список стран, в которых должны находиться все результаты. Страны представлены либо их двух-, либо трёхсимвольными кодами.
(строка)
Включаемые типы мест -> (список)
Включаемые типы мест.
(строка)
Краткий синтаксис:
IncludeCountries=string,string,IncludePlaceTypes=string,string
Синтаксис JSON:
{
"IncludeCountries": ["string", ...],
"IncludePlaceTypes": ["Locality"|"PostalCode"|"Intersection"|"Street"|"PointAddress"|"InterpolatedAddress", ...]
}
--additional-features (список)
Список необязательных дополнительных параметров, таких как часовой пояс, которые можно запросить для каждого результата.
(строка)
Синтаксис:
"string" "string" ...
Where valid values are:
TimeZone
Access
--language (строка)
--political-view (строка)
--intended-use (строка)
Указывает, будут ли результаты сохранены. По умолчанию SingleUse , если пусто.
Возможные значения:
SingleUseStorage
--key (строка)
--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-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматический запрос параметров ввода CLI.
Результат
PricingBucket -> (строка)
Ценовой сегмент, за который взимается плата за запрос.
Для получения дополнительной информации о ценообразовании посетите страницу Amazon Location Service Pricing .
ResultItems -> (список)
Список мест или результатов, возвращенных по запросу.
(структура)
Полученный результат геокодирования.
PlaceId -> (строка)
PlaceId места, для которого требуется информация.PlaceType -> (строка)
PlaceType — это категория, к которой должно принадлежать место результата.Title -> (строка)
language .Address -> (структура)
Адрес места.
Label -> (строка)
Country -> (структура)
Компонент страны в адресе.
Code2 -> (строка)
Code3 -> (строка)
Name -> (строка)
Region -> (структура)
Регион или штат, в котором должны присутствовать результаты.
Пример: North Rhine-Westphalia .
Code -> (строка)
Сокращенное обозначение штата, провинции или региона страны.
Пример: BC .
Name -> (строка)
Название штата, провинции или региона страны.
Пример: British Columbia .
SubRegion -> (структура)
Подрегион или уезд, в котором должны присутствовать результаты.
Code -> (строка)
Name -> (строка)
Locality -> (строка)
Населенный пункт или город адреса.
Пример: Vancouver .
District -> (строка)
SubDistrict -> (строка)
Подразделение района.
Пример: Minden-Lübbecke .
PostalCode -> (строка)
Block -> (строка)
Название квартала.
Пример: Sunny Mansion 203 block: 2 Chome
SubBlock -> (строка)
Название подквартала.
Пример: Sunny Mansion 203 sub-block: 4
Intersection -> (список)
Название улиц на пересечении.
Пример: ["Friedrichstraße","Unter den Linden"]
(строка)
Street -> (строка)
StreetComponents -> (список)
Компоненты улицы.
Пример: Younge из «улицы Younge».
(структура)
Компоненты улицы.
BaseName -> (строка)
Основная часть названия улицы.
Пример: Younge из «улицы Younge».
Type -> (строка)
Тип улицы в названии.
Пример: “avenue" .
TypePlacement -> (строка)
TypeSeparator -> (строка)
Prefix -> (строка)
Префикс — это направляющий идентификатор, который предшествует, но не входит в состав, основного названия дороги.
Пример: E для Востока.
Suffix -> (строка)
Суффикс — это направляющий идентификатор, который следует за, но не входит в состав, основного названия дороги.
Пример W для Запада.
Direction -> (строка)
Language -> (строка)
AddressNumber -> (строка)
Building -> (строка)
AddressNumberCorrected -> (булево)
PostalCodeDetails -> (список)
Содержит подробности о почтовом индексе места/результата.
(структура)
Содержит подробности о почтовом индексе места или результата.
PostalCode -> (строка)
PostalAuthority -> (строка)
PostalCodeType -> (строка)
UspsZip -> (структура)
Код классификации почтового индекса ZIP.
ZipClassificationCode -> (строка)
UspsZipPlus4 -> (структура)
Код записи USPS ZIP+4.
RecordTypeCode -> (строка)
Position -> (список)
Позиция по долготе и широте.
(двойное значение)
Distance -> (целое число)
MapView -> (список)
Прямоугольник, охватывающий геометрическую фигуру (площадь или линию), которую покрывает отдельный результат.
Прямоугольник, образованный, определяется как набор из 4 координат: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]
(двойное значение)
Categories -> (список)
Категории результатов, к которым должны принадлежать результаты.
(структура)
Категория возвращенного Place.
Id -> (строка)
Name -> (строка)
LocalizedName -> (строка)
Primary -> (булево)
FoodTypes -> (список)
Список типов еды, предлагаемых этим результатом.
(структура)
Список типов Food, предлагаемых этим результатом.
LocalizedName -> (строка)
Id -> (строка)
Primary -> (булево)
AccessPoints -> (список)
Позиция точки доступа, представленная долготой и широтой.
(структура)
Позиция точки доступа, представленная долготой и широтой для транспортного средства.
Position -> (список)
Позиция по долготе и широте.
(двойное значение)
TimeZone -> (структура)
Часовой пояс, в котором находится место.
Name -> (строка)
Offset -> (строка)
OffsetSeconds -> (целое число)
PoliticalView -> (строка)
MatchScores -> (структура)
Указывает, насколько хорошо весь ввод соответствует возвращенному. Равно 1, если все токены ввода распознаны и сопоставлены.
Overall -> (двойное значение)
Components -> (структура)
Указывает, насколько хорошо компонент ввода соответствует возвращенному. Равно 1, если все токены ввода распознаны и сопоставлены.
Title -> (двойное значение)
Address -> (структура)
Адрес места.
Country -> (двойное значение)
Region -> (двойное значение)
Регион или штат, в котором должны присутствовать результаты.
Пример: North Rhine-Westphalia .
SubRegion -> (двойное значение)
Locality -> (двойное значение)
Город или населенный пункт, в котором должны присутствовать результаты.
Пример: Vancouver .
District -> (двойное значение)
SubDistrict -> (двойное значение)
Подразделение района.
Пример: Minden-Lübbecke
PostalCode -> (двойное значение)
Block -> (двойное значение)
Название квартала.
Пример: Sunny Mansion 203 block: 2 Chome
SubBlock -> (двойное значение)
Название подквартала.
Пример: Sunny Mansion 203 sub-block: 4
Intersection -> (список)
Название улиц на пересечении.
Пример: ["Friedrichstraße","Unter den Linden"]
(двойное значение)
AddressNumber -> (двойное значение)
Building -> (двойное значение)
© Copyright 2025, Amazon Web Services. Created using Sphinx.