AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . location ]

forecast-geofence-events

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.

See also: AWS API Documentation

forecast-geofence-events is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: ForecastedEvents

Synopsis

  forecast-geofence-events
--collection-name <value>
--device-state <value>
[--time-horizon-minutes <value>]
[--distance-unit <value>]
[--speed-unit <value>]
[--cli-input-json <value>]
[--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>]

Options

--collection-name (string)

The name of the geofence collection.

--device-state (structure)

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

Position -> (list)

The device's position.

(double)

Speed -> (double)

The device's speed.

Shorthand Syntax:

Position=double,double,Speed=double

JSON Syntax:

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

--time-horizon-minutes (double)

Specifies the time horizon in minutes for the forecasted events.

--distance-unit (string)

The distance unit used for the NearestDistance property returned in a forecasted event. The measurement system must match for DistanceUnit and SpeedUnit ; if Kilometers is specified for DistanceUnit , then SpeedUnit must be KilometersPerHour .

Default Value: Kilometers

Possible values:

  • Kilometers
  • Miles

--speed-unit (string)

The speed unit for the device captured by the device state. The measurement system must match for DistanceUnit and SpeedUnit ; if Kilometers is specified for DistanceUnit , then SpeedUnit must be KilometersPerHour .

Default Value: KilometersPerHour .

Possible values:

  • KilometersPerHour
  • MilesPerHour

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

ForecastedEvents -> (list)

The list of forecasted events.

(structure)

A forecasted event represents a geofence event in relation to the requested device state, that may occur given the provided device state and time horizon.

EventId -> (string)

The forecasted event identifier.

GeofenceId -> (string)

The geofence identifier pertaining to the forecasted event.

IsDeviceInGeofence -> (boolean)

Indicates if the device is located within the geofence.

NearestDistance -> (double)

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

EventType -> (string)

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.

ForecastedBreachTime -> (timestamp)

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

GeofenceProperties -> (map)

The geofence properties.

key -> (string)

value -> (string)

NextToken -> (string)

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

DistanceUnit -> (string)

The distance unit for the forecasted events.

SpeedUnit -> (string)

The speed unit for the forecasted events.