Skip to content
AWS for Query.Farm

aws.location.forecast_geofence_events

Example SQL Queries

SELECT * FROM
aws.location.forecast_geofence_events
WHERE
"collection_name" = 'VALUE'
AND "device_state" = 'VALUE';

Description

Evaluates device positions against geofence geometries from a given geofence collection. The event forecasts three states for which a device can be in relative to a geofence:

ENTER: If a device is outside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

EXIT: If a device is inside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

IDLE: If a device is inside of a geofence, and the device is not moving.

Table Definition

Column NameColumn Data Type
collection_name Required Input Column

The name of the geofence collection.

VARCHAR
device_state Required Input Column

The device's state, including current position and speed.

STRUCT(
    "position" DOUBLE[],
    "speed" DOUBLE
)
Show child fields
device_state.position[]
device_state.speed

The device's speed.

distance_unit Input Column

The distance unit for the forecasted events.

VARCHAR
speed_unit Input Column

The speed unit for the forecasted events.

VARCHAR
time_horizon_minutes Input Column

Specifies the time horizon in minutes for the forecasted events.

DOUBLE
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

forecasted_events

The list of forecasted events.

STRUCT(
    "event_id" VARCHAR,
    "geofence_id" VARCHAR,
    "is_device_in_geofence" BOOLEAN,
    "nearest_distance" DOUBLE,
    "event_type" VARCHAR,
    "forecasted_breach_time" TIMESTAMP_S,
    "geofence_properties" MAP(VARCHAR, VARCHAR)
)[]
Show child fields
forecasted_events[]
Show child fields
forecasted_events[].event_id

The forecasted event identifier.

forecasted_events[].event_type

The event type, forecasting three states for which a device can be in relative to a geofence:

ENTER: If a device is outside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

EXIT: If a device is inside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

IDLE: If a device is inside of a geofence, and the device is not moving.

forecasted_events[].forecasted_breach_time

The forecasted time the device will breach the geofence in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

forecasted_events[].geofence_id

The geofence identifier pertaining to the forecasted event.

forecasted_events[].geofence_properties

The geofence properties.

forecasted_events[].is_device_in_geofence

Indicates if the device is located within the geofence.

forecasted_events[].nearest_distance

The closest distance from the device's position to the geofence.