aws-sdk-locationservice 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,152 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::LocationService
11
+
12
+ # When LocationService returns an error response, the Ruby SDK constructs and raises an error.
13
+ # These errors all extend Aws::LocationService::Errors::ServiceError < {Aws::Errors::ServiceError}
14
+ #
15
+ # You can rescue all LocationService errors using ServiceError:
16
+ #
17
+ # begin
18
+ # # do stuff
19
+ # rescue Aws::LocationService::Errors::ServiceError
20
+ # # rescues all LocationService API errors
21
+ # end
22
+ #
23
+ #
24
+ # ## Request Context
25
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
26
+ # information about the request that generated the error.
27
+ # See {Seahorse::Client::RequestContext} for more information.
28
+ #
29
+ # ## Error Classes
30
+ # * {AccessDeniedException}
31
+ # * {ConflictException}
32
+ # * {InternalServerException}
33
+ # * {ResourceNotFoundException}
34
+ # * {ThrottlingException}
35
+ # * {ValidationException}
36
+ #
37
+ # Additionally, error classes are dynamically generated for service errors based on the error code
38
+ # if they are not defined above.
39
+ module Errors
40
+
41
+ extend Aws::Errors::DynamicErrors
42
+
43
+ class AccessDeniedException < ServiceError
44
+
45
+ # @param [Seahorse::Client::RequestContext] context
46
+ # @param [String] message
47
+ # @param [Aws::LocationService::Types::AccessDeniedException] data
48
+ def initialize(context, message, data = Aws::EmptyStructure.new)
49
+ super(context, message, data)
50
+ end
51
+
52
+ # @return [String]
53
+ def message
54
+ @message || @data[:message]
55
+ end
56
+ end
57
+
58
+ class ConflictException < ServiceError
59
+
60
+ # @param [Seahorse::Client::RequestContext] context
61
+ # @param [String] message
62
+ # @param [Aws::LocationService::Types::ConflictException] data
63
+ def initialize(context, message, data = Aws::EmptyStructure.new)
64
+ super(context, message, data)
65
+ end
66
+
67
+ # @return [String]
68
+ def message
69
+ @message || @data[:message]
70
+ end
71
+ end
72
+
73
+ class InternalServerException < ServiceError
74
+
75
+ # @param [Seahorse::Client::RequestContext] context
76
+ # @param [String] message
77
+ # @param [Aws::LocationService::Types::InternalServerException] data
78
+ def initialize(context, message, data = Aws::EmptyStructure.new)
79
+ super(context, message, data)
80
+ end
81
+
82
+ # @return [String]
83
+ def message
84
+ @message || @data[:message]
85
+ end
86
+
87
+ def retryable?
88
+ true
89
+ end
90
+ end
91
+
92
+ class ResourceNotFoundException < ServiceError
93
+
94
+ # @param [Seahorse::Client::RequestContext] context
95
+ # @param [String] message
96
+ # @param [Aws::LocationService::Types::ResourceNotFoundException] data
97
+ def initialize(context, message, data = Aws::EmptyStructure.new)
98
+ super(context, message, data)
99
+ end
100
+
101
+ # @return [String]
102
+ def message
103
+ @message || @data[:message]
104
+ end
105
+ end
106
+
107
+ class ThrottlingException < ServiceError
108
+
109
+ # @param [Seahorse::Client::RequestContext] context
110
+ # @param [String] message
111
+ # @param [Aws::LocationService::Types::ThrottlingException] data
112
+ def initialize(context, message, data = Aws::EmptyStructure.new)
113
+ super(context, message, data)
114
+ end
115
+
116
+ # @return [String]
117
+ def message
118
+ @message || @data[:message]
119
+ end
120
+
121
+ def retryable?
122
+ true
123
+ end
124
+ end
125
+
126
+ class ValidationException < ServiceError
127
+
128
+ # @param [Seahorse::Client::RequestContext] context
129
+ # @param [String] message
130
+ # @param [Aws::LocationService::Types::ValidationException] data
131
+ def initialize(context, message, data = Aws::EmptyStructure.new)
132
+ super(context, message, data)
133
+ end
134
+
135
+ # @return [String]
136
+ def field_list
137
+ @data[:field_list]
138
+ end
139
+
140
+ # @return [String]
141
+ def message
142
+ @message || @data[:message]
143
+ end
144
+
145
+ # @return [String]
146
+ def reason
147
+ @data[:reason]
148
+ end
149
+ end
150
+
151
+ end
152
+ end
@@ -0,0 +1,26 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::LocationService
11
+
12
+ class Resource
13
+
14
+ # @param options ({})
15
+ # @option options [Client] :client
16
+ def initialize(options = {})
17
+ @client = options[:client] || Client.new(options)
18
+ end
19
+
20
+ # @return [Client]
21
+ def client
22
+ @client
23
+ end
24
+
25
+ end
26
+ end
@@ -0,0 +1,2975 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::LocationService
11
+ module Types
12
+
13
+ # The request was denied due to insufficient access or permission. Check
14
+ # with an administrator to verify your permissions.
15
+ #
16
+ # @!attribute [rw] message
17
+ # @return [String]
18
+ #
19
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/AccessDeniedException AWS API Documentation
20
+ #
21
+ class AccessDeniedException < Struct.new(
22
+ :message)
23
+ SENSITIVE = []
24
+ include Aws::Structure
25
+ end
26
+
27
+ # @note When making an API call, you may pass AssociateTrackerConsumerRequest
28
+ # data as a hash:
29
+ #
30
+ # {
31
+ # consumer_arn: "Arn", # required
32
+ # tracker_name: "ResourceName", # required
33
+ # }
34
+ #
35
+ # @!attribute [rw] consumer_arn
36
+ # The Amazon Resource Name (ARN) for the geofence collection to be
37
+ # associated to tracker resource. Used when you need to specify a
38
+ # resource across all AWS.
39
+ #
40
+ # * Format example:
41
+ # `arn:partition:service:region:account-id:resource-type:resource-id`
42
+ #
43
+ # ^
44
+ # @return [String]
45
+ #
46
+ # @!attribute [rw] tracker_name
47
+ # The name of the tracker resource to be associated with a geofence
48
+ # collection.
49
+ # @return [String]
50
+ #
51
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/AssociateTrackerConsumerRequest AWS API Documentation
52
+ #
53
+ class AssociateTrackerConsumerRequest < Struct.new(
54
+ :consumer_arn,
55
+ :tracker_name)
56
+ SENSITIVE = []
57
+ include Aws::Structure
58
+ end
59
+
60
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/AssociateTrackerConsumerResponse AWS API Documentation
61
+ #
62
+ class AssociateTrackerConsumerResponse < Aws::EmptyStructure; end
63
+
64
+ # Contains error details for each geofence that failed to delete from
65
+ # the geofence collection.
66
+ #
67
+ # @!attribute [rw] error
68
+ # Contains details associated to the batch error.
69
+ # @return [Types::BatchItemError]
70
+ #
71
+ # @!attribute [rw] geofence_id
72
+ # The geofence associated with the error message.
73
+ # @return [String]
74
+ #
75
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchDeleteGeofenceError AWS API Documentation
76
+ #
77
+ class BatchDeleteGeofenceError < Struct.new(
78
+ :error,
79
+ :geofence_id)
80
+ SENSITIVE = []
81
+ include Aws::Structure
82
+ end
83
+
84
+ # @note When making an API call, you may pass BatchDeleteGeofenceRequest
85
+ # data as a hash:
86
+ #
87
+ # {
88
+ # collection_name: "ResourceName", # required
89
+ # geofence_ids: ["Id"], # required
90
+ # }
91
+ #
92
+ # @!attribute [rw] collection_name
93
+ # The geofence collection storing the geofences to be deleted.
94
+ # @return [String]
95
+ #
96
+ # @!attribute [rw] geofence_ids
97
+ # The batch of geofences to be deleted.
98
+ # @return [Array<String>]
99
+ #
100
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchDeleteGeofenceRequest AWS API Documentation
101
+ #
102
+ class BatchDeleteGeofenceRequest < Struct.new(
103
+ :collection_name,
104
+ :geofence_ids)
105
+ SENSITIVE = []
106
+ include Aws::Structure
107
+ end
108
+
109
+ # @!attribute [rw] errors
110
+ # Contains error details for each geofence that failed to delete.
111
+ # @return [Array<Types::BatchDeleteGeofenceError>]
112
+ #
113
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchDeleteGeofenceResponse AWS API Documentation
114
+ #
115
+ class BatchDeleteGeofenceResponse < Struct.new(
116
+ :errors)
117
+ SENSITIVE = []
118
+ include Aws::Structure
119
+ end
120
+
121
+ # Contains error details for each device that failed to evaluate its
122
+ # position against the geofences in a given geofence collection.
123
+ #
124
+ # @!attribute [rw] device_id
125
+ # The device associated with the position evaluation error.
126
+ # @return [String]
127
+ #
128
+ # @!attribute [rw] error
129
+ # Contains details associated to the batch error.
130
+ # @return [Types::BatchItemError]
131
+ #
132
+ # @!attribute [rw] sample_time
133
+ # Specifies a timestamp for when the error occurred in [ISO 8601][1]
134
+ # format: `YYYY-MM-DDThh:mm:ss.sssZ`
135
+ #
136
+ #
137
+ #
138
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
139
+ # @return [Time]
140
+ #
141
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchEvaluateGeofencesError AWS API Documentation
142
+ #
143
+ class BatchEvaluateGeofencesError < Struct.new(
144
+ :device_id,
145
+ :error,
146
+ :sample_time)
147
+ SENSITIVE = []
148
+ include Aws::Structure
149
+ end
150
+
151
+ # @note When making an API call, you may pass BatchEvaluateGeofencesRequest
152
+ # data as a hash:
153
+ #
154
+ # {
155
+ # collection_name: "ResourceName", # required
156
+ # device_position_updates: [ # required
157
+ # {
158
+ # device_id: "Id", # required
159
+ # position: [1.0], # required
160
+ # sample_time: Time.now, # required
161
+ # },
162
+ # ],
163
+ # }
164
+ #
165
+ # @!attribute [rw] collection_name
166
+ # The geofence collection used in evaluating the position of devices
167
+ # against its geofences.
168
+ # @return [String]
169
+ #
170
+ # @!attribute [rw] device_position_updates
171
+ # Contains device details for each device to be evaluated against the
172
+ # given geofence collection.
173
+ # @return [Array<Types::DevicePositionUpdate>]
174
+ #
175
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchEvaluateGeofencesRequest AWS API Documentation
176
+ #
177
+ class BatchEvaluateGeofencesRequest < Struct.new(
178
+ :collection_name,
179
+ :device_position_updates)
180
+ SENSITIVE = []
181
+ include Aws::Structure
182
+ end
183
+
184
+ # @!attribute [rw] errors
185
+ # Contains error details for each device that failed to evaluate its
186
+ # position against the given geofence collection.
187
+ # @return [Array<Types::BatchEvaluateGeofencesError>]
188
+ #
189
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchEvaluateGeofencesResponse AWS API Documentation
190
+ #
191
+ class BatchEvaluateGeofencesResponse < Struct.new(
192
+ :errors)
193
+ SENSITIVE = []
194
+ include Aws::Structure
195
+ end
196
+
197
+ # Contains error details for each device that didn't return a position.
198
+ #
199
+ # @!attribute [rw] device_id
200
+ # The ID of the device that didn't return a position.
201
+ # @return [String]
202
+ #
203
+ # @!attribute [rw] error
204
+ # Contains details related to the error code.
205
+ # @return [Types::BatchItemError]
206
+ #
207
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchGetDevicePositionError AWS API Documentation
208
+ #
209
+ class BatchGetDevicePositionError < Struct.new(
210
+ :device_id,
211
+ :error)
212
+ SENSITIVE = []
213
+ include Aws::Structure
214
+ end
215
+
216
+ # @note When making an API call, you may pass BatchGetDevicePositionRequest
217
+ # data as a hash:
218
+ #
219
+ # {
220
+ # device_ids: ["Id"], # required
221
+ # tracker_name: "BatchGetDevicePositionRequestTrackerNameString", # required
222
+ # }
223
+ #
224
+ # @!attribute [rw] device_ids
225
+ # Devices whose position you want to retrieve.
226
+ #
227
+ # * For example, for two devices:
228
+ # `device-ids=DeviceId1&device-ids=DeviceId2`
229
+ #
230
+ # ^
231
+ # @return [Array<String>]
232
+ #
233
+ # @!attribute [rw] tracker_name
234
+ # The tracker resource retrieving the device position.
235
+ # @return [String]
236
+ #
237
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchGetDevicePositionRequest AWS API Documentation
238
+ #
239
+ class BatchGetDevicePositionRequest < Struct.new(
240
+ :device_ids,
241
+ :tracker_name)
242
+ SENSITIVE = []
243
+ include Aws::Structure
244
+ end
245
+
246
+ # @!attribute [rw] device_positions
247
+ # Contains device position details such as the device ID, position,
248
+ # and timestamps for when the position was received and sampled.
249
+ # @return [Array<Types::DevicePosition>]
250
+ #
251
+ # @!attribute [rw] errors
252
+ # Contains error details for each device that failed to send its
253
+ # position to the tracker resource.
254
+ # @return [Array<Types::BatchGetDevicePositionError>]
255
+ #
256
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchGetDevicePositionResponse AWS API Documentation
257
+ #
258
+ class BatchGetDevicePositionResponse < Struct.new(
259
+ :device_positions,
260
+ :errors)
261
+ SENSITIVE = []
262
+ include Aws::Structure
263
+ end
264
+
265
+ # Contains the batch request error details associated with the request.
266
+ #
267
+ # @!attribute [rw] code
268
+ # The error code associated with the batch request error.
269
+ # @return [String]
270
+ #
271
+ # @!attribute [rw] message
272
+ # A message with the reason for the batch request error.
273
+ # @return [String]
274
+ #
275
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchItemError AWS API Documentation
276
+ #
277
+ class BatchItemError < Struct.new(
278
+ :code,
279
+ :message)
280
+ SENSITIVE = []
281
+ include Aws::Structure
282
+ end
283
+
284
+ # Contains error details for each geofence that failed to be stored in a
285
+ # given geofence collection.
286
+ #
287
+ # @!attribute [rw] error
288
+ # Contains details associated to the batch error.
289
+ # @return [Types::BatchItemError]
290
+ #
291
+ # @!attribute [rw] geofence_id
292
+ # The geofence associated with the error message.
293
+ # @return [String]
294
+ #
295
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchPutGeofenceError AWS API Documentation
296
+ #
297
+ class BatchPutGeofenceError < Struct.new(
298
+ :error,
299
+ :geofence_id)
300
+ SENSITIVE = []
301
+ include Aws::Structure
302
+ end
303
+
304
+ # @note When making an API call, you may pass BatchPutGeofenceRequest
305
+ # data as a hash:
306
+ #
307
+ # {
308
+ # collection_name: "ResourceName", # required
309
+ # entries: [ # required
310
+ # {
311
+ # geofence_id: "Id", # required
312
+ # geometry: { # required
313
+ # polygon: [
314
+ # [
315
+ # [1.0],
316
+ # ],
317
+ # ],
318
+ # },
319
+ # },
320
+ # ],
321
+ # }
322
+ #
323
+ # @!attribute [rw] collection_name
324
+ # The geofence collection storing the geofences.
325
+ # @return [String]
326
+ #
327
+ # @!attribute [rw] entries
328
+ # The batch of geofences to be stored in a geofence collection.
329
+ # @return [Array<Types::BatchPutGeofenceRequestEntry>]
330
+ #
331
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchPutGeofenceRequest AWS API Documentation
332
+ #
333
+ class BatchPutGeofenceRequest < Struct.new(
334
+ :collection_name,
335
+ :entries)
336
+ SENSITIVE = []
337
+ include Aws::Structure
338
+ end
339
+
340
+ # Contains geofence details.
341
+ #
342
+ # @note When making an API call, you may pass BatchPutGeofenceRequestEntry
343
+ # data as a hash:
344
+ #
345
+ # {
346
+ # geofence_id: "Id", # required
347
+ # geometry: { # required
348
+ # polygon: [
349
+ # [
350
+ # [1.0],
351
+ # ],
352
+ # ],
353
+ # },
354
+ # }
355
+ #
356
+ # @!attribute [rw] geofence_id
357
+ # The identifier for the geofence to be stored in a given geofence
358
+ # collection.
359
+ # @return [String]
360
+ #
361
+ # @!attribute [rw] geometry
362
+ # The geometry details for the geofence.
363
+ # @return [Types::GeofenceGeometry]
364
+ #
365
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchPutGeofenceRequestEntry AWS API Documentation
366
+ #
367
+ class BatchPutGeofenceRequestEntry < Struct.new(
368
+ :geofence_id,
369
+ :geometry)
370
+ SENSITIVE = []
371
+ include Aws::Structure
372
+ end
373
+
374
+ # @!attribute [rw] errors
375
+ # Contains additional error details for each geofence that failed to
376
+ # be stored in a geofence collection.
377
+ # @return [Array<Types::BatchPutGeofenceError>]
378
+ #
379
+ # @!attribute [rw] successes
380
+ # Contains each geofence that was successfully stored in a geofence
381
+ # collection.
382
+ # @return [Array<Types::BatchPutGeofenceSuccess>]
383
+ #
384
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchPutGeofenceResponse AWS API Documentation
385
+ #
386
+ class BatchPutGeofenceResponse < Struct.new(
387
+ :errors,
388
+ :successes)
389
+ SENSITIVE = []
390
+ include Aws::Structure
391
+ end
392
+
393
+ # Contains a summary of each geofence that was successfully stored in a
394
+ # given geofence collection.
395
+ #
396
+ # @!attribute [rw] create_time
397
+ # The timestamp for when the geofence was stored in a geofence
398
+ # collection in [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`
399
+ #
400
+ #
401
+ #
402
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
403
+ # @return [Time]
404
+ #
405
+ # @!attribute [rw] geofence_id
406
+ # The geofence successfully stored in a geofence collection.
407
+ # @return [String]
408
+ #
409
+ # @!attribute [rw] update_time
410
+ # The timestamp for when the geofence was last updated in [ISO
411
+ # 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`
412
+ #
413
+ #
414
+ #
415
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
416
+ # @return [Time]
417
+ #
418
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchPutGeofenceSuccess AWS API Documentation
419
+ #
420
+ class BatchPutGeofenceSuccess < Struct.new(
421
+ :create_time,
422
+ :geofence_id,
423
+ :update_time)
424
+ SENSITIVE = []
425
+ include Aws::Structure
426
+ end
427
+
428
+ # Contains error details for each device that failed to update its
429
+ # position.
430
+ #
431
+ # @!attribute [rw] device_id
432
+ # The device associated with the failed location update.
433
+ # @return [String]
434
+ #
435
+ # @!attribute [rw] error
436
+ # Contains details related to the error code such as the error code
437
+ # and error message.
438
+ # @return [Types::BatchItemError]
439
+ #
440
+ # @!attribute [rw] sample_time
441
+ # The timestamp for when a position sample was attempted in [ ISO
442
+ # 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
443
+ #
444
+ #
445
+ #
446
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
447
+ # @return [Time]
448
+ #
449
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchUpdateDevicePositionError AWS API Documentation
450
+ #
451
+ class BatchUpdateDevicePositionError < Struct.new(
452
+ :device_id,
453
+ :error,
454
+ :sample_time)
455
+ SENSITIVE = []
456
+ include Aws::Structure
457
+ end
458
+
459
+ # @note When making an API call, you may pass BatchUpdateDevicePositionRequest
460
+ # data as a hash:
461
+ #
462
+ # {
463
+ # tracker_name: "ResourceName", # required
464
+ # updates: [ # required
465
+ # {
466
+ # device_id: "Id", # required
467
+ # position: [1.0], # required
468
+ # sample_time: Time.now, # required
469
+ # },
470
+ # ],
471
+ # }
472
+ #
473
+ # @!attribute [rw] tracker_name
474
+ # The name of the tracker resource to update.
475
+ # @return [String]
476
+ #
477
+ # @!attribute [rw] updates
478
+ # Contains the position update details for each device.
479
+ # @return [Array<Types::DevicePositionUpdate>]
480
+ #
481
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchUpdateDevicePositionRequest AWS API Documentation
482
+ #
483
+ class BatchUpdateDevicePositionRequest < Struct.new(
484
+ :tracker_name,
485
+ :updates)
486
+ SENSITIVE = []
487
+ include Aws::Structure
488
+ end
489
+
490
+ # @!attribute [rw] errors
491
+ # Contains error details for each device that failed to update its
492
+ # position.
493
+ # @return [Array<Types::BatchUpdateDevicePositionError>]
494
+ #
495
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchUpdateDevicePositionResponse AWS API Documentation
496
+ #
497
+ class BatchUpdateDevicePositionResponse < Struct.new(
498
+ :errors)
499
+ SENSITIVE = []
500
+ include Aws::Structure
501
+ end
502
+
503
+ # The request was unsuccessful due to a conflict.
504
+ #
505
+ # @!attribute [rw] message
506
+ # @return [String]
507
+ #
508
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ConflictException AWS API Documentation
509
+ #
510
+ class ConflictException < Struct.new(
511
+ :message)
512
+ SENSITIVE = []
513
+ include Aws::Structure
514
+ end
515
+
516
+ # @note When making an API call, you may pass CreateGeofenceCollectionRequest
517
+ # data as a hash:
518
+ #
519
+ # {
520
+ # collection_name: "ResourceName", # required
521
+ # description: "ResourceDescription",
522
+ # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
523
+ # }
524
+ #
525
+ # @!attribute [rw] collection_name
526
+ # A custom name for the geofence collection.
527
+ #
528
+ # Requirements:
529
+ #
530
+ # * Contain only alphanumeric characters (A–Z, a–z, 0-9), hyphens (-),
531
+ # and underscores (\_).
532
+ #
533
+ # * Must be a unique geofence collection name.
534
+ #
535
+ # * No spaces allowed. For example, `ExampleGeofenceCollection`.
536
+ # @return [String]
537
+ #
538
+ # @!attribute [rw] description
539
+ # An optional description for the geofence collection.
540
+ # @return [String]
541
+ #
542
+ # @!attribute [rw] pricing_plan
543
+ # Specifies the pricing plan for your geofence collection. There's
544
+ # three pricing plan options:
545
+ #
546
+ # * `RequestBasedUsage` — Selects the "Request-Based Usage" pricing
547
+ # plan.
548
+ #
549
+ # * `MobileAssetTracking` — Selects the "Mobile Asset Tracking"
550
+ # pricing plan.
551
+ #
552
+ # * `MobileAssetManagement` — Selects the "Mobile Asset Management"
553
+ # pricing plan.
554
+ #
555
+ # For additional details and restrictions on each pricing plan option,
556
+ # see the [Amazon Location Service pricing page][1].
557
+ #
558
+ #
559
+ #
560
+ # [1]: https://aws.amazon.com/location/pricing/
561
+ # @return [String]
562
+ #
563
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateGeofenceCollectionRequest AWS API Documentation
564
+ #
565
+ class CreateGeofenceCollectionRequest < Struct.new(
566
+ :collection_name,
567
+ :description,
568
+ :pricing_plan)
569
+ SENSITIVE = []
570
+ include Aws::Structure
571
+ end
572
+
573
+ # @!attribute [rw] collection_arn
574
+ # The Amazon Resource Name (ARN) for the geofence collection resource.
575
+ # Used when you need to specify a resource across all AWS.
576
+ # @return [String]
577
+ #
578
+ # @!attribute [rw] collection_name
579
+ # The name for the geofence collection.
580
+ # @return [String]
581
+ #
582
+ # @!attribute [rw] create_time
583
+ # The timestamp for when the geofence collection was created in [ISO
584
+ # 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`
585
+ #
586
+ #
587
+ #
588
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
589
+ # @return [Time]
590
+ #
591
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateGeofenceCollectionResponse AWS API Documentation
592
+ #
593
+ class CreateGeofenceCollectionResponse < Struct.new(
594
+ :collection_arn,
595
+ :collection_name,
596
+ :create_time)
597
+ SENSITIVE = []
598
+ include Aws::Structure
599
+ end
600
+
601
+ # @note When making an API call, you may pass CreateMapRequest
602
+ # data as a hash:
603
+ #
604
+ # {
605
+ # configuration: { # required
606
+ # style: "MapStyle", # required
607
+ # },
608
+ # description: "ResourceDescription",
609
+ # map_name: "ResourceName", # required
610
+ # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
611
+ # }
612
+ #
613
+ # @!attribute [rw] configuration
614
+ # Specifies the map style selected from an available data provider.
615
+ # @return [Types::MapConfiguration]
616
+ #
617
+ # @!attribute [rw] description
618
+ # An optional description for the map resource.
619
+ # @return [String]
620
+ #
621
+ # @!attribute [rw] map_name
622
+ # The name for the map resource.
623
+ #
624
+ # Requirements:
625
+ #
626
+ # * Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens
627
+ # (-), and underscores (\_).
628
+ #
629
+ # * Must be a unique map resource name.
630
+ #
631
+ # * No spaces allowed. For example, `ExampleMap`.
632
+ # @return [String]
633
+ #
634
+ # @!attribute [rw] pricing_plan
635
+ # Specifies the pricing plan for your map resource. There's three
636
+ # pricing plan options:
637
+ #
638
+ # * `RequestBasedUsage` — Selects the "Request-Based Usage" pricing
639
+ # plan.
640
+ #
641
+ # * `MobileAssetTracking` — Selects the "Mobile Asset Tracking"
642
+ # pricing plan.
643
+ #
644
+ # * `MobileAssetManagement` — Selects the "Mobile Asset Management"
645
+ # pricing plan.
646
+ #
647
+ # For additional details and restrictions on each pricing plan option,
648
+ # see the [Amazon Location Service pricing page][1].
649
+ #
650
+ #
651
+ #
652
+ # [1]: https://aws.amazon.com/location/pricing/
653
+ # @return [String]
654
+ #
655
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateMapRequest AWS API Documentation
656
+ #
657
+ class CreateMapRequest < Struct.new(
658
+ :configuration,
659
+ :description,
660
+ :map_name,
661
+ :pricing_plan)
662
+ SENSITIVE = []
663
+ include Aws::Structure
664
+ end
665
+
666
+ # @!attribute [rw] create_time
667
+ # The timestamp for when the map resource was created in [ISO 8601][1]
668
+ # format: `YYYY-MM-DDThh:mm:ss.sssZ`.
669
+ #
670
+ #
671
+ #
672
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
673
+ # @return [Time]
674
+ #
675
+ # @!attribute [rw] map_arn
676
+ # The Amazon Resource Name (ARN) for the map resource. Used when you
677
+ # need to specify a resource across all AWS.
678
+ #
679
+ # * Format example:
680
+ # `arn:partition:service:region:account-id:resource-type:resource-id`
681
+ #
682
+ # ^
683
+ # @return [String]
684
+ #
685
+ # @!attribute [rw] map_name
686
+ # The name of the map resource.
687
+ # @return [String]
688
+ #
689
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateMapResponse AWS API Documentation
690
+ #
691
+ class CreateMapResponse < Struct.new(
692
+ :create_time,
693
+ :map_arn,
694
+ :map_name)
695
+ SENSITIVE = []
696
+ include Aws::Structure
697
+ end
698
+
699
+ # @note When making an API call, you may pass CreatePlaceIndexRequest
700
+ # data as a hash:
701
+ #
702
+ # {
703
+ # data_source: "String", # required
704
+ # data_source_configuration: {
705
+ # intended_use: "SingleUse", # accepts SingleUse, Storage
706
+ # },
707
+ # description: "ResourceDescription",
708
+ # index_name: "ResourceName", # required
709
+ # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
710
+ # }
711
+ #
712
+ # @!attribute [rw] data_source
713
+ # Specifies the data provider of geospatial data.
714
+ # @return [String]
715
+ #
716
+ # @!attribute [rw] data_source_configuration
717
+ # Specifies the data storage option for requesting Places.
718
+ # @return [Types::DataSourceConfiguration]
719
+ #
720
+ # @!attribute [rw] description
721
+ # The optional description for the Place index resource.
722
+ # @return [String]
723
+ #
724
+ # @!attribute [rw] index_name
725
+ # The name of the Place index resource.
726
+ #
727
+ # Requirements:
728
+ #
729
+ # * Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-)
730
+ # and underscores (\_) ).
731
+ #
732
+ # * Must be a unique Place index resource name.
733
+ #
734
+ # * No spaces allowed. For example, `ExamplePlaceIndex`.
735
+ # @return [String]
736
+ #
737
+ # @!attribute [rw] pricing_plan
738
+ # Specifies the pricing plan for your Place index resource. There's
739
+ # three pricing plan options:
740
+ #
741
+ # * `RequestBasedUsage` — Selects the "Request-Based Usage" pricing
742
+ # plan.
743
+ #
744
+ # * `MobileAssetTracking` — Selects the "Mobile Asset Tracking"
745
+ # pricing plan.
746
+ #
747
+ # * `MobileAssetManagement` — Selects the "Mobile Asset Management"
748
+ # pricing plan.
749
+ #
750
+ # For additional details and restrictions on each pricing plan option,
751
+ # see the [Amazon Location Service pricing page][1].
752
+ #
753
+ #
754
+ #
755
+ # [1]: https://aws.amazon.com/location/pricing/
756
+ # @return [String]
757
+ #
758
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreatePlaceIndexRequest AWS API Documentation
759
+ #
760
+ class CreatePlaceIndexRequest < Struct.new(
761
+ :data_source,
762
+ :data_source_configuration,
763
+ :description,
764
+ :index_name,
765
+ :pricing_plan)
766
+ SENSITIVE = []
767
+ include Aws::Structure
768
+ end
769
+
770
+ # @!attribute [rw] create_time
771
+ # The timestamp for when the Place index resource was created in [ISO
772
+ # 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
773
+ #
774
+ #
775
+ #
776
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
777
+ # @return [Time]
778
+ #
779
+ # @!attribute [rw] index_arn
780
+ # The Amazon Resource Name (ARN) for the Place index resource. Used
781
+ # when you need to specify a resource across all AWS.
782
+ # @return [String]
783
+ #
784
+ # @!attribute [rw] index_name
785
+ # The name for the Place index resource.
786
+ # @return [String]
787
+ #
788
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreatePlaceIndexResponse AWS API Documentation
789
+ #
790
+ class CreatePlaceIndexResponse < Struct.new(
791
+ :create_time,
792
+ :index_arn,
793
+ :index_name)
794
+ SENSITIVE = []
795
+ include Aws::Structure
796
+ end
797
+
798
+ # @note When making an API call, you may pass CreateTrackerRequest
799
+ # data as a hash:
800
+ #
801
+ # {
802
+ # description: "ResourceDescription",
803
+ # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
804
+ # tracker_name: "ResourceName", # required
805
+ # }
806
+ #
807
+ # @!attribute [rw] description
808
+ # An optional description for the tracker resource.
809
+ # @return [String]
810
+ #
811
+ # @!attribute [rw] pricing_plan
812
+ # Specifies the pricing plan for your tracker resource. There's three
813
+ # pricing plan options:
814
+ #
815
+ # * `RequestBasedUsage` — Selects the "Request-Based Usage" pricing
816
+ # plan.
817
+ #
818
+ # * `MobileAssetTracking` — Selects the "Mobile Asset Tracking"
819
+ # pricing plan.
820
+ #
821
+ # * `MobileAssetManagement` — Selects the "Mobile Asset Management"
822
+ # pricing plan.
823
+ #
824
+ # For additional details and restrictions on each pricing plan option,
825
+ # see the [Amazon Location Service pricing page][1].
826
+ #
827
+ #
828
+ #
829
+ # [1]: https://aws.amazon.com/location/pricing/
830
+ # @return [String]
831
+ #
832
+ # @!attribute [rw] tracker_name
833
+ # The name for the tracker resource.
834
+ #
835
+ # Requirements:
836
+ #
837
+ # * Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-)
838
+ # and underscores (\_).
839
+ #
840
+ # * Must be a unique tracker resource name.
841
+ #
842
+ # * No spaces allowed. For example, `ExampleTracker`.
843
+ # @return [String]
844
+ #
845
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateTrackerRequest AWS API Documentation
846
+ #
847
+ class CreateTrackerRequest < Struct.new(
848
+ :description,
849
+ :pricing_plan,
850
+ :tracker_name)
851
+ SENSITIVE = []
852
+ include Aws::Structure
853
+ end
854
+
855
+ # @!attribute [rw] create_time
856
+ # The timestamp for when the tracker resource was created in [ ISO
857
+ # 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
858
+ #
859
+ #
860
+ #
861
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
862
+ # @return [Time]
863
+ #
864
+ # @!attribute [rw] tracker_arn
865
+ # The Amazon Resource Name (ARN) for the tracker resource. Used when
866
+ # you need to specify a resource across all AWS.
867
+ # @return [String]
868
+ #
869
+ # @!attribute [rw] tracker_name
870
+ # The name of the tracker resource.
871
+ # @return [String]
872
+ #
873
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateTrackerResponse AWS API Documentation
874
+ #
875
+ class CreateTrackerResponse < Struct.new(
876
+ :create_time,
877
+ :tracker_arn,
878
+ :tracker_name)
879
+ SENSITIVE = []
880
+ include Aws::Structure
881
+ end
882
+
883
+ # Specifies the data storage option chosen for requesting Places.
884
+ #
885
+ # <note markdown="1"> By using Places, you agree that AWS may transmit your API queries to
886
+ # your selected third party provider for processing, which may be
887
+ # outside the AWS region you are currently using.
888
+ #
889
+ # Also, when using HERE as your data provider, you may not (a) use HERE
890
+ # Places for Asset Management, or (b) select the `Storage` option for
891
+ # the `IntendedUse` parameter when requesting Places in Japan. For more
892
+ # information, see the [AWS Service Terms][1] for Amazon Location
893
+ # Service.
894
+ #
895
+ # </note>
896
+ #
897
+ #
898
+ #
899
+ # [1]: https://aws.amazon.com/service-terms/
900
+ #
901
+ # @note When making an API call, you may pass DataSourceConfiguration
902
+ # data as a hash:
903
+ #
904
+ # {
905
+ # intended_use: "SingleUse", # accepts SingleUse, Storage
906
+ # }
907
+ #
908
+ # @!attribute [rw] intended_use
909
+ # Specifies how the results of an operation will be stored by the
910
+ # caller.
911
+ #
912
+ # Valid values include:
913
+ #
914
+ # * `SingleUse` specifies that the results won't be stored.
915
+ #
916
+ # * `Storage` specifies that the result can be cached or stored in a
917
+ # database.
918
+ #
919
+ # Default value: `SingleUse`
920
+ # @return [String]
921
+ #
922
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DataSourceConfiguration AWS API Documentation
923
+ #
924
+ class DataSourceConfiguration < Struct.new(
925
+ :intended_use)
926
+ SENSITIVE = []
927
+ include Aws::Structure
928
+ end
929
+
930
+ # @note When making an API call, you may pass DeleteGeofenceCollectionRequest
931
+ # data as a hash:
932
+ #
933
+ # {
934
+ # collection_name: "ResourceName", # required
935
+ # }
936
+ #
937
+ # @!attribute [rw] collection_name
938
+ # The name of the geofence collection to be deleted.
939
+ # @return [String]
940
+ #
941
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteGeofenceCollectionRequest AWS API Documentation
942
+ #
943
+ class DeleteGeofenceCollectionRequest < Struct.new(
944
+ :collection_name)
945
+ SENSITIVE = []
946
+ include Aws::Structure
947
+ end
948
+
949
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteGeofenceCollectionResponse AWS API Documentation
950
+ #
951
+ class DeleteGeofenceCollectionResponse < Aws::EmptyStructure; end
952
+
953
+ # @note When making an API call, you may pass DeleteMapRequest
954
+ # data as a hash:
955
+ #
956
+ # {
957
+ # map_name: "ResourceName", # required
958
+ # }
959
+ #
960
+ # @!attribute [rw] map_name
961
+ # The name of the map resource to be deleted.
962
+ # @return [String]
963
+ #
964
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteMapRequest AWS API Documentation
965
+ #
966
+ class DeleteMapRequest < Struct.new(
967
+ :map_name)
968
+ SENSITIVE = []
969
+ include Aws::Structure
970
+ end
971
+
972
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteMapResponse AWS API Documentation
973
+ #
974
+ class DeleteMapResponse < Aws::EmptyStructure; end
975
+
976
+ # @note When making an API call, you may pass DeletePlaceIndexRequest
977
+ # data as a hash:
978
+ #
979
+ # {
980
+ # index_name: "ResourceName", # required
981
+ # }
982
+ #
983
+ # @!attribute [rw] index_name
984
+ # The name of the Place index resource to be deleted.
985
+ # @return [String]
986
+ #
987
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeletePlaceIndexRequest AWS API Documentation
988
+ #
989
+ class DeletePlaceIndexRequest < Struct.new(
990
+ :index_name)
991
+ SENSITIVE = []
992
+ include Aws::Structure
993
+ end
994
+
995
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeletePlaceIndexResponse AWS API Documentation
996
+ #
997
+ class DeletePlaceIndexResponse < Aws::EmptyStructure; end
998
+
999
+ # @note When making an API call, you may pass DeleteTrackerRequest
1000
+ # data as a hash:
1001
+ #
1002
+ # {
1003
+ # tracker_name: "ResourceName", # required
1004
+ # }
1005
+ #
1006
+ # @!attribute [rw] tracker_name
1007
+ # The name of the tracker resource to be deleted.
1008
+ # @return [String]
1009
+ #
1010
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteTrackerRequest AWS API Documentation
1011
+ #
1012
+ class DeleteTrackerRequest < Struct.new(
1013
+ :tracker_name)
1014
+ SENSITIVE = []
1015
+ include Aws::Structure
1016
+ end
1017
+
1018
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteTrackerResponse AWS API Documentation
1019
+ #
1020
+ class DeleteTrackerResponse < Aws::EmptyStructure; end
1021
+
1022
+ # @note When making an API call, you may pass DescribeGeofenceCollectionRequest
1023
+ # data as a hash:
1024
+ #
1025
+ # {
1026
+ # collection_name: "ResourceName", # required
1027
+ # }
1028
+ #
1029
+ # @!attribute [rw] collection_name
1030
+ # The name of the geofence collection.
1031
+ # @return [String]
1032
+ #
1033
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeGeofenceCollectionRequest AWS API Documentation
1034
+ #
1035
+ class DescribeGeofenceCollectionRequest < Struct.new(
1036
+ :collection_name)
1037
+ SENSITIVE = []
1038
+ include Aws::Structure
1039
+ end
1040
+
1041
+ # @!attribute [rw] collection_arn
1042
+ # The Amazon Resource Name (ARN) for the geofence collection resource.
1043
+ # Used when you need to specify a resource across all AWS.
1044
+ # @return [String]
1045
+ #
1046
+ # @!attribute [rw] collection_name
1047
+ # The name of the geofence collection.
1048
+ # @return [String]
1049
+ #
1050
+ # @!attribute [rw] create_time
1051
+ # The timestamp for when the geofence resource was created in [ISO
1052
+ # 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`
1053
+ #
1054
+ #
1055
+ #
1056
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
1057
+ # @return [Time]
1058
+ #
1059
+ # @!attribute [rw] description
1060
+ # The optional description for the geofence collection.
1061
+ # @return [String]
1062
+ #
1063
+ # @!attribute [rw] update_time
1064
+ # The timestamp for when the geofence collection was last updated in
1065
+ # [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`
1066
+ #
1067
+ #
1068
+ #
1069
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
1070
+ # @return [Time]
1071
+ #
1072
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeGeofenceCollectionResponse AWS API Documentation
1073
+ #
1074
+ class DescribeGeofenceCollectionResponse < Struct.new(
1075
+ :collection_arn,
1076
+ :collection_name,
1077
+ :create_time,
1078
+ :description,
1079
+ :update_time)
1080
+ SENSITIVE = []
1081
+ include Aws::Structure
1082
+ end
1083
+
1084
+ # @note When making an API call, you may pass DescribeMapRequest
1085
+ # data as a hash:
1086
+ #
1087
+ # {
1088
+ # map_name: "ResourceName", # required
1089
+ # }
1090
+ #
1091
+ # @!attribute [rw] map_name
1092
+ # The name of the map resource.
1093
+ # @return [String]
1094
+ #
1095
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeMapRequest AWS API Documentation
1096
+ #
1097
+ class DescribeMapRequest < Struct.new(
1098
+ :map_name)
1099
+ SENSITIVE = []
1100
+ include Aws::Structure
1101
+ end
1102
+
1103
+ # @!attribute [rw] configuration
1104
+ # Specifies the map tile style selected from a partner data provider.
1105
+ # @return [Types::MapConfiguration]
1106
+ #
1107
+ # @!attribute [rw] create_time
1108
+ # The timestamp for when the map resource was created in [ISO 8601][1]
1109
+ # format: `YYYY-MM-DDThh:mm:ss.sssZ`.
1110
+ #
1111
+ #
1112
+ #
1113
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
1114
+ # @return [Time]
1115
+ #
1116
+ # @!attribute [rw] data_source
1117
+ # Specifies the data provider for the associated map tiles.
1118
+ # @return [String]
1119
+ #
1120
+ # @!attribute [rw] description
1121
+ # The optional description for the map resource.
1122
+ # @return [String]
1123
+ #
1124
+ # @!attribute [rw] map_arn
1125
+ # The Amazon Resource Name (ARN) for the map resource. Used when you
1126
+ # need to specify a resource across all AWS.
1127
+ # @return [String]
1128
+ #
1129
+ # @!attribute [rw] map_name
1130
+ # The map style selected from an available provider.
1131
+ # @return [String]
1132
+ #
1133
+ # @!attribute [rw] update_time
1134
+ # The timestamp for when the map resource was last update in [ISO
1135
+ # 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
1136
+ #
1137
+ #
1138
+ #
1139
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
1140
+ # @return [Time]
1141
+ #
1142
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeMapResponse AWS API Documentation
1143
+ #
1144
+ class DescribeMapResponse < Struct.new(
1145
+ :configuration,
1146
+ :create_time,
1147
+ :data_source,
1148
+ :description,
1149
+ :map_arn,
1150
+ :map_name,
1151
+ :update_time)
1152
+ SENSITIVE = []
1153
+ include Aws::Structure
1154
+ end
1155
+
1156
+ # @note When making an API call, you may pass DescribePlaceIndexRequest
1157
+ # data as a hash:
1158
+ #
1159
+ # {
1160
+ # index_name: "ResourceName", # required
1161
+ # }
1162
+ #
1163
+ # @!attribute [rw] index_name
1164
+ # The name of the Place index resource.
1165
+ # @return [String]
1166
+ #
1167
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribePlaceIndexRequest AWS API Documentation
1168
+ #
1169
+ class DescribePlaceIndexRequest < Struct.new(
1170
+ :index_name)
1171
+ SENSITIVE = []
1172
+ include Aws::Structure
1173
+ end
1174
+
1175
+ # @!attribute [rw] create_time
1176
+ # The timestamp for when the Place index resource was created in [ISO
1177
+ # 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
1178
+ #
1179
+ #
1180
+ #
1181
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
1182
+ # @return [Time]
1183
+ #
1184
+ # @!attribute [rw] data_source
1185
+ # The data provider of geospatial data.
1186
+ # @return [String]
1187
+ #
1188
+ # @!attribute [rw] data_source_configuration
1189
+ # The specified data storage option for requesting Places.
1190
+ # @return [Types::DataSourceConfiguration]
1191
+ #
1192
+ # @!attribute [rw] description
1193
+ # The optional description for the Place index resource.
1194
+ # @return [String]
1195
+ #
1196
+ # @!attribute [rw] index_arn
1197
+ # The Amazon Resource Name (ARN) for the Place index resource. Used
1198
+ # when you need to specify a resource across all AWS.
1199
+ # @return [String]
1200
+ #
1201
+ # @!attribute [rw] index_name
1202
+ # The name of the Place index resource being described.
1203
+ # @return [String]
1204
+ #
1205
+ # @!attribute [rw] update_time
1206
+ # The timestamp for when the Place index resource was last updated in
1207
+ # [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
1208
+ #
1209
+ #
1210
+ #
1211
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
1212
+ # @return [Time]
1213
+ #
1214
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribePlaceIndexResponse AWS API Documentation
1215
+ #
1216
+ class DescribePlaceIndexResponse < Struct.new(
1217
+ :create_time,
1218
+ :data_source,
1219
+ :data_source_configuration,
1220
+ :description,
1221
+ :index_arn,
1222
+ :index_name,
1223
+ :update_time)
1224
+ SENSITIVE = []
1225
+ include Aws::Structure
1226
+ end
1227
+
1228
+ # @note When making an API call, you may pass DescribeTrackerRequest
1229
+ # data as a hash:
1230
+ #
1231
+ # {
1232
+ # tracker_name: "ResourceName", # required
1233
+ # }
1234
+ #
1235
+ # @!attribute [rw] tracker_name
1236
+ # The name of the tracker resource.
1237
+ # @return [String]
1238
+ #
1239
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeTrackerRequest AWS API Documentation
1240
+ #
1241
+ class DescribeTrackerRequest < Struct.new(
1242
+ :tracker_name)
1243
+ SENSITIVE = []
1244
+ include Aws::Structure
1245
+ end
1246
+
1247
+ # @!attribute [rw] create_time
1248
+ # The timestamp for when the tracker resource was created in [ ISO
1249
+ # 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
1250
+ #
1251
+ #
1252
+ #
1253
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
1254
+ # @return [Time]
1255
+ #
1256
+ # @!attribute [rw] description
1257
+ # The optional description for the tracker resource.
1258
+ # @return [String]
1259
+ #
1260
+ # @!attribute [rw] tracker_arn
1261
+ # The Amazon Resource Name (ARN) for the tracker resource. Used when
1262
+ # you need to specify a resource across all AWS.
1263
+ # @return [String]
1264
+ #
1265
+ # @!attribute [rw] tracker_name
1266
+ # The name of the tracker resource.
1267
+ # @return [String]
1268
+ #
1269
+ # @!attribute [rw] update_time
1270
+ # The timestamp for when the tracker resource was last updated in [
1271
+ # ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
1272
+ #
1273
+ #
1274
+ #
1275
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
1276
+ # @return [Time]
1277
+ #
1278
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeTrackerResponse AWS API Documentation
1279
+ #
1280
+ class DescribeTrackerResponse < Struct.new(
1281
+ :create_time,
1282
+ :description,
1283
+ :tracker_arn,
1284
+ :tracker_name,
1285
+ :update_time)
1286
+ SENSITIVE = []
1287
+ include Aws::Structure
1288
+ end
1289
+
1290
+ # Contains the device position details.
1291
+ #
1292
+ # @!attribute [rw] device_id
1293
+ # The device whose position you retrieved.
1294
+ # @return [String]
1295
+ #
1296
+ # @!attribute [rw] position
1297
+ # The last known device position.
1298
+ # @return [Array<Float>]
1299
+ #
1300
+ # @!attribute [rw] received_time
1301
+ # The timestamp for when the tracker resource recieved the position in
1302
+ # [ ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
1303
+ #
1304
+ #
1305
+ #
1306
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
1307
+ # @return [Time]
1308
+ #
1309
+ # @!attribute [rw] sample_time
1310
+ # The timestamp for when the position was detected and sampled in [
1311
+ # ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
1312
+ #
1313
+ #
1314
+ #
1315
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
1316
+ # @return [Time]
1317
+ #
1318
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DevicePosition AWS API Documentation
1319
+ #
1320
+ class DevicePosition < Struct.new(
1321
+ :device_id,
1322
+ :position,
1323
+ :received_time,
1324
+ :sample_time)
1325
+ SENSITIVE = [:position]
1326
+ include Aws::Structure
1327
+ end
1328
+
1329
+ # Contains the position update details for a device.
1330
+ #
1331
+ # @note When making an API call, you may pass DevicePositionUpdate
1332
+ # data as a hash:
1333
+ #
1334
+ # {
1335
+ # device_id: "Id", # required
1336
+ # position: [1.0], # required
1337
+ # sample_time: Time.now, # required
1338
+ # }
1339
+ #
1340
+ # @!attribute [rw] device_id
1341
+ # The device associated to the position update.
1342
+ # @return [String]
1343
+ #
1344
+ # @!attribute [rw] position
1345
+ # The latest device position defined in [WGS 84][1] format:
1346
+ # `[Xlongitude, Ylatitude]`.
1347
+ #
1348
+ #
1349
+ #
1350
+ # [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
1351
+ # @return [Array<Float>]
1352
+ #
1353
+ # @!attribute [rw] sample_time
1354
+ # The timestamp for when the position update was received in [ISO
1355
+ # 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`
1356
+ #
1357
+ #
1358
+ #
1359
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
1360
+ # @return [Time]
1361
+ #
1362
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DevicePositionUpdate AWS API Documentation
1363
+ #
1364
+ class DevicePositionUpdate < Struct.new(
1365
+ :device_id,
1366
+ :position,
1367
+ :sample_time)
1368
+ SENSITIVE = [:position]
1369
+ include Aws::Structure
1370
+ end
1371
+
1372
+ # @note When making an API call, you may pass DisassociateTrackerConsumerRequest
1373
+ # data as a hash:
1374
+ #
1375
+ # {
1376
+ # consumer_arn: "Arn", # required
1377
+ # tracker_name: "ResourceName", # required
1378
+ # }
1379
+ #
1380
+ # @!attribute [rw] consumer_arn
1381
+ # The Amazon Resource Name (ARN) for the geofence collection to be
1382
+ # disassociated from the tracker resource. Used when you need to
1383
+ # specify a resource across all AWS.
1384
+ #
1385
+ # * Format example:
1386
+ # `arn:partition:service:region:account-id:resource-type:resource-id`
1387
+ #
1388
+ # ^
1389
+ # @return [String]
1390
+ #
1391
+ # @!attribute [rw] tracker_name
1392
+ # The name of the tracker resource to be dissociated from the
1393
+ # consumer.
1394
+ # @return [String]
1395
+ #
1396
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DisassociateTrackerConsumerRequest AWS API Documentation
1397
+ #
1398
+ class DisassociateTrackerConsumerRequest < Struct.new(
1399
+ :consumer_arn,
1400
+ :tracker_name)
1401
+ SENSITIVE = []
1402
+ include Aws::Structure
1403
+ end
1404
+
1405
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DisassociateTrackerConsumerResponse AWS API Documentation
1406
+ #
1407
+ class DisassociateTrackerConsumerResponse < Aws::EmptyStructure; end
1408
+
1409
+ # Contains the geofence geometry details.
1410
+ #
1411
+ # <note markdown="1"> Limitation — Amazon Location does not currently support polygons with
1412
+ # holes, multipolygons, polygons that are wound clockwise, or that cross
1413
+ # the antimeridian.
1414
+ #
1415
+ # </note>
1416
+ #
1417
+ # @note When making an API call, you may pass GeofenceGeometry
1418
+ # data as a hash:
1419
+ #
1420
+ # {
1421
+ # polygon: [
1422
+ # [
1423
+ # [1.0],
1424
+ # ],
1425
+ # ],
1426
+ # }
1427
+ #
1428
+ # @!attribute [rw] polygon
1429
+ # An array of 1 or more linear rings. A linear ring is an array of 4
1430
+ # or more vertices, where the first and last vertex are the same to
1431
+ # form a closed boundary. Each vertex is a 2-dimensional point of the
1432
+ # form: `[longitude, latitude]`.
1433
+ #
1434
+ # The first linear ring is an outer ring, describing the polygon's
1435
+ # boundary. Subsequent linear rings may be inner or outer rings to
1436
+ # describe holes and islands. Outer rings must list their vertices in
1437
+ # counter-clockwise order around the ring's center, where the left
1438
+ # side is the polygon's exterior. Inner rings must list their
1439
+ # vertices in clockwise order, where the left side is the polygon's
1440
+ # interior.
1441
+ # @return [Array<Array<Array<Float>>>]
1442
+ #
1443
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GeofenceGeometry AWS API Documentation
1444
+ #
1445
+ class GeofenceGeometry < Struct.new(
1446
+ :polygon)
1447
+ SENSITIVE = []
1448
+ include Aws::Structure
1449
+ end
1450
+
1451
+ # @note When making an API call, you may pass GetDevicePositionHistoryRequest
1452
+ # data as a hash:
1453
+ #
1454
+ # {
1455
+ # device_id: "Id", # required
1456
+ # end_time_exclusive: Time.now,
1457
+ # next_token: "Token",
1458
+ # start_time_inclusive: Time.now,
1459
+ # tracker_name: "ResourceName", # required
1460
+ # }
1461
+ #
1462
+ # @!attribute [rw] device_id
1463
+ # The device whose position history you want to retrieve.
1464
+ # @return [String]
1465
+ #
1466
+ # @!attribute [rw] end_time_exclusive
1467
+ # Specify the end time for the position history in [ ISO 8601][1]
1468
+ # format: `YYYY-MM-DDThh:mm:ss.sssZ`.
1469
+ #
1470
+ # * The given time for `EndTimeExclusive` must be after the time for
1471
+ # `StartTimeInclusive`.
1472
+ #
1473
+ # ^
1474
+ #
1475
+ #
1476
+ #
1477
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
1478
+ # @return [Time]
1479
+ #
1480
+ # @!attribute [rw] next_token
1481
+ # The pagination token specifying which page of results to return in
1482
+ # the response. If no token is provided, the default page is the first
1483
+ # page.
1484
+ #
1485
+ # Default value: `null`
1486
+ # @return [String]
1487
+ #
1488
+ # @!attribute [rw] start_time_inclusive
1489
+ # Specify the start time for the position history in [ ISO 8601][1]
1490
+ # format: `YYYY-MM-DDThh:mm:ss.sssZ`.
1491
+ #
1492
+ # * The given time for `EndTimeExclusive` must be after the time for
1493
+ # `StartTimeInclusive`.
1494
+ #
1495
+ # ^
1496
+ #
1497
+ #
1498
+ #
1499
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
1500
+ # @return [Time]
1501
+ #
1502
+ # @!attribute [rw] tracker_name
1503
+ # The tracker resource receiving the request for the device position
1504
+ # history.
1505
+ # @return [String]
1506
+ #
1507
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetDevicePositionHistoryRequest AWS API Documentation
1508
+ #
1509
+ class GetDevicePositionHistoryRequest < Struct.new(
1510
+ :device_id,
1511
+ :end_time_exclusive,
1512
+ :next_token,
1513
+ :start_time_inclusive,
1514
+ :tracker_name)
1515
+ SENSITIVE = []
1516
+ include Aws::Structure
1517
+ end
1518
+
1519
+ # @!attribute [rw] device_positions
1520
+ # Contains the position history details for the requested device.
1521
+ # @return [Array<Types::DevicePosition>]
1522
+ #
1523
+ # @!attribute [rw] next_token
1524
+ # A pagination token indicating there are additional pages available.
1525
+ # You can use the token in a following request to fetch the next set
1526
+ # of results.
1527
+ # @return [String]
1528
+ #
1529
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetDevicePositionHistoryResponse AWS API Documentation
1530
+ #
1531
+ class GetDevicePositionHistoryResponse < Struct.new(
1532
+ :device_positions,
1533
+ :next_token)
1534
+ SENSITIVE = []
1535
+ include Aws::Structure
1536
+ end
1537
+
1538
+ # @note When making an API call, you may pass GetDevicePositionRequest
1539
+ # data as a hash:
1540
+ #
1541
+ # {
1542
+ # device_id: "Id", # required
1543
+ # tracker_name: "ResourceName", # required
1544
+ # }
1545
+ #
1546
+ # @!attribute [rw] device_id
1547
+ # The device whose position you want to retreieve.
1548
+ # @return [String]
1549
+ #
1550
+ # @!attribute [rw] tracker_name
1551
+ # The tracker resource receiving the position update.
1552
+ # @return [String]
1553
+ #
1554
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetDevicePositionRequest AWS API Documentation
1555
+ #
1556
+ class GetDevicePositionRequest < Struct.new(
1557
+ :device_id,
1558
+ :tracker_name)
1559
+ SENSITIVE = []
1560
+ include Aws::Structure
1561
+ end
1562
+
1563
+ # @!attribute [rw] device_id
1564
+ # The device whose position you retrieved.
1565
+ # @return [String]
1566
+ #
1567
+ # @!attribute [rw] position
1568
+ # The last known device position.
1569
+ # @return [Array<Float>]
1570
+ #
1571
+ # @!attribute [rw] received_time
1572
+ # The timestamp for when the tracker resource recieved the position in
1573
+ # [ ISO 8601 ][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
1574
+ #
1575
+ #
1576
+ #
1577
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
1578
+ # @return [Time]
1579
+ #
1580
+ # @!attribute [rw] sample_time
1581
+ # The timestamp for when the position was detected and sampled in [
1582
+ # ISO 8601 ][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
1583
+ #
1584
+ #
1585
+ #
1586
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
1587
+ # @return [Time]
1588
+ #
1589
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetDevicePositionResponse AWS API Documentation
1590
+ #
1591
+ class GetDevicePositionResponse < Struct.new(
1592
+ :device_id,
1593
+ :position,
1594
+ :received_time,
1595
+ :sample_time)
1596
+ SENSITIVE = [:position]
1597
+ include Aws::Structure
1598
+ end
1599
+
1600
+ # @note When making an API call, you may pass GetGeofenceRequest
1601
+ # data as a hash:
1602
+ #
1603
+ # {
1604
+ # collection_name: "ResourceName", # required
1605
+ # geofence_id: "Id", # required
1606
+ # }
1607
+ #
1608
+ # @!attribute [rw] collection_name
1609
+ # The geofence collection storing the target geofence.
1610
+ # @return [String]
1611
+ #
1612
+ # @!attribute [rw] geofence_id
1613
+ # The geofence you're retrieving details for.
1614
+ # @return [String]
1615
+ #
1616
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetGeofenceRequest AWS API Documentation
1617
+ #
1618
+ class GetGeofenceRequest < Struct.new(
1619
+ :collection_name,
1620
+ :geofence_id)
1621
+ SENSITIVE = []
1622
+ include Aws::Structure
1623
+ end
1624
+
1625
+ # @!attribute [rw] create_time
1626
+ # The timestamp for when the geofence collection was created in [ISO
1627
+ # 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`
1628
+ #
1629
+ #
1630
+ #
1631
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
1632
+ # @return [Time]
1633
+ #
1634
+ # @!attribute [rw] geofence_id
1635
+ # The geofence identifier.
1636
+ # @return [String]
1637
+ #
1638
+ # @!attribute [rw] geometry
1639
+ # Contains the geofence geometry details describing a polygon.
1640
+ # @return [Types::GeofenceGeometry]
1641
+ #
1642
+ # @!attribute [rw] status
1643
+ # Identifies the state of the geofence. A geofence will hold one of
1644
+ # the following states:
1645
+ #
1646
+ # * `ACTIVE` — The geofence has been indexed by the system.
1647
+ #
1648
+ # * `PENDING` — The geofence is being processed by the system.
1649
+ #
1650
+ # * `FAILED` — The geofence failed to be indexed by the system.
1651
+ #
1652
+ # * `DELETED` — The geofence has been deleted from the system index.
1653
+ #
1654
+ # * `DELETING` — The geofence is being deleted from the system index.
1655
+ # @return [String]
1656
+ #
1657
+ # @!attribute [rw] update_time
1658
+ # The timestamp for when the geofence collection was last updated in
1659
+ # [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`
1660
+ #
1661
+ #
1662
+ #
1663
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
1664
+ # @return [Time]
1665
+ #
1666
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetGeofenceResponse AWS API Documentation
1667
+ #
1668
+ class GetGeofenceResponse < Struct.new(
1669
+ :create_time,
1670
+ :geofence_id,
1671
+ :geometry,
1672
+ :status,
1673
+ :update_time)
1674
+ SENSITIVE = []
1675
+ include Aws::Structure
1676
+ end
1677
+
1678
+ # @note When making an API call, you may pass GetMapGlyphsRequest
1679
+ # data as a hash:
1680
+ #
1681
+ # {
1682
+ # font_stack: "String", # required
1683
+ # font_unicode_range: "GetMapGlyphsRequestFontUnicodeRangeString", # required
1684
+ # map_name: "ResourceName", # required
1685
+ # }
1686
+ #
1687
+ # @!attribute [rw] font_stack
1688
+ # A comma-separated list of fonts to load glyphs from in order of
1689
+ # preference.. For example, `Noto Sans, Arial Unicode`.
1690
+ # @return [String]
1691
+ #
1692
+ # @!attribute [rw] font_unicode_range
1693
+ # A Unicode range of characters to download glyphs for. Each response
1694
+ # will contain 256 characters. For example, 0-255 includes all
1695
+ # characters from range `U+0000` to `00FF`. Must be aligned to
1696
+ # multiples of 256.
1697
+ # @return [String]
1698
+ #
1699
+ # @!attribute [rw] map_name
1700
+ # The map resource associated with the glyph file.
1701
+ # @return [String]
1702
+ #
1703
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapGlyphsRequest AWS API Documentation
1704
+ #
1705
+ class GetMapGlyphsRequest < Struct.new(
1706
+ :font_stack,
1707
+ :font_unicode_range,
1708
+ :map_name)
1709
+ SENSITIVE = []
1710
+ include Aws::Structure
1711
+ end
1712
+
1713
+ # @!attribute [rw] blob
1714
+ # The blob's content type.
1715
+ # @return [String]
1716
+ #
1717
+ # @!attribute [rw] content_type
1718
+ # The map glyph content type. For example, `application/octet-stream`.
1719
+ # @return [String]
1720
+ #
1721
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapGlyphsResponse AWS API Documentation
1722
+ #
1723
+ class GetMapGlyphsResponse < Struct.new(
1724
+ :blob,
1725
+ :content_type)
1726
+ SENSITIVE = []
1727
+ include Aws::Structure
1728
+ end
1729
+
1730
+ # @note When making an API call, you may pass GetMapSpritesRequest
1731
+ # data as a hash:
1732
+ #
1733
+ # {
1734
+ # file_name: "GetMapSpritesRequestFileNameString", # required
1735
+ # map_name: "ResourceName", # required
1736
+ # }
1737
+ #
1738
+ # @!attribute [rw] file_name
1739
+ # The name of the sprite file. Use the following file names for the
1740
+ # sprite sheet:
1741
+ #
1742
+ # * `sprites.png`
1743
+ #
1744
+ # * `sprites@2x.png` for high pixel density displays
1745
+ #
1746
+ # For the JSON document contain image offsets. Use the following file
1747
+ # names:
1748
+ #
1749
+ # * `sprites.json`
1750
+ #
1751
+ # * `sprites@2x.json` for high pixel density displays
1752
+ # @return [String]
1753
+ #
1754
+ # @!attribute [rw] map_name
1755
+ # The map resource associated with the sprite file.
1756
+ # @return [String]
1757
+ #
1758
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapSpritesRequest AWS API Documentation
1759
+ #
1760
+ class GetMapSpritesRequest < Struct.new(
1761
+ :file_name,
1762
+ :map_name)
1763
+ SENSITIVE = []
1764
+ include Aws::Structure
1765
+ end
1766
+
1767
+ # @!attribute [rw] blob
1768
+ # Contains the body of the sprite sheet or JSON offset file.
1769
+ # @return [String]
1770
+ #
1771
+ # @!attribute [rw] content_type
1772
+ # The content type of the sprite sheet and offsets. For example, the
1773
+ # sprite sheet content type is `image/png`, and the sprite offset JSON
1774
+ # document is `application/json`.
1775
+ # @return [String]
1776
+ #
1777
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapSpritesResponse AWS API Documentation
1778
+ #
1779
+ class GetMapSpritesResponse < Struct.new(
1780
+ :blob,
1781
+ :content_type)
1782
+ SENSITIVE = []
1783
+ include Aws::Structure
1784
+ end
1785
+
1786
+ # @note When making an API call, you may pass GetMapStyleDescriptorRequest
1787
+ # data as a hash:
1788
+ #
1789
+ # {
1790
+ # map_name: "ResourceName", # required
1791
+ # }
1792
+ #
1793
+ # @!attribute [rw] map_name
1794
+ # The map resource to retrieve the style descriptor from.
1795
+ # @return [String]
1796
+ #
1797
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapStyleDescriptorRequest AWS API Documentation
1798
+ #
1799
+ class GetMapStyleDescriptorRequest < Struct.new(
1800
+ :map_name)
1801
+ SENSITIVE = []
1802
+ include Aws::Structure
1803
+ end
1804
+
1805
+ # @!attribute [rw] blob
1806
+ # Contains the body of the style descriptor.
1807
+ # @return [String]
1808
+ #
1809
+ # @!attribute [rw] content_type
1810
+ # The style descriptor's content type. For example,
1811
+ # `application/json`.
1812
+ # @return [String]
1813
+ #
1814
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapStyleDescriptorResponse AWS API Documentation
1815
+ #
1816
+ class GetMapStyleDescriptorResponse < Struct.new(
1817
+ :blob,
1818
+ :content_type)
1819
+ SENSITIVE = []
1820
+ include Aws::Structure
1821
+ end
1822
+
1823
+ # @note When making an API call, you may pass GetMapTileRequest
1824
+ # data as a hash:
1825
+ #
1826
+ # {
1827
+ # map_name: "ResourceName", # required
1828
+ # x: "GetMapTileRequestXString", # required
1829
+ # y: "GetMapTileRequestYString", # required
1830
+ # z: "GetMapTileRequestZString", # required
1831
+ # }
1832
+ #
1833
+ # @!attribute [rw] map_name
1834
+ # The map resource to retrieve the map tiles from.
1835
+ # @return [String]
1836
+ #
1837
+ # @!attribute [rw] x
1838
+ # The X axis value for the map tile.
1839
+ # @return [String]
1840
+ #
1841
+ # @!attribute [rw] y
1842
+ # The Y axis value for the map tile.
1843
+ # @return [String]
1844
+ #
1845
+ # @!attribute [rw] z
1846
+ # The zoom value for the map tile.
1847
+ # @return [String]
1848
+ #
1849
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapTileRequest AWS API Documentation
1850
+ #
1851
+ class GetMapTileRequest < Struct.new(
1852
+ :map_name,
1853
+ :x,
1854
+ :y,
1855
+ :z)
1856
+ SENSITIVE = []
1857
+ include Aws::Structure
1858
+ end
1859
+
1860
+ # @!attribute [rw] blob
1861
+ # Contains Mapbox Vector Tile (MVT) data.
1862
+ # @return [String]
1863
+ #
1864
+ # @!attribute [rw] content_type
1865
+ # The map tile's content type. For example,
1866
+ # `application/vnd.mapbox-vector-tile`.
1867
+ # @return [String]
1868
+ #
1869
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapTileResponse AWS API Documentation
1870
+ #
1871
+ class GetMapTileResponse < Struct.new(
1872
+ :blob,
1873
+ :content_type)
1874
+ SENSITIVE = []
1875
+ include Aws::Structure
1876
+ end
1877
+
1878
+ # The request has failed to process because of an unknown server error,
1879
+ # exception, or failure.
1880
+ #
1881
+ # @!attribute [rw] message
1882
+ # @return [String]
1883
+ #
1884
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/InternalServerException AWS API Documentation
1885
+ #
1886
+ class InternalServerException < Struct.new(
1887
+ :message)
1888
+ SENSITIVE = []
1889
+ include Aws::Structure
1890
+ end
1891
+
1892
+ # @note When making an API call, you may pass ListGeofenceCollectionsRequest
1893
+ # data as a hash:
1894
+ #
1895
+ # {
1896
+ # max_results: 1,
1897
+ # next_token: "Token",
1898
+ # }
1899
+ #
1900
+ # @!attribute [rw] max_results
1901
+ # An optional limit for the number of resources returned in a single
1902
+ # call.
1903
+ #
1904
+ # Default value: `100`
1905
+ # @return [Integer]
1906
+ #
1907
+ # @!attribute [rw] next_token
1908
+ # The pagination token specifying which page of results to return in
1909
+ # the response. If no token is provided, the default page is the first
1910
+ # page.
1911
+ #
1912
+ # Default value: `null`
1913
+ # @return [String]
1914
+ #
1915
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListGeofenceCollectionsRequest AWS API Documentation
1916
+ #
1917
+ class ListGeofenceCollectionsRequest < Struct.new(
1918
+ :max_results,
1919
+ :next_token)
1920
+ SENSITIVE = []
1921
+ include Aws::Structure
1922
+ end
1923
+
1924
+ # @!attribute [rw] entries
1925
+ # Lists the geofence collections that exist in your AWS account.
1926
+ # @return [Array<Types::ListGeofenceCollectionsResponseEntry>]
1927
+ #
1928
+ # @!attribute [rw] next_token
1929
+ # A pagination token indicating there are additional pages available.
1930
+ # You can use the token in a following request to fetch the next set
1931
+ # of results.
1932
+ # @return [String]
1933
+ #
1934
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListGeofenceCollectionsResponse AWS API Documentation
1935
+ #
1936
+ class ListGeofenceCollectionsResponse < Struct.new(
1937
+ :entries,
1938
+ :next_token)
1939
+ SENSITIVE = []
1940
+ include Aws::Structure
1941
+ end
1942
+
1943
+ # Contains the geofence collection details.
1944
+ #
1945
+ # @!attribute [rw] collection_name
1946
+ # The name of the geofence collection.
1947
+ # @return [String]
1948
+ #
1949
+ # @!attribute [rw] create_time
1950
+ # The timestamp for when the geofence collection was created in [ISO
1951
+ # 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`
1952
+ #
1953
+ #
1954
+ #
1955
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
1956
+ # @return [Time]
1957
+ #
1958
+ # @!attribute [rw] description
1959
+ # The description for the geofence collection
1960
+ # @return [String]
1961
+ #
1962
+ # @!attribute [rw] update_time
1963
+ # Specifies a timestamp for when the resource was last updated in [ISO
1964
+ # 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`
1965
+ #
1966
+ #
1967
+ #
1968
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
1969
+ # @return [Time]
1970
+ #
1971
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListGeofenceCollectionsResponseEntry AWS API Documentation
1972
+ #
1973
+ class ListGeofenceCollectionsResponseEntry < Struct.new(
1974
+ :collection_name,
1975
+ :create_time,
1976
+ :description,
1977
+ :update_time)
1978
+ SENSITIVE = []
1979
+ include Aws::Structure
1980
+ end
1981
+
1982
+ # Contains a list of geofences stored in a given geofence collection.
1983
+ #
1984
+ # @!attribute [rw] create_time
1985
+ # The timestamp for when the geofence was stored in a geofence
1986
+ # collection in [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`
1987
+ #
1988
+ #
1989
+ #
1990
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
1991
+ # @return [Time]
1992
+ #
1993
+ # @!attribute [rw] geofence_id
1994
+ # The geofence identifier.
1995
+ # @return [String]
1996
+ #
1997
+ # @!attribute [rw] geometry
1998
+ # Contains the geofence geometry details describing a polygon.
1999
+ # @return [Types::GeofenceGeometry]
2000
+ #
2001
+ # @!attribute [rw] status
2002
+ # Identifies the state of the geofence. A geofence will hold one of
2003
+ # the following states:
2004
+ #
2005
+ # * `ACTIVE` — The geofence has been indexed by the system.
2006
+ #
2007
+ # * `PENDING` — The geofence is being processed by the system.
2008
+ #
2009
+ # * `FAILED` — The geofence failed to be indexed by the system.
2010
+ #
2011
+ # * `DELETED` — The geofence has been deleted from the system index.
2012
+ #
2013
+ # * `DELETING` — The geofence is being deleted from the system index.
2014
+ # @return [String]
2015
+ #
2016
+ # @!attribute [rw] update_time
2017
+ # The timestamp for when the geofence was last updated in [ISO
2018
+ # 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`
2019
+ #
2020
+ #
2021
+ #
2022
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
2023
+ # @return [Time]
2024
+ #
2025
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListGeofenceResponseEntry AWS API Documentation
2026
+ #
2027
+ class ListGeofenceResponseEntry < Struct.new(
2028
+ :create_time,
2029
+ :geofence_id,
2030
+ :geometry,
2031
+ :status,
2032
+ :update_time)
2033
+ SENSITIVE = []
2034
+ include Aws::Structure
2035
+ end
2036
+
2037
+ # @note When making an API call, you may pass ListGeofencesRequest
2038
+ # data as a hash:
2039
+ #
2040
+ # {
2041
+ # collection_name: "ResourceName", # required
2042
+ # next_token: "Token",
2043
+ # }
2044
+ #
2045
+ # @!attribute [rw] collection_name
2046
+ # The name of the geofence collection storing the list of geofences.
2047
+ # @return [String]
2048
+ #
2049
+ # @!attribute [rw] next_token
2050
+ # The pagination token specifying which page of results to return in
2051
+ # the response. If no token is provided, the default page is the first
2052
+ # page.
2053
+ #
2054
+ # Default value: `null`
2055
+ # @return [String]
2056
+ #
2057
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListGeofencesRequest AWS API Documentation
2058
+ #
2059
+ class ListGeofencesRequest < Struct.new(
2060
+ :collection_name,
2061
+ :next_token)
2062
+ SENSITIVE = []
2063
+ include Aws::Structure
2064
+ end
2065
+
2066
+ # @!attribute [rw] entries
2067
+ # Contains a list of geofences stored in the geofence collection.
2068
+ # @return [Array<Types::ListGeofenceResponseEntry>]
2069
+ #
2070
+ # @!attribute [rw] next_token
2071
+ # A pagination token indicating there are additional pages available.
2072
+ # You can use the token in a following request to fetch the next set
2073
+ # of results.
2074
+ # @return [String]
2075
+ #
2076
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListGeofencesResponse AWS API Documentation
2077
+ #
2078
+ class ListGeofencesResponse < Struct.new(
2079
+ :entries,
2080
+ :next_token)
2081
+ SENSITIVE = []
2082
+ include Aws::Structure
2083
+ end
2084
+
2085
+ # @note When making an API call, you may pass ListMapsRequest
2086
+ # data as a hash:
2087
+ #
2088
+ # {
2089
+ # max_results: 1,
2090
+ # next_token: "Token",
2091
+ # }
2092
+ #
2093
+ # @!attribute [rw] max_results
2094
+ # An optional limit for the number of resources returned in a single
2095
+ # call.
2096
+ #
2097
+ # Default value: `100`
2098
+ # @return [Integer]
2099
+ #
2100
+ # @!attribute [rw] next_token
2101
+ # The pagination token specifying which page of results to return in
2102
+ # the response. If no token is provided, the default page is the first
2103
+ # page.
2104
+ #
2105
+ # Default value: `null`
2106
+ # @return [String]
2107
+ #
2108
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListMapsRequest AWS API Documentation
2109
+ #
2110
+ class ListMapsRequest < Struct.new(
2111
+ :max_results,
2112
+ :next_token)
2113
+ SENSITIVE = []
2114
+ include Aws::Structure
2115
+ end
2116
+
2117
+ # @!attribute [rw] entries
2118
+ # Contains a list of maps in your AWS account
2119
+ # @return [Array<Types::ListMapsResponseEntry>]
2120
+ #
2121
+ # @!attribute [rw] next_token
2122
+ # A pagination token indicating there are additional pages available.
2123
+ # You can use the token in a following request to fetch the next set
2124
+ # of results.
2125
+ # @return [String]
2126
+ #
2127
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListMapsResponse AWS API Documentation
2128
+ #
2129
+ class ListMapsResponse < Struct.new(
2130
+ :entries,
2131
+ :next_token)
2132
+ SENSITIVE = []
2133
+ include Aws::Structure
2134
+ end
2135
+
2136
+ # Contains details of an existing map resource in your AWS account.
2137
+ #
2138
+ # @!attribute [rw] create_time
2139
+ # The timestamp for when the map resource was created in [ISO 8601][1]
2140
+ # format: `YYYY-MM-DDThh:mm:ss.sssZ`.
2141
+ #
2142
+ #
2143
+ #
2144
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
2145
+ # @return [Time]
2146
+ #
2147
+ # @!attribute [rw] data_source
2148
+ # Specifies the data provider for the associated map tiles.
2149
+ # @return [String]
2150
+ #
2151
+ # @!attribute [rw] description
2152
+ # The description for the map resource.
2153
+ # @return [String]
2154
+ #
2155
+ # @!attribute [rw] map_name
2156
+ # The name of the associated map resource.
2157
+ # @return [String]
2158
+ #
2159
+ # @!attribute [rw] update_time
2160
+ # The timestamp for when the map resource was last updated in [ISO
2161
+ # 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
2162
+ #
2163
+ #
2164
+ #
2165
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
2166
+ # @return [Time]
2167
+ #
2168
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListMapsResponseEntry AWS API Documentation
2169
+ #
2170
+ class ListMapsResponseEntry < Struct.new(
2171
+ :create_time,
2172
+ :data_source,
2173
+ :description,
2174
+ :map_name,
2175
+ :update_time)
2176
+ SENSITIVE = []
2177
+ include Aws::Structure
2178
+ end
2179
+
2180
+ # @note When making an API call, you may pass ListPlaceIndexesRequest
2181
+ # data as a hash:
2182
+ #
2183
+ # {
2184
+ # max_results: 1,
2185
+ # next_token: "Token",
2186
+ # }
2187
+ #
2188
+ # @!attribute [rw] max_results
2189
+ # An optional limit for the maximum number of results returned in a
2190
+ # single call.
2191
+ #
2192
+ # Default value: `100`
2193
+ # @return [Integer]
2194
+ #
2195
+ # @!attribute [rw] next_token
2196
+ # The pagination token specifying which page of results to return in
2197
+ # the response. If no token is provided, the default page is the first
2198
+ # page.
2199
+ #
2200
+ # Default value: `null`
2201
+ # @return [String]
2202
+ #
2203
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListPlaceIndexesRequest AWS API Documentation
2204
+ #
2205
+ class ListPlaceIndexesRequest < Struct.new(
2206
+ :max_results,
2207
+ :next_token)
2208
+ SENSITIVE = []
2209
+ include Aws::Structure
2210
+ end
2211
+
2212
+ # @!attribute [rw] entries
2213
+ # Lists the Place index resources that exist in your AWS account
2214
+ # @return [Array<Types::ListPlaceIndexesResponseEntry>]
2215
+ #
2216
+ # @!attribute [rw] next_token
2217
+ # A pagination token indicating there are additional pages available.
2218
+ # You can use the token in a following request to fetch the next set
2219
+ # of results.
2220
+ # @return [String]
2221
+ #
2222
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListPlaceIndexesResponse AWS API Documentation
2223
+ #
2224
+ class ListPlaceIndexesResponse < Struct.new(
2225
+ :entries,
2226
+ :next_token)
2227
+ SENSITIVE = []
2228
+ include Aws::Structure
2229
+ end
2230
+
2231
+ # A Place index resource listed in your AWS account.
2232
+ #
2233
+ # @!attribute [rw] create_time
2234
+ # The timestamp for when the Place index resource was created in [ISO
2235
+ # 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
2236
+ #
2237
+ #
2238
+ #
2239
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
2240
+ # @return [Time]
2241
+ #
2242
+ # @!attribute [rw] data_source
2243
+ # The data provider of geospatial data.
2244
+ # @return [String]
2245
+ #
2246
+ # @!attribute [rw] description
2247
+ # The optional description for the Place index resource.
2248
+ # @return [String]
2249
+ #
2250
+ # @!attribute [rw] index_name
2251
+ # The name of the Place index resource.
2252
+ # @return [String]
2253
+ #
2254
+ # @!attribute [rw] update_time
2255
+ # The timestamp for when the Place index resource was last updated in
2256
+ # [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
2257
+ #
2258
+ #
2259
+ #
2260
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
2261
+ # @return [Time]
2262
+ #
2263
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListPlaceIndexesResponseEntry AWS API Documentation
2264
+ #
2265
+ class ListPlaceIndexesResponseEntry < Struct.new(
2266
+ :create_time,
2267
+ :data_source,
2268
+ :description,
2269
+ :index_name,
2270
+ :update_time)
2271
+ SENSITIVE = []
2272
+ include Aws::Structure
2273
+ end
2274
+
2275
+ # @note When making an API call, you may pass ListTrackerConsumersRequest
2276
+ # data as a hash:
2277
+ #
2278
+ # {
2279
+ # max_results: 1,
2280
+ # next_token: "Token",
2281
+ # tracker_name: "ResourceName", # required
2282
+ # }
2283
+ #
2284
+ # @!attribute [rw] max_results
2285
+ # An optional limit for the number of resources returned in a single
2286
+ # call.
2287
+ #
2288
+ # Default value: `100`
2289
+ # @return [Integer]
2290
+ #
2291
+ # @!attribute [rw] next_token
2292
+ # The pagination token specifying which page of results to return in
2293
+ # the response. If no token is provided, the default page is the first
2294
+ # page.
2295
+ #
2296
+ # Default value: `null`
2297
+ # @return [String]
2298
+ #
2299
+ # @!attribute [rw] tracker_name
2300
+ # The tracker resource whose associated geofence collections you want
2301
+ # to list.
2302
+ # @return [String]
2303
+ #
2304
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListTrackerConsumersRequest AWS API Documentation
2305
+ #
2306
+ class ListTrackerConsumersRequest < Struct.new(
2307
+ :max_results,
2308
+ :next_token,
2309
+ :tracker_name)
2310
+ SENSITIVE = []
2311
+ include Aws::Structure
2312
+ end
2313
+
2314
+ # @!attribute [rw] consumer_arns
2315
+ # Contains the list of geofence collection ARNs associated to the
2316
+ # tracker resource.
2317
+ # @return [Array<String>]
2318
+ #
2319
+ # @!attribute [rw] next_token
2320
+ # A pagination token indicating there are additional pages available.
2321
+ # You can use the token in a following request to fetch the next set
2322
+ # of results.
2323
+ # @return [String]
2324
+ #
2325
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListTrackerConsumersResponse AWS API Documentation
2326
+ #
2327
+ class ListTrackerConsumersResponse < Struct.new(
2328
+ :consumer_arns,
2329
+ :next_token)
2330
+ SENSITIVE = []
2331
+ include Aws::Structure
2332
+ end
2333
+
2334
+ # @note When making an API call, you may pass ListTrackersRequest
2335
+ # data as a hash:
2336
+ #
2337
+ # {
2338
+ # max_results: 1,
2339
+ # next_token: "Token",
2340
+ # }
2341
+ #
2342
+ # @!attribute [rw] max_results
2343
+ # An optional limit for the number of resources returned in a single
2344
+ # call.
2345
+ #
2346
+ # Default value: `100`
2347
+ # @return [Integer]
2348
+ #
2349
+ # @!attribute [rw] next_token
2350
+ # The pagination token specifying which page of results to return in
2351
+ # the response. If no token is provided, the default page is the first
2352
+ # page.
2353
+ #
2354
+ # Default value: `null`
2355
+ # @return [String]
2356
+ #
2357
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListTrackersRequest AWS API Documentation
2358
+ #
2359
+ class ListTrackersRequest < Struct.new(
2360
+ :max_results,
2361
+ :next_token)
2362
+ SENSITIVE = []
2363
+ include Aws::Structure
2364
+ end
2365
+
2366
+ # @!attribute [rw] entries
2367
+ # Contains tracker resources in your AWS account. Details include
2368
+ # tracker name, description and timestamps for when the tracker was
2369
+ # created and last updated.
2370
+ # @return [Array<Types::ListTrackersResponseEntry>]
2371
+ #
2372
+ # @!attribute [rw] next_token
2373
+ # A pagination token indicating there are additional pages available.
2374
+ # You can use the token in a following request to fetch the next set
2375
+ # of results.
2376
+ # @return [String]
2377
+ #
2378
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListTrackersResponse AWS API Documentation
2379
+ #
2380
+ class ListTrackersResponse < Struct.new(
2381
+ :entries,
2382
+ :next_token)
2383
+ SENSITIVE = []
2384
+ include Aws::Structure
2385
+ end
2386
+
2387
+ # Contains the tracker resource details.
2388
+ #
2389
+ # @!attribute [rw] create_time
2390
+ # The timestamp for when the tracker resource was created in [ ISO
2391
+ # 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
2392
+ #
2393
+ #
2394
+ #
2395
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
2396
+ # @return [Time]
2397
+ #
2398
+ # @!attribute [rw] description
2399
+ # The description for the tracker resource.
2400
+ # @return [String]
2401
+ #
2402
+ # @!attribute [rw] tracker_name
2403
+ # The name of the tracker resource.
2404
+ # @return [String]
2405
+ #
2406
+ # @!attribute [rw] update_time
2407
+ # The timestamp for when the position was detected and sampled in [
2408
+ # ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
2409
+ #
2410
+ #
2411
+ #
2412
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
2413
+ # @return [Time]
2414
+ #
2415
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListTrackersResponseEntry AWS API Documentation
2416
+ #
2417
+ class ListTrackersResponseEntry < Struct.new(
2418
+ :create_time,
2419
+ :description,
2420
+ :tracker_name,
2421
+ :update_time)
2422
+ SENSITIVE = []
2423
+ include Aws::Structure
2424
+ end
2425
+
2426
+ # Specifies the map tile style selected from an available provider.
2427
+ #
2428
+ # @note When making an API call, you may pass MapConfiguration
2429
+ # data as a hash:
2430
+ #
2431
+ # {
2432
+ # style: "MapStyle", # required
2433
+ # }
2434
+ #
2435
+ # @!attribute [rw] style
2436
+ # Specifies the map style selected from an available data provider.
2437
+ #
2438
+ # Valid styles: `VectorEsriLightGrayCanvas`, `VectorEsriLight`,
2439
+ # `VectorEsriStreets`, `VectorEsriNavigation`,
2440
+ # `VectorEsriDarkGrayCanvas`, `VectorEsriLightGrayCanvas`,
2441
+ # `VectorHereBerlin`
2442
+ #
2443
+ # <note markdown="1"> When using HERE as your data provider, and selecting the Style
2444
+ # `VectorHereBerlin`, you may not use HERE Maps for Asset Management.
2445
+ # See the [AWS Service Terms][1] for Amazon Location Service.
2446
+ #
2447
+ # </note>
2448
+ #
2449
+ #
2450
+ #
2451
+ # [1]: https://aws.amazon.com/service-terms/
2452
+ # @return [String]
2453
+ #
2454
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/MapConfiguration AWS API Documentation
2455
+ #
2456
+ class MapConfiguration < Struct.new(
2457
+ :style)
2458
+ SENSITIVE = []
2459
+ include Aws::Structure
2460
+ end
2461
+
2462
+ # Contains details about addresses or points of interest that match the
2463
+ # search criteria.
2464
+ #
2465
+ # @!attribute [rw] address_number
2466
+ # The numerical portion of an address, such as a building number.
2467
+ # @return [String]
2468
+ #
2469
+ # @!attribute [rw] country
2470
+ # A country/region specified using [ISO 3166][1] 3-digit
2471
+ # country/region code. For example, `CAN`.
2472
+ #
2473
+ #
2474
+ #
2475
+ # [1]: https://www.iso.org/iso-3166-country-codes.html
2476
+ # @return [String]
2477
+ #
2478
+ # @!attribute [rw] geometry
2479
+ # Places uses a point geometry to specify a location or a Place.
2480
+ # @return [Types::PlaceGeometry]
2481
+ #
2482
+ # @!attribute [rw] label
2483
+ # The full name and address of the point of interest such as a city,
2484
+ # region, or country. For example, `123 Any Street, Any Town, USA`.
2485
+ # @return [String]
2486
+ #
2487
+ # @!attribute [rw] municipality
2488
+ # A name for a local area, such as a city or town name. For example,
2489
+ # `Toronto`.
2490
+ # @return [String]
2491
+ #
2492
+ # @!attribute [rw] neighborhood
2493
+ # The name of a community district. For example, `Downtown`.
2494
+ # @return [String]
2495
+ #
2496
+ # @!attribute [rw] postal_code
2497
+ # A group of numbers and letters in a country-specific format, which
2498
+ # accompanies the address for the purpose of identifying a location.
2499
+ # @return [String]
2500
+ #
2501
+ # @!attribute [rw] region
2502
+ # A name for an area or geographical division, such as a province or
2503
+ # state name. For example, `British Columbia`.
2504
+ # @return [String]
2505
+ #
2506
+ # @!attribute [rw] street
2507
+ # The name for a street or a road to identify a location. For example,
2508
+ # `Main Street`.
2509
+ # @return [String]
2510
+ #
2511
+ # @!attribute [rw] sub_region
2512
+ # A country, or an area that's part of a larger region . For example,
2513
+ # `Metro Vancouver`.
2514
+ # @return [String]
2515
+ #
2516
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/Place AWS API Documentation
2517
+ #
2518
+ class Place < Struct.new(
2519
+ :address_number,
2520
+ :country,
2521
+ :geometry,
2522
+ :label,
2523
+ :municipality,
2524
+ :neighborhood,
2525
+ :postal_code,
2526
+ :region,
2527
+ :street,
2528
+ :sub_region)
2529
+ SENSITIVE = []
2530
+ include Aws::Structure
2531
+ end
2532
+
2533
+ # Places uses a point geometry to specify a location or a Place.
2534
+ #
2535
+ # @!attribute [rw] point
2536
+ # A single point geometry specifies a location for a Place using [WGS
2537
+ # 84][1] coordinates:
2538
+ #
2539
+ # * *x* — Specifies the x coordinate or longitude.
2540
+ #
2541
+ # * *y* — Specifies the y coordinate or latitude.
2542
+ #
2543
+ #
2544
+ #
2545
+ # [1]: https://gisgeography.com/wgs84-world-geodetic-system/
2546
+ # @return [Array<Float>]
2547
+ #
2548
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/PlaceGeometry AWS API Documentation
2549
+ #
2550
+ class PlaceGeometry < Struct.new(
2551
+ :point)
2552
+ SENSITIVE = [:point]
2553
+ include Aws::Structure
2554
+ end
2555
+
2556
+ # @note When making an API call, you may pass PutGeofenceRequest
2557
+ # data as a hash:
2558
+ #
2559
+ # {
2560
+ # collection_name: "ResourceName", # required
2561
+ # geofence_id: "Id", # required
2562
+ # geometry: { # required
2563
+ # polygon: [
2564
+ # [
2565
+ # [1.0],
2566
+ # ],
2567
+ # ],
2568
+ # },
2569
+ # }
2570
+ #
2571
+ # @!attribute [rw] collection_name
2572
+ # The geofence collection to store the geofence in.
2573
+ # @return [String]
2574
+ #
2575
+ # @!attribute [rw] geofence_id
2576
+ # An identifier for the geofence. For example, `ExampleGeofence-1`.
2577
+ # @return [String]
2578
+ #
2579
+ # @!attribute [rw] geometry
2580
+ # Contains the polygon details to specify the position of the
2581
+ # geofence.
2582
+ # @return [Types::GeofenceGeometry]
2583
+ #
2584
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/PutGeofenceRequest AWS API Documentation
2585
+ #
2586
+ class PutGeofenceRequest < Struct.new(
2587
+ :collection_name,
2588
+ :geofence_id,
2589
+ :geometry)
2590
+ SENSITIVE = []
2591
+ include Aws::Structure
2592
+ end
2593
+
2594
+ # @!attribute [rw] create_time
2595
+ # The timestamp for when the geofence was created in [ISO 8601][1]
2596
+ # format: `YYYY-MM-DDThh:mm:ss.sssZ`
2597
+ #
2598
+ #
2599
+ #
2600
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
2601
+ # @return [Time]
2602
+ #
2603
+ # @!attribute [rw] geofence_id
2604
+ # The geofence identifier entered in the request.
2605
+ # @return [String]
2606
+ #
2607
+ # @!attribute [rw] update_time
2608
+ # The timestamp for when the geofence was last updated in [ISO
2609
+ # 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`
2610
+ #
2611
+ #
2612
+ #
2613
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
2614
+ # @return [Time]
2615
+ #
2616
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/PutGeofenceResponse AWS API Documentation
2617
+ #
2618
+ class PutGeofenceResponse < Struct.new(
2619
+ :create_time,
2620
+ :geofence_id,
2621
+ :update_time)
2622
+ SENSITIVE = []
2623
+ include Aws::Structure
2624
+ end
2625
+
2626
+ # The resource that you've entered was not found in your AWS account.
2627
+ #
2628
+ # @!attribute [rw] message
2629
+ # @return [String]
2630
+ #
2631
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ResourceNotFoundException AWS API Documentation
2632
+ #
2633
+ class ResourceNotFoundException < Struct.new(
2634
+ :message)
2635
+ SENSITIVE = []
2636
+ include Aws::Structure
2637
+ end
2638
+
2639
+ # Specifies a single point of interest, or Place as a result of a search
2640
+ # query obtained from a dataset configured in the Place index Resource.
2641
+ #
2642
+ # @!attribute [rw] place
2643
+ # Contains details about the relevant point of interest.
2644
+ # @return [Types::Place]
2645
+ #
2646
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchForPositionResult AWS API Documentation
2647
+ #
2648
+ class SearchForPositionResult < Struct.new(
2649
+ :place)
2650
+ SENSITIVE = []
2651
+ include Aws::Structure
2652
+ end
2653
+
2654
+ # Contains relevant Places returned by calling
2655
+ # `SearchPlaceIndexForText`.
2656
+ #
2657
+ # @!attribute [rw] place
2658
+ # Contains details about the relevant point of interest.
2659
+ # @return [Types::Place]
2660
+ #
2661
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchForTextResult AWS API Documentation
2662
+ #
2663
+ class SearchForTextResult < Struct.new(
2664
+ :place)
2665
+ SENSITIVE = []
2666
+ include Aws::Structure
2667
+ end
2668
+
2669
+ # @note When making an API call, you may pass SearchPlaceIndexForPositionRequest
2670
+ # data as a hash:
2671
+ #
2672
+ # {
2673
+ # index_name: "ResourceName", # required
2674
+ # max_results: 1,
2675
+ # position: [1.0], # required
2676
+ # }
2677
+ #
2678
+ # @!attribute [rw] index_name
2679
+ # The name of the Place index resource you want to use for the search.
2680
+ # @return [String]
2681
+ #
2682
+ # @!attribute [rw] max_results
2683
+ # An optional paramer. The maximum number of results returned per
2684
+ # request.
2685
+ #
2686
+ # Default value: `50`
2687
+ # @return [Integer]
2688
+ #
2689
+ # @!attribute [rw] position
2690
+ # Specifies a coordinate for the query defined by a longitude, and
2691
+ # latitude.
2692
+ #
2693
+ # * The first position is the X coordinate, or longitude.
2694
+ #
2695
+ # * The second position is the Y coordinate, or latitude.
2696
+ #
2697
+ # For example, `position=xLongitude&position=yLatitude` .
2698
+ # @return [Array<Float>]
2699
+ #
2700
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForPositionRequest AWS API Documentation
2701
+ #
2702
+ class SearchPlaceIndexForPositionRequest < Struct.new(
2703
+ :index_name,
2704
+ :max_results,
2705
+ :position)
2706
+ SENSITIVE = [:position]
2707
+ include Aws::Structure
2708
+ end
2709
+
2710
+ # @!attribute [rw] results
2711
+ # Returns a list of Places closest to the specified position. Each
2712
+ # result contains additional information about the Places returned.
2713
+ # @return [Array<Types::SearchForPositionResult>]
2714
+ #
2715
+ # @!attribute [rw] summary
2716
+ # Contains a summary of the request.
2717
+ # @return [Types::SearchPlaceIndexForPositionSummary]
2718
+ #
2719
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForPositionResponse AWS API Documentation
2720
+ #
2721
+ class SearchPlaceIndexForPositionResponse < Struct.new(
2722
+ :results,
2723
+ :summary)
2724
+ SENSITIVE = []
2725
+ include Aws::Structure
2726
+ end
2727
+
2728
+ # A summary of the reverse geocoding request sent using
2729
+ # `SearchPlaceIndexForPosition`.
2730
+ #
2731
+ # @!attribute [rw] data_source
2732
+ # The data provider of geospatial data for the Place index resource.
2733
+ # @return [String]
2734
+ #
2735
+ # @!attribute [rw] max_results
2736
+ # An optional parameter. The maximum number of results returned per
2737
+ # request.
2738
+ #
2739
+ # Default value: `50`
2740
+ # @return [Integer]
2741
+ #
2742
+ # @!attribute [rw] position
2743
+ # The position given in the reverse geocoding request.
2744
+ # @return [Array<Float>]
2745
+ #
2746
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForPositionSummary AWS API Documentation
2747
+ #
2748
+ class SearchPlaceIndexForPositionSummary < Struct.new(
2749
+ :data_source,
2750
+ :max_results,
2751
+ :position)
2752
+ SENSITIVE = [:position]
2753
+ include Aws::Structure
2754
+ end
2755
+
2756
+ # @note When making an API call, you may pass SearchPlaceIndexForTextRequest
2757
+ # data as a hash:
2758
+ #
2759
+ # {
2760
+ # bias_position: [1.0],
2761
+ # filter_b_box: [1.0],
2762
+ # filter_countries: ["CountryCode"],
2763
+ # index_name: "ResourceName", # required
2764
+ # max_results: 1,
2765
+ # text: "SyntheticSearchPlaceIndexForTextRequestString", # required
2766
+ # }
2767
+ #
2768
+ # @!attribute [rw] bias_position
2769
+ # Searches for results closest to the given position. An optional
2770
+ # parameter defined by longitude, and latitude.
2771
+ #
2772
+ # * The first `bias` position is the X coordinate, or longitude.
2773
+ #
2774
+ # * The second `bias` position is the Y coordinate, or latitude.
2775
+ #
2776
+ # For example, `bias=xLongitude&bias=yLatitude`.
2777
+ # @return [Array<Float>]
2778
+ #
2779
+ # @!attribute [rw] filter_b_box
2780
+ # Filters the results by returning only Places within the provided
2781
+ # bounding box. An optional parameter.
2782
+ #
2783
+ # The first 2 `bbox` parameters describe the lower southwest corner:
2784
+ #
2785
+ # * The first `bbox` position is the X coordinate or longitude of the
2786
+ # lower southwest corner.
2787
+ #
2788
+ # * The second `bbox` position is the Y coordinate or latitude of the
2789
+ # lower southwest corner.
2790
+ #
2791
+ # For example, `bbox=xLongitudeSW&bbox=yLatitudeSW`.
2792
+ #
2793
+ # The next `bbox` parameters describe the upper northeast corner:
2794
+ #
2795
+ # * The third `bbox` position is the X coordinate, or longitude of the
2796
+ # upper northeast corner.
2797
+ #
2798
+ # * The fourth `bbox` position is the Y coordinate, or longitude of
2799
+ # the upper northeast corner.
2800
+ #
2801
+ # For example, `bbox=xLongitudeNE&bbox=yLatitudeNE`
2802
+ # @return [Array<Float>]
2803
+ #
2804
+ # @!attribute [rw] filter_countries
2805
+ # Limits the search to the given a list of countries/regions. An
2806
+ # optional parameter.
2807
+ #
2808
+ # * Use the [ISO 3166][1] 3-digit country code. For example, Australia
2809
+ # uses three upper-case characters: `AUS`.
2810
+ #
2811
+ # ^
2812
+ #
2813
+ #
2814
+ #
2815
+ # [1]: https://www.iso.org/iso-3166-country-codes.html
2816
+ # @return [Array<String>]
2817
+ #
2818
+ # @!attribute [rw] index_name
2819
+ # The name of the Place index resource you want to use for the search.
2820
+ # @return [String]
2821
+ #
2822
+ # @!attribute [rw] max_results
2823
+ # An optional parameter. The maximum number of results returned per
2824
+ # request.
2825
+ #
2826
+ # The default: `50`
2827
+ # @return [Integer]
2828
+ #
2829
+ # @!attribute [rw] text
2830
+ # The address, name, city, or region to be used in the search. In
2831
+ # free-form text format. For example, `123 Any Street`.
2832
+ # @return [String]
2833
+ #
2834
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForTextRequest AWS API Documentation
2835
+ #
2836
+ class SearchPlaceIndexForTextRequest < Struct.new(
2837
+ :bias_position,
2838
+ :filter_b_box,
2839
+ :filter_countries,
2840
+ :index_name,
2841
+ :max_results,
2842
+ :text)
2843
+ SENSITIVE = [:bias_position, :filter_b_box, :text]
2844
+ include Aws::Structure
2845
+ end
2846
+
2847
+ # @!attribute [rw] results
2848
+ # A list of Places closest to the specified position. Each result
2849
+ # contains additional information about the specific point of
2850
+ # interest.
2851
+ # @return [Array<Types::SearchForTextResult>]
2852
+ #
2853
+ # @!attribute [rw] summary
2854
+ # Contains a summary of the request. Contains the `BiasPosition`,
2855
+ # `DataSource`, `FilterBBox`, `FilterCountries`, `MaxResults`,
2856
+ # `ResultBBox`, and `Text`.
2857
+ # @return [Types::SearchPlaceIndexForTextSummary]
2858
+ #
2859
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForTextResponse AWS API Documentation
2860
+ #
2861
+ class SearchPlaceIndexForTextResponse < Struct.new(
2862
+ :results,
2863
+ :summary)
2864
+ SENSITIVE = []
2865
+ include Aws::Structure
2866
+ end
2867
+
2868
+ # A summary of the geocoding request sent using
2869
+ # `SearchPlaceIndexForText`.
2870
+ #
2871
+ # @!attribute [rw] bias_position
2872
+ # Contains the coordinates for the bias position entered in the
2873
+ # geocoding request.
2874
+ # @return [Array<Float>]
2875
+ #
2876
+ # @!attribute [rw] data_source
2877
+ # The data provider of geospatial data for the Place index resource.
2878
+ # @return [String]
2879
+ #
2880
+ # @!attribute [rw] filter_b_box
2881
+ # Contains the coordinates for the optional bounding box coordinated
2882
+ # entered in the geocoding request.
2883
+ # @return [Array<Float>]
2884
+ #
2885
+ # @!attribute [rw] filter_countries
2886
+ # Contains the country filter entered in the geocoding request.
2887
+ # @return [Array<String>]
2888
+ #
2889
+ # @!attribute [rw] max_results
2890
+ # Contains the maximum number of results indicated for the request.
2891
+ # @return [Integer]
2892
+ #
2893
+ # @!attribute [rw] result_b_box
2894
+ # A bounding box that contains the search results within the specified
2895
+ # area indicated by `FilterBBox`. A subset of bounding box specified
2896
+ # using `FilterBBox`.
2897
+ # @return [Array<Float>]
2898
+ #
2899
+ # @!attribute [rw] text
2900
+ # The address, name, city or region to be used in the geocoding
2901
+ # request. In free-form text format. For example, `Vancouver`.
2902
+ # @return [String]
2903
+ #
2904
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForTextSummary AWS API Documentation
2905
+ #
2906
+ class SearchPlaceIndexForTextSummary < Struct.new(
2907
+ :bias_position,
2908
+ :data_source,
2909
+ :filter_b_box,
2910
+ :filter_countries,
2911
+ :max_results,
2912
+ :result_b_box,
2913
+ :text)
2914
+ SENSITIVE = [:bias_position, :filter_b_box, :result_b_box, :text]
2915
+ include Aws::Structure
2916
+ end
2917
+
2918
+ # The request was denied due to request throttling.
2919
+ #
2920
+ # @!attribute [rw] message
2921
+ # @return [String]
2922
+ #
2923
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ThrottlingException AWS API Documentation
2924
+ #
2925
+ class ThrottlingException < Struct.new(
2926
+ :message)
2927
+ SENSITIVE = []
2928
+ include Aws::Structure
2929
+ end
2930
+
2931
+ # The input failed to meet the constraints specified by the AWS service.
2932
+ #
2933
+ # @!attribute [rw] field_list
2934
+ # The field where the invalid entry was detected.
2935
+ # @return [Array<Types::ValidationExceptionField>]
2936
+ #
2937
+ # @!attribute [rw] message
2938
+ # @return [String]
2939
+ #
2940
+ # @!attribute [rw] reason
2941
+ # A message with the reason for the validation exception error.
2942
+ # @return [String]
2943
+ #
2944
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ValidationException AWS API Documentation
2945
+ #
2946
+ class ValidationException < Struct.new(
2947
+ :field_list,
2948
+ :message,
2949
+ :reason)
2950
+ SENSITIVE = []
2951
+ include Aws::Structure
2952
+ end
2953
+
2954
+ # The input failed to meet the constraints specified by the AWS service
2955
+ # in a specified field.
2956
+ #
2957
+ # @!attribute [rw] message
2958
+ # A message with the reason for the validation exception error.
2959
+ # @return [String]
2960
+ #
2961
+ # @!attribute [rw] name
2962
+ # The field name where the invalid entry was detected.
2963
+ # @return [String]
2964
+ #
2965
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ValidationExceptionField AWS API Documentation
2966
+ #
2967
+ class ValidationExceptionField < Struct.new(
2968
+ :message,
2969
+ :name)
2970
+ SENSITIVE = []
2971
+ include Aws::Structure
2972
+ end
2973
+
2974
+ end
2975
+ end