import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { LocationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LocationClient"; import { ForecastGeofenceEventsRequest, ForecastGeofenceEventsResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link ForecastGeofenceEventsCommand}. */ export interface ForecastGeofenceEventsCommandInput extends ForecastGeofenceEventsRequest { } /** * @public * * The output of {@link ForecastGeofenceEventsCommand}. */ export interface ForecastGeofenceEventsCommandOutput extends ForecastGeofenceEventsResponse, __MetadataBearer { } declare const ForecastGeofenceEventsCommand_base: { new (input: ForecastGeofenceEventsCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: ForecastGeofenceEventsCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { LocationClient, ForecastGeofenceEventsCommand } from "@aws-sdk/client-location"; // ES Modules import * // const { LocationClient, ForecastGeofenceEventsCommand } = require("@aws-sdk/client-location"); // CommonJS import * const client = new LocationClient(config); * const input = { // ForecastGeofenceEventsRequest * CollectionName: "STRING_VALUE", // required * DeviceState: { // ForecastGeofenceEventsDeviceState * Position: [ // Position // required * Number("double"), * ], * Speed: Number("double"), * }, * TimeHorizonMinutes: Number("double"), * DistanceUnit: "STRING_VALUE", * SpeedUnit: "STRING_VALUE", * NextToken: "STRING_VALUE", * MaxResults: Number("int"), * }; * const command = new ForecastGeofenceEventsCommand(input); * const response = await client.send(command); * // { // ForecastGeofenceEventsResponse * // ForecastedEvents: [ // ForecastedEventsList // required * // { // ForecastedEvent * // EventId: "STRING_VALUE", // required * // GeofenceId: "STRING_VALUE", // required * // IsDeviceInGeofence: true || false, // required * // NearestDistance: Number("double"), // required * // EventType: "STRING_VALUE", // required * // ForecastedBreachTime: new Date("TIMESTAMP"), * // GeofenceProperties: { // PropertyMap * // "": "STRING_VALUE", * // }, * // }, * // ], * // NextToken: "STRING_VALUE", * // DistanceUnit: "STRING_VALUE", // required * // SpeedUnit: "STRING_VALUE", // required * // }; * * ``` * * @param ForecastGeofenceEventsCommandInput - {@link ForecastGeofenceEventsCommandInput} * @returns {@link ForecastGeofenceEventsCommandOutput} * @see {@link ForecastGeofenceEventsCommandInput} for command's `input` shape. * @see {@link ForecastGeofenceEventsCommandOutput} for command's `response` shape. * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

The request was denied because of insufficient access or permissions. Check with an * administrator to verify your permissions.

* * @throws {@link InternalServerException} (server fault) *

The request has failed to process because of an unknown server error, exception, or failure.

* * @throws {@link ResourceNotFoundException} (client fault) *

The resource that you've entered was not found in your AWS account.

* * @throws {@link ThrottlingException} (client fault) *

The request was denied because of request throttling.

* * @throws {@link ValidationException} (client fault) *

The input failed to meet the constraints specified by the AWS service.

* * @throws {@link LocationServiceException} *

Base exception class for all service exceptions from Location service.

* * * @public */ export declare class ForecastGeofenceEventsCommand extends ForecastGeofenceEventsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: ForecastGeofenceEventsRequest; output: ForecastGeofenceEventsResponse; }; sdk: { input: ForecastGeofenceEventsCommandInput; output: ForecastGeofenceEventsCommandOutput; }; }; }