Spec-Zone.ru › AWS CLI v2

[ aws . location ]

list-geofences

Описание

Выводит список геозон, сохранённых в заданном наборе геозон.

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

list-geofences это постраничная операция. Для получения всего набора результатов может потребоваться несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлекать данные из результатов следующих выражений запроса: Entries

Синтаксис

  list-geofences
--collection-name <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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 (строка)

Имя набора геозон, содержащего список геозон.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного в JSON, поскольку строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен, указывающий, с какой точки начать постраничную загрузку. Это NextToken из ранее обрываемого ответа.

Примеры использования см. в разделе Постраничная загрузка в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничная загрузка в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов, которые должны быть возвращены в выводе команды. Если общее количество доступных элементов больше, чем указанное значение, в выводе команды предоставляется NextToken. Для продолжения постраничной загрузки предоставьте значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken непосредственно вне AWS CLI.

Примеры использования см. в разделе Постраничная загрузка в Руководстве пользователя AWS Command Line Interface.

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

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

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

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

Polygon -> (список)

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

Каждая вершина является двумерной точкой вида: [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 вершин.

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

NextToken -> (строка)

Токен постраничной загрузки, указывающий, что доступны дополнительные страницы. Вы можете использовать токен в последующем запросе, чтобы получить следующий набор результатов.

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

Spec-Zone.ru

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