Spec-Zone.ru › AWS CLI v2

[ aws . location ]

create-place-index

Описание

Создаёт ресурс индекса мест в вашем аккаунте Amazon Web Services. Используйте ресурс индекса мест для геокодирования адресов и других текстовых запросов, используя операцию SearchPlaceIndexForText, и для обратного геокодирования координат, используя операцию SearchPlaceIndexForPosition, и для включения автодополнения, используя операцию SearchPlaceIndexForSuggestions.

Примечание

Если ваше приложение отслеживает или маршрутизирует активы, которые вы используете в своём бизнесе, такие как транспортные средства доставки или сотрудники, не используйте Esri в качестве поставщика геолокации. Более подробную информацию см. в разделе 82 Условий предоставления услуг Amazon Web Services.

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

Синтаксис

  create-place-index
--index-name <value>
--data-source <value>
[--pricing-plan <value>]
[--description <value>]
[--data-source-configuration <value>]
[--tags <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 (строка)

Имя ресурса индекса мест.

Требования:

  • Содержать только буквенно-цифровые символы (A–Z, a–z, 0–9), дефисы (-), точки (.) и символы нижнего подчеркивания (_).
  • Должно быть уникальным именем ресурса индекса мест.
  • Пробелы запрещены. Например, ExamplePlaceIndex.

--data-source (строка)

Указывает поставщика геопространственных данных для нового индекса мест.

Примечание

Это поле чувствительно к регистру. Вводите допустимые значения, как показано. Например, ввод HERE приводит к ошибке.

Допустимые значения:

  • Esri — Для дополнительной информации о покрытии Esri в вашем регионе интересов, см. детали Esri о покрытии геокодирования .
  • Grab — Grab предоставляет функциональность индекса мест для Юго-Восточной Азии. Для дополнительной информации о покрытии GrabMaps см. страны и регионы, охватываемые GrabMaps .
  • Here — Для дополнительной информации о покрытии HERE Technologies в вашем регионе интересов, см. детали HERE о покрытии геокодирования .

Предупреждение

Если вы укажете HERE Technologies (Here ) в качестве поставщика данных, вы не сможете хранить результаты для мест в Японии. Более подробную информацию см. в Условиях предоставления услуг Amazon Web Services для Amazon Location Service.

Для дополнительной информации см. Поставщики данных в Руководстве разработчика Amazon Location Service.

--pricing-plan (строка)

Больше не используется. Если включено, единственное допустимое значение — RequestBasedUsage.

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

  • RequestBasedUsage
  • MobileAssetTracking
  • MobileAssetManagement

--description (строка)

Необязательное описание ресурса индекса мест.

--data-source-configuration (структура)

Указывает вариант хранения данных, запрашивающий места.

IntendedUse -> (строка)

Указывает, как результаты операции будут храниться вызывающим агентом.

Допустимые значения включают:

  • SingleUse указывает, что результаты не будут храниться.
  • Storage указывает, что результат может быть кэширован или сохранён в базе данных.

Значение по умолчанию: SingleUse

Краткая форма синтаксиса:

IntendedUse=string

JSON синтаксис:

{
  "IntendedUse": "SingleUse"|"Storage"
}

--tags (массив)

Применяет один или несколько тегов к ресурсу индекса мест. Тег — это пара ключ-значение, которая помогает вам управлять, идентифицировать, искать и фильтровать ваши ресурсы.

Формат: "key" : "value"

Ограничения:

  • Максимум 50 тегов на ресурс.
  • Каждый ключ тега должен быть уникальным и иметь ровно одно связанное значение.
  • Максимальная длина ключа: 128 символов Юникода в UTF-8.
  • Максимальная длина значения: 256 символов Юникода в UTF-8.
  • Можно использовать буквенно-цифровые символы (A–Z, a–z, 0–9) и следующие символы: + - = . _ : / @
  • Нельзя использовать «aws:” в качестве префикса ключа.

key -> (строка)

value -> (строка)

Краткая форма синтаксиса:

KeyName1=string,KeyName2=string

JSON синтаксис:

{"string": "string"
  ...}

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

Вывод

IndexName -> (строка)

Имя ресурса индекса мест.

IndexArn -> (строка)

Amazon Resource Name (ARN) ресурса индекса мест. Используется для указания ресурса в Amazon Web Services.

  • Пример формата: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

CreateTime -> (отметка времени)

Отметка времени создания ресурса индекса мест в формате ISO 8601: YYYY-MM-DDThh:mm:ss.sssZ.

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

Spec-Zone.ru

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