@aws-sdk/client-location 3.588.0 → 3.592.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -0
- package/dist-cjs/index.js +269 -61
- package/dist-es/Location.js +4 -0
- package/dist-es/commands/ForecastGeofenceEventsCommand.js +25 -0
- package/dist-es/commands/VerifyDevicePositionCommand.js +25 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_0.js +35 -0
- package/dist-es/pagination/ForecastGeofenceEventsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +173 -0
- package/dist-types/Location.d.ts +14 -0
- package/dist-types/LocationClient.d.ts +8 -6
- package/dist-types/commands/AssociateTrackerConsumerCommand.d.ts +2 -1
- package/dist-types/commands/BatchDeleteDevicePositionHistoryCommand.d.ts +2 -1
- package/dist-types/commands/BatchDeleteGeofenceCommand.d.ts +2 -1
- package/dist-types/commands/BatchEvaluateGeofencesCommand.d.ts +2 -1
- package/dist-types/commands/BatchGetDevicePositionCommand.d.ts +2 -1
- package/dist-types/commands/BatchPutGeofenceCommand.d.ts +3 -1
- package/dist-types/commands/BatchUpdateDevicePositionCommand.d.ts +2 -1
- package/dist-types/commands/CalculateRouteCommand.d.ts +2 -1
- package/dist-types/commands/CalculateRouteMatrixCommand.d.ts +2 -1
- package/dist-types/commands/CreateGeofenceCollectionCommand.d.ts +2 -1
- package/dist-types/commands/CreateKeyCommand.d.ts +2 -1
- package/dist-types/commands/CreateMapCommand.d.ts +2 -1
- package/dist-types/commands/CreatePlaceIndexCommand.d.ts +2 -1
- package/dist-types/commands/CreateRouteCalculatorCommand.d.ts +2 -1
- package/dist-types/commands/CreateTrackerCommand.d.ts +2 -1
- package/dist-types/commands/DeleteGeofenceCollectionCommand.d.ts +2 -1
- package/dist-types/commands/DeleteKeyCommand.d.ts +2 -1
- package/dist-types/commands/DeleteMapCommand.d.ts +2 -1
- package/dist-types/commands/DeletePlaceIndexCommand.d.ts +2 -1
- package/dist-types/commands/DeleteRouteCalculatorCommand.d.ts +2 -1
- package/dist-types/commands/DeleteTrackerCommand.d.ts +2 -1
- package/dist-types/commands/DescribeGeofenceCollectionCommand.d.ts +2 -1
- package/dist-types/commands/DescribeKeyCommand.d.ts +2 -1
- package/dist-types/commands/DescribeMapCommand.d.ts +2 -1
- package/dist-types/commands/DescribePlaceIndexCommand.d.ts +2 -1
- package/dist-types/commands/DescribeRouteCalculatorCommand.d.ts +2 -1
- package/dist-types/commands/DescribeTrackerCommand.d.ts +2 -1
- package/dist-types/commands/DisassociateTrackerConsumerCommand.d.ts +2 -1
- package/dist-types/commands/ForecastGeofenceEventsCommand.d.ts +110 -0
- package/dist-types/commands/GetDevicePositionCommand.d.ts +2 -1
- package/dist-types/commands/GetDevicePositionHistoryCommand.d.ts +2 -1
- package/dist-types/commands/GetGeofenceCommand.d.ts +6 -1
- package/dist-types/commands/GetMapGlyphsCommand.d.ts +2 -1
- package/dist-types/commands/GetMapSpritesCommand.d.ts +2 -1
- package/dist-types/commands/GetMapStyleDescriptorCommand.d.ts +2 -1
- package/dist-types/commands/GetMapTileCommand.d.ts +2 -1
- package/dist-types/commands/GetPlaceCommand.d.ts +2 -1
- package/dist-types/commands/ListDevicePositionsCommand.d.ts +2 -1
- package/dist-types/commands/ListGeofenceCollectionsCommand.d.ts +2 -1
- package/dist-types/commands/ListGeofencesCommand.d.ts +3 -1
- package/dist-types/commands/ListKeysCommand.d.ts +2 -1
- package/dist-types/commands/ListMapsCommand.d.ts +2 -1
- package/dist-types/commands/ListPlaceIndexesCommand.d.ts +2 -1
- package/dist-types/commands/ListRouteCalculatorsCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/ListTrackerConsumersCommand.d.ts +2 -1
- package/dist-types/commands/ListTrackersCommand.d.ts +2 -1
- package/dist-types/commands/PutGeofenceCommand.d.ts +3 -1
- package/dist-types/commands/SearchPlaceIndexForPositionCommand.d.ts +2 -1
- package/dist-types/commands/SearchPlaceIndexForSuggestionsCommand.d.ts +2 -1
- package/dist-types/commands/SearchPlaceIndexForTextCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateGeofenceCollectionCommand.d.ts +2 -1
- package/dist-types/commands/UpdateKeyCommand.d.ts +2 -1
- package/dist-types/commands/UpdateMapCommand.d.ts +2 -1
- package/dist-types/commands/UpdatePlaceIndexCommand.d.ts +2 -1
- package/dist-types/commands/UpdateRouteCalculatorCommand.d.ts +2 -1
- package/dist-types/commands/UpdateTrackerCommand.d.ts +2 -1
- package/dist-types/commands/VerifyDevicePositionCommand.d.ts +134 -0
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/index.d.ts +2 -2
- package/dist-types/models/LocationServiceException.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +494 -112
- package/dist-types/pagination/ForecastGeofenceEventsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
- package/dist-types/runtimeConfig.native.d.ts +1 -1
- package/dist-types/ts3.4/Location.d.ts +34 -0
- package/dist-types/ts3.4/LocationClient.d.ts +15 -3
- package/dist-types/ts3.4/commands/AssociateTrackerConsumerCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/BatchDeleteDevicePositionHistoryCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/BatchDeleteGeofenceCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/BatchEvaluateGeofencesCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/BatchGetDevicePositionCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/BatchPutGeofenceCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/BatchUpdateDevicePositionCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/CalculateRouteCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/CalculateRouteMatrixCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/CreateGeofenceCollectionCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/CreateKeyCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/CreateMapCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/CreatePlaceIndexCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/CreateRouteCalculatorCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/CreateTrackerCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/DeleteGeofenceCollectionCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/DeleteKeyCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/DeleteMapCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/DeletePlaceIndexCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/DeleteRouteCalculatorCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/DeleteTrackerCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/DescribeGeofenceCollectionCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/DescribeKeyCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/DescribeMapCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/DescribePlaceIndexCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/DescribeRouteCalculatorCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/DescribeTrackerCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/DisassociateTrackerConsumerCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/ForecastGeofenceEventsCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/GetDevicePositionCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/GetDevicePositionHistoryCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/GetGeofenceCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/GetMapGlyphsCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/GetMapSpritesCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/GetMapStyleDescriptorCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/GetMapTileCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/GetPlaceCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/ListDevicePositionsCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/ListGeofenceCollectionsCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/ListGeofencesCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/ListKeysCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/ListMapsCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/ListPlaceIndexesCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/ListRouteCalculatorsCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/ListTrackerConsumersCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/ListTrackersCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/PutGeofenceCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/SearchPlaceIndexForPositionCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/SearchPlaceIndexForSuggestionsCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/SearchPlaceIndexForTextCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/UpdateGeofenceCollectionCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/UpdateKeyCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/UpdateMapCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/UpdatePlaceIndexCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/UpdateRouteCalculatorCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/UpdateTrackerCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/VerifyDevicePositionCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/LocationServiceException.d.ts +2 -1
- package/dist-types/ts3.4/models/models_0.d.ts +110 -0
- package/dist-types/ts3.4/pagination/ForecastGeofenceEventsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -1
- package/package.json +6 -6
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { LocationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LocationClient";
|
|
4
|
+
import { ForecastGeofenceEventsRequest, ForecastGeofenceEventsResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ForecastGeofenceEventsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ForecastGeofenceEventsCommandInput extends ForecastGeofenceEventsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ForecastGeofenceEventsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ForecastGeofenceEventsCommandOutput extends ForecastGeofenceEventsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ForecastGeofenceEventsCommand_base: {
|
|
25
|
+
new (input: ForecastGeofenceEventsCommandInput): import("@smithy/smithy-client").CommandImpl<ForecastGeofenceEventsCommandInput, ForecastGeofenceEventsCommandOutput, LocationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ForecastGeofenceEventsCommandInput): import("@smithy/smithy-client").CommandImpl<ForecastGeofenceEventsCommandInput, ForecastGeofenceEventsCommandOutput, LocationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Evaluates device positions against
|
|
31
|
+
* geofence geometries from a given geofence collection. The event forecasts three states for which
|
|
32
|
+
* a device can be in relative to a geofence:</p>
|
|
33
|
+
* <p>
|
|
34
|
+
* <code>ENTER</code>: 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.</p>
|
|
35
|
+
* <p>
|
|
36
|
+
* <code>EXIT</code>: 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.</p>
|
|
37
|
+
* <p>
|
|
38
|
+
* <code>IDLE</code>: If a device is inside of a geofence, and the device is not moving.</p>
|
|
39
|
+
* @example
|
|
40
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
41
|
+
* ```javascript
|
|
42
|
+
* import { LocationClient, ForecastGeofenceEventsCommand } from "@aws-sdk/client-location"; // ES Modules import
|
|
43
|
+
* // const { LocationClient, ForecastGeofenceEventsCommand } = require("@aws-sdk/client-location"); // CommonJS import
|
|
44
|
+
* const client = new LocationClient(config);
|
|
45
|
+
* const input = { // ForecastGeofenceEventsRequest
|
|
46
|
+
* CollectionName: "STRING_VALUE", // required
|
|
47
|
+
* DeviceState: { // ForecastGeofenceEventsDeviceState
|
|
48
|
+
* Position: [ // Position // required
|
|
49
|
+
* Number("double"),
|
|
50
|
+
* ],
|
|
51
|
+
* Speed: Number("double"),
|
|
52
|
+
* },
|
|
53
|
+
* TimeHorizonMinutes: Number("double"),
|
|
54
|
+
* DistanceUnit: "STRING_VALUE",
|
|
55
|
+
* SpeedUnit: "STRING_VALUE",
|
|
56
|
+
* NextToken: "STRING_VALUE",
|
|
57
|
+
* MaxResults: Number("int"),
|
|
58
|
+
* };
|
|
59
|
+
* const command = new ForecastGeofenceEventsCommand(input);
|
|
60
|
+
* const response = await client.send(command);
|
|
61
|
+
* // { // ForecastGeofenceEventsResponse
|
|
62
|
+
* // ForecastedEvents: [ // ForecastedEventsList // required
|
|
63
|
+
* // { // ForecastedEvent
|
|
64
|
+
* // EventId: "STRING_VALUE", // required
|
|
65
|
+
* // GeofenceId: "STRING_VALUE", // required
|
|
66
|
+
* // IsDeviceInGeofence: true || false, // required
|
|
67
|
+
* // NearestDistance: Number("double"), // required
|
|
68
|
+
* // EventType: "STRING_VALUE", // required
|
|
69
|
+
* // ForecastedBreachTime: new Date("TIMESTAMP"),
|
|
70
|
+
* // GeofenceProperties: { // PropertyMap
|
|
71
|
+
* // "<keys>": "STRING_VALUE",
|
|
72
|
+
* // },
|
|
73
|
+
* // },
|
|
74
|
+
* // ],
|
|
75
|
+
* // NextToken: "STRING_VALUE",
|
|
76
|
+
* // DistanceUnit: "STRING_VALUE", // required
|
|
77
|
+
* // SpeedUnit: "STRING_VALUE", // required
|
|
78
|
+
* // };
|
|
79
|
+
*
|
|
80
|
+
* ```
|
|
81
|
+
*
|
|
82
|
+
* @param ForecastGeofenceEventsCommandInput - {@link ForecastGeofenceEventsCommandInput}
|
|
83
|
+
* @returns {@link ForecastGeofenceEventsCommandOutput}
|
|
84
|
+
* @see {@link ForecastGeofenceEventsCommandInput} for command's `input` shape.
|
|
85
|
+
* @see {@link ForecastGeofenceEventsCommandOutput} for command's `response` shape.
|
|
86
|
+
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
89
|
+
* <p>The request was denied because of insufficient access or permissions. Check with an
|
|
90
|
+
* administrator to verify your permissions.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link InternalServerException} (server fault)
|
|
93
|
+
* <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
96
|
+
* <p>The resource that you've entered was not found in your AWS account.</p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
99
|
+
* <p>The request was denied because of request throttling.</p>
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link ValidationException} (client fault)
|
|
102
|
+
* <p>The input failed to meet the constraints specified by the AWS service. </p>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link LocationServiceException}
|
|
105
|
+
* <p>Base exception class for all service exceptions from Location service.</p>
|
|
106
|
+
*
|
|
107
|
+
* @public
|
|
108
|
+
*/
|
|
109
|
+
export declare class ForecastGeofenceEventsCommand extends ForecastGeofenceEventsCommand_base {
|
|
110
|
+
}
|
|
@@ -5,7 +5,8 @@ import { GetGeofenceRequest, GetGeofenceResponse } from "../models/models_0";
|
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
8
|
-
export { __MetadataBearer
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
9
10
|
/**
|
|
10
11
|
* @public
|
|
11
12
|
*
|
|
@@ -27,6 +28,9 @@ declare const GetGeofenceCommand_base: {
|
|
|
27
28
|
};
|
|
28
29
|
/**
|
|
29
30
|
* <p>Retrieves the geofence details from a geofence collection.</p>
|
|
31
|
+
* <note>
|
|
32
|
+
* <p>The returned geometry will always match the geometry format used when the geofence was created.</p>
|
|
33
|
+
* </note>
|
|
30
34
|
* @example
|
|
31
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
36
|
* ```javascript
|
|
@@ -55,6 +59,7 @@ declare const GetGeofenceCommand_base: {
|
|
|
55
59
|
* // ],
|
|
56
60
|
* // Radius: Number("double"), // required
|
|
57
61
|
* // },
|
|
62
|
+
* // Geobuf: new Uint8Array(),
|
|
58
63
|
* // },
|
|
59
64
|
* // Status: "STRING_VALUE", // required
|
|
60
65
|
* // CreateTime: new Date("TIMESTAMP"), // required
|
|
@@ -5,7 +5,8 @@ import { ListGeofencesRequest, ListGeofencesResponse } from "../models/models_0"
|
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
8
|
-
export { __MetadataBearer
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
9
10
|
/**
|
|
10
11
|
* @public
|
|
11
12
|
*
|
|
@@ -58,6 +59,7 @@ declare const ListGeofencesCommand_base: {
|
|
|
58
59
|
* // ],
|
|
59
60
|
* // Radius: Number("double"), // required
|
|
60
61
|
* // },
|
|
62
|
+
* // Geobuf: new Uint8Array(),
|
|
61
63
|
* // },
|
|
62
64
|
* // Status: "STRING_VALUE", // required
|
|
63
65
|
* // CreateTime: new Date("TIMESTAMP"), // required
|
|
@@ -5,7 +5,8 @@ import { PutGeofenceRequest, PutGeofenceResponse } from "../models/models_0";
|
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
8
|
-
export { __MetadataBearer
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
9
10
|
/**
|
|
10
11
|
* @public
|
|
11
12
|
*
|
|
@@ -51,6 +52,7 @@ declare const PutGeofenceCommand_base: {
|
|
|
51
52
|
* ],
|
|
52
53
|
* Radius: Number("double"), // required
|
|
53
54
|
* },
|
|
55
|
+
* Geobuf: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
|
|
54
56
|
* },
|
|
55
57
|
* GeofenceProperties: { // PropertyMap
|
|
56
58
|
* "<keys>": "STRING_VALUE",
|