Spec-Zone.ru › AWS CLI v2

[ aws . geo-места ]

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 (строка)

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

--political-view (строка)

Двух- или трёхсимвольный код политической точки зрения страны. Политическая точка зрения относится к результатам запроса, чтобы представить нерешенные территориальные претензии с точки зрения указанной страны.

--intended-use (строка)

Указывает, будут ли результаты сохранены. По умолчанию SingleUse , если пусто.

Возможные значения:

  • SingleUse
  • Storage

--key (строка)

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

--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 -> (строка)

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

Code3 -> (строка)

Страна, представленная ее трехсимвольным кодом ISO.

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 -> (строка)

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

AddressNumber -> (строка)

Номер, определяющий адрес на улице.

Building -> (строка)

Название здания по адресу.

AddressNumberCorrected -> (булево)

Булево значение, указывающее, был ли скорректирован предоставленный адрес.

PostalCodeDetails -> (список)

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

(структура)

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

PostalCode -> (строка)

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

PostalAuthority -> (строка)

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

PostalCodeType -> (строка)

Тип почтового индекса.

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

Код классификации почтового индекса ZIP.

ZipClassificationCode -> (строка)

Код классификации почтового индекса ZIP.

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

Код записи USPS ZIP+4.

RecordTypeCode -> (строка)

Код записи USPS ZIP+4.

Position -> (список)

Позиция по долготе и широте.

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

Distance -> (целое число)

Расстояние в метрах от QueryPosition.

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 -> (строка)

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

OffsetSeconds -> (целое число)

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

PoliticalView -> (строка)

Двух- или трехсимвольный код ISO для политической точки зрения страны. Политическая точка зрения относится к результатам запроса для представления неразрешенных территориальных претензий с точки зрения указанной страны.

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

Указывает, насколько хорошо весь ввод соответствует возвращенному. Равно 1, если все токены ввода распознаны и сопоставлены.

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

Указывает, насколько хорошо весь ввод соответствует возвращенному. Равно 1, если все токены ввода распознаны и сопоставлены.

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

Указывает, насколько хорошо компонент ввода соответствует возвращенному. Равно 1, если все токены ввода распознаны и сопоставлены.

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

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

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

Адрес места.

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

Двух- или трехсимвольный код ISO страны, в которой должны присутствовать результаты.

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.

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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