Spec-Zone.ru › AWS CLI v2

[ aws . geo-места ]

Поиск рядом

Описание

Поиск мест рядом с указанным местоположением.

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

Синтаксис

  search-nearby
--query-position <value>
[--query-radius <value>]
[--max-results <value>]
[--filter <value>]
[--additional-features <value>]
[--language <value>]
[--political-view <value>]
[--intended-use <value>]
[--next-token <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-position (список)

Позиция в [lng, lat] для которой вы запрашиваете результаты поиска рядом. Результаты, более близкие к позиции, будут иметь более высокий рейтинг, чем результаты, более удалённые от позиции.

(число с плавающей точкой)

Синтаксис:

double double ...

--query-radius (целое число)

Максимальное расстояние в метрах от QueryPosition, с которого будет возвращён результат.

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

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

--filter (структура)

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

BoundingBox -> (список)

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

Прямоугольная область определяется как набор из 4 координат: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]

(число с плавающей точкой)

IncludeCountries -> (список)

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

(строка)

IncludeCategories -> (список)

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

(строка)

ExcludeCategories -> (список)

Категории результатов, которые исключены.

(строка)

IncludeBusinessChains -> (список)

Сети компаний, ассоциированные с местом.

(строка)

ExcludeBusinessChains -> (список)

Сети компаний, ассоциированные с местом.

(строка)

IncludeFoodTypes -> (список)

Типы блюд, которые включаются в результаты.

(строка)

ExcludeFoodTypes -> (список)

Типы блюд, которые исключаются из результатов.

(строка)

Сокращённый синтаксис:

BoundingBox=double,double,IncludeCountries=string,string,IncludeCategories=string,string,ExcludeCategories=string,string,IncludeBusinessChains=string,string,ExcludeBusinessChains=string,string,IncludeFoodTypes=string,string,ExcludeFoodTypes=string,string

Синтаксис JSON:

{
  "BoundingBox": [double, ...],
  "IncludeCountries": ["string", ...],
  "IncludeCategories": ["string", ...],
  "ExcludeCategories": ["string", ...],
  "IncludeBusinessChains": ["string", ...],
  "ExcludeBusinessChains": ["string", ...],
  "IncludeFoodTypes": ["string", ...],
  "ExcludeFoodTypes": ["string", ...]
}

--additional-features (список)

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

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  TimeZone
  Phonemes
  Access
  Contact

--language (строка)

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

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

Код политического взгляда страны (2 или 3 символа). Политический взгляд применяется к результатам запроса для отображения нерешённых территориальных претензий с точки зрения указанной страны.

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

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

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

  • SingleUse
  • Storage

--next-token (строка)

Если nextToken возвращён, доступны дополнительные результаты. Значение nextToken — уникальный маркер для каждой страницы.

--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 для вывода.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

PricingBucket -> (строка)

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

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

ResultItems -> (список)

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

(структура)

Результаты поиска близлежащих мест.

PlaceId -> (строка)

PlaceId места, для которого требуется информация.

PlaceType -> (строка)

PlaceType — категория, к которой должно принадлежать найденное место.

Title -> (строка)

Название элемента.

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

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

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 для East (Восток).

Suffix -> (строка)

Суффикс — это направленное обозначение, которое следует, но не входит в состав, основного названия дороги.

Пример: W для West (Запад).

Direction -> (строка)

Указывает официальные обозначения направления, присвоенные шоссе.

Language -> (строка)

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

AddressNumber -> (строка)

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

Building -> (строка)

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

AddressNumberCorrected -> (булево)

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

Position -> (список)

Положение в долготе и широте.

(число с плавающей запятой)

Distance -> (целое)

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

MapView -> (список)

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

Прямоугольная область определяется как набор 4 координат: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]

(число с плавающей запятой)

Categories -> (список)

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

(структура)

Категория возвращаемого Place.

Id -> (строка)

Идентификатор категории.

Name -> (строка)

Название категории.

LocalizedName -> (строка)

Локализованное имя типа категории.

Primary -> (булево)

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

FoodTypes -> (список)

Список типов блюд, предлагаемых этим результатом.

(структура)

Список Food типов, предлагаемых этим результатом.

LocalizedName -> (строка)

Локализованное имя типа блюда.

Id -> (строка)

Идентификатор типа блюда.

Primary -> (булево)

Булево значение, указывающее, является ли этот тип блюда основным, предлагаемым местом. Например, если место предлагает как фаст-фуд, так и десерты, основным типом, скорее всего, будет фаст-фуд.

BusinessChains -> (список)

Сеть предприятий, связанные с местом.

(структура)

Бизнес-сеть — это цепь предприятий, принадлежащих одному бренду. Например, 7-11.

Name -> (строка)

Название сети предприятий.

Id -> (строка)

Идентификатор сети предприятий.

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

Список потенциальных способов связи с результатом/местом.

Phones -> (список)

Список номеров телефонов для связи с результатом.

(структура)

Подробности, связанные с контактами.

Label -> (строка)

Метка контакта.

Value -> (строка)

Значение контакта.

Categories -> (список)

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

(структура)

Категория возвращаемого Place.

Id -> (строка)

Идентификатор категории.

Name -> (строка)

Название категории.

LocalizedName -> (строка)

Локализованное имя типа категории.

Primary -> (булево)

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

Faxes -> (список)

Список факсов для связи с результатом.

(структура)

Подробности, связанные с контактами.

Label -> (строка)

Метка контакта.

Value -> (строка)

Значение контакта.

Categories -> (список)

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

(структура)

Категория возвращаемого Place.

Id -> (строка)

Идентификатор категории.

Name -> (строка)

Название категории.

LocalizedName -> (строка)

Локализованное имя типа категории.

Primary -> (булево)

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

Websites -> (список)

Список URL-адресов веб-сайтов, относящихся к результату.

(структура)

Подробности, связанные с контактами.

Label -> (строка)

Метка контакта.

Value -> (строка)

Значение контакта.

Categories -> (список)

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

(структура)

Категория возвращаемого Place.

Id -> (строка)

Идентификатор категории.

Name -> (строка)

Название категории.

LocalizedName -> (строка)

Локализованное имя типа категории.

Primary -> (булево)

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

Emails -> (список)

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

(структура)

Подробности, связанные с контактами.

Label -> (строка)

Метка контакта.

Value -> (строка)

Значение контакта.

Categories -> (список)

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

(структура)

Категория возвращаемого Place.

Id -> (строка)

Идентификатор категории.

Name -> (строка)

Название категории.

LocalizedName -> (строка)

Локализованное имя типа категории.

Primary -> (булево)

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

OpeningHours -> (список)

Список объектов с часами работы.

(структура)

Список объектов с часами работы.

Display -> (список)

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

(строка)

OpenNow -> (булево)

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

Components -> (список)

Компоненты объекта с часами работы.

(структура)

Компоненты объекта с часами работы.

OpenTime -> (строка)

Строка, представляющая часы работы, например, "T070000".

OpenDuration -> (строка)

Строка, представляющая продолжительность периода работы, например, "PT12H00M".

Recurrence -> (строка)

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

Пример: FREQ:DAILY;BYDAY:MO,TU,WE,TH,SU

Categories -> (список)

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

(структура)

Категория возвращаемого Place.

Id -> (строка)

Идентификатор категории.

Name -> (строка)

Название категории.

LocalizedName -> (строка)

Локализованное имя типа категории.

Primary -> (булево)

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

AccessPoints -> (список)

Положение точки доступа, представленное долготой и широтой.

(структура)

Положение точки доступа, представленное долготой и широтой для транспортного средства.

Position -> (список)

Положение в долготе и широте.

(число с плавающей запятой)

AccessRestrictions -> (список)

Указывает известные ограничения доступа к точке доступа к транспортному средству. Индекс соответствует точке доступа и указывает, существует ли какой-либо тип ограничения доступа через эту точку.

(структура)

Указывает, ограничен ли доступ к месту. Индекс соответствует индексу точки доступа и указывает, существует ли какой-либо тип ограничения доступа через эту точку.

Restricted -> (boolean)

Ограничение.

Categories -> (список)

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

(структура)

Категория возвращенного Place.

Id -> (строка)

Идентификатор категории.

Name -> (строка)

Название категории.

LocalizedName -> (строка)

Локализованное название типа категории.

Primary -> (boolean)

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

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

Часовой пояс, в котором расположено место.

Name -> (строка)

Название часового пояса.

Offset -> (строка)

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

OffsetSeconds -> (long)

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

PoliticalView -> (строка)

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

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

Как различные компоненты адреса результата произносятся на различных языках.

Title -> (список)

Список PhonemeTranscription. См. PhonemeTranscription для полей.

(структура)

Как произносятся различные компоненты адреса или места.

Value -> (строка)

Значение, указывающее, как произнести значение.

Language -> (строка)

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

Preferred -> (boolean)

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

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

Как произносится адрес.

Country -> (список)

Двух- или трехбуквенный код (alpha-2 или alpha-3) страны, в которой будут представлены результаты.

(структура)

Как произносятся различные компоненты адреса или места.

Value -> (строка)

Значение, указывающее, как произнести значение.

Language -> (строка)

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

Preferred -> (boolean)

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

Region -> (список)

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

(структура)

Как произносятся различные компоненты адреса или места.

Value -> (строка)

Значение, указывающее, как произнести значение.

Language -> (строка)

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

Preferred -> (boolean)

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

SubRegion -> (список)

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

(структура)

Как произносятся различные компоненты адреса или места.

Value -> (строка)

Значение, указывающее, как произнести значение.

Language -> (строка)

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

Preferred -> (boolean)

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

Locality -> (список)

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

Пример: Vancouver.

(структура)

Как произносятся различные компоненты адреса или места.

Value -> (строка)

Значение, указывающее, как произнести значение.

Language -> (строка)

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

Preferred -> (boolean)

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

District -> (список)

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

(структура)

Как произносятся различные компоненты адреса или места.

Value -> (строка)

Значение, указывающее, как произнести значение.

Language -> (строка)

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

Preferred -> (boolean)

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

SubDistrict -> (список)

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

(структура)

Как произносятся различные компоненты адреса или места.

Value -> (строка)

Значение, указывающее, как произнести значение.

Language -> (строка)

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

Preferred -> (boolean)

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

Block -> (список)

Как произносится название квартала.

(структура)

Как произносятся различные компоненты адреса или места.

Value -> (строка)

Значение, указывающее, как произнести значение.

Language -> (строка)

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

Preferred -> (boolean)

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

SubBlock -> (список)

Как произносится название подквартала.

(структура)

Как произносятся различные компоненты адреса или места.

Value -> (строка)

Значение, указывающее, как произнести значение.

Language -> (строка)

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

Preferred -> (boolean)

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

Street -> (список)

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

(структура)

Как произносятся различные компоненты адреса или места.

Value -> (строка)

Значение, указывающее, как произнести значение.

Language -> (строка)

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

Preferred -> (boolean)

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

NextToken -> (строка)

Если nextToken возвращается, есть больше результатов. Значение nextToken — это уникальный маркер страницы для каждой страницы.

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

Spec-Zone.ru

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