@aws-sdk/client-location 3.36.0 → 3.39.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.
Files changed (140) hide show
  1. package/CHANGELOG.md +42 -0
  2. package/dist-cjs/Location.js +0 -3
  3. package/dist-cjs/LocationClient.js +0 -8
  4. package/dist-cjs/commands/AssociateTrackerConsumerCommand.js +0 -30
  5. package/dist-cjs/commands/BatchDeleteDevicePositionHistoryCommand.js +0 -24
  6. package/dist-cjs/commands/BatchDeleteGeofenceCommand.js +0 -27
  7. package/dist-cjs/commands/BatchEvaluateGeofencesCommand.js +0 -44
  8. package/dist-cjs/commands/BatchGetDevicePositionCommand.js +0 -24
  9. package/dist-cjs/commands/BatchPutGeofenceCommand.js +0 -25
  10. package/dist-cjs/commands/BatchUpdateDevicePositionCommand.js +0 -34
  11. package/dist-cjs/commands/CalculateRouteCommand.js +0 -54
  12. package/dist-cjs/commands/CreateGeofenceCollectionCommand.js +0 -24
  13. package/dist-cjs/commands/CreateMapCommand.js +0 -25
  14. package/dist-cjs/commands/CreatePlaceIndexCommand.js +0 -25
  15. package/dist-cjs/commands/CreateRouteCalculatorCommand.js +0 -27
  16. package/dist-cjs/commands/CreateTrackerCommand.js +0 -25
  17. package/dist-cjs/commands/DeleteGeofenceCollectionCommand.js +0 -28
  18. package/dist-cjs/commands/DeleteMapCommand.js +0 -28
  19. package/dist-cjs/commands/DeletePlaceIndexCommand.js +0 -27
  20. package/dist-cjs/commands/DeleteRouteCalculatorCommand.js +0 -27
  21. package/dist-cjs/commands/DeleteTrackerCommand.js +0 -29
  22. package/dist-cjs/commands/DescribeGeofenceCollectionCommand.js +0 -24
  23. package/dist-cjs/commands/DescribeMapCommand.js +0 -24
  24. package/dist-cjs/commands/DescribePlaceIndexCommand.js +0 -24
  25. package/dist-cjs/commands/DescribeRouteCalculatorCommand.js +0 -24
  26. package/dist-cjs/commands/DescribeTrackerCommand.js +0 -24
  27. package/dist-cjs/commands/DisassociateTrackerConsumerCommand.js +0 -28
  28. package/dist-cjs/commands/GetDevicePositionCommand.js +0 -27
  29. package/dist-cjs/commands/GetDevicePositionHistoryCommand.js +0 -28
  30. package/dist-cjs/commands/GetGeofenceCommand.js +0 -24
  31. package/dist-cjs/commands/GetMapGlyphsCommand.js +0 -24
  32. package/dist-cjs/commands/GetMapSpritesCommand.js +0 -26
  33. package/dist-cjs/commands/GetMapStyleDescriptorCommand.js +0 -27
  34. package/dist-cjs/commands/GetMapTileCommand.js +0 -29
  35. package/dist-cjs/commands/ListDevicePositionsCommand.js +0 -24
  36. package/dist-cjs/commands/ListGeofenceCollectionsCommand.js +0 -24
  37. package/dist-cjs/commands/ListGeofencesCommand.js +0 -24
  38. package/dist-cjs/commands/ListMapsCommand.js +0 -24
  39. package/dist-cjs/commands/ListPlaceIndexesCommand.js +0 -24
  40. package/dist-cjs/commands/ListRouteCalculatorsCommand.js +0 -24
  41. package/dist-cjs/commands/ListTagsForResourceCommand.js +0 -24
  42. package/dist-cjs/commands/ListTrackerConsumersCommand.js +0 -24
  43. package/dist-cjs/commands/ListTrackersCommand.js +0 -24
  44. package/dist-cjs/commands/PutGeofenceCommand.js +0 -25
  45. package/dist-cjs/commands/SearchPlaceIndexForPositionCommand.js +0 -25
  46. package/dist-cjs/commands/SearchPlaceIndexForTextCommand.js +0 -32
  47. package/dist-cjs/commands/TagResourceCommand.js +0 -37
  48. package/dist-cjs/commands/UntagResourceCommand.js +0 -24
  49. package/dist-cjs/commands/UpdateGeofenceCollectionCommand.js +0 -24
  50. package/dist-cjs/commands/UpdateMapCommand.js +0 -24
  51. package/dist-cjs/commands/UpdatePlaceIndexCommand.js +0 -24
  52. package/dist-cjs/commands/UpdateRouteCalculatorCommand.js +0 -24
  53. package/dist-cjs/commands/UpdateTrackerCommand.js +0 -24
  54. package/dist-cjs/commands/index.js +53 -0
  55. package/dist-cjs/endpoints.js +6 -1
  56. package/dist-cjs/index.js +4 -62
  57. package/dist-cjs/models/models_0.js +0 -429
  58. package/dist-cjs/pagination/GetDevicePositionHistoryPaginator.js +0 -10
  59. package/dist-cjs/pagination/ListDevicePositionsPaginator.js +0 -10
  60. package/dist-cjs/pagination/ListGeofenceCollectionsPaginator.js +0 -10
  61. package/dist-cjs/pagination/ListGeofencesPaginator.js +0 -10
  62. package/dist-cjs/pagination/ListMapsPaginator.js +0 -10
  63. package/dist-cjs/pagination/ListPlaceIndexesPaginator.js +0 -10
  64. package/dist-cjs/pagination/ListRouteCalculatorsPaginator.js +0 -10
  65. package/dist-cjs/pagination/ListTrackerConsumersPaginator.js +0 -10
  66. package/dist-cjs/pagination/ListTrackersPaginator.js +0 -10
  67. package/dist-cjs/pagination/index.js +13 -0
  68. package/dist-cjs/protocols/Aws_restJson1.js +0 -5
  69. package/dist-cjs/runtimeConfig.browser.js +1 -5
  70. package/dist-cjs/runtimeConfig.js +1 -5
  71. package/dist-cjs/runtimeConfig.native.js +0 -3
  72. package/dist-cjs/runtimeConfig.shared.js +0 -3
  73. package/dist-es/commands/index.js +50 -0
  74. package/dist-es/endpoints.js +6 -1
  75. package/dist-es/index.js +4 -62
  76. package/dist-es/pagination/index.js +10 -0
  77. package/dist-types/commands/index.d.ts +50 -0
  78. package/dist-types/index.d.ts +4 -62
  79. package/dist-types/pagination/index.d.ts +10 -0
  80. package/dist-types/ts3.4/Location.d.ts +51 -292
  81. package/dist-types/ts3.4/LocationClient.d.ts +24 -89
  82. package/dist-types/ts3.4/commands/AssociateTrackerConsumerCommand.d.ts +2 -26
  83. package/dist-types/ts3.4/commands/BatchDeleteDevicePositionHistoryCommand.d.ts +2 -20
  84. package/dist-types/ts3.4/commands/BatchDeleteGeofenceCommand.d.ts +2 -23
  85. package/dist-types/ts3.4/commands/BatchEvaluateGeofencesCommand.d.ts +2 -40
  86. package/dist-types/ts3.4/commands/BatchGetDevicePositionCommand.d.ts +2 -20
  87. package/dist-types/ts3.4/commands/BatchPutGeofenceCommand.d.ts +2 -21
  88. package/dist-types/ts3.4/commands/BatchUpdateDevicePositionCommand.d.ts +2 -30
  89. package/dist-types/ts3.4/commands/CalculateRouteCommand.d.ts +2 -50
  90. package/dist-types/ts3.4/commands/CreateGeofenceCollectionCommand.d.ts +2 -20
  91. package/dist-types/ts3.4/commands/CreateMapCommand.d.ts +2 -21
  92. package/dist-types/ts3.4/commands/CreatePlaceIndexCommand.d.ts +2 -21
  93. package/dist-types/ts3.4/commands/CreateRouteCalculatorCommand.d.ts +2 -23
  94. package/dist-types/ts3.4/commands/CreateTrackerCommand.d.ts +2 -21
  95. package/dist-types/ts3.4/commands/DeleteGeofenceCollectionCommand.d.ts +2 -24
  96. package/dist-types/ts3.4/commands/DeleteMapCommand.d.ts +2 -24
  97. package/dist-types/ts3.4/commands/DeletePlaceIndexCommand.d.ts +2 -23
  98. package/dist-types/ts3.4/commands/DeleteRouteCalculatorCommand.d.ts +2 -23
  99. package/dist-types/ts3.4/commands/DeleteTrackerCommand.d.ts +2 -25
  100. package/dist-types/ts3.4/commands/DescribeGeofenceCollectionCommand.d.ts +2 -20
  101. package/dist-types/ts3.4/commands/DescribeMapCommand.d.ts +2 -20
  102. package/dist-types/ts3.4/commands/DescribePlaceIndexCommand.d.ts +2 -20
  103. package/dist-types/ts3.4/commands/DescribeRouteCalculatorCommand.d.ts +2 -20
  104. package/dist-types/ts3.4/commands/DescribeTrackerCommand.d.ts +2 -20
  105. package/dist-types/ts3.4/commands/DisassociateTrackerConsumerCommand.d.ts +2 -24
  106. package/dist-types/ts3.4/commands/GetDevicePositionCommand.d.ts +2 -23
  107. package/dist-types/ts3.4/commands/GetDevicePositionHistoryCommand.d.ts +2 -24
  108. package/dist-types/ts3.4/commands/GetGeofenceCommand.d.ts +2 -20
  109. package/dist-types/ts3.4/commands/GetMapGlyphsCommand.d.ts +2 -20
  110. package/dist-types/ts3.4/commands/GetMapSpritesCommand.d.ts +2 -22
  111. package/dist-types/ts3.4/commands/GetMapStyleDescriptorCommand.d.ts +2 -23
  112. package/dist-types/ts3.4/commands/GetMapTileCommand.d.ts +2 -25
  113. package/dist-types/ts3.4/commands/ListDevicePositionsCommand.d.ts +2 -20
  114. package/dist-types/ts3.4/commands/ListGeofenceCollectionsCommand.d.ts +2 -20
  115. package/dist-types/ts3.4/commands/ListGeofencesCommand.d.ts +2 -20
  116. package/dist-types/ts3.4/commands/ListMapsCommand.d.ts +2 -20
  117. package/dist-types/ts3.4/commands/ListPlaceIndexesCommand.d.ts +2 -20
  118. package/dist-types/ts3.4/commands/ListRouteCalculatorsCommand.d.ts +2 -20
  119. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -20
  120. package/dist-types/ts3.4/commands/ListTrackerConsumersCommand.d.ts +2 -20
  121. package/dist-types/ts3.4/commands/ListTrackersCommand.d.ts +2 -20
  122. package/dist-types/ts3.4/commands/PutGeofenceCommand.d.ts +2 -21
  123. package/dist-types/ts3.4/commands/SearchPlaceIndexForPositionCommand.d.ts +2 -21
  124. package/dist-types/ts3.4/commands/SearchPlaceIndexForTextCommand.d.ts +2 -28
  125. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -33
  126. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -20
  127. package/dist-types/ts3.4/commands/UpdateGeofenceCollectionCommand.d.ts +2 -20
  128. package/dist-types/ts3.4/commands/UpdateMapCommand.d.ts +2 -20
  129. package/dist-types/ts3.4/commands/UpdatePlaceIndexCommand.d.ts +2 -20
  130. package/dist-types/ts3.4/commands/UpdateRouteCalculatorCommand.d.ts +2 -20
  131. package/dist-types/ts3.4/commands/UpdateTrackerCommand.d.ts +2 -20
  132. package/dist-types/ts3.4/commands/index.d.ts +50 -0
  133. package/dist-types/ts3.4/index.d.ts +4 -62
  134. package/dist-types/ts3.4/models/models_0.d.ts +580 -3098
  135. package/dist-types/ts3.4/pagination/index.d.ts +10 -0
  136. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  137. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  138. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  139. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  140. package/package.json +32 -32
@@ -1,68 +1,41 @@
1
1
  import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
- /**
3
- * <p>The request was denied because of insufficient access or permissions. Check with an
4
- * administrator to verify your permissions.</p>
5
- */
2
+
6
3
  export interface AccessDeniedException extends __SmithyException, $MetadataBearer {
7
4
  name: "AccessDeniedException";
8
5
  $fault: "client";
9
6
  Message: string | undefined;
10
7
  }
11
8
  export declare namespace AccessDeniedException {
12
- /**
13
- * @internal
14
- */
9
+
15
10
  const filterSensitiveLog: (obj: AccessDeniedException) => any;
16
11
  }
17
12
  export interface AssociateTrackerConsumerRequest {
18
- /**
19
- * <p>The name of the tracker resource to be associated with a geofence collection.</p>
20
- */
13
+
21
14
  TrackerName: string | undefined;
22
- /**
23
- * <p>The Amazon Resource Name (ARN) for the geofence collection to be associated to tracker
24
- * resource. Used when you need to specify a resource across all AWS.</p>
25
- * <ul>
26
- * <li>
27
- * <p>Format example:
28
- * <code>arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer</code>
29
- * </p>
30
- * </li>
31
- * </ul>
32
- */
15
+
33
16
  ConsumerArn: string | undefined;
34
17
  }
35
18
  export declare namespace AssociateTrackerConsumerRequest {
36
- /**
37
- * @internal
38
- */
19
+
39
20
  const filterSensitiveLog: (obj: AssociateTrackerConsumerRequest) => any;
40
21
  }
41
22
  export interface AssociateTrackerConsumerResponse {
42
23
  }
43
24
  export declare namespace AssociateTrackerConsumerResponse {
44
- /**
45
- * @internal
46
- */
25
+
47
26
  const filterSensitiveLog: (obj: AssociateTrackerConsumerResponse) => any;
48
27
  }
49
- /**
50
- * <p>The request was unsuccessful because of a conflict.</p>
51
- */
28
+
52
29
  export interface ConflictException extends __SmithyException, $MetadataBearer {
53
30
  name: "ConflictException";
54
31
  $fault: "client";
55
32
  Message: string | undefined;
56
33
  }
57
34
  export declare namespace ConflictException {
58
- /**
59
- * @internal
60
- */
35
+
61
36
  const filterSensitiveLog: (obj: ConflictException) => any;
62
37
  }
63
- /**
64
- * <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
65
- */
38
+
66
39
  export interface InternalServerException extends __SmithyException, $MetadataBearer {
67
40
  name: "InternalServerException";
68
41
  $fault: "server";
@@ -70,46 +43,31 @@ export interface InternalServerException extends __SmithyException, $MetadataBea
70
43
  Message: string | undefined;
71
44
  }
72
45
  export declare namespace InternalServerException {
73
- /**
74
- * @internal
75
- */
46
+
76
47
  const filterSensitiveLog: (obj: InternalServerException) => any;
77
48
  }
78
- /**
79
- * <p>The resource that you've entered was not found in your AWS account.</p>
80
- */
49
+
81
50
  export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
82
51
  name: "ResourceNotFoundException";
83
52
  $fault: "client";
84
53
  Message: string | undefined;
85
54
  }
86
55
  export declare namespace ResourceNotFoundException {
87
- /**
88
- * @internal
89
- */
56
+
90
57
  const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
91
58
  }
92
- /**
93
- * <p>The operation was denied because the request would exceed the maximum <a href="https://docs.aws.amazon.com/location/latest/developerguide/location-quotas.html">quota</a>
94
- * set for Amazon Location Service.</p>
95
- */
59
+
96
60
  export interface ServiceQuotaExceededException extends __SmithyException, $MetadataBearer {
97
61
  name: "ServiceQuotaExceededException";
98
62
  $fault: "client";
99
- /**
100
- * <p>A message with the reason for the service quota exceeded exception error.</p>
101
- */
63
+
102
64
  Message: string | undefined;
103
65
  }
104
66
  export declare namespace ServiceQuotaExceededException {
105
- /**
106
- * @internal
107
- */
67
+
108
68
  const filterSensitiveLog: (obj: ServiceQuotaExceededException) => any;
109
69
  }
110
- /**
111
- * <p>The request was denied because of request throttling.</p>
112
- */
70
+
113
71
  export interface ThrottlingException extends __SmithyException, $MetadataBearer {
114
72
  name: "ThrottlingException";
115
73
  $fault: "client";
@@ -117,4146 +75,1670 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer
117
75
  Message: string | undefined;
118
76
  }
119
77
  export declare namespace ThrottlingException {
120
- /**
121
- * @internal
122
- */
78
+
123
79
  const filterSensitiveLog: (obj: ThrottlingException) => any;
124
80
  }
125
- /**
126
- * <p>The input failed to meet the constraints specified by the AWS service in a specified
127
- * field. </p>
128
- */
81
+
129
82
  export interface ValidationExceptionField {
130
- /**
131
- * <p>The field name where the invalid entry was detected.</p>
132
- */
83
+
133
84
  Name: string | undefined;
134
- /**
135
- * <p>A message with the reason for the validation exception error.</p>
136
- */
85
+
137
86
  Message: string | undefined;
138
87
  }
139
88
  export declare namespace ValidationExceptionField {
140
- /**
141
- * @internal
142
- */
89
+
143
90
  const filterSensitiveLog: (obj: ValidationExceptionField) => any;
144
91
  }
145
92
  export declare type ValidationExceptionReason = "CannotParse" | "FieldValidationFailed" | "Missing" | "Other" | "UnknownOperation";
146
- /**
147
- * <p>The input failed to meet the constraints specified by the AWS service. </p>
148
- */
93
+
149
94
  export interface ValidationException extends __SmithyException, $MetadataBearer {
150
95
  name: "ValidationException";
151
96
  $fault: "client";
152
97
  Message: string | undefined;
153
- /**
154
- * <p>A message with the reason for the validation exception error.</p>
155
- */
98
+
156
99
  Reason: ValidationExceptionReason | string | undefined;
157
- /**
158
- * <p>The field where the invalid entry was detected.</p>
159
- */
100
+
160
101
  FieldList: ValidationExceptionField[] | undefined;
161
102
  }
162
103
  export declare namespace ValidationException {
163
- /**
164
- * @internal
165
- */
104
+
166
105
  const filterSensitiveLog: (obj: ValidationException) => any;
167
106
  }
168
107
  export interface BatchDeleteDevicePositionHistoryRequest {
169
- /**
170
- * <p>The name of the tracker resource to delete the device position history from.</p>
171
- */
108
+
172
109
  TrackerName: string | undefined;
173
- /**
174
- * <p>Devices whose position history you want to delete.</p>
175
- * <ul>
176
- * <li>
177
- * <p>For example, for two devices:
178
- * <code>“DeviceIds” : [DeviceId1,DeviceId2]</code>
179
- * </p>
180
- * </li>
181
- * </ul>
182
- */
110
+
183
111
  DeviceIds: string[] | undefined;
184
112
  }
185
113
  export declare namespace BatchDeleteDevicePositionHistoryRequest {
186
- /**
187
- * @internal
188
- */
114
+
189
115
  const filterSensitiveLog: (obj: BatchDeleteDevicePositionHistoryRequest) => any;
190
116
  }
191
117
  export declare type BatchItemErrorCode = "AccessDeniedError" | "ConflictError" | "InternalServerError" | "ResourceNotFoundError" | "ThrottlingError" | "ValidationError";
192
- /**
193
- * <p>Contains the batch request error details associated with the request.</p>
194
- */
118
+
195
119
  export interface BatchItemError {
196
- /**
197
- * <p>The error code associated with the batch request error.</p>
198
- */
120
+
199
121
  Code?: BatchItemErrorCode | string;
200
- /**
201
- * <p>A message with the reason for the batch request error.</p>
202
- */
122
+
203
123
  Message?: string;
204
124
  }
205
125
  export declare namespace BatchItemError {
206
- /**
207
- * @internal
208
- */
126
+
209
127
  const filterSensitiveLog: (obj: BatchItemError) => any;
210
128
  }
211
- /**
212
- * <p>Contains the tracker resource details.</p>
213
- */
129
+
214
130
  export interface BatchDeleteDevicePositionHistoryError {
215
- /**
216
- * <p>The ID of the device for this position.</p>
217
- */
131
+
218
132
  DeviceId: string | undefined;
219
- /**
220
- * <p>Contains the batch request error details associated with the request.</p>
221
- */
133
+
222
134
  Error: BatchItemError | undefined;
223
135
  }
224
136
  export declare namespace BatchDeleteDevicePositionHistoryError {
225
- /**
226
- * @internal
227
- */
137
+
228
138
  const filterSensitiveLog: (obj: BatchDeleteDevicePositionHistoryError) => any;
229
139
  }
230
140
  export interface BatchDeleteDevicePositionHistoryResponse {
231
- /**
232
- * <p>Contains error details for each device history that failed to delete.</p>
233
- */
141
+
234
142
  Errors: BatchDeleteDevicePositionHistoryError[] | undefined;
235
143
  }
236
144
  export declare namespace BatchDeleteDevicePositionHistoryResponse {
237
- /**
238
- * @internal
239
- */
145
+
240
146
  const filterSensitiveLog: (obj: BatchDeleteDevicePositionHistoryResponse) => any;
241
147
  }
242
148
  export interface BatchDeleteGeofenceRequest {
243
- /**
244
- * <p>The geofence collection storing the geofences to be deleted.</p>
245
- */
149
+
246
150
  CollectionName: string | undefined;
247
- /**
248
- * <p>The batch of geofences to be deleted.</p>
249
- */
151
+
250
152
  GeofenceIds: string[] | undefined;
251
153
  }
252
154
  export declare namespace BatchDeleteGeofenceRequest {
253
- /**
254
- * @internal
255
- */
155
+
256
156
  const filterSensitiveLog: (obj: BatchDeleteGeofenceRequest) => any;
257
157
  }
258
- /**
259
- * <p>Contains error details for each geofence that failed to delete from the geofence
260
- * collection.</p>
261
- */
158
+
262
159
  export interface BatchDeleteGeofenceError {
263
- /**
264
- * <p>The geofence associated with the error message.</p>
265
- */
160
+
266
161
  GeofenceId: string | undefined;
267
- /**
268
- * <p>Contains details associated to the batch error.</p>
269
- */
162
+
270
163
  Error: BatchItemError | undefined;
271
164
  }
272
165
  export declare namespace BatchDeleteGeofenceError {
273
- /**
274
- * @internal
275
- */
166
+
276
167
  const filterSensitiveLog: (obj: BatchDeleteGeofenceError) => any;
277
168
  }
278
169
  export interface BatchDeleteGeofenceResponse {
279
- /**
280
- * <p>Contains error details for each geofence that failed to delete.</p>
281
- */
170
+
282
171
  Errors: BatchDeleteGeofenceError[] | undefined;
283
172
  }
284
173
  export declare namespace BatchDeleteGeofenceResponse {
285
- /**
286
- * @internal
287
- */
174
+
288
175
  const filterSensitiveLog: (obj: BatchDeleteGeofenceResponse) => any;
289
176
  }
290
- /**
291
- * <p>Contains the position update details for a device.</p>
292
- */
177
+
293
178
  export interface DevicePositionUpdate {
294
- /**
295
- * <p>The device associated to the position update.</p>
296
- */
179
+
297
180
  DeviceId: string | undefined;
298
- /**
299
- * <p>The timestamp at which the device's position was determined. Uses <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
300
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
301
- * </p>
302
- */
181
+
303
182
  SampleTime: Date | undefined;
304
- /**
305
- * <p>The latest device position defined in <a href="https://earth-info.nga.mil/GandG/wgs84/index.html">WGS 84</a> format:
306
- * <code>[X or longitude, Y or latitude]</code>.</p>
307
- */
183
+
308
184
  Position: number[] | undefined;
309
185
  }
310
186
  export declare namespace DevicePositionUpdate {
311
- /**
312
- * @internal
313
- */
187
+
314
188
  const filterSensitiveLog: (obj: DevicePositionUpdate) => any;
315
189
  }
316
190
  export interface BatchEvaluateGeofencesRequest {
317
- /**
318
- * <p>The geofence collection used in evaluating the position of devices against its
319
- * geofences.</p>
320
- */
191
+
321
192
  CollectionName: string | undefined;
322
- /**
323
- * <p>Contains device details for each device to be evaluated against the given geofence
324
- * collection.</p>
325
- */
193
+
326
194
  DevicePositionUpdates: DevicePositionUpdate[] | undefined;
327
195
  }
328
196
  export declare namespace BatchEvaluateGeofencesRequest {
329
- /**
330
- * @internal
331
- */
197
+
332
198
  const filterSensitiveLog: (obj: BatchEvaluateGeofencesRequest) => any;
333
199
  }
334
- /**
335
- * <p>Contains error details for each device that failed to evaluate its position against
336
- * the geofences in a given geofence collection.</p>
337
- */
200
+
338
201
  export interface BatchEvaluateGeofencesError {
339
- /**
340
- * <p>The device associated with the position evaluation error.</p>
341
- */
202
+
342
203
  DeviceId: string | undefined;
343
- /**
344
- * <p>Specifies a timestamp for when the error occurred in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
345
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
346
- * </p>
347
- */
204
+
348
205
  SampleTime: Date | undefined;
349
- /**
350
- * <p>Contains details associated to the batch error.</p>
351
- */
206
+
352
207
  Error: BatchItemError | undefined;
353
208
  }
354
209
  export declare namespace BatchEvaluateGeofencesError {
355
- /**
356
- * @internal
357
- */
210
+
358
211
  const filterSensitiveLog: (obj: BatchEvaluateGeofencesError) => any;
359
212
  }
360
213
  export interface BatchEvaluateGeofencesResponse {
361
- /**
362
- * <p>Contains error details for each device that failed to evaluate its position against
363
- * the given geofence collection.</p>
364
- */
214
+
365
215
  Errors: BatchEvaluateGeofencesError[] | undefined;
366
216
  }
367
217
  export declare namespace BatchEvaluateGeofencesResponse {
368
- /**
369
- * @internal
370
- */
218
+
371
219
  const filterSensitiveLog: (obj: BatchEvaluateGeofencesResponse) => any;
372
220
  }
373
221
  export interface BatchGetDevicePositionRequest {
374
- /**
375
- * <p>The tracker resource retrieving the device position.</p>
376
- */
222
+
377
223
  TrackerName: string | undefined;
378
- /**
379
- * <p>Devices whose position you want to retrieve.</p>
380
- * <ul>
381
- * <li>
382
- * <p>For example, for two devices:
383
- * <code>device-ids=DeviceId1&amp;device-ids=DeviceId2</code>
384
- * </p>
385
- * </li>
386
- * </ul>
387
- */
224
+
388
225
  DeviceIds: string[] | undefined;
389
226
  }
390
227
  export declare namespace BatchGetDevicePositionRequest {
391
- /**
392
- * @internal
393
- */
228
+
394
229
  const filterSensitiveLog: (obj: BatchGetDevicePositionRequest) => any;
395
230
  }
396
- /**
397
- * <p>Contains the device position details.</p>
398
- */
231
+
399
232
  export interface DevicePosition {
400
- /**
401
- * <p>The device whose position you retrieved.</p>
402
- */
233
+
403
234
  DeviceId?: string;
404
- /**
405
- * <p>The timestamp at which the device's position was determined. Uses <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
406
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
407
- */
235
+
408
236
  SampleTime: Date | undefined;
409
- /**
410
- * <p>The timestamp for when the tracker resource received the device position in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
411
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
412
- */
237
+
413
238
  ReceivedTime: Date | undefined;
414
- /**
415
- * <p>The last known device position.</p>
416
- */
239
+
417
240
  Position: number[] | undefined;
418
241
  }
419
242
  export declare namespace DevicePosition {
420
- /**
421
- * @internal
422
- */
243
+
423
244
  const filterSensitiveLog: (obj: DevicePosition) => any;
424
245
  }
425
- /**
426
- * <p>Contains error details for each device that didn't return a position.</p>
427
- */
246
+
428
247
  export interface BatchGetDevicePositionError {
429
- /**
430
- * <p>The ID of the device that didn't return a position.</p>
431
- */
248
+
432
249
  DeviceId: string | undefined;
433
- /**
434
- * <p>Contains details related to the error code.</p>
435
- */
250
+
436
251
  Error: BatchItemError | undefined;
437
252
  }
438
253
  export declare namespace BatchGetDevicePositionError {
439
- /**
440
- * @internal
441
- */
254
+
442
255
  const filterSensitiveLog: (obj: BatchGetDevicePositionError) => any;
443
256
  }
444
257
  export interface BatchGetDevicePositionResponse {
445
- /**
446
- * <p>Contains error details for each device that failed to send its position to the tracker
447
- * resource.</p>
448
- */
258
+
449
259
  Errors: BatchGetDevicePositionError[] | undefined;
450
- /**
451
- * <p>Contains device position details such as the device ID, position, and timestamps for
452
- * when the position was received and sampled.</p>
453
- */
260
+
454
261
  DevicePositions: DevicePosition[] | undefined;
455
262
  }
456
263
  export declare namespace BatchGetDevicePositionResponse {
457
- /**
458
- * @internal
459
- */
264
+
460
265
  const filterSensitiveLog: (obj: BatchGetDevicePositionResponse) => any;
461
266
  }
462
- /**
463
- * <p>Contains the geofence geometry details.</p>
464
- * <note>
465
- * <p>Amazon Location doesn't currently support polygons with holes, multipolygons, polygons
466
- * that are wound clockwise, or that cross the antimeridian. </p>
467
- * </note>
468
- */
267
+
469
268
  export interface GeofenceGeometry {
470
- /**
471
- * <p>An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices,
472
- * where the first and last vertex are the same to form a closed boundary. Each vertex is a
473
- * 2-dimensional point of the form: <code>[longitude, latitude]</code>. </p>
474
- * <p>The first linear ring is an outer ring, describing the polygon's boundary. Subsequent
475
- * linear rings may be inner or outer rings to describe holes and islands. Outer rings must
476
- * list their vertices in counter-clockwise order around the ring's center, where the left
477
- * side is the polygon's exterior. Inner rings must list their vertices in clockwise order,
478
- * where the left side is the polygon's interior.</p>
479
- */
269
+
480
270
  Polygon?: number[][][];
481
271
  }
482
272
  export declare namespace GeofenceGeometry {
483
- /**
484
- * @internal
485
- */
273
+
486
274
  const filterSensitiveLog: (obj: GeofenceGeometry) => any;
487
275
  }
488
- /**
489
- * <p>Contains geofence geometry details. </p>
490
- */
276
+
491
277
  export interface BatchPutGeofenceRequestEntry {
492
- /**
493
- * <p>The identifier for the geofence to be stored in a given geofence collection.</p>
494
- */
278
+
495
279
  GeofenceId: string | undefined;
496
- /**
497
- * <p>Contains the polygon details to specify the position of the geofence.</p>
498
- * <note>
499
- * <p>Each <a href="https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html">geofence polygon</a> can have a maximum of 1,000 vertices.</p>
500
- * </note>
501
- */
280
+
502
281
  Geometry: GeofenceGeometry | undefined;
503
282
  }
504
283
  export declare namespace BatchPutGeofenceRequestEntry {
505
- /**
506
- * @internal
507
- */
284
+
508
285
  const filterSensitiveLog: (obj: BatchPutGeofenceRequestEntry) => any;
509
286
  }
510
287
  export interface BatchPutGeofenceRequest {
511
- /**
512
- * <p>The geofence collection storing the geofences.</p>
513
- */
288
+
514
289
  CollectionName: string | undefined;
515
- /**
516
- * <p>The batch of geofences to be stored in a geofence collection.</p>
517
- */
290
+
518
291
  Entries: BatchPutGeofenceRequestEntry[] | undefined;
519
292
  }
520
293
  export declare namespace BatchPutGeofenceRequest {
521
- /**
522
- * @internal
523
- */
294
+
524
295
  const filterSensitiveLog: (obj: BatchPutGeofenceRequest) => any;
525
296
  }
526
- /**
527
- * <p>Contains error details for each geofence that failed to be stored in a given geofence
528
- * collection.</p>
529
- */
297
+
530
298
  export interface BatchPutGeofenceError {
531
- /**
532
- * <p>The geofence associated with the error message.</p>
533
- */
299
+
534
300
  GeofenceId: string | undefined;
535
- /**
536
- * <p>Contains details associated to the batch error.</p>
537
- */
301
+
538
302
  Error: BatchItemError | undefined;
539
303
  }
540
304
  export declare namespace BatchPutGeofenceError {
541
- /**
542
- * @internal
543
- */
305
+
544
306
  const filterSensitiveLog: (obj: BatchPutGeofenceError) => any;
545
307
  }
546
- /**
547
- * <p>Contains a summary of each geofence that was successfully stored in a given geofence
548
- * collection.</p>
549
- */
308
+
550
309
  export interface BatchPutGeofenceSuccess {
551
- /**
552
- * <p>The geofence successfully stored in a geofence collection.</p>
553
- */
310
+
554
311
  GeofenceId: string | undefined;
555
- /**
556
- * <p>The timestamp for when the geofence was stored in a geofence collection in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
557
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
558
- * </p>
559
- */
312
+
560
313
  CreateTime: Date | undefined;
561
- /**
562
- * <p>The timestamp for when the geofence was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
563
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
564
- * </p>
565
- */
314
+
566
315
  UpdateTime: Date | undefined;
567
316
  }
568
317
  export declare namespace BatchPutGeofenceSuccess {
569
- /**
570
- * @internal
571
- */
318
+
572
319
  const filterSensitiveLog: (obj: BatchPutGeofenceSuccess) => any;
573
320
  }
574
321
  export interface BatchPutGeofenceResponse {
575
- /**
576
- * <p>Contains each geofence that was successfully stored in a geofence collection.</p>
577
- */
322
+
578
323
  Successes: BatchPutGeofenceSuccess[] | undefined;
579
- /**
580
- * <p>Contains additional error details for each geofence that failed to be stored in a
581
- * geofence collection.</p>
582
- */
324
+
583
325
  Errors: BatchPutGeofenceError[] | undefined;
584
326
  }
585
327
  export declare namespace BatchPutGeofenceResponse {
586
- /**
587
- * @internal
588
- */
328
+
589
329
  const filterSensitiveLog: (obj: BatchPutGeofenceResponse) => any;
590
330
  }
591
331
  export interface BatchUpdateDevicePositionRequest {
592
- /**
593
- * <p>The name of the tracker resource to update.</p>
594
- */
332
+
595
333
  TrackerName: string | undefined;
596
- /**
597
- * <p>Contains the position update details for each device.</p>
598
- */
334
+
599
335
  Updates: DevicePositionUpdate[] | undefined;
600
336
  }
601
337
  export declare namespace BatchUpdateDevicePositionRequest {
602
- /**
603
- * @internal
604
- */
338
+
605
339
  const filterSensitiveLog: (obj: BatchUpdateDevicePositionRequest) => any;
606
340
  }
607
- /**
608
- * <p>Contains error details for each device that failed to update its position.</p>
609
- */
341
+
610
342
  export interface BatchUpdateDevicePositionError {
611
- /**
612
- * <p>The device associated with the failed location update.</p>
613
- */
343
+
614
344
  DeviceId: string | undefined;
615
- /**
616
- * <p>The timestamp at which the device position was determined. Uses <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
617
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
618
- */
345
+
619
346
  SampleTime: Date | undefined;
620
- /**
621
- * <p>Contains details related to the error code such as the error code and error
622
- * message.</p>
623
- */
347
+
624
348
  Error: BatchItemError | undefined;
625
349
  }
626
350
  export declare namespace BatchUpdateDevicePositionError {
627
- /**
628
- * @internal
629
- */
351
+
630
352
  const filterSensitiveLog: (obj: BatchUpdateDevicePositionError) => any;
631
353
  }
632
354
  export interface BatchUpdateDevicePositionResponse {
633
- /**
634
- * <p>Contains error details for each device that failed to update its position.</p>
635
- */
355
+
636
356
  Errors: BatchUpdateDevicePositionError[] | undefined;
637
357
  }
638
358
  export declare namespace BatchUpdateDevicePositionResponse {
639
- /**
640
- * @internal
641
- */
359
+
642
360
  const filterSensitiveLog: (obj: BatchUpdateDevicePositionResponse) => any;
643
361
  }
644
- /**
645
- * <p>Contains details about additional route preferences for requests that specify
646
- * <code>TravelMode</code> as <code>Car</code>.</p>
647
- */
362
+
648
363
  export interface CalculateRouteCarModeOptions {
649
- /**
650
- * <p>Avoids ferries when calculating routes.</p>
651
- * <p>Default Value: <code>false</code>
652
- * </p>
653
- * <p>Valid Values: <code>false</code> | <code>true</code>
654
- * </p>
655
- */
364
+
656
365
  AvoidFerries?: boolean;
657
- /**
658
- * <p>Avoids tolls when calculating routes.</p>
659
- * <p>Default Value: <code>false</code>
660
- * </p>
661
- * <p>Valid Values: <code>false</code> | <code>true</code>
662
- * </p>
663
- */
366
+
664
367
  AvoidTolls?: boolean;
665
368
  }
666
369
  export declare namespace CalculateRouteCarModeOptions {
667
- /**
668
- * @internal
669
- */
370
+
670
371
  const filterSensitiveLog: (obj: CalculateRouteCarModeOptions) => any;
671
372
  }
672
373
  export declare type DistanceUnit = "Kilometers" | "Miles";
673
374
  export declare type TravelMode = "Car" | "Truck" | "Walking";
674
375
  export declare type DimensionUnit = "Feet" | "Meters";
675
- /**
676
- * <p>Contains details about the truck dimensions in the unit of measurement that you
677
- * specify. Used to filter out roads that can't support or allow the specified dimensions
678
- * for requests that specify <code>TravelMode</code> as <code>Truck</code>.</p>
679
- */
376
+
680
377
  export interface TruckDimensions {
681
- /**
682
- * <p>The length of the truck.</p>
683
- * <ul>
684
- * <li>
685
- * <p>For example, <code>15.5</code>.</p>
686
- * </li>
687
- * </ul>
688
- */
378
+
689
379
  Length?: number;
690
- /**
691
- * <p>The height of the truck.</p>
692
- * <ul>
693
- * <li>
694
- * <p>For example, <code>4.5</code>.</p>
695
- * </li>
696
- * </ul>
697
- */
380
+
698
381
  Height?: number;
699
- /**
700
- * <p>The width of the truck.</p>
701
- * <ul>
702
- * <li>
703
- * <p>For example, <code>4.5</code>.</p>
704
- * </li>
705
- * </ul>
706
- */
382
+
707
383
  Width?: number;
708
- /**
709
- * <p> Specifies the unit of measurement for the truck dimensions.</p>
710
- * <p>Default Value: <code>Meters</code>
711
- * </p>
712
- */
384
+
713
385
  Unit?: DimensionUnit | string;
714
386
  }
715
387
  export declare namespace TruckDimensions {
716
- /**
717
- * @internal
718
- */
388
+
719
389
  const filterSensitiveLog: (obj: TruckDimensions) => any;
720
390
  }
721
391
  export declare type VehicleWeightUnit = "Kilograms" | "Pounds";
722
- /**
723
- * <p>Contains details about the truck's weight specifications. Used to avoid roads that
724
- * can't support or allow the total weight for requests that specify
725
- * <code>TravelMode</code> as <code>Truck</code>.</p>
726
- */
392
+
727
393
  export interface TruckWeight {
728
- /**
729
- * <p>The total weight of the truck. </p>
730
- * <ul>
731
- * <li>
732
- * <p>For example, <code>3500</code>.</p>
733
- * </li>
734
- * </ul>
735
- */
394
+
736
395
  Total?: number;
737
- /**
738
- * <p>The unit of measurement to use for the truck weight.</p>
739
- * <p>Default Value: <code>Kilograms</code>
740
- * </p>
741
- */
396
+
742
397
  Unit?: VehicleWeightUnit | string;
743
398
  }
744
399
  export declare namespace TruckWeight {
745
- /**
746
- * @internal
747
- */
400
+
748
401
  const filterSensitiveLog: (obj: TruckWeight) => any;
749
402
  }
750
- /**
751
- * <p>Contains details about additional route preferences for requests that specify
752
- * <code>TravelMode</code> as <code>Truck</code>.</p>
753
- */
403
+
754
404
  export interface CalculateRouteTruckModeOptions {
755
- /**
756
- * <p>Avoids ferries when calculating routes.</p>
757
- * <p>Default Value: <code>false</code>
758
- * </p>
759
- * <p>Valid Values: <code>false</code> | <code>true</code>
760
- * </p>
761
- */
405
+
762
406
  AvoidFerries?: boolean;
763
- /**
764
- * <p>Avoids ferries when calculating routes.</p>
765
- * <p>Default Value: <code>false</code>
766
- * </p>
767
- * <p>Valid Values: <code>false</code> | <code>true</code>
768
- * </p>
769
- */
407
+
770
408
  AvoidTolls?: boolean;
771
- /**
772
- * <p>Specifies the truck's dimension specifications including length, height, width, and
773
- * unit of measurement. Used to avoid roads that can't support the truck's
774
- * dimensions.</p>
775
- */
409
+
776
410
  Dimensions?: TruckDimensions;
777
- /**
778
- * <p>Specifies the truck's weight specifications including total weight and unit of
779
- * measurement. Used to avoid roads that can't support the truck's weight.</p>
780
- */
411
+
781
412
  Weight?: TruckWeight;
782
413
  }
783
414
  export declare namespace CalculateRouteTruckModeOptions {
784
- /**
785
- * @internal
786
- */
415
+
787
416
  const filterSensitiveLog: (obj: CalculateRouteTruckModeOptions) => any;
788
417
  }
789
418
  export interface CalculateRouteRequest {
790
- /**
791
- * <p>The name of the route calculator resource that you want to use to calculate a route. </p>
792
- */
419
+
793
420
  CalculatorName: string | undefined;
794
- /**
795
- * <p>The start position for the route. Defined in <a href="https://earth-info.nga.mil/GandG/wgs84/index.html">WGS 84</a> format:
796
- * <code>[longitude, latitude]</code>.</p>
797
- * <ul>
798
- * <li>
799
- * <p>For example, <code>[-123.115, 49.285]</code>
800
- * </p>
801
- * </li>
802
- * </ul>
803
- * <note>
804
- * <p>If you specify a departure that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road">moves the
805
- * position to the nearest road</a>. If Esri is the provider for your route calculator,
806
- * specifying a route that is longer than 400 km returns a <code>400 RoutesValidationException</code> error.</p>
807
- * </note>
808
- * <p>Valid Values: <code>[-180 to 180,-90 to 90]</code>
809
- * </p>
810
- */
421
+
811
422
  DeparturePosition: number[] | undefined;
812
- /**
813
- * <p>The finish position for the route. Defined in <a href="https://earth-info.nga.mil/GandG/wgs84/index.html">WGS 84</a> format:
814
- * <code>[longitude, latitude]</code>.</p>
815
- * <ul>
816
- * <li>
817
- * <p> For example, <code>[-122.339, 47.615]</code>
818
- * </p>
819
- * </li>
820
- * </ul>
821
- * <note>
822
- * <p>If you specify a destination that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road">moves the position to the nearest road</a>. </p>
823
- * </note>
824
- * <p>Valid Values: <code>[-180 to 180,-90 to 90]</code>
825
- * </p>
826
- */
423
+
827
424
  DestinationPosition: number[] | undefined;
828
- /**
829
- * <p>Specifies an ordered list of up to 23 intermediate positions to include along a route
830
- * between the departure position and destination position. </p>
831
- * <ul>
832
- * <li>
833
- * <p>For example, from the <code>DeparturePosition</code>
834
- * <code>[-123.115, 49.285]</code>, the route follows the order that the waypoint
835
- * positions are given <code>[[-122.757, 49.0021],[-122.349, 47.620]]</code>
836
- * </p>
837
- * </li>
838
- * </ul>
839
- * <note>
840
- * <p>If you specify a waypoint position that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road">moves the position to the nearest road</a>. </p>
841
- * <p>Specifying more than 23 waypoints returns a <code>400 ValidationException</code>
842
- * error.</p>
843
- * <p>If Esri is the provider for your route calculator, specifying a
844
- * route that is longer than 400 km returns a <code>400 RoutesValidationException</code> error.</p>
845
- * </note>
846
- * <p>Valid Values: <code>[-180 to 180,-90 to 90]</code>
847
- * </p>
848
- */
425
+
849
426
  WaypointPositions?: number[][];
850
- /**
851
- * <p>Specifies the mode of transport when calculating a route. Used in estimating the speed
852
- * of travel and road compatibility.</p>
853
- * <p>The <code>TravelMode</code> you specify determines how you specify route preferences: </p>
854
- * <ul>
855
- * <li>
856
- * <p>If traveling by <code>Car</code> use the <code>CarModeOptions</code>
857
- * parameter.</p>
858
- * </li>
859
- * <li>
860
- * <p>If traveling by <code>Truck</code> use the <code>TruckModeOptions</code>
861
- * parameter.</p>
862
- * </li>
863
- * </ul>
864
- * <p>Default Value: <code>Car</code>
865
- * </p>
866
- */
427
+
867
428
  TravelMode?: TravelMode | string;
868
- /**
869
- * <p>Specifies the desired time of departure. Uses the given time to calculate a route.
870
- * Otherwise, the best time of day to travel with the best traffic conditions is used to
871
- * calculate the route.</p>
872
- * <note>
873
- * <p>Setting a departure time in the past returns a <code>400
874
- * ValidationException</code> error.</p>
875
- * </note>
876
- * <ul>
877
- * <li>
878
- * <p>In <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO
879
- * 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. For example,
880
- * <code>2020–07-2T12:15:20.000Z+01:00</code>
881
- * </p>
882
- * </li>
883
- * </ul>
884
- */
429
+
885
430
  DepartureTime?: Date;
886
- /**
887
- * <p>Sets the time of departure as the current time. Uses the current time to calculate a
888
- * route. Otherwise, the best time of day to travel with the best traffic conditions is
889
- * used to calculate the route.</p>
890
- * <p>Default Value: <code>false</code>
891
- * </p>
892
- * <p>Valid Values: <code>false</code> | <code>true</code>
893
- * </p>
894
- */
431
+
895
432
  DepartNow?: boolean;
896
- /**
897
- * <p>Set the unit system to specify the distance.</p>
898
- * <p>Default Value: <code>Kilometers</code>
899
- * </p>
900
- */
433
+
901
434
  DistanceUnit?: DistanceUnit | string;
902
- /**
903
- * <p>Set to include the geometry details in the result for each path between a pair of
904
- * positions.</p>
905
- * <p>Default Value: <code>false</code>
906
- * </p>
907
- * <p>Valid Values: <code>false</code> | <code>true</code>
908
- * </p>
909
- */
435
+
910
436
  IncludeLegGeometry?: boolean;
911
- /**
912
- * <p>Specifies route preferences when traveling by <code>Car</code>, such as avoiding
913
- * routes that use ferries or tolls.</p>
914
- * <p>Requirements: <code>TravelMode</code> must be specified as <code>Car</code>.</p>
915
- */
437
+
916
438
  CarModeOptions?: CalculateRouteCarModeOptions;
917
- /**
918
- * <p>Specifies route preferences when traveling by <code>Truck</code>, such as avoiding
919
- * routes that use ferries or tolls, and truck specifications to consider when choosing an
920
- * optimal road.</p>
921
- * <p>Requirements: <code>TravelMode</code> must be specified as <code>Truck</code>.</p>
922
- */
439
+
923
440
  TruckModeOptions?: CalculateRouteTruckModeOptions;
924
441
  }
925
442
  export declare namespace CalculateRouteRequest {
926
- /**
927
- * @internal
928
- */
443
+
929
444
  const filterSensitiveLog: (obj: CalculateRouteRequest) => any;
930
445
  }
931
- /**
932
- * <p>Contains the geometry details for each path between a pair of positions. Used in
933
- * plotting a route leg on a map.</p>
934
- */
446
+
935
447
  export interface LegGeometry {
936
- /**
937
- * <p>An ordered list of positions used to plot a route on a map. </p>
938
- * <p>The first position is closest to the start position for the leg, and the last position
939
- * is the closest to the end position for the leg.</p>
940
- * <ul>
941
- * <li>
942
- * <p>For example, <code>[[-123.117, 49.284],[-123.115, 49.285],[-123.115,
943
- * 49.285]]</code>
944
- * </p>
945
- * </li>
946
- * </ul>
947
- */
448
+
948
449
  LineString?: number[][];
949
450
  }
950
451
  export declare namespace LegGeometry {
951
- /**
952
- * @internal
953
- */
452
+
954
453
  const filterSensitiveLog: (obj: LegGeometry) => any;
955
454
  }
956
- /**
957
- * <p> Represents an element of a leg within a route. A step contains instructions for how
958
- * to move to the next step in the leg. </p>
959
- */
455
+
960
456
  export interface Step {
961
- /**
962
- * <p>The starting position of a step. If the position is the first step in the leg, this
963
- * position is the same as the start position of the leg.</p>
964
- */
457
+
965
458
  StartPosition: number[] | undefined;
966
- /**
967
- * <p>The end position of a step. If the position the last step in the leg, this position is
968
- * the same as the end position of the leg.</p>
969
- */
459
+
970
460
  EndPosition: number[] | undefined;
971
- /**
972
- * <p>The travel distance between the step's <code>StartPosition</code> and
973
- * <code>EndPosition</code>.</p>
974
- */
461
+
975
462
  Distance: number | undefined;
976
- /**
977
- * <p>The estimated travel time, in seconds, from the step's <code>StartPosition</code> to
978
- * the <code>EndPosition</code>. . The travel mode and departure time that you specify in
979
- * the request determines the calculated time.</p>
980
- */
463
+
981
464
  DurationSeconds: number | undefined;
982
- /**
983
- * <p>Represents the start position, or index, in a sequence of steps within the leg's line
984
- * string geometry. For example, the index of the first step in a leg geometry is
985
- * <code>0</code>. </p>
986
- * <p>Included in the response for queries that set <code>IncludeLegGeometry</code> to
987
- * <code>True</code>. </p>
988
- */
465
+
989
466
  GeometryOffset?: number;
990
467
  }
991
468
  export declare namespace Step {
992
- /**
993
- * @internal
994
- */
469
+
995
470
  const filterSensitiveLog: (obj: Step) => any;
996
471
  }
997
- /**
998
- * <p>Contains the calculated route's details for each path between a pair of positions. The
999
- * number of legs returned corresponds to one fewer than the total number of positions in
1000
- * the request. </p>
1001
- * <p>For example, a route with a departure position and destination position returns one
1002
- * leg with the positions <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road">snapped to a nearby road</a>:</p>
1003
- * <ul>
1004
- * <li>
1005
- * <p>The <code>StartPosition</code> is the departure position.</p>
1006
- * </li>
1007
- * <li>
1008
- * <p>The <code>EndPosition</code> is the destination position.</p>
1009
- * </li>
1010
- * </ul>
1011
- * <p>A route with a waypoint between the departure and destination position returns two
1012
- * legs with the positions snapped to a nearby road:</p>
1013
- * <ul>
1014
- * <li>
1015
- * <p>Leg 1: The <code>StartPosition</code> is the departure position . The
1016
- * <code>EndPosition</code> is the waypoint positon.</p>
1017
- * </li>
1018
- * <li>
1019
- * <p>Leg 2: The <code>StartPosition</code> is the waypoint position. The
1020
- * <code>EndPosition</code> is the destination position.</p>
1021
- * </li>
1022
- * </ul>
1023
- */
472
+
1024
473
  export interface Leg {
1025
- /**
1026
- * <p>The starting position of the leg. Follows the format
1027
- * <code>[longitude,latitude]</code>.</p>
1028
- * <note>
1029
- * <p>If the <code>StartPosition</code> isn't located on a road, it's <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road">snapped to a nearby road</a>. </p>
1030
- * </note>
1031
- */
474
+
1032
475
  StartPosition: number[] | undefined;
1033
- /**
1034
- * <p>The terminating position of the leg. Follows the format
1035
- * <code>[longitude,latitude]</code>.</p>
1036
- * <note>
1037
- * <p>If the <code>EndPosition</code> isn't located on a road, it's <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road">snapped to a nearby road</a>. </p>
1038
- * </note>
1039
- */
476
+
1040
477
  EndPosition: number[] | undefined;
1041
- /**
1042
- * <p>The distance between the leg's <code>StartPosition</code> and <code>EndPosition</code>
1043
- * along a calculated route. </p>
1044
- * <ul>
1045
- * <li>
1046
- * <p>The default measurement is <code>Kilometers</code> unless the request
1047
- * specifies a <code>DistanceUnit</code> of <code>Miles</code>.</p>
1048
- * </li>
1049
- * </ul>
1050
- */
478
+
1051
479
  Distance: number | undefined;
1052
- /**
1053
- * <p>The estimated travel time between the leg's <code>StartPosition</code> and
1054
- * <code>EndPosition</code>. The travel mode and departure time that you specify in the
1055
- * request determines the calculated time.</p>
1056
- */
480
+
1057
481
  DurationSeconds: number | undefined;
1058
- /**
1059
- * <p>Contains the calculated route's path as a linestring geometry.</p>
1060
- */
482
+
1061
483
  Geometry?: LegGeometry;
1062
- /**
1063
- * <p>Contains a list of steps, which represent subsections of a leg. Each step provides
1064
- * instructions for how to move to the next step in the leg such as the step's start
1065
- * position, end position, travel distance, travel duration, and geometry offset.</p>
1066
- */
484
+
1067
485
  Steps: Step[] | undefined;
1068
486
  }
1069
487
  export declare namespace Leg {
1070
- /**
1071
- * @internal
1072
- */
488
+
1073
489
  const filterSensitiveLog: (obj: Leg) => any;
1074
490
  }
1075
- /**
1076
- * <p>A summary of the calculated route.</p>
1077
- */
491
+
1078
492
  export interface CalculateRouteSummary {
1079
- /**
1080
- * <p>Specifies a geographical box surrounding a route. Used to zoom into a route when
1081
- * displaying it in a map. For example, <code>[min x, min y, max x, max y]</code>.</p>
1082
- * <p>The first 2 <code>bbox</code> parameters describe the lower southwest corner: </p>
1083
- * <ul>
1084
- * <li>
1085
- * <p>The first <code>bbox</code> position is the X coordinate or longitude of the
1086
- * lower southwest corner. </p>
1087
- * </li>
1088
- * <li>
1089
- * <p>The second <code>bbox</code> position is the Y coordinate or latitude of the
1090
- * lower southwest corner. </p>
1091
- * </li>
1092
- * </ul>
1093
- * <p>The next 2 <code>bbox</code> parameters describe the upper northeast corner: </p>
1094
- * <ul>
1095
- * <li>
1096
- * <p>The third <code>bbox</code> position is the X coordinate, or longitude of the
1097
- * upper northeast corner. </p>
1098
- * </li>
1099
- * <li>
1100
- * <p>The fourth <code>bbox</code> position is the Y coordinate, or latitude of the
1101
- * upper northeast corner. </p>
1102
- * </li>
1103
- * </ul>
1104
- */
493
+
1105
494
  RouteBBox: number[] | undefined;
1106
- /**
1107
- * <p>The data provider of traffic and road network data used to calculate the route.
1108
- * Indicates one of the available providers:</p>
1109
- * <ul>
1110
- * <li>
1111
- * <p>
1112
- * <code>Esri</code>
1113
- * </p>
1114
- * </li>
1115
- * <li>
1116
- * <p>
1117
- * <code>Here</code>
1118
- * </p>
1119
- * </li>
1120
- * </ul>
1121
- * <p>For more information about data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
1122
- */
495
+
1123
496
  DataSource: string | undefined;
1124
- /**
1125
- * <p>The total distance covered by the route. The sum of the distance travelled between
1126
- * every stop on the route.</p>
1127
- * <note>
1128
- * <p>If Esri is the data source for the route calculator, the route distance can’t
1129
- * be greater than 400 km. If the route exceeds 400 km, the response is a
1130
- * <code>400 RoutesValidationException</code> error.</p>
1131
- * </note>
1132
- */
497
+
1133
498
  Distance: number | undefined;
1134
- /**
1135
- * <p>The total travel time for the route measured in seconds. The sum of the travel time
1136
- * between every stop on the
1137
- * route.</p>
1138
- */
499
+
1139
500
  DurationSeconds: number | undefined;
1140
- /**
1141
- * <p>The unit of measurement for the distance.</p>
1142
- */
501
+
1143
502
  DistanceUnit: DistanceUnit | string | undefined;
1144
503
  }
1145
504
  export declare namespace CalculateRouteSummary {
1146
- /**
1147
- * @internal
1148
- */
505
+
1149
506
  const filterSensitiveLog: (obj: CalculateRouteSummary) => any;
1150
507
  }
1151
- /**
1152
- * <p>Returns the result of the route calculation. Metadata includes legs and route
1153
- * summary.</p>
1154
- */
508
+
1155
509
  export interface CalculateRouteResponse {
1156
- /**
1157
- * <p>Contains details about each path between a pair of positions included along a route
1158
- * such as: <code>StartPosition</code>, <code>EndPosition</code>, <code>Distance</code>,
1159
- * <code>DurationSeconds</code>, <code>Geometry</code>, and <code>Steps</code>. The
1160
- * number of legs returned corresponds to one fewer than the total number of positions in
1161
- * the request. </p>
1162
- * <p>For example, a route with a departure position and destination position returns one
1163
- * leg with the positions <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road">snapped to a nearby road</a>:</p>
1164
- * <ul>
1165
- * <li>
1166
- * <p>The <code>StartPosition</code> is the departure position.</p>
1167
- * </li>
1168
- * <li>
1169
- * <p>The <code>EndPosition</code> is the destination position.</p>
1170
- * </li>
1171
- * </ul>
1172
- * <p>A route with a waypoint between the departure and destination position returns two
1173
- * legs with the positions snapped to a nearby road:</p>
1174
- * <ul>
1175
- * <li>
1176
- * <p>Leg 1: The <code>StartPosition</code> is the departure position . The
1177
- * <code>EndPosition</code> is the waypoint positon.</p>
1178
- * </li>
1179
- * <li>
1180
- * <p>Leg 2: The <code>StartPosition</code> is the waypoint position. The
1181
- * <code>EndPosition</code> is the destination position.</p>
1182
- * </li>
1183
- * </ul>
1184
- */
510
+
1185
511
  Legs: Leg[] | undefined;
1186
- /**
1187
- * <p>Contains information about the whole route, such as: <code>RouteBBox</code>,
1188
- * <code>DataSource</code>, <code>Distance</code>, <code>DistanceUnit</code>, and
1189
- * <code>DurationSeconds</code>.</p>
1190
- */
512
+
1191
513
  Summary: CalculateRouteSummary | undefined;
1192
514
  }
1193
515
  export declare namespace CalculateRouteResponse {
1194
- /**
1195
- * @internal
1196
- */
516
+
1197
517
  const filterSensitiveLog: (obj: CalculateRouteResponse) => any;
1198
518
  }
1199
519
  export declare type PricingPlan = "MobileAssetManagement" | "MobileAssetTracking" | "RequestBasedUsage";
1200
520
  export interface CreateGeofenceCollectionRequest {
1201
- /**
1202
- * <p>A custom name for the geofence collection.</p>
1203
- * <p>Requirements:</p>
1204
- * <ul>
1205
- * <li>
1206
- * <p>Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods
1207
- * (.), and underscores (_). </p>
1208
- * </li>
1209
- * <li>
1210
- * <p>Must be a unique geofence collection name.</p>
1211
- * </li>
1212
- * <li>
1213
- * <p>No spaces allowed. For example, <code>ExampleGeofenceCollection</code>.</p>
1214
- * </li>
1215
- * </ul>
1216
- */
521
+
1217
522
  CollectionName: string | undefined;
1218
- /**
1219
- * <p>Specifies the pricing plan for the geofence collection.</p>
1220
- * <p>For additional details and restrictions on each pricing plan option, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing
1221
- * page</a>.</p>
1222
- */
523
+
1223
524
  PricingPlan: PricingPlan | string | undefined;
1224
- /**
1225
- * <p>Specifies the data provider for the geofence collection.</p>
1226
- * <ul>
1227
- * <li>
1228
- * <p>Required value for the following pricing plans: <code>MobileAssetTracking
1229
- * </code>| <code>MobileAssetManagement</code>
1230
- * </p>
1231
- * </li>
1232
- * </ul>
1233
- * <p>For more information about <a href="https://aws.amazon.com/location/data-providers/">Data Providers</a>, and <a href="https://aws.amazon.com/location/pricing/">Pricing plans</a>, see the Amazon Location
1234
- * Service product page.</p>
1235
- * <note>
1236
- * <p>Amazon Location Service only uses <code>PricingPlanDataSource</code> to calculate billing for
1237
- * your geofence collection. Your data won't be shared with the data provider, and will
1238
- * remain in your AWS account or Region unless you move it.</p>
1239
- * </note>
1240
- * <p>Valid Values: <code>Esri </code>| <code>Here</code>
1241
- * </p>
1242
- */
525
+
1243
526
  PricingPlanDataSource?: string;
1244
- /**
1245
- * <p>An optional description for the geofence collection.</p>
1246
- */
527
+
1247
528
  Description?: string;
1248
- /**
1249
- * <p>Applies one or more tags to the geofence collection. A tag is a key-value pair helps
1250
- * manage, identify, search, and filter your resources by labelling them.</p>
1251
- * <p>Format: <code>"key" : "value"</code>
1252
- * </p>
1253
- * <p>Restrictions:</p>
1254
- * <ul>
1255
- * <li>
1256
- * <p>Maximum 50 tags per resource</p>
1257
- * </li>
1258
- * <li>
1259
- * <p>Each resource tag must be unique with a maximum of one value.</p>
1260
- * </li>
1261
- * <li>
1262
- * <p>Maximum key length: 128 Unicode characters in UTF-8</p>
1263
- * </li>
1264
- * <li>
1265
- * <p>Maximum value length: 256 Unicode characters in UTF-8</p>
1266
- * </li>
1267
- * <li>
1268
- * <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters:
1269
- * + - = . _ : / @. </p>
1270
- * </li>
1271
- * </ul>
1272
- */
529
+
1273
530
  Tags?: {
1274
531
  [key: string]: string;
1275
532
  };
1276
- /**
1277
- * <p>A key identifier for an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">AWS KMS customer managed key</a>. Enter a key ID, key ARN, alias name, or alias ARN.
1278
- * </p>
1279
- */
533
+
1280
534
  KmsKeyId?: string;
1281
535
  }
1282
536
  export declare namespace CreateGeofenceCollectionRequest {
1283
- /**
1284
- * @internal
1285
- */
537
+
1286
538
  const filterSensitiveLog: (obj: CreateGeofenceCollectionRequest) => any;
1287
539
  }
1288
540
  export interface CreateGeofenceCollectionResponse {
1289
- /**
1290
- * <p>The name for the geofence collection.</p>
1291
- */
541
+
1292
542
  CollectionName: string | undefined;
1293
- /**
1294
- * <p>The Amazon Resource Name (ARN) for the geofence collection resource. Used when you
1295
- * need to specify a resource across all AWS. </p>
1296
- * <ul>
1297
- * <li>
1298
- * <p>Format example:
1299
- * <code>arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection</code>
1300
- * </p>
1301
- * </li>
1302
- * </ul>
1303
- */
543
+
1304
544
  CollectionArn: string | undefined;
1305
- /**
1306
- * <p>The timestamp for when the geofence collection was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
1307
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
1308
- * </p>
1309
- */
545
+
1310
546
  CreateTime: Date | undefined;
1311
547
  }
1312
548
  export declare namespace CreateGeofenceCollectionResponse {
1313
- /**
1314
- * @internal
1315
- */
549
+
1316
550
  const filterSensitiveLog: (obj: CreateGeofenceCollectionResponse) => any;
1317
551
  }
1318
- /**
1319
- * <p>Specifies the map tile style selected from an available provider.</p>
1320
- */
552
+
1321
553
  export interface MapConfiguration {
1322
- /**
1323
- * <p>Specifies the map style selected from an available data provider.</p>
1324
- * <p>Valid <a href="https://docs.aws.amazon.com/location/latest/developerguide/esri.html">Esri map styles</a>:</p>
1325
- * <ul>
1326
- * <li>
1327
- * <p>
1328
- * <code>VectorEsriDarkGrayCanvas</code> – The Esri Dark Gray Canvas map style. A
1329
- * vector basemap with a dark gray, neutral background with minimal colors, labels,
1330
- * and features that's designed to draw attention to your thematic content. </p>
1331
- * </li>
1332
- * <li>
1333
- * <p>
1334
- * <code>RasterEsriImagery</code> – The Esri Imagery map style. A raster basemap
1335
- * that provides one meter or better satellite and aerial imagery in many parts of
1336
- * the world and lower resolution satellite imagery worldwide. </p>
1337
- * </li>
1338
- * <li>
1339
- * <p>
1340
- * <code>VectorEsriLightGrayCanvas</code> – The Esri Light Gray Canvas map style,
1341
- * which provides a detailed vector basemap with a light gray, neutral background
1342
- * style with minimal colors, labels, and features that's designed to draw
1343
- * attention to your thematic content. </p>
1344
- * </li>
1345
- * <li>
1346
- * <p>
1347
- * <code>VectorEsriTopographic</code> – The Esri Light map style, which provides
1348
- * a detailed vector basemap with a classic Esri map style.</p>
1349
- * </li>
1350
- * <li>
1351
- * <p>
1352
- * <code>VectorEsriStreets</code> – The Esri World Streets map style, which
1353
- * provides a detailed vector basemap for the world symbolized with a classic Esri
1354
- * street map style. The vector tile layer is similar in content and style to the
1355
- * World Street Map raster map.</p>
1356
- * </li>
1357
- * <li>
1358
- * <p>
1359
- * <code>VectorEsriNavigation</code> – The Esri World Navigation map style, which
1360
- * provides a detailed basemap for the world symbolized with a custom navigation
1361
- * map style that's designed for use during the day in mobile devices.</p>
1362
- * </li>
1363
- * </ul>
1364
- * <p>Valid <a href="https://docs.aws.amazon.com/location/latest/developerguide/HERE.html">HERE
1365
- * Technologies map styles</a>:</p>
1366
- * <ul>
1367
- * <li>
1368
- * <p>
1369
- * <code>VectorHereBerlin</code> – The HERE Berlin map style is a high contrast
1370
- * detailed base map of the world that blends 3D and 2D rendering.</p>
1371
- * <note>
1372
- * <p>When using HERE as your data provider, and selecting the Style
1373
- * <code>VectorHereBerlin</code>, you may not use HERE Technologies maps
1374
- * for Asset Management. See the <a href="https://aws.amazon.com/service-terms/">AWS Service Terms</a>
1375
- * for Amazon Location Service.</p>
1376
- * </note>
1377
- * </li>
1378
- * </ul>
1379
- */
554
+
1380
555
  Style: string | undefined;
1381
556
  }
1382
557
  export declare namespace MapConfiguration {
1383
- /**
1384
- * @internal
1385
- */
558
+
1386
559
  const filterSensitiveLog: (obj: MapConfiguration) => any;
1387
560
  }
1388
561
  export interface CreateMapRequest {
1389
- /**
1390
- * <p>The name for the map resource.</p>
1391
- * <p>Requirements:</p>
1392
- * <ul>
1393
- * <li>
1394
- * <p>Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). </p>
1395
- * </li>
1396
- * <li>
1397
- * <p>Must be a unique map resource name. </p>
1398
- * </li>
1399
- * <li>
1400
- * <p>No spaces allowed. For example, <code>ExampleMap</code>.</p>
1401
- * </li>
1402
- * </ul>
1403
- */
562
+
1404
563
  MapName: string | undefined;
1405
- /**
1406
- * <p>Specifies the map style selected from an available data provider.</p>
1407
- */
564
+
1408
565
  Configuration: MapConfiguration | undefined;
1409
- /**
1410
- * <p>Specifies the pricing plan for your map resource.</p>
1411
- * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
1412
- */
566
+
1413
567
  PricingPlan: PricingPlan | string | undefined;
1414
- /**
1415
- * <p>An optional description for the map resource.</p>
1416
- */
568
+
1417
569
  Description?: string;
1418
- /**
1419
- * <p>Applies one or more tags to the map resource. A tag is a key-value pair helps manage,
1420
- * identify, search, and filter your resources by labelling them.</p>
1421
- * <p>Format: <code>"key" : "value"</code>
1422
- * </p>
1423
- * <p>Restrictions:</p>
1424
- * <ul>
1425
- * <li>
1426
- * <p>Maximum 50 tags per resource</p>
1427
- * </li>
1428
- * <li>
1429
- * <p>Each resource tag must be unique with a maximum of one value.</p>
1430
- * </li>
1431
- * <li>
1432
- * <p>Maximum key length: 128 Unicode characters in UTF-8</p>
1433
- * </li>
1434
- * <li>
1435
- * <p>Maximum value length: 256 Unicode characters in UTF-8</p>
1436
- * </li>
1437
- * <li>
1438
- * <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : /
1439
- * @. </p>
1440
- * </li>
1441
- * </ul>
1442
- */
570
+
1443
571
  Tags?: {
1444
572
  [key: string]: string;
1445
573
  };
1446
574
  }
1447
575
  export declare namespace CreateMapRequest {
1448
- /**
1449
- * @internal
1450
- */
576
+
1451
577
  const filterSensitiveLog: (obj: CreateMapRequest) => any;
1452
578
  }
1453
579
  export interface CreateMapResponse {
1454
- /**
1455
- * <p>The name of the map resource.</p>
1456
- */
580
+
1457
581
  MapName: string | undefined;
1458
- /**
1459
- * <p>The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across
1460
- * all AWS.</p>
1461
- * <ul>
1462
- * <li>
1463
- * <p>Format example:
1464
- * <code>arn:aws:geo:region:account-id:maps/ExampleMap</code>
1465
- * </p>
1466
- * </li>
1467
- * </ul>
1468
- */
582
+
1469
583
  MapArn: string | undefined;
1470
- /**
1471
- * <p>The timestamp for when the map resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
1472
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
1473
- */
584
+
1474
585
  CreateTime: Date | undefined;
1475
586
  }
1476
587
  export declare namespace CreateMapResponse {
1477
- /**
1478
- * @internal
1479
- */
588
+
1480
589
  const filterSensitiveLog: (obj: CreateMapResponse) => any;
1481
590
  }
1482
591
  export declare type IntendedUse = "SingleUse" | "Storage";
1483
- /**
1484
- * <p>Specifies the data storage option chosen for requesting Places.</p>
1485
- * <important>
1486
- * <p>When using Amazon Location Places:</p>
1487
- * <ul>
1488
- * <li>
1489
- * <p>If using HERE Technologies as a data provider, you can't store results for
1490
- * locations in Japan by setting <code>IntendedUse</code> to <code>Storage</code>.
1491
- * parameter.</p>
1492
- * </li>
1493
- * <li>
1494
- * <p>Under the <code>MobileAssetTracking</code> or <code>MobilAssetManagement</code>
1495
- * pricing plan, you can't store results from your place index resources by setting <code>IntendedUse</code> to <code>Storage</code>. This
1496
- * returns a validation exception error.</p>
1497
- * </li>
1498
- * </ul>
1499
- * <p>For more information, see the <a href="https://aws.amazon.com/service-terms/">AWS Service Terms</a> for
1500
- * Amazon Location Service.</p>
1501
- * </important>
1502
- */
592
+
1503
593
  export interface DataSourceConfiguration {
1504
- /**
1505
- * <p>Specifies how the results of an operation will be stored by the caller. </p>
1506
- * <p>Valid values include:</p>
1507
- * <ul>
1508
- * <li>
1509
- * <p>
1510
- * <code>SingleUse</code> specifies that the results won't be stored. </p>
1511
- * </li>
1512
- * <li>
1513
- * <p>
1514
- * <code>Storage</code> specifies that the result can be cached or stored in a database.</p>
1515
- * </li>
1516
- * </ul>
1517
- * <p>Default value: <code>SingleUse</code>
1518
- * </p>
1519
- */
594
+
1520
595
  IntendedUse?: IntendedUse | string;
1521
596
  }
1522
597
  export declare namespace DataSourceConfiguration {
1523
- /**
1524
- * @internal
1525
- */
598
+
1526
599
  const filterSensitiveLog: (obj: DataSourceConfiguration) => any;
1527
600
  }
1528
601
  export interface CreatePlaceIndexRequest {
1529
- /**
1530
- * <p>The name of the place index resource. </p>
1531
- * <p>Requirements:</p>
1532
- * <ul>
1533
- * <li>
1534
- * <p>Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and
1535
- * underscores (_).</p>
1536
- * </li>
1537
- * <li>
1538
- * <p>Must be a unique place index resource name.</p>
1539
- * </li>
1540
- * <li>
1541
- * <p>No spaces allowed. For example, <code>ExamplePlaceIndex</code>.</p>
1542
- * </li>
1543
- * </ul>
1544
- */
602
+
1545
603
  IndexName: string | undefined;
1546
- /**
1547
- * <p>Specifies the data provider of geospatial data.</p>
1548
- * <note>
1549
- * <p>This field is case-sensitive. Enter the valid values as shown. For example, entering
1550
- * <code>HERE</code> returns an error.</p>
1551
- * </note>
1552
- * <p>Valid values include:</p>
1553
- * <ul>
1554
- * <li>
1555
- * <p>
1556
- * <code>Esri</code> – For additional information about <a href="https://docs.aws.amazon.com/location/latest/developerguide/esri.html">Esri</a>'s coverage in your
1557
- * region of interest, see <a href="https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm">Esri details on geocoding coverage</a>.</p>
1558
- * </li>
1559
- * <li>
1560
- * <p>
1561
- * <code>Here</code> – For additional information about <a href="https://docs.aws.amazon.com/location/latest/developerguide/HERE.html">HERE Technologies</a>'
1562
- * coverage in your region of interest, see <a href="https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html">HERE details on goecoding coverage</a>.</p>
1563
- * <important>
1564
- * <p>Place index resources using HERE Technologies as a data provider can't <a href="https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html">store results</a> for locations in Japan. For more information, see the
1565
- * <a href="https://aws.amazon.com/service-terms/">AWS Service Terms</a>
1566
- * for Amazon Location Service.</p>
1567
- * </important>
1568
- * </li>
1569
- * </ul>
1570
- * <p>For additional information , see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Data providers</a>
1571
- * on the <i>Amazon Location Service Developer Guide</i>.</p>
1572
- */
604
+
1573
605
  DataSource: string | undefined;
1574
- /**
1575
- * <p>Specifies the pricing plan for your place index resource.</p>
1576
- * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
1577
- */
606
+
1578
607
  PricingPlan: PricingPlan | string | undefined;
1579
- /**
1580
- * <p>The optional description for the place index resource.</p>
1581
- */
608
+
1582
609
  Description?: string;
1583
- /**
1584
- * <p>Specifies the data storage option requesting Places.</p>
1585
- */
610
+
1586
611
  DataSourceConfiguration?: DataSourceConfiguration;
1587
- /**
1588
- * <p>Applies one or more tags to the place index resource. A tag is a key-value pair helps
1589
- * manage, identify, search, and filter your resources by labelling them.</p>
1590
- * <p>Format: <code>"key" : "value"</code>
1591
- * </p>
1592
- * <p>Restrictions:</p>
1593
- * <ul>
1594
- * <li>
1595
- * <p>Maximum 50 tags per resource</p>
1596
- * </li>
1597
- * <li>
1598
- * <p>Each resource tag must be unique with a maximum of one value.</p>
1599
- * </li>
1600
- * <li>
1601
- * <p>Maximum key length: 128 Unicode characters in UTF-8</p>
1602
- * </li>
1603
- * <li>
1604
- * <p>Maximum value length: 256 Unicode characters in UTF-8</p>
1605
- * </li>
1606
- * <li>
1607
- * <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + -
1608
- * = . _ : / @. </p>
1609
- * </li>
1610
- * </ul>
1611
- */
612
+
1612
613
  Tags?: {
1613
614
  [key: string]: string;
1614
615
  };
1615
616
  }
1616
617
  export declare namespace CreatePlaceIndexRequest {
1617
- /**
1618
- * @internal
1619
- */
618
+
1620
619
  const filterSensitiveLog: (obj: CreatePlaceIndexRequest) => any;
1621
620
  }
1622
621
  export interface CreatePlaceIndexResponse {
1623
- /**
1624
- * <p>The name for the place index resource.</p>
1625
- */
622
+
1626
623
  IndexName: string | undefined;
1627
- /**
1628
- * <p>The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource
1629
- * across AWS. </p>
1630
- * <ul>
1631
- * <li>
1632
- * <p>Format example:
1633
- * <code>arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex</code>
1634
- * </p>
1635
- * </li>
1636
- * </ul>
1637
- */
624
+
1638
625
  IndexArn: string | undefined;
1639
- /**
1640
- * <p>The timestamp for when the place index resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format:
1641
- * <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
1642
- */
626
+
1643
627
  CreateTime: Date | undefined;
1644
628
  }
1645
629
  export declare namespace CreatePlaceIndexResponse {
1646
- /**
1647
- * @internal
1648
- */
630
+
1649
631
  const filterSensitiveLog: (obj: CreatePlaceIndexResponse) => any;
1650
632
  }
1651
633
  export interface CreateRouteCalculatorRequest {
1652
- /**
1653
- * <p>The name of the route calculator resource. </p>
1654
- * <p>Requirements:</p>
1655
- * <ul>
1656
- * <li>
1657
- * <p>Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores
1658
- * (_).</p>
1659
- * </li>
1660
- * <li>
1661
- * <p>Must be a unique Route calculator resource name.</p>
1662
- * </li>
1663
- * <li>
1664
- * <p>No spaces allowed. For example, <code>ExampleRouteCalculator</code>.</p>
1665
- * </li>
1666
- * </ul>
1667
- */
634
+
1668
635
  CalculatorName: string | undefined;
1669
- /**
1670
- * <p>Specifies the data provider of traffic and road network data.</p>
1671
- * <note>
1672
- * <p>This field is case-sensitive. Enter the valid values as shown. For example,
1673
- * entering <code>HERE</code> returns an error. Route calculators that use Esri as a data source
1674
- * only calculate routes that are shorter than 400 km.</p>
1675
- * </note>
1676
- * <p>Valid values include:</p>
1677
- * <ul>
1678
- * <li>
1679
- * <p>
1680
- * <code>Esri</code> – For additional information about <a href="https://docs.aws.amazon.com/location/latest/developerguide/esri.html">Esri</a>'s coverage in your region of interest, see <a href="https://doc.arcgis.com/en/arcgis-online/reference/network-coverage.htm">Esri details on street networks and traffic coverage</a>.</p>
1681
- * </li>
1682
- * <li>
1683
- * <p>
1684
- * <code>Here</code> – For additional information about <a href="https://docs.aws.amazon.com/location/latest/developerguide/HERE.html">HERE
1685
- * Technologies</a>' coverage in your region of interest, see <a href="https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/car-routing.html">HERE car routing coverage</a> and <a href="https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/truck-routing.html">HERE truck routing coverage</a>.</p>
1686
- * </li>
1687
- * </ul>
1688
- * <p>For additional information , see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Data
1689
- * providers</a> on the <i>Amazon Location Service Developer Guide</i>.</p>
1690
- */
636
+
1691
637
  DataSource: string | undefined;
1692
- /**
1693
- * <p>Specifies the pricing plan for your route calculator resource.</p>
1694
- * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
1695
- */
638
+
1696
639
  PricingPlan: PricingPlan | string | undefined;
1697
- /**
1698
- * <p>The optional description for the route calculator resource.</p>
1699
- */
640
+
1700
641
  Description?: string;
1701
- /**
1702
- * <p>Applies one or more tags to the route calculator resource. A tag is a key-value pair
1703
- * helps manage, identify, search, and filter your resources by labelling them.</p>
1704
- * <ul>
1705
- * <li>
1706
- * <p>For example: { <code>"tag1" : "value1"</code>, <code>"tag2" :
1707
- * "value2"</code>}</p>
1708
- * </li>
1709
- * </ul>
1710
- * <p>Format: <code>"key" : "value"</code>
1711
- * </p>
1712
- * <p>Restrictions:</p>
1713
- * <ul>
1714
- * <li>
1715
- * <p>Maximum 50 tags per resource</p>
1716
- * </li>
1717
- * <li>
1718
- * <p>Each resource tag must be unique with a maximum of one value.</p>
1719
- * </li>
1720
- * <li>
1721
- * <p>Maximum key length: 128 Unicode characters in UTF-8</p>
1722
- * </li>
1723
- * <li>
1724
- * <p>Maximum value length: 256 Unicode characters in UTF-8</p>
1725
- * </li>
1726
- * <li>
1727
- * <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters:
1728
- * + - = . _ : / @. </p>
1729
- * </li>
1730
- * </ul>
1731
- */
642
+
1732
643
  Tags?: {
1733
644
  [key: string]: string;
1734
645
  };
1735
646
  }
1736
647
  export declare namespace CreateRouteCalculatorRequest {
1737
- /**
1738
- * @internal
1739
- */
648
+
1740
649
  const filterSensitiveLog: (obj: CreateRouteCalculatorRequest) => any;
1741
650
  }
1742
651
  export interface CreateRouteCalculatorResponse {
1743
- /**
1744
- * <p>The name of the route calculator resource. </p>
1745
- * <ul>
1746
- * <li>
1747
- * <p>For example, <code>ExampleRouteCalculator</code>.</p>
1748
- * </li>
1749
- * </ul>
1750
- */
652
+
1751
653
  CalculatorName: string | undefined;
1752
- /**
1753
- * <p>The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you
1754
- * specify a resource across all AWS.</p>
1755
- * <ul>
1756
- * <li>
1757
- * <p>Format example:
1758
- * <code>arn:aws:geo:region:account-id:route-calculator/ExampleCalculator</code>
1759
- * </p>
1760
- * </li>
1761
- * </ul>
1762
- */
654
+
1763
655
  CalculatorArn: string | undefined;
1764
- /**
1765
- * <p>The timestamp when the route calculator resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
1766
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
1767
- * <ul>
1768
- * <li>
1769
- * <p>For example, <code>2020–07-2T12:15:20.000Z+01:00</code>
1770
- * </p>
1771
- * </li>
1772
- * </ul>
1773
- */
656
+
1774
657
  CreateTime: Date | undefined;
1775
658
  }
1776
659
  export declare namespace CreateRouteCalculatorResponse {
1777
- /**
1778
- * @internal
1779
- */
660
+
1780
661
  const filterSensitiveLog: (obj: CreateRouteCalculatorResponse) => any;
1781
662
  }
1782
663
  export declare type PositionFiltering = "DistanceBased" | "TimeBased";
1783
664
  export interface CreateTrackerRequest {
1784
- /**
1785
- * <p>The name for the tracker resource.</p>
1786
- * <p>Requirements:</p>
1787
- * <ul>
1788
- * <li>
1789
- * <p>Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_).</p>
1790
- * </li>
1791
- * <li>
1792
- * <p>Must be a unique tracker resource name.</p>
1793
- * </li>
1794
- * <li>
1795
- * <p>No spaces allowed. For example, <code>ExampleTracker</code>.</p>
1796
- * </li>
1797
- * </ul>
1798
- */
665
+
1799
666
  TrackerName: string | undefined;
1800
- /**
1801
- * <p>Specifies the pricing plan for the tracker resource.</p>
1802
- * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
1803
- */
667
+
1804
668
  PricingPlan: PricingPlan | string | undefined;
1805
- /**
1806
- * <p>A key identifier for an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">AWS KMS customer managed key</a>. Enter a key ID, key ARN, alias name, or alias ARN.</p>
1807
- */
669
+
1808
670
  KmsKeyId?: string;
1809
- /**
1810
- * <p>Specifies the data provider for the tracker resource.</p>
1811
- * <ul>
1812
- * <li>
1813
- * <p>Required value for the following pricing plans: <code>MobileAssetTracking
1814
- * </code>| <code>MobileAssetManagement</code>
1815
- * </p>
1816
- * </li>
1817
- * </ul>
1818
- * <p>For more information about <a href="https://aws.amazon.com/location/data-providers/">Data Providers</a>, and <a href="https://aws.amazon.com/location/pricing/">Pricing plans</a>, see the Amazon Location
1819
- * Service product page.</p>
1820
- * <note>
1821
- * <p>Amazon Location Service only uses <code>PricingPlanDataSource</code> to calculate billing for your tracker resource. Your data will not be shared with the data provider, and will remain in your AWS account or Region unless you move it.</p>
1822
- * </note>
1823
- * <p>Valid values: <code>Esri</code> | <code>Here</code>
1824
- * </p>
1825
- */
671
+
1826
672
  PricingPlanDataSource?: string;
1827
- /**
1828
- * <p>An optional description for the tracker resource.</p>
1829
- */
673
+
1830
674
  Description?: string;
1831
- /**
1832
- * <p>Applies one or more tags to the tracker resource. A tag is a key-value pair helps
1833
- * manage, identify, search, and filter your resources by labelling them.</p>
1834
- * <p>Format: <code>"key" : "value"</code>
1835
- * </p>
1836
- * <p>Restrictions:</p>
1837
- * <ul>
1838
- * <li>
1839
- * <p>Maximum 50 tags per resource</p>
1840
- * </li>
1841
- * <li>
1842
- * <p>Each resource tag must be unique with a maximum of one value.</p>
1843
- * </li>
1844
- * <li>
1845
- * <p>Maximum key length: 128 Unicode characters in UTF-8</p>
1846
- * </li>
1847
- * <li>
1848
- * <p>Maximum value length: 256 Unicode characters in UTF-8</p>
1849
- * </li>
1850
- * <li>
1851
- * <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters:
1852
- * + - = . _ : / @. </p>
1853
- * </li>
1854
- * </ul>
1855
- */
675
+
1856
676
  Tags?: {
1857
677
  [key: string]: string;
1858
678
  };
1859
- /**
1860
- * <p>Specifies the position filtering for the tracker resource.</p>
1861
- * <p>Valid values:</p>
1862
- * <ul>
1863
- * <li>
1864
- * <p>
1865
- * <code>TimeBased</code> - Location updates are evaluated against linked geofence collections,
1866
- * but not every location update is stored. If your update frequency is more often than 30 seconds,
1867
- * only one update per 30 seconds is stored for each unique device ID.
1868
- * </p>
1869
- * </li>
1870
- * <li>
1871
- * <p>
1872
- * <code>DistanceBased</code> - If the device has moved less than 30 m (98.4 ft), location updates are
1873
- * ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored.
1874
- * This helps control costs by reducing the number of geofence evaluations and device positions to retrieve.
1875
- * Distance-based filtering can also reduce the jitter effect when displaying device trajectory on a map.
1876
- * </p>
1877
- * </li>
1878
- * </ul>
1879
- * <p>This field is optional. If not specified, the default value is <code>TimeBased</code>.</p>
1880
- */
679
+
1881
680
  PositionFiltering?: PositionFiltering | string;
1882
681
  }
1883
682
  export declare namespace CreateTrackerRequest {
1884
- /**
1885
- * @internal
1886
- */
683
+
1887
684
  const filterSensitiveLog: (obj: CreateTrackerRequest) => any;
1888
685
  }
1889
686
  export interface CreateTrackerResponse {
1890
- /**
1891
- * <p>The name of the tracker resource.</p>
1892
- */
687
+
1893
688
  TrackerName: string | undefined;
1894
- /**
1895
- * <p>The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify
1896
- * a resource across all AWS.</p>
1897
- * <ul>
1898
- * <li>
1899
- * <p>Format example:
1900
- * <code>arn:aws:geo:region:account-id:tracker/ExampleTracker</code>
1901
- * </p>
1902
- * </li>
1903
- * </ul>
1904
- */
689
+
1905
690
  TrackerArn: string | undefined;
1906
- /**
1907
- * <p>The timestamp for when the tracker resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
1908
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
1909
- */
691
+
1910
692
  CreateTime: Date | undefined;
1911
693
  }
1912
694
  export declare namespace CreateTrackerResponse {
1913
- /**
1914
- * @internal
1915
- */
695
+
1916
696
  const filterSensitiveLog: (obj: CreateTrackerResponse) => any;
1917
697
  }
1918
698
  export interface DeleteGeofenceCollectionRequest {
1919
- /**
1920
- * <p>The name of the geofence collection to be deleted.</p>
1921
- */
699
+
1922
700
  CollectionName: string | undefined;
1923
701
  }
1924
702
  export declare namespace DeleteGeofenceCollectionRequest {
1925
- /**
1926
- * @internal
1927
- */
703
+
1928
704
  const filterSensitiveLog: (obj: DeleteGeofenceCollectionRequest) => any;
1929
705
  }
1930
706
  export interface DeleteGeofenceCollectionResponse {
1931
707
  }
1932
708
  export declare namespace DeleteGeofenceCollectionResponse {
1933
- /**
1934
- * @internal
1935
- */
709
+
1936
710
  const filterSensitiveLog: (obj: DeleteGeofenceCollectionResponse) => any;
1937
711
  }
1938
712
  export interface DeleteMapRequest {
1939
- /**
1940
- * <p>The name of the map resource to be deleted.</p>
1941
- */
713
+
1942
714
  MapName: string | undefined;
1943
715
  }
1944
716
  export declare namespace DeleteMapRequest {
1945
- /**
1946
- * @internal
1947
- */
717
+
1948
718
  const filterSensitiveLog: (obj: DeleteMapRequest) => any;
1949
719
  }
1950
720
  export interface DeleteMapResponse {
1951
721
  }
1952
722
  export declare namespace DeleteMapResponse {
1953
- /**
1954
- * @internal
1955
- */
723
+
1956
724
  const filterSensitiveLog: (obj: DeleteMapResponse) => any;
1957
725
  }
1958
726
  export interface DeletePlaceIndexRequest {
1959
- /**
1960
- * <p>The name of the place index resource to be deleted.</p>
1961
- */
727
+
1962
728
  IndexName: string | undefined;
1963
729
  }
1964
730
  export declare namespace DeletePlaceIndexRequest {
1965
- /**
1966
- * @internal
1967
- */
731
+
1968
732
  const filterSensitiveLog: (obj: DeletePlaceIndexRequest) => any;
1969
733
  }
1970
734
  export interface DeletePlaceIndexResponse {
1971
735
  }
1972
736
  export declare namespace DeletePlaceIndexResponse {
1973
- /**
1974
- * @internal
1975
- */
737
+
1976
738
  const filterSensitiveLog: (obj: DeletePlaceIndexResponse) => any;
1977
739
  }
1978
740
  export interface DeleteRouteCalculatorRequest {
1979
- /**
1980
- * <p>The name of the route calculator resource to be deleted.</p>
1981
- */
741
+
1982
742
  CalculatorName: string | undefined;
1983
743
  }
1984
744
  export declare namespace DeleteRouteCalculatorRequest {
1985
- /**
1986
- * @internal
1987
- */
745
+
1988
746
  const filterSensitiveLog: (obj: DeleteRouteCalculatorRequest) => any;
1989
747
  }
1990
748
  export interface DeleteRouteCalculatorResponse {
1991
749
  }
1992
750
  export declare namespace DeleteRouteCalculatorResponse {
1993
- /**
1994
- * @internal
1995
- */
751
+
1996
752
  const filterSensitiveLog: (obj: DeleteRouteCalculatorResponse) => any;
1997
753
  }
1998
754
  export interface DeleteTrackerRequest {
1999
- /**
2000
- * <p>The name of the tracker resource to be deleted.</p>
2001
- */
755
+
2002
756
  TrackerName: string | undefined;
2003
757
  }
2004
758
  export declare namespace DeleteTrackerRequest {
2005
- /**
2006
- * @internal
2007
- */
759
+
2008
760
  const filterSensitiveLog: (obj: DeleteTrackerRequest) => any;
2009
761
  }
2010
762
  export interface DeleteTrackerResponse {
2011
763
  }
2012
764
  export declare namespace DeleteTrackerResponse {
2013
- /**
2014
- * @internal
2015
- */
765
+
2016
766
  const filterSensitiveLog: (obj: DeleteTrackerResponse) => any;
2017
767
  }
2018
768
  export interface DescribeGeofenceCollectionRequest {
2019
- /**
2020
- * <p>The name of the geofence collection.</p>
2021
- */
769
+
2022
770
  CollectionName: string | undefined;
2023
771
  }
2024
772
  export declare namespace DescribeGeofenceCollectionRequest {
2025
- /**
2026
- * @internal
2027
- */
773
+
2028
774
  const filterSensitiveLog: (obj: DescribeGeofenceCollectionRequest) => any;
2029
775
  }
2030
776
  export interface DescribeGeofenceCollectionResponse {
2031
- /**
2032
- * <p>The name of the geofence collection.</p>
2033
- */
777
+
2034
778
  CollectionName: string | undefined;
2035
- /**
2036
- * <p>The Amazon Resource Name (ARN) for the geofence collection resource. Used when you
2037
- * need to specify a resource across all AWS. </p>
2038
- * <ul>
2039
- * <li>
2040
- * <p>Format example:
2041
- * <code>arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection</code>
2042
- * </p>
2043
- * </li>
2044
- * </ul>
2045
- */
779
+
2046
780
  CollectionArn: string | undefined;
2047
- /**
2048
- * <p>The optional description for the geofence collection.</p>
2049
- */
781
+
2050
782
  Description: string | undefined;
2051
- /**
2052
- * <p>The pricing plan selected for the specified geofence collection.</p>
2053
- * <p>For additional details and restrictions on each pricing plan option, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing
2054
- * page</a>.</p>
2055
- */
783
+
2056
784
  PricingPlan: PricingPlan | string | undefined;
2057
- /**
2058
- * <p>The specified data provider for the geofence collection.</p>
2059
- */
785
+
2060
786
  PricingPlanDataSource?: string;
2061
- /**
2062
- * <p>A key identifier for an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">AWS KMS customer managed key</a> assigned to the Amazon Location resource</p>
2063
- */
787
+
2064
788
  KmsKeyId?: string;
2065
- /**
2066
- * <p>Displays the key, value pairs of tags associated with this resource.</p>
2067
- */
789
+
2068
790
  Tags?: {
2069
791
  [key: string]: string;
2070
792
  };
2071
- /**
2072
- * <p>The timestamp for when the geofence resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
2073
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
2074
- * </p>
2075
- */
793
+
2076
794
  CreateTime: Date | undefined;
2077
- /**
2078
- * <p>The timestamp for when the geofence collection was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
2079
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
2080
- * </p>
2081
- */
795
+
2082
796
  UpdateTime: Date | undefined;
2083
797
  }
2084
798
  export declare namespace DescribeGeofenceCollectionResponse {
2085
- /**
2086
- * @internal
2087
- */
799
+
2088
800
  const filterSensitiveLog: (obj: DescribeGeofenceCollectionResponse) => any;
2089
801
  }
2090
802
  export interface DescribeMapRequest {
2091
- /**
2092
- * <p>The name of the map resource.</p>
2093
- */
803
+
2094
804
  MapName: string | undefined;
2095
805
  }
2096
806
  export declare namespace DescribeMapRequest {
2097
- /**
2098
- * @internal
2099
- */
807
+
2100
808
  const filterSensitiveLog: (obj: DescribeMapRequest) => any;
2101
809
  }
2102
810
  export interface DescribeMapResponse {
2103
- /**
2104
- * <p>The map style selected from an available provider.</p>
2105
- */
811
+
2106
812
  MapName: string | undefined;
2107
- /**
2108
- * <p>The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across
2109
- * all AWS.</p>
2110
- * <ul>
2111
- * <li>
2112
- * <p>Format example:
2113
- * <code>arn:aws:geo:region:account-id:maps/ExampleMap</code>
2114
- * </p>
2115
- * </li>
2116
- * </ul>
2117
- */
813
+
2118
814
  MapArn: string | undefined;
2119
- /**
2120
- * <p>The pricing plan selected for the specified map resource.</p>
2121
- *
2122
- * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
2123
- */
815
+
2124
816
  PricingPlan: PricingPlan | string | undefined;
2125
- /**
2126
- * <p>Specifies the data provider for the associated map tiles.</p>
2127
- */
817
+
2128
818
  DataSource: string | undefined;
2129
- /**
2130
- * <p>Specifies the map tile style selected from a partner data provider.</p>
2131
- */
819
+
2132
820
  Configuration: MapConfiguration | undefined;
2133
- /**
2134
- * <p>The optional description for the map resource.</p>
2135
- */
821
+
2136
822
  Description: string | undefined;
2137
- /**
2138
- * <p>Tags associated with the map resource.</p>
2139
- */
823
+
2140
824
  Tags?: {
2141
825
  [key: string]: string;
2142
826
  };
2143
- /**
2144
- * <p>The timestamp for when the map resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
2145
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
2146
- */
827
+
2147
828
  CreateTime: Date | undefined;
2148
- /**
2149
- * <p>The timestamp for when the map resource was last update in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
2150
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
2151
- */
829
+
2152
830
  UpdateTime: Date | undefined;
2153
831
  }
2154
832
  export declare namespace DescribeMapResponse {
2155
- /**
2156
- * @internal
2157
- */
833
+
2158
834
  const filterSensitiveLog: (obj: DescribeMapResponse) => any;
2159
835
  }
2160
836
  export interface DescribePlaceIndexRequest {
2161
- /**
2162
- * <p>The name of the place index resource.</p>
2163
- */
837
+
2164
838
  IndexName: string | undefined;
2165
839
  }
2166
840
  export declare namespace DescribePlaceIndexRequest {
2167
- /**
2168
- * @internal
2169
- */
841
+
2170
842
  const filterSensitiveLog: (obj: DescribePlaceIndexRequest) => any;
2171
843
  }
2172
844
  export interface DescribePlaceIndexResponse {
2173
- /**
2174
- * <p>The name of the place index resource being described.</p>
2175
- */
845
+
2176
846
  IndexName: string | undefined;
2177
- /**
2178
- * <p>The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource
2179
- * across AWS. </p>
2180
- * <ul>
2181
- * <li>
2182
- * <p>Format example:
2183
- * <code>arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex</code>
2184
- * </p>
2185
- * </li>
2186
- * </ul>
2187
- */
847
+
2188
848
  IndexArn: string | undefined;
2189
- /**
2190
- * <p>The pricing plan selected for the specified place index resource.</p>
2191
- * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
2192
- */
849
+
2193
850
  PricingPlan: PricingPlan | string | undefined;
2194
- /**
2195
- * <p>The optional description for the place index resource.</p>
2196
- */
851
+
2197
852
  Description: string | undefined;
2198
- /**
2199
- * <p>The timestamp for when the place index resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format:
2200
- * <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
2201
- */
853
+
2202
854
  CreateTime: Date | undefined;
2203
- /**
2204
- * <p>The timestamp for when the place index resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format:
2205
- * <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
2206
- */
855
+
2207
856
  UpdateTime: Date | undefined;
2208
- /**
2209
- * <p>The data provider of geospatial data. Indicates one of the available providers:</p>
2210
- * <ul>
2211
- * <li>
2212
- * <p>
2213
- * <code>Esri</code>
2214
- * </p>
2215
- * </li>
2216
- * <li>
2217
- * <p>
2218
- * <code>Here</code>
2219
- * </p>
2220
- * </li>
2221
- * </ul>
2222
- * <p>For additional details on data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
2223
- */
857
+
2224
858
  DataSource: string | undefined;
2225
- /**
2226
- * <p>The specified data storage option for requesting Places.</p>
2227
- */
859
+
2228
860
  DataSourceConfiguration: DataSourceConfiguration | undefined;
2229
- /**
2230
- * <p>Tags associated with place index resource.</p>
2231
- */
861
+
2232
862
  Tags?: {
2233
863
  [key: string]: string;
2234
864
  };
2235
865
  }
2236
866
  export declare namespace DescribePlaceIndexResponse {
2237
- /**
2238
- * @internal
2239
- */
867
+
2240
868
  const filterSensitiveLog: (obj: DescribePlaceIndexResponse) => any;
2241
869
  }
2242
870
  export interface DescribeRouteCalculatorRequest {
2243
- /**
2244
- * <p>The name of the route calculator resource.</p>
2245
- */
871
+
2246
872
  CalculatorName: string | undefined;
2247
873
  }
2248
874
  export declare namespace DescribeRouteCalculatorRequest {
2249
- /**
2250
- * @internal
2251
- */
875
+
2252
876
  const filterSensitiveLog: (obj: DescribeRouteCalculatorRequest) => any;
2253
877
  }
2254
878
  export interface DescribeRouteCalculatorResponse {
2255
- /**
2256
- * <p>The name of the route calculator resource being described.</p>
2257
- */
879
+
2258
880
  CalculatorName: string | undefined;
2259
- /**
2260
- * <p>The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you
2261
- * specify a resource across AWS.</p>
2262
- * <ul>
2263
- * <li>
2264
- * <p>Format example:
2265
- * <code>arn:aws:geo:region:account-id:route-calculator/ExampleCalculator</code>
2266
- * </p>
2267
- * </li>
2268
- * </ul>
2269
- */
881
+
2270
882
  CalculatorArn: string | undefined;
2271
- /**
2272
- * <p>The pricing plan selected for the specified route calculator resource.</p>
2273
- * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
2274
- */
883
+
2275
884
  PricingPlan: PricingPlan | string | undefined;
2276
- /**
2277
- * <p>The optional description of the route calculator resource.</p>
2278
- */
885
+
2279
886
  Description: string | undefined;
2280
- /**
2281
- * <p>The timestamp when the route calculator resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
2282
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
2283
- * <ul>
2284
- * <li>
2285
- * <p>For example, <code>2020–07-2T12:15:20.000Z+01:00</code>
2286
- * </p>
2287
- * </li>
2288
- * </ul>
2289
- */
887
+
2290
888
  CreateTime: Date | undefined;
2291
- /**
2292
- * <p>The timestamp when the route calculator resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
2293
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
2294
- * <ul>
2295
- * <li>
2296
- * <p>For example, <code>2020–07-2T12:15:20.000Z+01:00</code>
2297
- * </p>
2298
- * </li>
2299
- * </ul>
2300
- */
889
+
2301
890
  UpdateTime: Date | undefined;
2302
- /**
2303
- * <p>The data provider of traffic and road network data. Indicates one of the available
2304
- * providers:</p>
2305
- * <ul>
2306
- * <li>
2307
- * <p>
2308
- * <code>Esri</code>
2309
- * </p>
2310
- * </li>
2311
- * <li>
2312
- * <p>
2313
- * <code>Here</code>
2314
- * </p>
2315
- * </li>
2316
- * </ul>
2317
- * <p>For more information about data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
2318
- */
891
+
2319
892
  DataSource: string | undefined;
2320
- /**
2321
- * <p>Tags associated with route calculator resource.</p>
2322
- */
893
+
2323
894
  Tags?: {
2324
895
  [key: string]: string;
2325
896
  };
2326
897
  }
2327
898
  export declare namespace DescribeRouteCalculatorResponse {
2328
- /**
2329
- * @internal
2330
- */
899
+
2331
900
  const filterSensitiveLog: (obj: DescribeRouteCalculatorResponse) => any;
2332
901
  }
2333
902
  export interface DescribeTrackerRequest {
2334
- /**
2335
- * <p>The name of the tracker resource.</p>
2336
- */
903
+
2337
904
  TrackerName: string | undefined;
2338
905
  }
2339
906
  export declare namespace DescribeTrackerRequest {
2340
- /**
2341
- * @internal
2342
- */
907
+
2343
908
  const filterSensitiveLog: (obj: DescribeTrackerRequest) => any;
2344
909
  }
2345
910
  export interface DescribeTrackerResponse {
2346
- /**
2347
- * <p>The name of the tracker resource.</p>
2348
- */
911
+
2349
912
  TrackerName: string | undefined;
2350
- /**
2351
- * <p>The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify
2352
- * a resource across all AWS.</p>
2353
- * <ul>
2354
- * <li>
2355
- * <p>Format example:
2356
- * <code>arn:aws:geo:region:account-id:tracker/ExampleTracker</code>
2357
- * </p>
2358
- * </li>
2359
- * </ul>
2360
- */
913
+
2361
914
  TrackerArn: string | undefined;
2362
- /**
2363
- * <p>The optional description for the tracker resource.</p>
2364
- */
915
+
2365
916
  Description: string | undefined;
2366
- /**
2367
- * <p>The pricing plan selected for the specified tracker resource.</p>
2368
- * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
2369
- */
917
+
2370
918
  PricingPlan: PricingPlan | string | undefined;
2371
- /**
2372
- * <p>The specified data provider for the tracker resource.</p>
2373
- */
919
+
2374
920
  PricingPlanDataSource?: string;
2375
- /**
2376
- * <p>The tags associated with the tracker resource.</p>
2377
- */
921
+
2378
922
  Tags?: {
2379
923
  [key: string]: string;
2380
924
  };
2381
- /**
2382
- * <p>The timestamp for when the tracker resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
2383
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
2384
- */
925
+
2385
926
  CreateTime: Date | undefined;
2386
- /**
2387
- * <p>The timestamp for when the tracker resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
2388
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
2389
- */
927
+
2390
928
  UpdateTime: Date | undefined;
2391
- /**
2392
- * <p>A key identifier for an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">AWS KMS customer managed key</a> assigned to the Amazon Location resource.</p>
2393
- */
929
+
2394
930
  KmsKeyId?: string;
2395
- /**
2396
- * <p>The position filtering method of the tracker resource.</p>
2397
- */
931
+
2398
932
  PositionFiltering?: PositionFiltering | string;
2399
933
  }
2400
934
  export declare namespace DescribeTrackerResponse {
2401
- /**
2402
- * @internal
2403
- */
935
+
2404
936
  const filterSensitiveLog: (obj: DescribeTrackerResponse) => any;
2405
937
  }
2406
938
  export interface DisassociateTrackerConsumerRequest {
2407
- /**
2408
- * <p>The name of the tracker resource to be dissociated from the consumer.</p>
2409
- */
939
+
2410
940
  TrackerName: string | undefined;
2411
- /**
2412
- * <p>The Amazon Resource Name (ARN) for the geofence collection to be disassociated from
2413
- * the tracker resource. Used when you need to specify a resource across all AWS. </p>
2414
- * <ul>
2415
- * <li>
2416
- * <p>Format example:
2417
- * <code>arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer</code>
2418
- * </p>
2419
- * </li>
2420
- * </ul>
2421
- */
941
+
2422
942
  ConsumerArn: string | undefined;
2423
943
  }
2424
944
  export declare namespace DisassociateTrackerConsumerRequest {
2425
- /**
2426
- * @internal
2427
- */
945
+
2428
946
  const filterSensitiveLog: (obj: DisassociateTrackerConsumerRequest) => any;
2429
947
  }
2430
948
  export interface DisassociateTrackerConsumerResponse {
2431
949
  }
2432
950
  export declare namespace DisassociateTrackerConsumerResponse {
2433
- /**
2434
- * @internal
2435
- */
951
+
2436
952
  const filterSensitiveLog: (obj: DisassociateTrackerConsumerResponse) => any;
2437
953
  }
2438
954
  export interface ListTagsForResourceRequest {
2439
- /**
2440
- * <p>The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.</p>
2441
- * <ul>
2442
- * <li>
2443
- * <p>Format example: <code>arn:aws:geo:region:account-id:resourcetype/ExampleResource</code>
2444
- * </p>
2445
- * </li>
2446
- * </ul>
2447
- */
955
+
2448
956
  ResourceArn: string | undefined;
2449
957
  }
2450
958
  export declare namespace ListTagsForResourceRequest {
2451
- /**
2452
- * @internal
2453
- */
959
+
2454
960
  const filterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
2455
961
  }
2456
962
  export interface ListTagsForResourceResponse {
2457
- /**
2458
- * <p>Tags that have been applied to the specified resource. Tags are mapped from the tag key to the tag value: <code>"TagKey" : "TagValue"</code>.</p>
2459
- * <ul>
2460
- * <li>
2461
- * <p>Format example: <code>{"tag1" : "value1", "tag2" : "value2"} </code>
2462
- * </p>
2463
- * </li>
2464
- * </ul>
2465
- */
963
+
2466
964
  Tags?: {
2467
965
  [key: string]: string;
2468
966
  };
2469
967
  }
2470
968
  export declare namespace ListTagsForResourceResponse {
2471
- /**
2472
- * @internal
2473
- */
969
+
2474
970
  const filterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
2475
971
  }
2476
972
  export interface TagResourceRequest {
2477
- /**
2478
- * <p>The Amazon Resource Name (ARN) of the resource whose tags you want to update.</p>
2479
- * <ul>
2480
- * <li>
2481
- * <p>Format example: <code>arn:aws:geo:region:account-id:resourcetype/ExampleResource</code>
2482
- * </p>
2483
- * </li>
2484
- * </ul>
2485
- */
973
+
2486
974
  ResourceArn: string | undefined;
2487
- /**
2488
- * <p>Tags that have been applied to the specified resource. Tags are mapped from the tag key to the tag value: <code>"TagKey" : "TagValue"</code>.</p>
2489
- * <ul>
2490
- * <li>
2491
- * <p>Format example: <code>{"tag1" : "value1", "tag2" : "value2"} </code>
2492
- * </p>
2493
- * </li>
2494
- * </ul>
2495
- */
975
+
2496
976
  Tags: {
2497
977
  [key: string]: string;
2498
978
  } | undefined;
2499
979
  }
2500
980
  export declare namespace TagResourceRequest {
2501
- /**
2502
- * @internal
2503
- */
981
+
2504
982
  const filterSensitiveLog: (obj: TagResourceRequest) => any;
2505
983
  }
2506
984
  export interface TagResourceResponse {
2507
985
  }
2508
986
  export declare namespace TagResourceResponse {
2509
- /**
2510
- * @internal
2511
- */
987
+
2512
988
  const filterSensitiveLog: (obj: TagResourceResponse) => any;
2513
989
  }
2514
990
  export interface UntagResourceRequest {
2515
- /**
2516
- * <p>The Amazon Resource Name (ARN) of the resource from which you want to remove tags.</p>
2517
- * <ul>
2518
- * <li>
2519
- * <p>Format example: <code>arn:aws:geo:region:account-id:resourcetype/ExampleResource</code>
2520
- * </p>
2521
- * </li>
2522
- * </ul>
2523
- */
991
+
2524
992
  ResourceArn: string | undefined;
2525
- /**
2526
- * <p>The list of tag keys to remove from the specified resource.</p>
2527
- */
993
+
2528
994
  TagKeys: string[] | undefined;
2529
995
  }
2530
996
  export declare namespace UntagResourceRequest {
2531
- /**
2532
- * @internal
2533
- */
997
+
2534
998
  const filterSensitiveLog: (obj: UntagResourceRequest) => any;
2535
999
  }
2536
1000
  export interface UntagResourceResponse {
2537
1001
  }
2538
1002
  export declare namespace UntagResourceResponse {
2539
- /**
2540
- * @internal
2541
- */
1003
+
2542
1004
  const filterSensitiveLog: (obj: UntagResourceResponse) => any;
2543
1005
  }
2544
1006
  export interface GetGeofenceRequest {
2545
- /**
2546
- * <p>The geofence collection storing the target geofence.</p>
2547
- */
1007
+
2548
1008
  CollectionName: string | undefined;
2549
- /**
2550
- * <p>The geofence you're retrieving details for.</p>
2551
- */
1009
+
2552
1010
  GeofenceId: string | undefined;
2553
1011
  }
2554
1012
  export declare namespace GetGeofenceRequest {
2555
- /**
2556
- * @internal
2557
- */
1013
+
2558
1014
  const filterSensitiveLog: (obj: GetGeofenceRequest) => any;
2559
1015
  }
2560
1016
  export interface GetGeofenceResponse {
2561
- /**
2562
- * <p>The geofence identifier.</p>
2563
- */
1017
+
2564
1018
  GeofenceId: string | undefined;
2565
- /**
2566
- * <p>Contains the geofence geometry details describing a polygon.</p>
2567
- */
1019
+
2568
1020
  Geometry: GeofenceGeometry | undefined;
2569
- /**
2570
- * <p>Identifies the state of the geofence. A geofence will hold one of the following
2571
- * states:</p>
2572
- * <ul>
2573
- * <li>
2574
- * <p>
2575
- * <code>ACTIVE</code> — The geofence has been indexed by the system. </p>
2576
- * </li>
2577
- * <li>
2578
- * <p>
2579
- * <code>PENDING</code> — The geofence is being processed by the system.</p>
2580
- * </li>
2581
- * <li>
2582
- * <p>
2583
- * <code>FAILED</code> — The geofence failed to be indexed by the system.</p>
2584
- * </li>
2585
- * <li>
2586
- * <p>
2587
- * <code>DELETED</code> — The geofence has been deleted from the system
2588
- * index.</p>
2589
- * </li>
2590
- * <li>
2591
- * <p>
2592
- * <code>DELETING</code> — The geofence is being deleted from the system
2593
- * index.</p>
2594
- * </li>
2595
- * </ul>
2596
- */
1021
+
2597
1022
  Status: string | undefined;
2598
- /**
2599
- * <p>The timestamp for when the geofence collection was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
2600
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
2601
- * </p>
2602
- */
1023
+
2603
1024
  CreateTime: Date | undefined;
2604
- /**
2605
- * <p>The timestamp for when the geofence collection was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
2606
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
2607
- * </p>
2608
- */
1025
+
2609
1026
  UpdateTime: Date | undefined;
2610
1027
  }
2611
1028
  export declare namespace GetGeofenceResponse {
2612
- /**
2613
- * @internal
2614
- */
1029
+
2615
1030
  const filterSensitiveLog: (obj: GetGeofenceResponse) => any;
2616
1031
  }
2617
1032
  export interface ListGeofenceCollectionsRequest {
2618
- /**
2619
- * <p>An optional limit for the number of resources returned in a single call. </p>
2620
- * <p>Default value: <code>100</code>
2621
- * </p>
2622
- */
1033
+
2623
1034
  MaxResults?: number;
2624
- /**
2625
- * <p>The pagination token specifying which page of results to return in the response. If no
2626
- * token is provided, the default page is the first page. </p>
2627
- * <p>Default value: <code>null</code>
2628
- * </p>
2629
- */
1035
+
2630
1036
  NextToken?: string;
2631
1037
  }
2632
1038
  export declare namespace ListGeofenceCollectionsRequest {
2633
- /**
2634
- * @internal
2635
- */
1039
+
2636
1040
  const filterSensitiveLog: (obj: ListGeofenceCollectionsRequest) => any;
2637
1041
  }
2638
- /**
2639
- * <p>Contains the geofence collection details.</p>
2640
- */
1042
+
2641
1043
  export interface ListGeofenceCollectionsResponseEntry {
2642
- /**
2643
- * <p>The name of the geofence collection.</p>
2644
- */
1044
+
2645
1045
  CollectionName: string | undefined;
2646
- /**
2647
- * <p>The description for the geofence collection</p>
2648
- */
1046
+
2649
1047
  Description: string | undefined;
2650
- /**
2651
- * <p>The pricing plan for the specified geofence collection.</p>
2652
- * <p>For additional details and restrictions on each pricing plan option, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing
2653
- * page</a>.</p>
2654
- */
1048
+
2655
1049
  PricingPlan: PricingPlan | string | undefined;
2656
- /**
2657
- * <p>The specified data provider for the geofence collection.</p>
2658
- */
1050
+
2659
1051
  PricingPlanDataSource?: string;
2660
- /**
2661
- * <p>The timestamp for when the geofence collection was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
2662
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
2663
- * </p>
2664
- */
1052
+
2665
1053
  CreateTime: Date | undefined;
2666
- /**
2667
- * <p>Specifies a timestamp for when the resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
2668
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
2669
- * </p>
2670
- */
1054
+
2671
1055
  UpdateTime: Date | undefined;
2672
1056
  }
2673
1057
  export declare namespace ListGeofenceCollectionsResponseEntry {
2674
- /**
2675
- * @internal
2676
- */
1058
+
2677
1059
  const filterSensitiveLog: (obj: ListGeofenceCollectionsResponseEntry) => any;
2678
1060
  }
2679
1061
  export interface ListGeofenceCollectionsResponse {
2680
- /**
2681
- * <p>Lists the geofence collections that exist in your AWS account.</p>
2682
- */
1062
+
2683
1063
  Entries: ListGeofenceCollectionsResponseEntry[] | undefined;
2684
- /**
2685
- * <p>A pagination token indicating there are additional pages available. You can use the
2686
- * token in a following request to fetch the next set of results. </p>
2687
- */
1064
+
2688
1065
  NextToken?: string;
2689
1066
  }
2690
1067
  export declare namespace ListGeofenceCollectionsResponse {
2691
- /**
2692
- * @internal
2693
- */
1068
+
2694
1069
  const filterSensitiveLog: (obj: ListGeofenceCollectionsResponse) => any;
2695
1070
  }
2696
1071
  export interface ListGeofencesRequest {
2697
- /**
2698
- * <p>The name of the geofence collection storing the list of geofences.</p>
2699
- */
1072
+
2700
1073
  CollectionName: string | undefined;
2701
- /**
2702
- * <p>The pagination token specifying which page of results to return in the response. If no
2703
- * token is provided, the default page is the first page. </p>
2704
- * <p>Default value: <code>null</code>
2705
- * </p>
2706
- */
1074
+
2707
1075
  NextToken?: string;
2708
1076
  }
2709
1077
  export declare namespace ListGeofencesRequest {
2710
- /**
2711
- * @internal
2712
- */
1078
+
2713
1079
  const filterSensitiveLog: (obj: ListGeofencesRequest) => any;
2714
1080
  }
2715
- /**
2716
- * <p>Contains a list of geofences stored in a given geofence collection.</p>
2717
- */
1081
+
2718
1082
  export interface ListGeofenceResponseEntry {
2719
- /**
2720
- * <p>The geofence identifier.</p>
2721
- */
1083
+
2722
1084
  GeofenceId: string | undefined;
2723
- /**
2724
- * <p>Contains the geofence geometry details describing a polygon.</p>
2725
- */
1085
+
2726
1086
  Geometry: GeofenceGeometry | undefined;
2727
- /**
2728
- * <p>Identifies the state of the geofence. A geofence will hold one of the following
2729
- * states:</p>
2730
- * <ul>
2731
- * <li>
2732
- * <p>
2733
- * <code>ACTIVE</code> — The geofence has been indexed by the system. </p>
2734
- * </li>
2735
- * <li>
2736
- * <p>
2737
- * <code>PENDING</code> — The geofence is being processed by the system.</p>
2738
- * </li>
2739
- * <li>
2740
- * <p>
2741
- * <code>FAILED</code> — The geofence failed to be indexed by the system.</p>
2742
- * </li>
2743
- * <li>
2744
- * <p>
2745
- * <code>DELETED</code> — The geofence has been deleted from the system
2746
- * index.</p>
2747
- * </li>
2748
- * <li>
2749
- * <p>
2750
- * <code>DELETING</code> — The geofence is being deleted from the system
2751
- * index.</p>
2752
- * </li>
2753
- * </ul>
2754
- */
1087
+
2755
1088
  Status: string | undefined;
2756
- /**
2757
- * <p>The timestamp for when the geofence was stored in a geofence collection in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
2758
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
2759
- * </p>
2760
- */
1089
+
2761
1090
  CreateTime: Date | undefined;
2762
- /**
2763
- * <p>The timestamp for when the geofence was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
2764
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
2765
- * </p>
2766
- */
1091
+
2767
1092
  UpdateTime: Date | undefined;
2768
1093
  }
2769
1094
  export declare namespace ListGeofenceResponseEntry {
2770
- /**
2771
- * @internal
2772
- */
1095
+
2773
1096
  const filterSensitiveLog: (obj: ListGeofenceResponseEntry) => any;
2774
1097
  }
2775
1098
  export interface ListGeofencesResponse {
2776
- /**
2777
- * <p>Contains a list of geofences stored in the geofence collection.</p>
2778
- */
1099
+
2779
1100
  Entries: ListGeofenceResponseEntry[] | undefined;
2780
- /**
2781
- * <p>A pagination token indicating there are additional pages available. You can use the
2782
- * token in a following request to fetch the next set of results. </p>
2783
- */
1101
+
2784
1102
  NextToken?: string;
2785
1103
  }
2786
1104
  export declare namespace ListGeofencesResponse {
2787
- /**
2788
- * @internal
2789
- */
1105
+
2790
1106
  const filterSensitiveLog: (obj: ListGeofencesResponse) => any;
2791
1107
  }
2792
1108
  export interface PutGeofenceRequest {
2793
- /**
2794
- * <p>The geofence collection to store the geofence in.</p>
2795
- */
1109
+
2796
1110
  CollectionName: string | undefined;
2797
- /**
2798
- * <p>An identifier for the geofence. For example, <code>ExampleGeofence-1</code>.</p>
2799
- */
1111
+
2800
1112
  GeofenceId: string | undefined;
2801
- /**
2802
- * <p>Contains the polygon details to specify the position of the geofence.</p>
2803
- * <note>
2804
- * <p>Each <a href="https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html">geofence polygon</a> can have a maximum of 1,000 vertices.</p>
2805
- * </note>
2806
- */
1113
+
2807
1114
  Geometry: GeofenceGeometry | undefined;
2808
1115
  }
2809
1116
  export declare namespace PutGeofenceRequest {
2810
- /**
2811
- * @internal
2812
- */
1117
+
2813
1118
  const filterSensitiveLog: (obj: PutGeofenceRequest) => any;
2814
1119
  }
2815
1120
  export interface PutGeofenceResponse {
2816
- /**
2817
- * <p>The geofence identifier entered in the request.</p>
2818
- */
1121
+
2819
1122
  GeofenceId: string | undefined;
2820
- /**
2821
- * <p>The timestamp for when the geofence was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
2822
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
2823
- * </p>
2824
- */
1123
+
2825
1124
  CreateTime: Date | undefined;
2826
- /**
2827
- * <p>The timestamp for when the geofence was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
2828
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
2829
- * </p>
2830
- */
1125
+
2831
1126
  UpdateTime: Date | undefined;
2832
1127
  }
2833
1128
  export declare namespace PutGeofenceResponse {
2834
- /**
2835
- * @internal
2836
- */
1129
+
2837
1130
  const filterSensitiveLog: (obj: PutGeofenceResponse) => any;
2838
1131
  }
2839
1132
  export interface UpdateGeofenceCollectionRequest {
2840
- /**
2841
- * <p>The name of the geofence collection to update.</p>
2842
- */
1133
+
2843
1134
  CollectionName: string | undefined;
2844
- /**
2845
- * <p>Updates the pricing plan for the geofence collection.</p>
2846
- * <p>For more information about each pricing plan option restrictions, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service
2847
- * pricing</a>.</p>
2848
- */
1135
+
2849
1136
  PricingPlan?: PricingPlan | string;
2850
- /**
2851
- * <p>Updates the data provider for the geofence collection. </p>
2852
- * <p>A required value for the following pricing plans: <code>MobileAssetTracking</code>|
2853
- * <code>MobileAssetManagement</code>
2854
- * </p>
2855
- * <p>For more information about <a href="https://aws.amazon.com/location/data-providers/">data providers</a> and
2856
- * <a href="https://aws.amazon.com/location/pricing/">pricing plans</a>, see the
2857
- * Amazon Location Service product page.</p>
2858
- * <note>
2859
- * <p>This can only be updated when updating the <code>PricingPlan</code> in the same
2860
- * request.</p>
2861
- * <p>Amazon Location Service uses <code>PricingPlanDataSource</code> to calculate
2862
- * billing for your geofence collection. Your data won't be shared with the data
2863
- * provider, and will remain in your AWS account and Region unless you move it.</p>
2864
- * </note>
2865
- */
1137
+
2866
1138
  PricingPlanDataSource?: string;
2867
- /**
2868
- * <p>Updates the description for the geofence collection.</p>
2869
- */
1139
+
2870
1140
  Description?: string;
2871
1141
  }
2872
1142
  export declare namespace UpdateGeofenceCollectionRequest {
2873
- /**
2874
- * @internal
2875
- */
1143
+
2876
1144
  const filterSensitiveLog: (obj: UpdateGeofenceCollectionRequest) => any;
2877
1145
  }
2878
1146
  export interface UpdateGeofenceCollectionResponse {
2879
- /**
2880
- * <p>The name of the updated geofence collection.</p>
2881
- */
1147
+
2882
1148
  CollectionName: string | undefined;
2883
- /**
2884
- * <p>The Amazon Resource Name (ARN) of the updated geofence collection. Used to specify a
2885
- * resource across AWS.</p>
2886
- * <ul>
2887
- * <li>
2888
- * <p>Format example:
2889
- * <code>arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection</code>
2890
- * </p>
2891
- * </li>
2892
- * </ul>
2893
- */
1149
+
2894
1150
  CollectionArn: string | undefined;
2895
- /**
2896
- * <p>The time when the geofence collection was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
2897
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>
2898
- * </p>
2899
- */
1151
+
2900
1152
  UpdateTime: Date | undefined;
2901
1153
  }
2902
1154
  export declare namespace UpdateGeofenceCollectionResponse {
2903
- /**
2904
- * @internal
2905
- */
1155
+
2906
1156
  const filterSensitiveLog: (obj: UpdateGeofenceCollectionResponse) => any;
2907
1157
  }
2908
1158
  export interface GetDevicePositionRequest {
2909
- /**
2910
- * <p>The tracker resource receiving the position update.</p>
2911
- */
1159
+
2912
1160
  TrackerName: string | undefined;
2913
- /**
2914
- * <p>The device whose position you want to retrieve.</p>
2915
- */
1161
+
2916
1162
  DeviceId: string | undefined;
2917
1163
  }
2918
1164
  export declare namespace GetDevicePositionRequest {
2919
- /**
2920
- * @internal
2921
- */
1165
+
2922
1166
  const filterSensitiveLog: (obj: GetDevicePositionRequest) => any;
2923
1167
  }
2924
1168
  export interface GetDevicePositionResponse {
2925
- /**
2926
- * <p>The device whose position you retrieved.</p>
2927
- */
1169
+
2928
1170
  DeviceId?: string;
2929
- /**
2930
- * <p>The timestamp at which the device's position was determined. Uses <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601 </a>
2931
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
2932
- */
1171
+
2933
1172
  SampleTime: Date | undefined;
2934
- /**
2935
- * <p>The timestamp for when the tracker resource received the device position in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601 </a>
2936
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
2937
- */
1173
+
2938
1174
  ReceivedTime: Date | undefined;
2939
- /**
2940
- * <p>The last known device position.</p>
2941
- */
1175
+
2942
1176
  Position: number[] | undefined;
2943
1177
  }
2944
1178
  export declare namespace GetDevicePositionResponse {
2945
- /**
2946
- * @internal
2947
- */
1179
+
2948
1180
  const filterSensitiveLog: (obj: GetDevicePositionResponse) => any;
2949
1181
  }
2950
1182
  export interface GetDevicePositionHistoryRequest {
2951
- /**
2952
- * <p>The tracker resource receiving the request for the device position history.</p>
2953
- */
1183
+
2954
1184
  TrackerName: string | undefined;
2955
- /**
2956
- * <p>The device whose position history you want to retrieve.</p>
2957
- */
1185
+
2958
1186
  DeviceId: string | undefined;
2959
- /**
2960
- * <p>The pagination token specifying which page of results to return in the response. If no
2961
- * token is provided, the default page is the first page. </p>
2962
- * <p>Default value: <code>null</code>
2963
- * </p>
2964
- */
1187
+
2965
1188
  NextToken?: string;
2966
- /**
2967
- * <p>Specify the start time for the position history in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
2968
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. By default, the value will be 24 hours
2969
- * prior to the time that the request is made.</p>
2970
- * <p>Requirement:</p>
2971
- * <ul>
2972
- * <li>
2973
- * <p>The time specified for <code>StartTimeInclusive</code> must be before
2974
- * <code>EndTimeExclusive</code>.</p>
2975
- * </li>
2976
- * </ul>
2977
- */
1189
+
2978
1190
  StartTimeInclusive?: Date;
2979
- /**
2980
- * <p>Specify the end time for the position history in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
2981
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. By default, the value will be the time
2982
- * that the request is made.</p>
2983
- * <p>Requirement:</p>
2984
- * <ul>
2985
- * <li>
2986
- * <p>The time specified for <code>EndTimeExclusive</code> must be after the time for
2987
- * <code>StartTimeInclusive</code>.</p>
2988
- * </li>
2989
- * </ul>
2990
- */
1191
+
2991
1192
  EndTimeExclusive?: Date;
2992
1193
  }
2993
1194
  export declare namespace GetDevicePositionHistoryRequest {
2994
- /**
2995
- * @internal
2996
- */
1195
+
2997
1196
  const filterSensitiveLog: (obj: GetDevicePositionHistoryRequest) => any;
2998
1197
  }
2999
1198
  export interface GetDevicePositionHistoryResponse {
3000
- /**
3001
- * <p>Contains the position history details for the requested device.</p>
3002
- */
1199
+
3003
1200
  DevicePositions: DevicePosition[] | undefined;
3004
- /**
3005
- * <p>A pagination token indicating there are additional pages available. You can use the
3006
- * token in a following request to fetch the next set of results.</p>
3007
- */
1201
+
3008
1202
  NextToken?: string;
3009
1203
  }
3010
1204
  export declare namespace GetDevicePositionHistoryResponse {
3011
- /**
3012
- * @internal
3013
- */
1205
+
3014
1206
  const filterSensitiveLog: (obj: GetDevicePositionHistoryResponse) => any;
3015
1207
  }
3016
1208
  export interface GetMapGlyphsRequest {
3017
- /**
3018
- * <p>The map resource associated with the glyph file.</p>
3019
- */
1209
+
3020
1210
  MapName: string | undefined;
3021
- /**
3022
- * <p>A comma-separated list of fonts to load glyphs from in order of preference. For
3023
- * example, <code>Noto Sans Regular, Arial Unicode</code>.</p>
3024
- * <p>Valid fonts stacks for <a href="https://docs.aws.amazon.com/location/latest/developerguide/esri.html">Esri</a> styles: </p>
3025
- * <ul>
3026
- * <li>
3027
- * <p>VectorEsriDarkGrayCanvas – <code>Ubuntu Medium Italic</code> | <code>Ubuntu
3028
- * Medium</code> | <code>Ubuntu Italic</code> | <code>Ubuntu Regular</code> |
3029
- * <code>Ubuntu Bold</code>
3030
- * </p>
3031
- * </li>
3032
- * <li>
3033
- * <p>VectorEsriLightGrayCanvas – <code>Ubuntu Italic</code> | <code>Ubuntu
3034
- * Regular</code> | <code>Ubuntu Light</code> | <code>Ubuntu Bold</code>
3035
- * </p>
3036
- * </li>
3037
- * <li>
3038
- * <p>VectorEsriTopographic – <code>Noto Sans Italic</code> | <code>Noto Sans
3039
- * Regular</code> | <code>Noto Sans Bold</code> | <code>Noto Serif
3040
- * Regular</code> | <code>Roboto Condensed Light Italic</code>
3041
- * </p>
3042
- * </li>
3043
- * <li>
3044
- * <p>VectorEsriStreets – <code>Arial Regular</code> | <code>Arial Italic</code> |
3045
- * <code>Arial Bold</code>
3046
- * </p>
3047
- * </li>
3048
- * <li>
3049
- * <p>VectorEsriNavigation – <code>Arial Regular</code> | <code>Arial Italic</code>
3050
- * | <code>Arial Bold</code>
3051
- * </p>
3052
- * </li>
3053
- * </ul>
3054
- * <p>Valid font stacks for <a href="https://docs.aws.amazon.com/location/latest/developerguide/HERE.html">HERE Technologies</a> styles: </p>
3055
- * <ul>
3056
- * <li>
3057
- * <p>VectorHereBerlin – <code>Fira GO Regular</code> | <code>Fira GO
3058
- * Bold</code>
3059
- * </p>
3060
- * </li>
3061
- * </ul>
3062
- */
1211
+
3063
1212
  FontStack: string | undefined;
3064
- /**
3065
- * <p>A Unicode range of characters to download glyphs for. Each response will contain 256
3066
- * characters. For example, 0–255 includes all characters from range <code>U+0000</code> to
3067
- * <code>00FF</code>. Must be aligned to multiples of 256.</p>
3068
- */
1213
+
3069
1214
  FontUnicodeRange: string | undefined;
3070
1215
  }
3071
1216
  export declare namespace GetMapGlyphsRequest {
3072
- /**
3073
- * @internal
3074
- */
1217
+
3075
1218
  const filterSensitiveLog: (obj: GetMapGlyphsRequest) => any;
3076
1219
  }
3077
1220
  export interface GetMapGlyphsResponse {
3078
- /**
3079
- * <p>The blob's content type.</p>
3080
- */
1221
+
3081
1222
  Blob?: Uint8Array;
3082
- /**
3083
- * <p>The map glyph content type. For example, <code>application/octet-stream</code>.</p>
3084
- */
1223
+
3085
1224
  ContentType?: string;
3086
1225
  }
3087
1226
  export declare namespace GetMapGlyphsResponse {
3088
- /**
3089
- * @internal
3090
- */
1227
+
3091
1228
  const filterSensitiveLog: (obj: GetMapGlyphsResponse) => any;
3092
1229
  }
3093
1230
  export interface GetMapSpritesRequest {
3094
- /**
3095
- * <p>The map resource associated with the sprite file.</p>
3096
- */
1231
+
3097
1232
  MapName: string | undefined;
3098
- /**
3099
- * <p>The name of the sprite file. Use the following file names for the sprite sheet:</p>
3100
- * <ul>
3101
- * <li>
3102
- * <p>
3103
- * <code>sprites.png</code>
3104
- * </p>
3105
- * </li>
3106
- * <li>
3107
- * <p>
3108
- * <code>sprites@2x.png</code> for high pixel density displays</p>
3109
- * </li>
3110
- * </ul>
3111
- * <p>For the JSON document contain image offsets. Use the following file names:</p>
3112
- * <ul>
3113
- * <li>
3114
- * <p>
3115
- * <code>sprites.json</code>
3116
- * </p>
3117
- * </li>
3118
- * <li>
3119
- * <p>
3120
- * <code>sprites@2x.json</code> for high pixel density displays</p>
3121
- * </li>
3122
- * </ul>
3123
- */
1233
+
3124
1234
  FileName: string | undefined;
3125
1235
  }
3126
1236
  export declare namespace GetMapSpritesRequest {
3127
- /**
3128
- * @internal
3129
- */
1237
+
3130
1238
  const filterSensitiveLog: (obj: GetMapSpritesRequest) => any;
3131
1239
  }
3132
1240
  export interface GetMapSpritesResponse {
3133
- /**
3134
- * <p>Contains the body of the sprite sheet or JSON offset file.</p>
3135
- */
1241
+
3136
1242
  Blob?: Uint8Array;
3137
- /**
3138
- * <p>The content type of the sprite sheet and offsets. For example, the sprite sheet
3139
- * content type is <code>image/png</code>, and the sprite offset JSON document is
3140
- * <code>application/json</code>. </p>
3141
- */
1243
+
3142
1244
  ContentType?: string;
3143
1245
  }
3144
1246
  export declare namespace GetMapSpritesResponse {
3145
- /**
3146
- * @internal
3147
- */
1247
+
3148
1248
  const filterSensitiveLog: (obj: GetMapSpritesResponse) => any;
3149
1249
  }
3150
1250
  export interface GetMapStyleDescriptorRequest {
3151
- /**
3152
- * <p>The map resource to retrieve the style descriptor from.</p>
3153
- */
1251
+
3154
1252
  MapName: string | undefined;
3155
1253
  }
3156
1254
  export declare namespace GetMapStyleDescriptorRequest {
3157
- /**
3158
- * @internal
3159
- */
1255
+
3160
1256
  const filterSensitiveLog: (obj: GetMapStyleDescriptorRequest) => any;
3161
1257
  }
3162
1258
  export interface GetMapStyleDescriptorResponse {
3163
- /**
3164
- * <p>Contains the body of the style descriptor.</p>
3165
- */
1259
+
3166
1260
  Blob?: Uint8Array;
3167
- /**
3168
- * <p>The style descriptor's content type. For example,
3169
- * <code>application/json</code>.</p>
3170
- */
1261
+
3171
1262
  ContentType?: string;
3172
1263
  }
3173
1264
  export declare namespace GetMapStyleDescriptorResponse {
3174
- /**
3175
- * @internal
3176
- */
1265
+
3177
1266
  const filterSensitiveLog: (obj: GetMapStyleDescriptorResponse) => any;
3178
1267
  }
3179
1268
  export interface GetMapTileRequest {
3180
- /**
3181
- * <p>The map resource to retrieve the map tiles from.</p>
3182
- */
1269
+
3183
1270
  MapName: string | undefined;
3184
- /**
3185
- * <p>The zoom value for the map tile.</p>
3186
- */
1271
+
3187
1272
  Z: string | undefined;
3188
- /**
3189
- * <p>The X axis value for the map tile.</p>
3190
- */
1273
+
3191
1274
  X: string | undefined;
3192
- /**
3193
- * <p>The Y axis value for the map tile. </p>
3194
- */
1275
+
3195
1276
  Y: string | undefined;
3196
1277
  }
3197
1278
  export declare namespace GetMapTileRequest {
3198
- /**
3199
- * @internal
3200
- */
1279
+
3201
1280
  const filterSensitiveLog: (obj: GetMapTileRequest) => any;
3202
1281
  }
3203
1282
  export interface GetMapTileResponse {
3204
- /**
3205
- * <p>Contains Mapbox Vector Tile (MVT) data.</p>
3206
- */
1283
+
3207
1284
  Blob?: Uint8Array;
3208
- /**
3209
- * <p>The map tile's content type. For example,
3210
- * <code>application/vnd.mapbox-vector-tile</code>.</p>
3211
- */
1285
+
3212
1286
  ContentType?: string;
3213
1287
  }
3214
1288
  export declare namespace GetMapTileResponse {
3215
- /**
3216
- * @internal
3217
- */
1289
+
3218
1290
  const filterSensitiveLog: (obj: GetMapTileResponse) => any;
3219
1291
  }
3220
1292
  export interface ListDevicePositionsRequest {
3221
- /**
3222
- * <p>The tracker resource containing the requested devices.</p>
3223
- */
1293
+
3224
1294
  TrackerName: string | undefined;
3225
- /**
3226
- * <p>An optional limit for the number of entries returned in a single call.</p>
3227
- * <p>Default value: <code>100</code>
3228
- * </p>
3229
- */
1295
+
3230
1296
  MaxResults?: number;
3231
- /**
3232
- * <p>The pagination token specifying which page of results to return in the response. If no
3233
- * token is provided, the default page is the first page.</p>
3234
- * <p>Default value: <code>null</code>
3235
- * </p>
3236
- */
1297
+
3237
1298
  NextToken?: string;
3238
1299
  }
3239
1300
  export declare namespace ListDevicePositionsRequest {
3240
- /**
3241
- * @internal
3242
- */
1301
+
3243
1302
  const filterSensitiveLog: (obj: ListDevicePositionsRequest) => any;
3244
1303
  }
3245
- /**
3246
- * <p>Contains the tracker resource details.</p>
3247
- */
1304
+
3248
1305
  export interface ListDevicePositionsResponseEntry {
3249
- /**
3250
- * <p>The ID of the device for this position.</p>
3251
- */
1306
+
3252
1307
  DeviceId: string | undefined;
3253
- /**
3254
- * <p>The timestamp at which the device position was determined. Uses <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
3255
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
3256
- */
1308
+
3257
1309
  SampleTime: Date | undefined;
3258
- /**
3259
- * <p>The last known device position. Empty if no positions currently stored.</p>
3260
- */
1310
+
3261
1311
  Position: number[] | undefined;
3262
1312
  }
3263
1313
  export declare namespace ListDevicePositionsResponseEntry {
3264
- /**
3265
- * @internal
3266
- */
1314
+
3267
1315
  const filterSensitiveLog: (obj: ListDevicePositionsResponseEntry) => any;
3268
1316
  }
3269
1317
  export interface ListDevicePositionsResponse {
3270
- /**
3271
- * <p>Contains details about each device's last known position. These details includes the device ID,
3272
- * the time when the position was sampled on the device, the time that the service received the update, and the most recent coordinates.</p>
3273
- */
1318
+
3274
1319
  Entries: ListDevicePositionsResponseEntry[] | undefined;
3275
- /**
3276
- * <p>A pagination token indicating there are additional pages available. You can use the
3277
- * token in a following request to fetch the next set of results.</p>
3278
- */
1320
+
3279
1321
  NextToken?: string;
3280
1322
  }
3281
1323
  export declare namespace ListDevicePositionsResponse {
3282
- /**
3283
- * @internal
3284
- */
1324
+
3285
1325
  const filterSensitiveLog: (obj: ListDevicePositionsResponse) => any;
3286
1326
  }
3287
1327
  export interface ListMapsRequest {
3288
- /**
3289
- * <p>An optional limit for the number of resources returned in a single call. </p>
3290
- * <p>Default value: <code>100</code>
3291
- * </p>
3292
- */
1328
+
3293
1329
  MaxResults?: number;
3294
- /**
3295
- * <p>The pagination token specifying which page of results to return in the response. If no
3296
- * token is provided, the default page is the first page.</p>
3297
- * <p>Default value: <code>null</code>
3298
- * </p>
3299
- */
1330
+
3300
1331
  NextToken?: string;
3301
1332
  }
3302
1333
  export declare namespace ListMapsRequest {
3303
- /**
3304
- * @internal
3305
- */
1334
+
3306
1335
  const filterSensitiveLog: (obj: ListMapsRequest) => any;
3307
1336
  }
3308
- /**
3309
- * <p>Contains details of an existing map resource in your AWS account.</p>
3310
- */
1337
+
3311
1338
  export interface ListMapsResponseEntry {
3312
- /**
3313
- * <p>The name of the associated map resource.</p>
3314
- */
1339
+
3315
1340
  MapName: string | undefined;
3316
- /**
3317
- * <p>The description for the map resource.</p>
3318
- */
1341
+
3319
1342
  Description: string | undefined;
3320
- /**
3321
- * <p>Specifies the data provider for the associated map tiles.</p>
3322
- */
1343
+
3323
1344
  DataSource: string | undefined;
3324
- /**
3325
- * <p>The pricing plan for the specified map resource.</p>
3326
- * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
3327
- */
1345
+
3328
1346
  PricingPlan: PricingPlan | string | undefined;
3329
- /**
3330
- * <p>The timestamp for when the map resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
3331
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
3332
- */
1347
+
3333
1348
  CreateTime: Date | undefined;
3334
- /**
3335
- * <p>The timestamp for when the map resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
3336
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
3337
- */
1349
+
3338
1350
  UpdateTime: Date | undefined;
3339
1351
  }
3340
1352
  export declare namespace ListMapsResponseEntry {
3341
- /**
3342
- * @internal
3343
- */
1353
+
3344
1354
  const filterSensitiveLog: (obj: ListMapsResponseEntry) => any;
3345
1355
  }
3346
1356
  export interface ListMapsResponse {
3347
- /**
3348
- * <p>Contains a list of maps in your AWS account</p>
3349
- */
1357
+
3350
1358
  Entries: ListMapsResponseEntry[] | undefined;
3351
- /**
3352
- * <p>A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results. </p>
3353
- */
1359
+
3354
1360
  NextToken?: string;
3355
1361
  }
3356
1362
  export declare namespace ListMapsResponse {
3357
- /**
3358
- * @internal
3359
- */
1363
+
3360
1364
  const filterSensitiveLog: (obj: ListMapsResponse) => any;
3361
1365
  }
3362
1366
  export interface ListPlaceIndexesRequest {
3363
- /**
3364
- * <p>An optional limit for the maximum number of results returned in a single call.</p>
3365
- * <p>Default value: <code>100</code>
3366
- * </p>
3367
- */
1367
+
3368
1368
  MaxResults?: number;
3369
- /**
3370
- * <p>The pagination token specifying which page of results to return in the response. If no
3371
- * token is provided, the default page is the first page.</p>
3372
- * <p>Default value: <code>null</code>
3373
- * </p>
3374
- */
1369
+
3375
1370
  NextToken?: string;
3376
1371
  }
3377
1372
  export declare namespace ListPlaceIndexesRequest {
3378
- /**
3379
- * @internal
3380
- */
1373
+
3381
1374
  const filterSensitiveLog: (obj: ListPlaceIndexesRequest) => any;
3382
1375
  }
3383
- /**
3384
- * <p>A place index resource listed in your AWS account.</p>
3385
- */
1376
+
3386
1377
  export interface ListPlaceIndexesResponseEntry {
3387
- /**
3388
- * <p>The name of the place index resource.</p>
3389
- */
1378
+
3390
1379
  IndexName: string | undefined;
3391
- /**
3392
- * <p>The optional description for the place index resource.</p>
3393
- */
1380
+
3394
1381
  Description: string | undefined;
3395
- /**
3396
- * <p>The data provider of geospatial data. Indicates one of the available providers:</p>
3397
- * <ul>
3398
- * <li>
3399
- * <p>
3400
- * <code>Esri</code>
3401
- * </p>
3402
- * </li>
3403
- * <li>
3404
- * <p>
3405
- * <code>Here</code>
3406
- * </p>
3407
- * </li>
3408
- * </ul>
3409
- * <p>For additional details on data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
3410
- */
1382
+
3411
1383
  DataSource: string | undefined;
3412
- /**
3413
- * <p>The pricing plan for the specified place index resource.</p>
3414
- * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
3415
- */
1384
+
3416
1385
  PricingPlan: PricingPlan | string | undefined;
3417
- /**
3418
- * <p>The timestamp for when the place index resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format:
3419
- * <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
3420
- */
1386
+
3421
1387
  CreateTime: Date | undefined;
3422
- /**
3423
- * <p>The timestamp for when the place index resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format:
3424
- * <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
3425
- */
1388
+
3426
1389
  UpdateTime: Date | undefined;
3427
1390
  }
3428
1391
  export declare namespace ListPlaceIndexesResponseEntry {
3429
- /**
3430
- * @internal
3431
- */
1392
+
3432
1393
  const filterSensitiveLog: (obj: ListPlaceIndexesResponseEntry) => any;
3433
1394
  }
3434
1395
  export interface ListPlaceIndexesResponse {
3435
- /**
3436
- * <p>Lists the place index resources that exist in your AWS account</p>
3437
- */
1396
+
3438
1397
  Entries: ListPlaceIndexesResponseEntry[] | undefined;
3439
- /**
3440
- * <p>A pagination token indicating there are additional pages available. You can use the
3441
- * token in a following request to fetch the next set of results.</p>
3442
- */
1398
+
3443
1399
  NextToken?: string;
3444
1400
  }
3445
1401
  export declare namespace ListPlaceIndexesResponse {
3446
- /**
3447
- * @internal
3448
- */
1402
+
3449
1403
  const filterSensitiveLog: (obj: ListPlaceIndexesResponse) => any;
3450
1404
  }
3451
1405
  export interface ListRouteCalculatorsRequest {
3452
- /**
3453
- * <p>An optional maximum number of results returned in a single call.</p>
3454
- * <p>Default Value: <code>100</code>
3455
- * </p>
3456
- */
1406
+
3457
1407
  MaxResults?: number;
3458
- /**
3459
- * <p>The pagination token specifying which page of results to return in the response. If no
3460
- * token is provided, the default page is the first page.</p>
3461
- * <p>Default Value: <code>null</code>
3462
- * </p>
3463
- */
1408
+
3464
1409
  NextToken?: string;
3465
1410
  }
3466
1411
  export declare namespace ListRouteCalculatorsRequest {
3467
- /**
3468
- * @internal
3469
- */
1412
+
3470
1413
  const filterSensitiveLog: (obj: ListRouteCalculatorsRequest) => any;
3471
1414
  }
3472
- /**
3473
- * <p>A route calculator resource listed in your AWS account.</p>
3474
- */
1415
+
3475
1416
  export interface ListRouteCalculatorsResponseEntry {
3476
- /**
3477
- * <p>The name of the route calculator resource.</p>
3478
- */
1417
+
3479
1418
  CalculatorName: string | undefined;
3480
- /**
3481
- * <p>The optional description of the route calculator resource.</p>
3482
- */
1419
+
3483
1420
  Description: string | undefined;
3484
- /**
3485
- * <p>The data provider of traffic and road network data. Indicates one of the available
3486
- * providers:</p>
3487
- * <ul>
3488
- * <li>
3489
- * <p>
3490
- * <code>Esri</code>
3491
- * </p>
3492
- * </li>
3493
- * <li>
3494
- * <p>
3495
- * <code>Here</code>
3496
- * </p>
3497
- * </li>
3498
- * </ul>
3499
- * <p>For more information about data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
3500
- */
1421
+
3501
1422
  DataSource: string | undefined;
3502
- /**
3503
- * <p>The pricing plan for the specified route calculator resource.</p>
3504
- * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
3505
- */
1423
+
3506
1424
  PricingPlan: PricingPlan | string | undefined;
3507
- /**
3508
- * <p>The timestamp when the route calculator resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
3509
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
3510
- * <ul>
3511
- * <li>
3512
- * <p>For example, <code>2020–07-2T12:15:20.000Z+01:00</code>
3513
- * </p>
3514
- * </li>
3515
- * </ul>
3516
- */
1425
+
3517
1426
  CreateTime: Date | undefined;
3518
- /**
3519
- * <p>The timestamp when the route calculator resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
3520
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
3521
- * <ul>
3522
- * <li>
3523
- * <p>For example, <code>2020–07-2T12:15:20.000Z+01:00</code>
3524
- * </p>
3525
- * </li>
3526
- * </ul>
3527
- */
1427
+
3528
1428
  UpdateTime: Date | undefined;
3529
1429
  }
3530
1430
  export declare namespace ListRouteCalculatorsResponseEntry {
3531
- /**
3532
- * @internal
3533
- */
1431
+
3534
1432
  const filterSensitiveLog: (obj: ListRouteCalculatorsResponseEntry) => any;
3535
1433
  }
3536
1434
  export interface ListRouteCalculatorsResponse {
3537
- /**
3538
- * <p>Lists the route calculator resources that exist in your AWS account</p>
3539
- */
1435
+
3540
1436
  Entries: ListRouteCalculatorsResponseEntry[] | undefined;
3541
- /**
3542
- * <p>A pagination token indicating there are additional pages available. You can use the
3543
- * token in a subsequent request to fetch the next set of results.</p>
3544
- */
1437
+
3545
1438
  NextToken?: string;
3546
1439
  }
3547
1440
  export declare namespace ListRouteCalculatorsResponse {
3548
- /**
3549
- * @internal
3550
- */
1441
+
3551
1442
  const filterSensitiveLog: (obj: ListRouteCalculatorsResponse) => any;
3552
1443
  }
3553
1444
  export interface ListTrackerConsumersRequest {
3554
- /**
3555
- * <p>The tracker resource whose associated geofence collections you want to list.</p>
3556
- */
1445
+
3557
1446
  TrackerName: string | undefined;
3558
- /**
3559
- * <p>An optional limit for the number of resources returned in a single call. </p>
3560
- * <p>Default value: <code>100</code>
3561
- * </p>
3562
- */
1447
+
3563
1448
  MaxResults?: number;
3564
- /**
3565
- * <p>The pagination token specifying which page of results to return in the response. If no
3566
- * token is provided, the default page is the first page. </p>
3567
- * <p>Default value: <code>null</code>
3568
- * </p>
3569
- */
1449
+
3570
1450
  NextToken?: string;
3571
1451
  }
3572
1452
  export declare namespace ListTrackerConsumersRequest {
3573
- /**
3574
- * @internal
3575
- */
1453
+
3576
1454
  const filterSensitiveLog: (obj: ListTrackerConsumersRequest) => any;
3577
1455
  }
3578
1456
  export interface ListTrackerConsumersResponse {
3579
- /**
3580
- * <p>Contains the list of geofence collection ARNs associated to the tracker resource.</p>
3581
- */
1457
+
3582
1458
  ConsumerArns: string[] | undefined;
3583
- /**
3584
- * <p>A pagination token indicating there are additional pages available. You can use the
3585
- * token in a following request to fetch the next set of results. </p>
3586
- */
1459
+
3587
1460
  NextToken?: string;
3588
1461
  }
3589
1462
  export declare namespace ListTrackerConsumersResponse {
3590
- /**
3591
- * @internal
3592
- */
1463
+
3593
1464
  const filterSensitiveLog: (obj: ListTrackerConsumersResponse) => any;
3594
1465
  }
3595
1466
  export interface ListTrackersRequest {
3596
- /**
3597
- * <p>An optional limit for the number of resources returned in a single call. </p>
3598
- * <p>Default value: <code>100</code>
3599
- * </p>
3600
- */
1467
+
3601
1468
  MaxResults?: number;
3602
- /**
3603
- * <p>The pagination token specifying which page of results to return in the response. If no
3604
- * token is provided, the default page is the first page. </p>
3605
- * <p>Default value: <code>null</code>
3606
- * </p>
3607
- */
1469
+
3608
1470
  NextToken?: string;
3609
1471
  }
3610
1472
  export declare namespace ListTrackersRequest {
3611
- /**
3612
- * @internal
3613
- */
1473
+
3614
1474
  const filterSensitiveLog: (obj: ListTrackersRequest) => any;
3615
1475
  }
3616
- /**
3617
- * <p>Contains the tracker resource details.</p>
3618
- */
1476
+
3619
1477
  export interface ListTrackersResponseEntry {
3620
- /**
3621
- * <p>The name of the tracker resource.</p>
3622
- */
1478
+
3623
1479
  TrackerName: string | undefined;
3624
- /**
3625
- * <p>The description for the tracker resource.</p>
3626
- */
1480
+
3627
1481
  Description: string | undefined;
3628
- /**
3629
- * <p>The pricing plan for the specified tracker resource.</p>
3630
- * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
3631
- */
1482
+
3632
1483
  PricingPlan: PricingPlan | string | undefined;
3633
- /**
3634
- * <p>The specified data provider for the tracker resource.</p>
3635
- */
1484
+
3636
1485
  PricingPlanDataSource?: string;
3637
- /**
3638
- * <p>The timestamp for when the tracker resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
3639
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
3640
- */
1486
+
3641
1487
  CreateTime: Date | undefined;
3642
- /**
3643
- * <p>The timestamp at which the device's position was determined. Uses <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
3644
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
3645
- */
1488
+
3646
1489
  UpdateTime: Date | undefined;
3647
1490
  }
3648
1491
  export declare namespace ListTrackersResponseEntry {
3649
- /**
3650
- * @internal
3651
- */
1492
+
3652
1493
  const filterSensitiveLog: (obj: ListTrackersResponseEntry) => any;
3653
1494
  }
3654
1495
  export interface ListTrackersResponse {
3655
- /**
3656
- * <p>Contains tracker resources in your AWS account. Details include tracker name,
3657
- * description and timestamps for when the tracker was created and last updated.</p>
3658
- */
1496
+
3659
1497
  Entries: ListTrackersResponseEntry[] | undefined;
3660
- /**
3661
- * <p>A pagination token indicating there are additional pages available. You can use the
3662
- * token in a following request to fetch the next set of results. </p>
3663
- */
1498
+
3664
1499
  NextToken?: string;
3665
1500
  }
3666
1501
  export declare namespace ListTrackersResponse {
3667
- /**
3668
- * @internal
3669
- */
1502
+
3670
1503
  const filterSensitiveLog: (obj: ListTrackersResponse) => any;
3671
1504
  }
3672
1505
  export interface UpdateMapRequest {
3673
- /**
3674
- * <p>The name of the map resource to update.</p>
3675
- */
1506
+
3676
1507
  MapName: string | undefined;
3677
- /**
3678
- * <p>Updates the pricing plan for the map resource.</p>
3679
- * <p>For more information about each pricing plan option restrictions, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
3680
- */
1508
+
3681
1509
  PricingPlan?: PricingPlan | string;
3682
- /**
3683
- * <p>Updates the description for the map resource.</p>
3684
- */
1510
+
3685
1511
  Description?: string;
3686
1512
  }
3687
1513
  export declare namespace UpdateMapRequest {
3688
- /**
3689
- * @internal
3690
- */
1514
+
3691
1515
  const filterSensitiveLog: (obj: UpdateMapRequest) => any;
3692
1516
  }
3693
1517
  export interface UpdateMapResponse {
3694
- /**
3695
- * <p>The name of the updated map resource.</p>
3696
- */
1518
+
3697
1519
  MapName: string | undefined;
3698
- /**
3699
- * <p>The Amazon Resource Name (ARN) of the updated map resource. Used to specify a resource
3700
- * across AWS.</p>
3701
- * <ul>
3702
- * <li>
3703
- * <p>Format example: <code>arn:aws:geo:region:account-id:maps/ExampleMap</code>
3704
- * </p>
3705
- * </li>
3706
- * </ul>
3707
- */
1520
+
3708
1521
  MapArn: string | undefined;
3709
- /**
3710
- * <p>The timestamp for when the map resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
3711
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
3712
- */
1522
+
3713
1523
  UpdateTime: Date | undefined;
3714
1524
  }
3715
1525
  export declare namespace UpdateMapResponse {
3716
- /**
3717
- * @internal
3718
- */
1526
+
3719
1527
  const filterSensitiveLog: (obj: UpdateMapResponse) => any;
3720
1528
  }
3721
1529
  export interface SearchPlaceIndexForPositionRequest {
3722
- /**
3723
- * <p>The name of the place index resource you want to use for the search.</p>
3724
- */
1530
+
3725
1531
  IndexName: string | undefined;
3726
- /**
3727
- * <p>Specifies a coordinate for the query defined by a longitude, and latitude.</p>
3728
- * <ul>
3729
- * <li>
3730
- * <p>The first position is the X coordinate, or longitude.</p>
3731
- * </li>
3732
- * <li>
3733
- * <p>The second position is the Y coordinate, or latitude. </p>
3734
- * </li>
3735
- * </ul>
3736
- * <p>For example, <code>position=xLongitude&amp;position=yLatitude</code> .</p>
3737
- */
1532
+
3738
1533
  Position: number[] | undefined;
3739
- /**
3740
- * <p>An optional paramer. The maximum number of results returned per request. </p>
3741
- * <p>Default value: <code>50</code>
3742
- * </p>
3743
- */
1534
+
3744
1535
  MaxResults?: number;
3745
1536
  }
3746
1537
  export declare namespace SearchPlaceIndexForPositionRequest {
3747
- /**
3748
- * @internal
3749
- */
1538
+
3750
1539
  const filterSensitiveLog: (obj: SearchPlaceIndexForPositionRequest) => any;
3751
1540
  }
3752
- /**
3753
- * <p>Places uses a point geometry to specify a location or a Place.</p>
3754
- */
1541
+
3755
1542
  export interface PlaceGeometry {
3756
- /**
3757
- * <p>A single point geometry specifies a location for a Place using <a href="https://gisgeography.com/wgs84-world-geodetic-system/">WGS 84</a>
3758
- * coordinates:</p>
3759
- * <ul>
3760
- * <li>
3761
- * <p>
3762
- * <i>x</i> — Specifies the x coordinate or longitude. </p>
3763
- * </li>
3764
- * <li>
3765
- * <p>
3766
- * <i>y</i> — Specifies the y coordinate or latitude. </p>
3767
- * </li>
3768
- * </ul>
3769
- */
1543
+
3770
1544
  Point?: number[];
3771
1545
  }
3772
1546
  export declare namespace PlaceGeometry {
3773
- /**
3774
- * @internal
3775
- */
1547
+
3776
1548
  const filterSensitiveLog: (obj: PlaceGeometry) => any;
3777
1549
  }
3778
- /**
3779
- * <p>Contains details about addresses or points of interest that match the search
3780
- * criteria.</p>
3781
- */
1550
+
3782
1551
  export interface Place {
3783
- /**
3784
- * <p>The full name and address of the point of interest such as a city,
3785
- * region, or country. For example, <code>123 Any Street, Any Town, USA</code>.</p>
3786
- */
1552
+
3787
1553
  Label?: string;
3788
- /**
3789
- * <p>Places uses a point geometry to specify a location or a Place.</p>
3790
- */
1554
+
3791
1555
  Geometry: PlaceGeometry | undefined;
3792
- /**
3793
- * <p>The numerical portion of an address, such as a building number. </p>
3794
- */
1556
+
3795
1557
  AddressNumber?: string;
3796
- /**
3797
- * <p>The name for a street or a road to identify a location. For example, <code>Main
3798
- * Street</code>.</p>
3799
- */
1558
+
3800
1559
  Street?: string;
3801
- /**
3802
- * <p>The name of a community district. For example, <code>Downtown</code>.</p>
3803
- */
1560
+
3804
1561
  Neighborhood?: string;
3805
- /**
3806
- * <p>A name for a local area, such as a city or town name. For example,
3807
- * <code>Toronto</code>.</p>
3808
- */
1562
+
3809
1563
  Municipality?: string;
3810
- /**
3811
- * <p>A country, or an area that's part of a larger region . For example, <code>Metro
3812
- * Vancouver</code>.</p>
3813
- */
1564
+
3814
1565
  SubRegion?: string;
3815
- /**
3816
- * <p>A name for an area or geographical division, such as a province or state name. For
3817
- * example, <code>British Columbia</code>.</p>
3818
- */
1566
+
3819
1567
  Region?: string;
3820
- /**
3821
- * <p>A country/region specified using <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166</a> 3-digit
3822
- * country/region code. For example, <code>CAN</code>.</p>
3823
- */
1568
+
3824
1569
  Country?: string;
3825
- /**
3826
- * <p>A group of numbers and letters in a country-specific format, which accompanies the
3827
- * address for the purpose of identifying a location. </p>
3828
- */
1570
+
3829
1571
  PostalCode?: string;
3830
1572
  }
3831
1573
  export declare namespace Place {
3832
- /**
3833
- * @internal
3834
- */
1574
+
3835
1575
  const filterSensitiveLog: (obj: Place) => any;
3836
1576
  }
3837
- /**
3838
- * <p>Specifies a single point of interest, or Place as a result of a search query obtained
3839
- * from a dataset configured in the place index resource.</p>
3840
- */
1577
+
3841
1578
  export interface SearchForPositionResult {
3842
- /**
3843
- * <p>Contains details about the relevant point of interest.</p>
3844
- */
1579
+
3845
1580
  Place: Place | undefined;
3846
1581
  }
3847
1582
  export declare namespace SearchForPositionResult {
3848
- /**
3849
- * @internal
3850
- */
1583
+
3851
1584
  const filterSensitiveLog: (obj: SearchForPositionResult) => any;
3852
1585
  }
3853
- /**
3854
- * <p>A summary of the reverse geocoding request sent using <code>SearchPlaceIndexForPosition</code>.</p>
3855
- */
1586
+
3856
1587
  export interface SearchPlaceIndexForPositionSummary {
3857
- /**
3858
- * <p>The position given in the reverse geocoding request.</p>
3859
- */
1588
+
3860
1589
  Position: number[] | undefined;
3861
- /**
3862
- * <p>An optional parameter. The maximum number of results returned per request. </p>
3863
- * <p>Default value: <code>50</code>
3864
- * </p>
3865
- */
1590
+
3866
1591
  MaxResults?: number;
3867
- /**
3868
- * <p>The data provider of geospatial data. Indicates one of the available providers:</p>
3869
- * <ul>
3870
- * <li>
3871
- * <p>Esri</p>
3872
- * </li>
3873
- * <li>
3874
- * <p>HERE</p>
3875
- * </li>
3876
- * </ul>
3877
- * <p>For additional details on data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
3878
- */
1592
+
3879
1593
  DataSource: string | undefined;
3880
1594
  }
3881
1595
  export declare namespace SearchPlaceIndexForPositionSummary {
3882
- /**
3883
- * @internal
3884
- */
1596
+
3885
1597
  const filterSensitiveLog: (obj: SearchPlaceIndexForPositionSummary) => any;
3886
1598
  }
3887
1599
  export interface SearchPlaceIndexForPositionResponse {
3888
- /**
3889
- * <p>Contains a summary of the request.</p>
3890
- */
1600
+
3891
1601
  Summary: SearchPlaceIndexForPositionSummary | undefined;
3892
- /**
3893
- * <p>Returns a list of Places closest to the specified position. Each result contains
3894
- * additional information about the Places returned.</p>
3895
- */
1602
+
3896
1603
  Results: SearchForPositionResult[] | undefined;
3897
1604
  }
3898
1605
  export declare namespace SearchPlaceIndexForPositionResponse {
3899
- /**
3900
- * @internal
3901
- */
1606
+
3902
1607
  const filterSensitiveLog: (obj: SearchPlaceIndexForPositionResponse) => any;
3903
1608
  }
3904
1609
  export interface SearchPlaceIndexForTextRequest {
3905
- /**
3906
- * <p>The name of the place index resource you want to use for the search.</p>
3907
- */
1610
+
3908
1611
  IndexName: string | undefined;
3909
- /**
3910
- * <p>The address, name,
3911
- * city, or region to be used in the search. In free-form text format. For example, <code>123 Any
3912
- * Street</code>.</p>
3913
- */
1612
+
3914
1613
  Text: string | undefined;
3915
- /**
3916
- * <p>Searches for results closest to the given position. An optional parameter defined by
3917
- * longitude, and latitude.</p>
3918
- * <ul>
3919
- * <li>
3920
- * <p>The first <code>bias</code> position is the X coordinate, or longitude.</p>
3921
- * </li>
3922
- * <li>
3923
- * <p>The second <code>bias</code> position is the Y coordinate, or latitude. </p>
3924
- * </li>
3925
- * </ul>
3926
- * <p>For example, <code>bias=xLongitude&amp;bias=yLatitude</code>.</p>
3927
- */
1614
+
3928
1615
  BiasPosition?: number[];
3929
- /**
3930
- * <p>Filters the results by returning only Places within the provided bounding box. An
3931
- * optional parameter.</p>
3932
- * <p>The first 2 <code>bbox</code> parameters describe the lower southwest corner:</p>
3933
- * <ul>
3934
- * <li>
3935
- * <p>The first <code>bbox</code> position is the X coordinate or longitude of the lower
3936
- * southwest corner.</p>
3937
- * </li>
3938
- * <li>
3939
- * <p>The second <code>bbox</code> position is the Y coordinate or latitude of the lower
3940
- * southwest corner.</p>
3941
- * </li>
3942
- * </ul>
3943
- * <p>For example, <code>bbox=xLongitudeSW&amp;bbox=yLatitudeSW</code>.</p>
3944
- * <p>The next <code>bbox</code> parameters describe the upper northeast corner:</p>
3945
- * <ul>
3946
- * <li>
3947
- * <p>The third <code>bbox</code> position is the X coordinate, or longitude of the
3948
- * upper northeast corner.</p>
3949
- * </li>
3950
- * <li>
3951
- * <p>The fourth <code>bbox</code> position is the Y coordinate, or longitude of the
3952
- * upper northeast corner.</p>
3953
- * </li>
3954
- * </ul>
3955
- * <p>For example, <code>bbox=xLongitudeNE&amp;bbox=yLatitudeNE</code>
3956
- * </p>
3957
- */
1616
+
3958
1617
  FilterBBox?: number[];
3959
- /**
3960
- * <p>Limits the search to the given a list of countries/regions. An optional
3961
- * parameter.</p>
3962
- * <ul>
3963
- * <li>
3964
- * <p>Use the <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166</a> 3-digit
3965
- * country code. For example, Australia uses three upper-case characters:
3966
- * <code>AUS</code>.</p>
3967
- * </li>
3968
- * </ul>
3969
- */
1618
+
3970
1619
  FilterCountries?: string[];
3971
- /**
3972
- * <p>An optional parameter. The maximum number of results returned per request. </p>
3973
- * <p>The default: <code>50</code>
3974
- * </p>
3975
- */
1620
+
3976
1621
  MaxResults?: number;
3977
1622
  }
3978
1623
  export declare namespace SearchPlaceIndexForTextRequest {
3979
- /**
3980
- * @internal
3981
- */
1624
+
3982
1625
  const filterSensitiveLog: (obj: SearchPlaceIndexForTextRequest) => any;
3983
1626
  }
3984
- /**
3985
- * <p>Contains relevant Places returned by calling
3986
- * <code>SearchPlaceIndexForText</code>.</p>
3987
- */
1627
+
3988
1628
  export interface SearchForTextResult {
3989
- /**
3990
- * <p>Contains details about the relevant point of interest.</p>
3991
- */
1629
+
3992
1630
  Place: Place | undefined;
3993
1631
  }
3994
1632
  export declare namespace SearchForTextResult {
3995
- /**
3996
- * @internal
3997
- */
1633
+
3998
1634
  const filterSensitiveLog: (obj: SearchForTextResult) => any;
3999
1635
  }
4000
- /**
4001
- * <p>A summary of the geocoding request sent using <code>SearchPlaceIndexForText</code>.</p>
4002
- */
1636
+
4003
1637
  export interface SearchPlaceIndexForTextSummary {
4004
- /**
4005
- * <p>The address, name, city or region to be used in the geocoding request. In free-form text
4006
- * format. For example, <code>Vancouver</code>.</p>
4007
- */
1638
+
4008
1639
  Text: string | undefined;
4009
- /**
4010
- * <p>Contains the coordinates for the bias position entered in the geocoding request.</p>
4011
- */
1640
+
4012
1641
  BiasPosition?: number[];
4013
- /**
4014
- * <p>Contains the coordinates for the optional bounding box coordinated entered in the
4015
- * geocoding request.</p>
4016
- */
1642
+
4017
1643
  FilterBBox?: number[];
4018
- /**
4019
- * <p>Contains the country filter entered in the geocoding request.</p>
4020
- */
1644
+
4021
1645
  FilterCountries?: string[];
4022
- /**
4023
- * <p>Contains the maximum number of results indicated for the request.</p>
4024
- */
1646
+
4025
1647
  MaxResults?: number;
4026
- /**
4027
- * <p>A bounding box that contains the search results within the specified area indicated by
4028
- * <code>FilterBBox</code>. A subset of bounding box specified using
4029
- * <code>FilterBBox</code>.</p>
4030
- */
1648
+
4031
1649
  ResultBBox?: number[];
4032
- /**
4033
- * <p>The data provider of geospatial data. Indicates one of the available providers:</p>
4034
- * <ul>
4035
- * <li>
4036
- * <p>Esri</p>
4037
- * </li>
4038
- * <li>
4039
- * <p>HERE</p>
4040
- * </li>
4041
- * </ul>
4042
- * <p>For additional details on data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
4043
- */
1650
+
4044
1651
  DataSource: string | undefined;
4045
1652
  }
4046
1653
  export declare namespace SearchPlaceIndexForTextSummary {
4047
- /**
4048
- * @internal
4049
- */
1654
+
4050
1655
  const filterSensitiveLog: (obj: SearchPlaceIndexForTextSummary) => any;
4051
1656
  }
4052
1657
  export interface SearchPlaceIndexForTextResponse {
4053
- /**
4054
- * <p>Contains a summary of the request. Contains the <code>BiasPosition</code>,
4055
- * <code>DataSource</code>, <code>FilterBBox</code>, <code>FilterCountries</code>,
4056
- * <code>MaxResults</code>, <code>ResultBBox</code>, and <code>Text</code>.</p>
4057
- */
1658
+
4058
1659
  Summary: SearchPlaceIndexForTextSummary | undefined;
4059
- /**
4060
- * <p>A list of Places closest to the specified position. Each result contains additional
4061
- * information about the specific point of interest. </p>
4062
- */
1660
+
4063
1661
  Results: SearchForTextResult[] | undefined;
4064
1662
  }
4065
1663
  export declare namespace SearchPlaceIndexForTextResponse {
4066
- /**
4067
- * @internal
4068
- */
1664
+
4069
1665
  const filterSensitiveLog: (obj: SearchPlaceIndexForTextResponse) => any;
4070
1666
  }
4071
1667
  export interface UpdatePlaceIndexRequest {
4072
- /**
4073
- * <p>The name of the place index resource to update.</p>
4074
- */
1668
+
4075
1669
  IndexName: string | undefined;
4076
- /**
4077
- * <p>Updates the pricing plan for the place index resource.</p>
4078
- * <p>For more information about each pricing plan option restrictions, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
4079
- */
1670
+
4080
1671
  PricingPlan?: PricingPlan | string;
4081
- /**
4082
- * <p>Updates the description for the place index resource.</p>
4083
- */
1672
+
4084
1673
  Description?: string;
4085
- /**
4086
- * <p>Updates the data storage option for the place index resource.</p>
4087
- */
1674
+
4088
1675
  DataSourceConfiguration?: DataSourceConfiguration;
4089
1676
  }
4090
1677
  export declare namespace UpdatePlaceIndexRequest {
4091
- /**
4092
- * @internal
4093
- */
1678
+
4094
1679
  const filterSensitiveLog: (obj: UpdatePlaceIndexRequest) => any;
4095
1680
  }
4096
1681
  export interface UpdatePlaceIndexResponse {
4097
- /**
4098
- * <p>The name of the updated place index resource.</p>
4099
- */
1682
+
4100
1683
  IndexName: string | undefined;
4101
- /**
4102
- * <p>The Amazon Resource Name (ARN) of the upated place index resource. Used to specify a
4103
- * resource across AWS.</p>
4104
- * <ul>
4105
- * <li>
4106
- * <p>Format example: <code>arn:aws:geo:region:account-id:place-
4107
- * index/ExamplePlaceIndex</code>
4108
- * </p>
4109
- * </li>
4110
- * </ul>
4111
- */
1684
+
4112
1685
  IndexArn: string | undefined;
4113
- /**
4114
- * <p>The timestamp for when the place index resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a> format:
4115
- * <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
4116
- */
1686
+
4117
1687
  UpdateTime: Date | undefined;
4118
1688
  }
4119
1689
  export declare namespace UpdatePlaceIndexResponse {
4120
- /**
4121
- * @internal
4122
- */
1690
+
4123
1691
  const filterSensitiveLog: (obj: UpdatePlaceIndexResponse) => any;
4124
1692
  }
4125
1693
  export interface UpdateRouteCalculatorRequest {
4126
- /**
4127
- * <p>The name of the route calculator resource to update.</p>
4128
- */
1694
+
4129
1695
  CalculatorName: string | undefined;
4130
- /**
4131
- * <p>Updates the pricing plan for the route calculator resource.</p>
4132
- * <p>For more information about each pricing plan option restrictions, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location
4133
- * Service pricing</a>.</p>
4134
- */
1696
+
4135
1697
  PricingPlan?: PricingPlan | string;
4136
- /**
4137
- * <p>Updates the description for the route calculator resource.</p>
4138
- */
1698
+
4139
1699
  Description?: string;
4140
1700
  }
4141
1701
  export declare namespace UpdateRouteCalculatorRequest {
4142
- /**
4143
- * @internal
4144
- */
1702
+
4145
1703
  const filterSensitiveLog: (obj: UpdateRouteCalculatorRequest) => any;
4146
1704
  }
4147
1705
  export interface UpdateRouteCalculatorResponse {
4148
- /**
4149
- * <p>The name of the updated route calculator resource.</p>
4150
- */
1706
+
4151
1707
  CalculatorName: string | undefined;
4152
- /**
4153
- * <p>The Amazon Resource Name (ARN) of the updated route calculator resource. Used to specify a resource
4154
- * across AWS.</p>
4155
- * <ul>
4156
- * <li>
4157
- * <p>Format example: <code>arn:aws:geo:region:account-id:route-
4158
- * calculator/ExampleCalculator</code>
4159
- * </p>
4160
- * </li>
4161
- * </ul>
4162
- */
1708
+
4163
1709
  CalculatorArn: string | undefined;
4164
- /**
4165
- * <p>The timestamp for when the route calculator was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
4166
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
4167
- */
1710
+
4168
1711
  UpdateTime: Date | undefined;
4169
1712
  }
4170
1713
  export declare namespace UpdateRouteCalculatorResponse {
4171
- /**
4172
- * @internal
4173
- */
1714
+
4174
1715
  const filterSensitiveLog: (obj: UpdateRouteCalculatorResponse) => any;
4175
1716
  }
4176
1717
  export interface UpdateTrackerRequest {
4177
- /**
4178
- * <p>The name of the tracker resource to update.</p>
4179
- */
1718
+
4180
1719
  TrackerName: string | undefined;
4181
- /**
4182
- * <p>Updates the pricing plan for the tracker resource.</p>
4183
- * <p>For more information about each pricing plan option restrictions, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service
4184
- * pricing</a>.</p>
4185
- */
1720
+
4186
1721
  PricingPlan?: PricingPlan | string;
4187
- /**
4188
- * <p>Updates the data provider for the tracker resource. </p>
4189
- * <p>A required value for the following pricing plans: <code>MobileAssetTracking</code>| <code>MobileAssetManagement</code>
4190
- * </p>
4191
- * <p>For more information about <a href="https://aws.amazon.com/location/data-providers/">data providers</a> and <a href="https://aws.amazon.com/location/pricing/">pricing plans</a>, see the Amazon Location Service product
4192
- * page</p>
4193
- * <note>
4194
- * <p>This can only be updated when updating the <code>PricingPlan</code> in the same
4195
- * request.</p>
4196
- * <p>Amazon Location Service uses <code>PricingPlanDataSource</code> to calculate
4197
- * billing for your tracker resource. Your data won't be shared with the data provider,
4198
- * and will remain in your AWS account and Region unless you move it.</p>
4199
- * </note>
4200
- */
1722
+
4201
1723
  PricingPlanDataSource?: string;
4202
- /**
4203
- * <p>Updates the description for the tracker resource.</p>
4204
- */
1724
+
4205
1725
  Description?: string;
4206
- /**
4207
- * <p>Updates the position filtering for the tracker resource.</p>
4208
- * <p>Valid values:</p>
4209
- * <ul>
4210
- * <li>
4211
- * <p>
4212
- * <code>TimeBased</code> - Location updates are evaluated against linked geofence collections,
4213
- * but not every location update is stored. If your update frequency is more often than 30 seconds,
4214
- * only one update per 30 seconds is stored for each unique device ID.
4215
- * </p>
4216
- * </li>
4217
- * <li>
4218
- * <p>
4219
- * <code>DistanceBased</code> - If the device has moved less than 30 m (98.4 ft), location updates are
4220
- * ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored.
4221
- * This helps control costs by reducing the number of geofence evaluations and device positions to retrieve.
4222
- * Distance-based filtering can also reduce the jitter effect when displaying device trajectory on a map.
4223
- * </p>
4224
- * </li>
4225
- * </ul>
4226
- */
1726
+
4227
1727
  PositionFiltering?: PositionFiltering | string;
4228
1728
  }
4229
1729
  export declare namespace UpdateTrackerRequest {
4230
- /**
4231
- * @internal
4232
- */
1730
+
4233
1731
  const filterSensitiveLog: (obj: UpdateTrackerRequest) => any;
4234
1732
  }
4235
1733
  export interface UpdateTrackerResponse {
4236
- /**
4237
- * <p>The name of the updated tracker resource.</p>
4238
- */
1734
+
4239
1735
  TrackerName: string | undefined;
4240
- /**
4241
- * <p>The Amazon Resource Name (ARN) of the updated tracker resource. Used to specify a resource across
4242
- * AWS.</p>
4243
- * <ul>
4244
- * <li>
4245
- * <p>Format example: <code>arn:aws:geo:region:account-id:tracker/ExampleTracker</code>
4246
- * </p>
4247
- * </li>
4248
- * </ul>
4249
- */
1736
+
4250
1737
  TrackerArn: string | undefined;
4251
- /**
4252
- * <p>The timestamp for when the tracker resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
4253
- * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
4254
- */
1738
+
4255
1739
  UpdateTime: Date | undefined;
4256
1740
  }
4257
1741
  export declare namespace UpdateTrackerResponse {
4258
- /**
4259
- * @internal
4260
- */
1742
+
4261
1743
  const filterSensitiveLog: (obj: UpdateTrackerResponse) => any;
4262
1744
  }