Spec-Zone.ru › AWS CLI v2

[ aws . location ]

put-geofence

Описание

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

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

Синтаксис

  put-geofence
--collection-name <value>
--geofence-id <value>
--geometry <value>
[--geofence-properties <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]

Параметры

--collection-name (строка)

Набор геозон для хранения геозоны.

--geofence-id (строка)

Идентификатор геозоны. Например, ExampleGeofence-1.

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

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

Примечание

Формат полигона геозоны поддерживает максимальное количество 1000 вершин. Формат Geobuf геозоны поддерживает максимальное количество 100 000 вершин.

Многоугольник -> (список)

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

Каждая вершина — это двумерная точка вида: [longitude, latitude]. Она представлена массивом из двух чисел с плавающей запятой (например, [double, double]).

Массив из 4 или более вершин, где первая и последняя вершины совпадают (чтобы образовать замкнутую границу), называется линейной линией. Вершины линейной линии должны быть перечислены против часовой стрелки вокруг внутренности линии. Линейная линия представлена массивом вершин или массивом массивов чисел с плавающей запятой ([[double, double], ...]).

Геозона состоит из одной линейной линии. Для будущего расширения параметр Polygon принимает массив линейных линий, который представлен массивом массивов массивов чисел с плавающей запятой ([[[double, double], ...], ...]).

Линейная линия для использования в геозонах может состоять из 4 до 1000 вершин.

(список)

(вещественное число)

Окружность -> (структура)

Окружность на Земле, определенная центральной точкой и радиусом.

Центр -> (список)

Геометрия единственной точки, определяющая центр окружности, с координатами WGS 84 в формате [longitude, latitude].

(вещественное число)

Радиус -> (вещественное число)

Радиус окружности в метрах. Должен быть больше нуля и не больше 100 000 (100 километров).

Geobuf -> (бинарный блок)

Geobuf — это компактное двоичное кодирование географических данных, обеспечивающее сжатие полигонов GeoJSON без потерь. Geobuf должен быть закодирован в Base64.

Полигон в формате Geobuf может иметь до 100 000 вершин.

Синтаксис JSON:

{
  "Polygon": [
    [
      [double, ...]
      ...
    ]
    ...
  ],
  "Circle": {
    "Center": [double, ...],
    "Radius": double
  },
  "Geobuf": blob
}

--geofence-properties (карта)

Связывает одну или несколько свойств с геозоной. Свойство представляет собой пару «ключ-значение», хранящуюся с геозоной и добавляемую в любое событие геозоны, сгенерированное с помощью этой геозоны.

Формат: "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
  • текст
  • таблица
  • 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.

Вывод

GeofenceId -> (строка)

Идентификатор геозоны, указанный в запросе.

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

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

UpdateTime -> (временная метка)

Временная метка последнего обновления геозоны в формате ISO 8601: YYYY-MM-DDThh:mm:ss.sssZ

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

Spec-Zone.ru

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