get-geofence

Описание

Извлекает подробности геозоны из коллекции геозон.

Примечание

Возвращаемая геометрия всегда будет соответствовать формату геометрии, используемому при создании геозоны.

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

Синтаксис

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

Геозона, для которой извлекаются подробности.

--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
table
yaml
yaml-stream

--query (строка)

Запрос JMESPath для использования в фильтрации данных ответа.

--profile (строка)

Использование определенного профиля из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/окружения.

--version (строка)

Отображает версию этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

on
off
auto

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

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

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

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

Polygon -> (список)

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

Каждая вершина — это двумерная точка вида: [longitude, latitude] . Это представлено как массив с двумя числами с плавающей точкой (так что [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 вершин.

Status -> (строка)

Определяет состояние геозоны. Геозона будет находиться в одном из следующих состояний:

ACTIVE — Геозона была проиндексирована системой.
PENDING — Геозона обрабатывается системой.
FAILED — Геозона не смогла быть проиндексирована системой.
DELETED — Геозона была удалена из индекса системы.
DELETING — Геозона удаляется из индекса системы.

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

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

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

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

GeofenceProperties -> (карта)

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

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

key -> (строка)

value -> (строка)