Spec-Zone.ru › AWS CLI v2

[ aws . location ]

batch-put-geofence

Описание

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

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

Синтаксис

  batch-put-geofence
--collection-name <value>
--entries <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 (строка)

Набор геозон, хранящий геозоны.

--entries (список)

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

(структура)

Содержит подробности геометрии геозоны.

GeofenceId -> (строка)

Идентификатор геозоны, которая должна быть сохранена в заданном наборе геозон.

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

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

Примечание

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

Polygon -> (список)

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

Каждая вершина — это 2-мерная точка в формате: [longitude, latitude] . Это представлено как массив двойных чисел длиной 2 (так [double, double] ).

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

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

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

(список)

(список)

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

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

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

Center -> (список)

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

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

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

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

Geobuf -> (блок данных)

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

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

GeofenceProperties -> (карта)

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

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

key -> (строка)

value -> (строка)

Синтаксис JSON:

[
  {
    "GeofenceId": "string",
    "Geometry": {
      "Polygon": [
        [
          [double, ...]
          ...
        ]
        ...
      ],
      "Circle": {
        "Center": [double, ...],
        "Radius": double
      },
      "Geobuf": blob
    },
    "GeofenceProperties": {"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-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

Ошибки -> (список)

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

(структура)

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

GeofenceId -> (строка)

Геозона, связанная с сообщением об ошибке.

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

Содержит данные, связанные с ошибкой партии.

Code -> (строка)

Код ошибки, связанный с ошибкой партионного запроса.

Message -> (строка)

Сообщение с причиной ошибки партионного запроса.

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

Spec-Zone.ru

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