Spec-Zone.ru › AWS CLI v2

[ aws . location ]

Прогнозирование событий геозоны

Описание

Оценивает позиции устройств по отношению к геозонам из заданного набора геозон. Прогноз событий указывает три состояния устройства относительно геозоны:

ENTER : Если устройство находится вне геозоны, но может пересечь ее, если будет двигаться со своей текущей скоростью в течение заданного временного интервала.

EXIT : Если устройство находится внутри геозоны, но может пересечь ее, если будет двигаться со своей текущей скоростью в течение заданного временного интервала.

IDLE : Если устройство находится внутри геозоны и не движется.

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

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

Синтаксис

  forecast-geofence-events
--collection-name <value>
--device-state <value>
[--time-horizon-minutes <value>]
[--distance-unit <value>]
[--speed-unit <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 (строка)

Название набора геозон.

--device-state (структура)

Состояние устройства, включая текущую позицию и скорость.

Позиция -> (список)

Позиция устройства.

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

Скорость -> (число с плавающей запятой)

Скорость устройства.

Сокращенный синтаксис:

Position=double,double,Speed=double

Синтаксис JSON:

{
  "Position": [double, ...],
  "Speed": double
}

--time-horizon-minutes (число с плавающей запятой)

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

--distance-unit (строка)

Единица измерения расстояния, используемая для свойства NearestDistance, возвращаемого в прогнозируемом событии. Система измерения должна соответствовать для DistanceUnit и SpeedUnit; если Kilometers указано для DistanceUnit, то SpeedUnit должно быть KilometersPerHour.

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

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

  • Kilometers
  • Miles

--speed-unit (строка)

Единица измерения скорости устройства, зафиксированная в состоянии устройства. Система измерения должна соответствовать для DistanceUnit и SpeedUnit; если Kilometers указано для DistanceUnit, то SpeedUnit должно быть KilometersPerHour.

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

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

  • KilometersPerHour
  • MilesPerHour

--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.

Вывод

ForecastedEvents -> (список)

Список прогнозируемых событий.

(структура)

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

EventId -> (строка)

Идентификатор прогнозируемого события.

GeofenceId -> (строка)

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

IsDeviceInGeofence -> (логическое значение)

Указывает, находится ли устройство внутри геозоны.

NearestDistance -> (число с плавающей запятой)

Наименьшее расстояние от позиции устройства до геозоны.

EventType -> (строка)

Тип события, прогнозирующий три состояния, в которых устройство может находиться относительно геозоны:

ENTER : Если устройство находится вне геозоны, но может пересечь ее, если будет двигаться со своей текущей скоростью в течение заданного временного интервала.

EXIT : Если устройство находится внутри геозоны, но может пересечь ее, если будет двигаться со своей текущей скоростью в течение заданного временного интервала.

IDLE : Если устройство находится внутри геозоны и не движется.

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

Прогнозируемое время пересечения геозоны в формате ISO 8601: YYYY-MM-DDThh:mm:ss.sssZ

GeofenceProperties -> (карта)

Свойства геозоны.

ключ -> (строка)

значение -> (строка)

NextToken -> (строка)

Токен постраничной обработки, определяющий, какую страницу результатов вернуть в ответе. Если токен не указан, используется первая страница.

DistanceUnit -> (строка)

Единица измерения расстояния для прогнозируемых событий.

SpeedUnit -> (строка)

Единица измерения скорости для прогнозируемых событий.

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

Spec-Zone.ru

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