Поиск текста
Описание
Используйте операцию SearchText для поиска информации о географических координатах и местах. Затем вы можете выполнить последующий запрос, предложенный API Suggest, с помощью идентификатора запроса.
См. также: Документация API AWS
Синтаксис
search-text
[--query-text <value>]
[--query-id <value>]
[--max-results <value>]
[--bias-position <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-text (строка)
--query-id (строка)
--max-results (целое число)
--bias-position (список)
Положение (долгота и широта), к которому результаты должны быть близки. Как правило, результаты местоположений ранжируются выше, чем ближе они к этому положению. Сохраняется в [lng, lat] и в формате WSG84.
Примечание
ПоляBiasPosition , FilterBoundingBox и FilterCircle взаимоисключающие.(двойное значение)
Синтаксис:
double double ...
--filter (структура)
Структура, содержащая набор свойств включения/исключения, которыми должны обладать результаты, чтобы быть возвращенными.
BoundingBox -> (список)
Охватывающая прямоугольная область геометрической фигуры (площади или линии), которую охватывает отдельный результат.
Определяется как набор из 4 координат: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]
(двойное значение)
Circle -> (структура)
Circle, в котором должны находиться все результаты.
Center -> (список)
Центральное положение (долгота и широта) FilterCircle.
(двойное значение)
Radius -> (длинное целое число)
FilterCircle в метрах.IncludeCountries -> (список)
Список стран, в которых должны находиться все результаты. Страны представлены кодами из 2 или 3 символов (alpha-2 или alpha-3).
(строка)
Сокращенный синтаксис:
BoundingBox=double,double,Circle={Center=[double,double],Radius=long},IncludeCountries=string,string
Синтаксис JSON:
{
"BoundingBox": [double, ...],
"Circle": {
"Center": [double, ...],
"Radius": long
},
"IncludeCountries": ["string", ...]
}
--additional-features (список)
Список необязательных дополнительных параметров, таких как часовой пояс, которые могут быть запрошены для каждого результата.
(строка)
Синтаксис:
"string" "string" ...
Where valid values are:
TimeZone
Phonemes
Access
Contact
--language (строка)
--political-view (строка)
--intended-use (строка)
Указывает, будут ли результаты сохранены. По умолчанию SingleUse, если оставлено пустым.
Возможные значения:
SingleUseStorage
--next-token (строка)
nextToken, доступны дополнительные результаты. Значение nextToken — уникальный маркер для каждой страницы.--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, 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 -> (строка)
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 -> (строка)
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 -> (булево)
Position -> (список)
Координаты — широта и долгота.
(двойное число)
Distance -> (целое число)
MapView -> (список)
Охватывающая рамка геометрической формы (площади или линии), которую охватывает отдельный результат.
Охватывающая рамка сформирована четырьмя координатами: [{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 -> (список)
Список веб-сайтов, относящихся к результату.
(структура)
Подробные сведения о контактах.
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 -> (строка)
OffsetSeconds -> (длинное целое число)
PoliticalView -> (строка)
Phonemes -> (структура)
Как различные компоненты адреса результата произносятся на разных языках.
Title -> (список)
Список PhonemeTranscription. См. PhonemeTranscription для полей.
(структура)
Как произносятся различные компоненты адреса или места.
Value -> (строка)
Language -> (строка)
Preferred -> (boolean)
Address -> (структура)
Как произносится адрес.
Country -> (список)
Двух- или трёхбуквенный код страны, в которой будут отображаться результаты.
(структура)
Как произносятся различные компоненты адреса или места.
Value -> (строка)
Language -> (строка)
Preferred -> (boolean)
Region -> (список)
Как произносится регион или штат, в котором должны отображаться результаты.
(структура)
Как произносятся различные компоненты адреса или места.
Value -> (строка)
Language -> (строка)
Preferred -> (boolean)
SubRegion -> (список)
Как произносится подрегион или округ, для которых должны отображаться результаты.
(структура)
Как произносятся различные компоненты адреса или места.
Value -> (строка)
Language -> (строка)
Preferred -> (boolean)
Locality -> (список)
Как произносится город или населенный пункт, в котором должны отображаться результаты.
Пример: Vancouver .
(структура)
Как произносятся различные компоненты адреса или места.
Value -> (строка)
Language -> (строка)
Preferred -> (boolean)
District -> (список)
Как произносится район или подразделение города, в котором должны отображаться результаты.
(структура)
Как произносятся различные компоненты адреса или места.
Value -> (строка)
Language -> (строка)
Preferred -> (boolean)
SubDistrict -> (список)
Как произносится подрайон или подразделение города, в котором должны отображаться результаты.
(структура)
Как произносятся различные компоненты адреса или места.
Value -> (строка)
Language -> (строка)
Preferred -> (boolean)
Block -> (список)
Как произносится название блока.
(структура)
Как произносятся различные компоненты адреса или места.
Value -> (строка)
Language -> (строка)
Preferred -> (boolean)
SubBlock -> (список)
Как произносится название подблока.
(структура)
Как произносятся различные компоненты адреса или места.
Value -> (строка)
Language -> (строка)
Preferred -> (boolean)
Street -> (список)
Как произносится название улицы, в которой должны отображаться результаты.
(структура)
Как произносятся различные компоненты адреса или места.
Value -> (строка)
Language -> (строка)
Preferred -> (boolean)
NextToken -> (строка)
nextToken возвращено, доступны дополнительные результаты. Значение nextToken — это уникальный маркер постраничной навигации для каждой страницы.
© Copyright 2025, Amazon Web Services. Created using Sphinx.