aws-sdk-locationservice 1.1.0 → 1.5.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +33 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-locationservice.rb +2 -2
- data/lib/aws-sdk-locationservice/client.rb +1390 -225
- data/lib/aws-sdk-locationservice/client_api.rb +579 -1
- data/lib/aws-sdk-locationservice/errors.rb +17 -1
- data/lib/aws-sdk-locationservice/resource.rb +1 -1
- data/lib/aws-sdk-locationservice/types.rb +3779 -1496
- metadata +9 -7
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3b9a496b53b55353435b3220b541343abe5f7bba8ebc8964a442a56900eaa74f
|
4
|
+
data.tar.gz: aa33791915aa6852945f400b749408ccdd099db3a0b62deb44b5d4288de0746c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 748928910476909d0fdd33d05990bd5f2695f70aeed6f1318ab3837311e1ee95a8f4f62db3c5be53821163890b814e8b73048b4b4531511663c1fe2571dd5be8
|
7
|
+
data.tar.gz: 42e4d4bdf805f8e2b9f9e90a8b42900a2b91a8fe97f270bddf92a669a07537551228adb22d77756561c65cfca40d616e7d1c6e37d24bfe10b9e8485ac548db35
|
data/CHANGELOG.md
ADDED
@@ -0,0 +1,33 @@
|
|
1
|
+
Unreleased Changes
|
2
|
+
------------------
|
3
|
+
|
4
|
+
1.5.0 (2021-07-19)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Add five new API operations: UpdateGeofenceCollection, UpdateMap, UpdatePlaceIndex, UpdateRouteCalculator, UpdateTracker.
|
8
|
+
|
9
|
+
1.4.0 (2021-05-28)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Adds support for calculation of routes, resource tagging and customer provided KMS keys.
|
13
|
+
|
14
|
+
1.3.0 (2021-03-29)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Amazon Location added support for specifying pricing plan information on resources in alignment with our cost model.
|
18
|
+
|
19
|
+
1.2.0 (2021-03-10)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
24
|
+
1.1.0 (2021-02-02)
|
25
|
+
------------------
|
26
|
+
|
27
|
+
* Feature - Doc only update for Amazon Location Maps that fixes a customer related issue regarding MapConfiguration
|
28
|
+
|
29
|
+
1.0.0 (2020-12-16)
|
30
|
+
------------------
|
31
|
+
|
32
|
+
* Feature - Initial release of `aws-sdk-locationservice`.
|
33
|
+
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
1.5.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-locationservice/customizations'
|
|
48
48
|
# @!group service
|
49
49
|
module Aws::LocationService
|
50
50
|
|
51
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.5.0'
|
52
52
|
|
53
53
|
end
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -331,13 +331,22 @@ module Aws::LocationService
|
|
331
331
|
# resource. This allows the tracker resource to communicate location
|
332
332
|
# data to the linked geofence collection.
|
333
333
|
#
|
334
|
+
# You can associate up to five geofence collections to each tracker
|
335
|
+
# resource.
|
336
|
+
#
|
337
|
+
# <note markdown="1"> Currently not supported — Cross-account configurations, such as
|
338
|
+
# creating associations between a tracker resource in one account and a
|
339
|
+
# geofence collection in another account.
|
340
|
+
#
|
341
|
+
# </note>
|
342
|
+
#
|
334
343
|
# @option params [required, String] :consumer_arn
|
335
344
|
# The Amazon Resource Name (ARN) for the geofence collection to be
|
336
345
|
# associated to tracker resource. Used when you need to specify a
|
337
346
|
# resource across all AWS.
|
338
347
|
#
|
339
348
|
# * Format example:
|
340
|
-
# `arn:
|
349
|
+
# `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer`
|
341
350
|
#
|
342
351
|
# ^
|
343
352
|
#
|
@@ -363,10 +372,50 @@ module Aws::LocationService
|
|
363
372
|
req.send_request(options)
|
364
373
|
end
|
365
374
|
|
375
|
+
# Deletes the position history of one or more devices from a tracker
|
376
|
+
# resource.
|
377
|
+
#
|
378
|
+
# @option params [required, Array<String>] :device_ids
|
379
|
+
# Devices whose position history you want to delete.
|
380
|
+
#
|
381
|
+
# * For example, for two devices: `“DeviceIds” : [DeviceId1,DeviceId2]`
|
382
|
+
#
|
383
|
+
# ^
|
384
|
+
#
|
385
|
+
# @option params [required, String] :tracker_name
|
386
|
+
# The name of the tracker resource to delete the device position history
|
387
|
+
# from.
|
388
|
+
#
|
389
|
+
# @return [Types::BatchDeleteDevicePositionHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
390
|
+
#
|
391
|
+
# * {Types::BatchDeleteDevicePositionHistoryResponse#errors #errors} => Array<Types::BatchDeleteDevicePositionHistoryError>
|
392
|
+
#
|
393
|
+
# @example Request syntax with placeholder values
|
394
|
+
#
|
395
|
+
# resp = client.batch_delete_device_position_history({
|
396
|
+
# device_ids: ["Id"], # required
|
397
|
+
# tracker_name: "ResourceName", # required
|
398
|
+
# })
|
399
|
+
#
|
400
|
+
# @example Response structure
|
401
|
+
#
|
402
|
+
# resp.errors #=> Array
|
403
|
+
# resp.errors[0].device_id #=> String
|
404
|
+
# resp.errors[0].error.code #=> String, one of "AccessDeniedError", "ConflictError", "InternalServerError", "ResourceNotFoundError", "ThrottlingError", "ValidationError"
|
405
|
+
# resp.errors[0].error.message #=> String
|
406
|
+
#
|
407
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchDeleteDevicePositionHistory AWS API Documentation
|
408
|
+
#
|
409
|
+
# @overload batch_delete_device_position_history(params = {})
|
410
|
+
# @param [Hash] params ({})
|
411
|
+
def batch_delete_device_position_history(params = {}, options = {})
|
412
|
+
req = build_request(:batch_delete_device_position_history, params)
|
413
|
+
req.send_request(options)
|
414
|
+
end
|
415
|
+
|
366
416
|
# Deletes a batch of geofences from a geofence collection.
|
367
417
|
#
|
368
|
-
# <note markdown="1"> This
|
369
|
-
# action.
|
418
|
+
# <note markdown="1"> This operation deletes the resource permanently.
|
370
419
|
#
|
371
420
|
# </note>
|
372
421
|
#
|
@@ -403,8 +452,24 @@ module Aws::LocationService
|
|
403
452
|
req.send_request(options)
|
404
453
|
end
|
405
454
|
|
406
|
-
#
|
407
|
-
#
|
455
|
+
# Evaluates device positions against the geofence geometries from a
|
456
|
+
# given geofence collection.
|
457
|
+
#
|
458
|
+
# This operation always returns an empty response because geofences are
|
459
|
+
# asynchronously evaluated. The evaluation determines if the device has
|
460
|
+
# entered or exited a geofenced area, and then publishes one of the
|
461
|
+
# following events to Amazon EventBridge:
|
462
|
+
#
|
463
|
+
# * `ENTER` if Amazon Location determines that the tracked device has
|
464
|
+
# entered a geofenced area.
|
465
|
+
#
|
466
|
+
# * `EXIT` if Amazon Location determines that the tracked device has
|
467
|
+
# exited a geofenced area.
|
468
|
+
#
|
469
|
+
# <note markdown="1"> The last geofence that a device was observed within is tracked for 30
|
470
|
+
# days after the most recent device position update.
|
471
|
+
#
|
472
|
+
# </note>
|
408
473
|
#
|
409
474
|
# @option params [required, String] :collection_name
|
410
475
|
# The geofence collection used in evaluating the position of devices
|
@@ -448,11 +513,7 @@ module Aws::LocationService
|
|
448
513
|
req.send_request(options)
|
449
514
|
end
|
450
515
|
|
451
|
-
#
|
452
|
-
#
|
453
|
-
# <note markdown="1"> The response will return the device positions from the last 24 hours.
|
454
|
-
#
|
455
|
-
# </note>
|
516
|
+
# Lists the latest device positions for requested devices.
|
456
517
|
#
|
457
518
|
# @option params [required, Array<String>] :device_ids
|
458
519
|
# Devices whose position you want to retrieve.
|
@@ -499,8 +560,9 @@ module Aws::LocationService
|
|
499
560
|
req.send_request(options)
|
500
561
|
end
|
501
562
|
|
502
|
-
# A batch request for storing
|
503
|
-
# collection
|
563
|
+
# A batch request for storing geofence geometries into a given geofence
|
564
|
+
# collection, or updates the geometry of an existing geofence if a
|
565
|
+
# geofence ID is included in the request.
|
504
566
|
#
|
505
567
|
# @option params [required, String] :collection_name
|
506
568
|
# The geofence collection storing the geofences.
|
@@ -551,12 +613,13 @@ module Aws::LocationService
|
|
551
613
|
req.send_request(options)
|
552
614
|
end
|
553
615
|
|
554
|
-
# Uploads
|
555
|
-
# resource.
|
556
|
-
# position and position history.
|
616
|
+
# Uploads position update data for one or more devices to a tracker
|
617
|
+
# resource. Amazon Location uses the data when reporting the last known
|
618
|
+
# device position and position history.
|
557
619
|
#
|
558
|
-
# <note markdown="1">
|
559
|
-
#
|
620
|
+
# <note markdown="1"> Only one position update is stored per sample time. Location data is
|
621
|
+
# sampled at a fixed rate of one position per 30-second interval and
|
622
|
+
# retained for 30 days before it's deleted.
|
560
623
|
#
|
561
624
|
# </note>
|
562
625
|
#
|
@@ -600,6 +663,249 @@ module Aws::LocationService
|
|
600
663
|
req.send_request(options)
|
601
664
|
end
|
602
665
|
|
666
|
+
# [Calculates a route][1] given the following required parameters:
|
667
|
+
# `DeparturePostiton` and `DestinationPosition`. Requires that you first
|
668
|
+
# [create a route calculator resource][2]
|
669
|
+
#
|
670
|
+
# By default, a request that doesn't specify a departure time uses the
|
671
|
+
# best time of day to travel with the best traffic conditions when
|
672
|
+
# calculating the route.
|
673
|
+
#
|
674
|
+
# Additional options include:
|
675
|
+
#
|
676
|
+
# * [Specifying a departure time][3] using either `DepartureTime` or
|
677
|
+
# `DepartureNow`. This calculates a route based on predictive traffic
|
678
|
+
# data at the given time.
|
679
|
+
#
|
680
|
+
# <note markdown="1"> You can't specify both `DepartureTime` and `DepartureNow` in a
|
681
|
+
# single request. Specifying both parameters returns an error message.
|
682
|
+
#
|
683
|
+
# </note>
|
684
|
+
#
|
685
|
+
# * [Specifying a travel mode][4] using TravelMode. This lets you
|
686
|
+
# specify an additional route preference such as `CarModeOptions` if
|
687
|
+
# traveling by `Car`, or `TruckModeOptions` if traveling by `Truck`.
|
688
|
+
#
|
689
|
+
#
|
690
|
+
#
|
691
|
+
#
|
692
|
+
#
|
693
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html
|
694
|
+
# [2]: https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html
|
695
|
+
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#departure-time
|
696
|
+
# [4]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#travel-mode
|
697
|
+
#
|
698
|
+
# @option params [required, String] :calculator_name
|
699
|
+
# The name of the route calculator resource that you want to use to
|
700
|
+
# calculate a route.
|
701
|
+
#
|
702
|
+
# @option params [Types::CalculateRouteCarModeOptions] :car_mode_options
|
703
|
+
# Specifies route preferences when traveling by `Car`, such as avoiding
|
704
|
+
# routes that use ferries or tolls.
|
705
|
+
#
|
706
|
+
# Requirements: `TravelMode` must be specified as `Car`.
|
707
|
+
#
|
708
|
+
# @option params [Boolean] :depart_now
|
709
|
+
# Sets the time of departure as the current time. Uses the current time
|
710
|
+
# to calculate a route. Otherwise, the best time of day to travel with
|
711
|
+
# the best traffic conditions is used to calculate the route.
|
712
|
+
#
|
713
|
+
# Default Value: `false`
|
714
|
+
#
|
715
|
+
# Valid Values: `false` \| `true`
|
716
|
+
#
|
717
|
+
# @option params [required, Array<Float>] :departure_position
|
718
|
+
# The start position for the route. Defined in [WGS 84][1] format:
|
719
|
+
# `[longitude, latitude]`.
|
720
|
+
#
|
721
|
+
# * For example, `[-123.115, 49.285]`
|
722
|
+
#
|
723
|
+
# ^
|
724
|
+
#
|
725
|
+
# <note markdown="1"> If you specify a departure that's not located on a road, Amazon
|
726
|
+
# Location [moves the position to the nearest road][2].
|
727
|
+
#
|
728
|
+
# </note>
|
729
|
+
#
|
730
|
+
# Valid Values: `[-180 to 180,-90 to 90]`
|
731
|
+
#
|
732
|
+
#
|
733
|
+
#
|
734
|
+
# [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
|
735
|
+
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
|
736
|
+
#
|
737
|
+
# @option params [Time,DateTime,Date,Integer,String] :departure_time
|
738
|
+
# Specifies the desired time of departure. Uses the given time to
|
739
|
+
# calculate a route. Otherwise, the best time of day to travel with the
|
740
|
+
# best traffic conditions is used to calculate the route.
|
741
|
+
#
|
742
|
+
# <note markdown="1"> Setting a departure time in the past returns a `400
|
743
|
+
# ValidationException` error.
|
744
|
+
#
|
745
|
+
# </note>
|
746
|
+
#
|
747
|
+
# * In [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example,
|
748
|
+
# `2020–07-2T12:15:20.000Z+01:00`
|
749
|
+
#
|
750
|
+
# ^
|
751
|
+
#
|
752
|
+
#
|
753
|
+
#
|
754
|
+
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
755
|
+
#
|
756
|
+
# @option params [required, Array<Float>] :destination_position
|
757
|
+
# The finish position for the route. Defined in [WGS 84][1] format:
|
758
|
+
# `[longitude, latitude]`.
|
759
|
+
#
|
760
|
+
# * For example, `[-122.339, 47.615]`
|
761
|
+
#
|
762
|
+
# ^
|
763
|
+
#
|
764
|
+
# <note markdown="1"> If you specify a destination that's not located on a road, Amazon
|
765
|
+
# Location [moves the position to the nearest road][2].
|
766
|
+
#
|
767
|
+
# </note>
|
768
|
+
#
|
769
|
+
# Valid Values: `[-180 to 180,-90 to 90]`
|
770
|
+
#
|
771
|
+
#
|
772
|
+
#
|
773
|
+
# [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
|
774
|
+
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
|
775
|
+
#
|
776
|
+
# @option params [String] :distance_unit
|
777
|
+
# Set the unit system to specify the distance.
|
778
|
+
#
|
779
|
+
# Default Value: `Kilometers`
|
780
|
+
#
|
781
|
+
# @option params [Boolean] :include_leg_geometry
|
782
|
+
# Set to include the geometry details in the result for each path
|
783
|
+
# between a pair of positions.
|
784
|
+
#
|
785
|
+
# Default Value: `false`
|
786
|
+
#
|
787
|
+
# Valid Values: `false` \| `true`
|
788
|
+
#
|
789
|
+
# @option params [String] :travel_mode
|
790
|
+
# Specifies the mode of transport when calculating a route. Used in
|
791
|
+
# estimating the speed of travel and road compatibility.
|
792
|
+
#
|
793
|
+
# The `TravelMode` you specify determines how you specify route
|
794
|
+
# preferences:
|
795
|
+
#
|
796
|
+
# * If traveling by `Car` use the `CarModeOptions` parameter.
|
797
|
+
#
|
798
|
+
# * If traveling by `Truck` use the `TruckModeOptions` parameter.
|
799
|
+
#
|
800
|
+
# Default Value: `Car`
|
801
|
+
#
|
802
|
+
# @option params [Types::CalculateRouteTruckModeOptions] :truck_mode_options
|
803
|
+
# Specifies route preferences when traveling by `Truck`, such as
|
804
|
+
# avoiding routes that use ferries or tolls, and truck specifications to
|
805
|
+
# consider when choosing an optimal road.
|
806
|
+
#
|
807
|
+
# Requirements: `TravelMode` must be specified as `Truck`.
|
808
|
+
#
|
809
|
+
# @option params [Array<Array>] :waypoint_positions
|
810
|
+
# Specifies an ordered list of up to 23 intermediate positions to
|
811
|
+
# include along a route between the departure position and destination
|
812
|
+
# position.
|
813
|
+
#
|
814
|
+
# * For example, from the `DeparturePosition` `[-123.115, 49.285]`, the
|
815
|
+
# route follows the order that the waypoint positions are given
|
816
|
+
# `[[-122.757, 49.0021],[-122.349, 47.620]]`
|
817
|
+
#
|
818
|
+
# ^
|
819
|
+
#
|
820
|
+
# <note markdown="1"> If you specify a waypoint position that's not located on a road,
|
821
|
+
# Amazon Location [moves the position to the nearest road][1].
|
822
|
+
#
|
823
|
+
# Specifying more than 23 waypoints returns a `400 ValidationException`
|
824
|
+
# error.
|
825
|
+
#
|
826
|
+
# </note>
|
827
|
+
#
|
828
|
+
# Valid Values: `[-180 to 180,-90 to 90]`
|
829
|
+
#
|
830
|
+
#
|
831
|
+
#
|
832
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
|
833
|
+
#
|
834
|
+
# @return [Types::CalculateRouteResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
835
|
+
#
|
836
|
+
# * {Types::CalculateRouteResponse#legs #legs} => Array<Types::Leg>
|
837
|
+
# * {Types::CalculateRouteResponse#summary #summary} => Types::CalculateRouteSummary
|
838
|
+
#
|
839
|
+
# @example Request syntax with placeholder values
|
840
|
+
#
|
841
|
+
# resp = client.calculate_route({
|
842
|
+
# calculator_name: "ResourceName", # required
|
843
|
+
# car_mode_options: {
|
844
|
+
# avoid_ferries: false,
|
845
|
+
# avoid_tolls: false,
|
846
|
+
# },
|
847
|
+
# depart_now: false,
|
848
|
+
# departure_position: [1.0], # required
|
849
|
+
# departure_time: Time.now,
|
850
|
+
# destination_position: [1.0], # required
|
851
|
+
# distance_unit: "Kilometers", # accepts Kilometers, Miles
|
852
|
+
# include_leg_geometry: false,
|
853
|
+
# travel_mode: "Car", # accepts Car, Truck, Walking
|
854
|
+
# truck_mode_options: {
|
855
|
+
# avoid_ferries: false,
|
856
|
+
# avoid_tolls: false,
|
857
|
+
# dimensions: {
|
858
|
+
# height: 1.0,
|
859
|
+
# length: 1.0,
|
860
|
+
# unit: "Meters", # accepts Meters, Feet
|
861
|
+
# width: 1.0,
|
862
|
+
# },
|
863
|
+
# weight: {
|
864
|
+
# total: 1.0,
|
865
|
+
# unit: "Kilograms", # accepts Kilograms, Pounds
|
866
|
+
# },
|
867
|
+
# },
|
868
|
+
# waypoint_positions: [
|
869
|
+
# [1.0],
|
870
|
+
# ],
|
871
|
+
# })
|
872
|
+
#
|
873
|
+
# @example Response structure
|
874
|
+
#
|
875
|
+
# resp.legs #=> Array
|
876
|
+
# resp.legs[0].distance #=> Float
|
877
|
+
# resp.legs[0].duration_seconds #=> Float
|
878
|
+
# resp.legs[0].end_position #=> Array
|
879
|
+
# resp.legs[0].end_position[0] #=> Float
|
880
|
+
# resp.legs[0].geometry.line_string #=> Array
|
881
|
+
# resp.legs[0].geometry.line_string[0] #=> Array
|
882
|
+
# resp.legs[0].geometry.line_string[0][0] #=> Float
|
883
|
+
# resp.legs[0].start_position #=> Array
|
884
|
+
# resp.legs[0].start_position[0] #=> Float
|
885
|
+
# resp.legs[0].steps #=> Array
|
886
|
+
# resp.legs[0].steps[0].distance #=> Float
|
887
|
+
# resp.legs[0].steps[0].duration_seconds #=> Float
|
888
|
+
# resp.legs[0].steps[0].end_position #=> Array
|
889
|
+
# resp.legs[0].steps[0].end_position[0] #=> Float
|
890
|
+
# resp.legs[0].steps[0].geometry_offset #=> Integer
|
891
|
+
# resp.legs[0].steps[0].start_position #=> Array
|
892
|
+
# resp.legs[0].steps[0].start_position[0] #=> Float
|
893
|
+
# resp.summary.data_source #=> String
|
894
|
+
# resp.summary.distance #=> Float
|
895
|
+
# resp.summary.distance_unit #=> String, one of "Kilometers", "Miles"
|
896
|
+
# resp.summary.duration_seconds #=> Float
|
897
|
+
# resp.summary.route_b_box #=> Array
|
898
|
+
# resp.summary.route_b_box[0] #=> Float
|
899
|
+
#
|
900
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRoute AWS API Documentation
|
901
|
+
#
|
902
|
+
# @overload calculate_route(params = {})
|
903
|
+
# @param [Hash] params ({})
|
904
|
+
def calculate_route(params = {}, options = {})
|
905
|
+
req = build_request(:calculate_route, params)
|
906
|
+
req.send_request(options)
|
907
|
+
end
|
908
|
+
|
603
909
|
# Creates a geofence collection, which manages and stores geofences.
|
604
910
|
#
|
605
911
|
# @option params [required, String] :collection_name
|
@@ -607,8 +913,8 @@ module Aws::LocationService
|
|
607
913
|
#
|
608
914
|
# Requirements:
|
609
915
|
#
|
610
|
-
# * Contain only alphanumeric characters (A–Z, a–z, 0
|
611
|
-
# and underscores (\_).
|
916
|
+
# * Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-),
|
917
|
+
# periods (.), and underscores (\_).
|
612
918
|
#
|
613
919
|
# * Must be a unique geofence collection name.
|
614
920
|
#
|
@@ -617,18 +923,16 @@ module Aws::LocationService
|
|
617
923
|
# @option params [String] :description
|
618
924
|
# An optional description for the geofence collection.
|
619
925
|
#
|
620
|
-
# @option params [
|
621
|
-
#
|
622
|
-
#
|
926
|
+
# @option params [String] :kms_key_id
|
927
|
+
# A key identifier for an [AWS KMS customer managed key][1]. Enter a key
|
928
|
+
# ID, key ARN, alias name, or alias ARN.
|
623
929
|
#
|
624
|
-
# * `RequestBasedUsage` — Selects the "Request-Based Usage" pricing
|
625
|
-
# plan.
|
626
930
|
#
|
627
|
-
# * `MobileAssetTracking` — Selects the "Mobile Asset Tracking"
|
628
|
-
# pricing plan.
|
629
931
|
#
|
630
|
-
#
|
631
|
-
#
|
932
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
|
933
|
+
#
|
934
|
+
# @option params [required, String] :pricing_plan
|
935
|
+
# Specifies the pricing plan for the geofence collection.
|
632
936
|
#
|
633
937
|
# For additional details and restrictions on each pricing plan option,
|
634
938
|
# see the [Amazon Location Service pricing page][1].
|
@@ -637,6 +941,51 @@ module Aws::LocationService
|
|
637
941
|
#
|
638
942
|
# [1]: https://aws.amazon.com/location/pricing/
|
639
943
|
#
|
944
|
+
# @option params [String] :pricing_plan_data_source
|
945
|
+
# Specifies the data provider for the geofence collection.
|
946
|
+
#
|
947
|
+
# * Required value for the following pricing plans: `MobileAssetTracking
|
948
|
+
# `\| `MobileAssetManagement`
|
949
|
+
#
|
950
|
+
# ^
|
951
|
+
#
|
952
|
+
# For more information about [Data Providers][1], and [Pricing
|
953
|
+
# plans][2], see the Amazon Location Service product page.
|
954
|
+
#
|
955
|
+
# <note markdown="1"> Amazon Location Service only uses `PricingPlanDataSource` to calculate
|
956
|
+
# billing for your geofence collection. Your data won't be shared with
|
957
|
+
# the data provider, and will remain in your AWS account or Region
|
958
|
+
# unless you move it.
|
959
|
+
#
|
960
|
+
# </note>
|
961
|
+
#
|
962
|
+
# Valid Values: `Esri `\| `Here`
|
963
|
+
#
|
964
|
+
#
|
965
|
+
#
|
966
|
+
# [1]: https://aws.amazon.com/location/data-providers/
|
967
|
+
# [2]: https://aws.amazon.com/location/pricing/
|
968
|
+
#
|
969
|
+
# @option params [Hash<String,String>] :tags
|
970
|
+
# Applies one or more tags to the geofence collection. A tag is a
|
971
|
+
# key-value pair helps manage, identify, search, and filter your
|
972
|
+
# resources by labelling them.
|
973
|
+
#
|
974
|
+
# Format: `"key" : "value"`
|
975
|
+
#
|
976
|
+
# Restrictions:
|
977
|
+
#
|
978
|
+
# * Maximum 50 tags per resource
|
979
|
+
#
|
980
|
+
# * Each resource tag must be unique with a maximum of one value.
|
981
|
+
#
|
982
|
+
# * Maximum key length: 128 Unicode characters in UTF-8
|
983
|
+
#
|
984
|
+
# * Maximum value length: 256 Unicode characters in UTF-8
|
985
|
+
#
|
986
|
+
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
987
|
+
# characters: + - = . \_ : / @.
|
988
|
+
#
|
640
989
|
# @return [Types::CreateGeofenceCollectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
641
990
|
#
|
642
991
|
# * {Types::CreateGeofenceCollectionResponse#collection_arn #collection_arn} => String
|
@@ -648,7 +997,12 @@ module Aws::LocationService
|
|
648
997
|
# resp = client.create_geofence_collection({
|
649
998
|
# collection_name: "ResourceName", # required
|
650
999
|
# description: "ResourceDescription",
|
1000
|
+
# kms_key_id: "KmsKeyId",
|
651
1001
|
# pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1002
|
+
# pricing_plan_data_source: "String",
|
1003
|
+
# tags: {
|
1004
|
+
# "TagKey" => "TagValue",
|
1005
|
+
# },
|
652
1006
|
# })
|
653
1007
|
#
|
654
1008
|
# @example Response structure
|
@@ -669,17 +1023,6 @@ module Aws::LocationService
|
|
669
1023
|
# Creates a map resource in your AWS account, which provides map tiles
|
670
1024
|
# of different styles sourced from global location data providers.
|
671
1025
|
#
|
672
|
-
# <note markdown="1"> By using Maps, you agree that AWS may transmit your API queries to
|
673
|
-
# your selected third party provider for processing, which may be
|
674
|
-
# outside the AWS region you are currently using. For more information,
|
675
|
-
# see the [AWS Service Terms][1] for Amazon Location Service.
|
676
|
-
#
|
677
|
-
# </note>
|
678
|
-
#
|
679
|
-
#
|
680
|
-
#
|
681
|
-
# [1]: https://aws.amazon.com/service-terms/
|
682
|
-
#
|
683
1026
|
# @option params [required, Types::MapConfiguration] :configuration
|
684
1027
|
# Specifies the map style selected from an available data provider.
|
685
1028
|
#
|
@@ -692,24 +1035,14 @@ module Aws::LocationService
|
|
692
1035
|
# Requirements:
|
693
1036
|
#
|
694
1037
|
# * Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens
|
695
|
-
# (-), and underscores (\_).
|
1038
|
+
# (-), periods (.), and underscores (\_).
|
696
1039
|
#
|
697
1040
|
# * Must be a unique map resource name.
|
698
1041
|
#
|
699
1042
|
# * No spaces allowed. For example, `ExampleMap`.
|
700
1043
|
#
|
701
1044
|
# @option params [required, String] :pricing_plan
|
702
|
-
# Specifies the pricing plan for your map resource.
|
703
|
-
# pricing plan options:
|
704
|
-
#
|
705
|
-
# * `RequestBasedUsage` — Selects the "Request-Based Usage" pricing
|
706
|
-
# plan.
|
707
|
-
#
|
708
|
-
# * `MobileAssetTracking` — Selects the "Mobile Asset Tracking"
|
709
|
-
# pricing plan.
|
710
|
-
#
|
711
|
-
# * `MobileAssetManagement` — Selects the "Mobile Asset Management"
|
712
|
-
# pricing plan.
|
1045
|
+
# Specifies the pricing plan for your map resource.
|
713
1046
|
#
|
714
1047
|
# For additional details and restrictions on each pricing plan option,
|
715
1048
|
# see the [Amazon Location Service pricing page][1].
|
@@ -718,6 +1051,26 @@ module Aws::LocationService
|
|
718
1051
|
#
|
719
1052
|
# [1]: https://aws.amazon.com/location/pricing/
|
720
1053
|
#
|
1054
|
+
# @option params [Hash<String,String>] :tags
|
1055
|
+
# Applies one or more tags to the map resource. A tag is a key-value
|
1056
|
+
# pair helps manage, identify, search, and filter your resources by
|
1057
|
+
# labelling them.
|
1058
|
+
#
|
1059
|
+
# Format: `"key" : "value"`
|
1060
|
+
#
|
1061
|
+
# Restrictions:
|
1062
|
+
#
|
1063
|
+
# * Maximum 50 tags per resource
|
1064
|
+
#
|
1065
|
+
# * Each resource tag must be unique with a maximum of one value.
|
1066
|
+
#
|
1067
|
+
# * Maximum key length: 128 Unicode characters in UTF-8
|
1068
|
+
#
|
1069
|
+
# * Maximum value length: 256 Unicode characters in UTF-8
|
1070
|
+
#
|
1071
|
+
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1072
|
+
# characters: + - = . \_ : / @.
|
1073
|
+
#
|
721
1074
|
# @return [Types::CreateMapResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
722
1075
|
#
|
723
1076
|
# * {Types::CreateMapResponse#create_time #create_time} => Time
|
@@ -733,6 +1086,9 @@ module Aws::LocationService
|
|
733
1086
|
# description: "ResourceDescription",
|
734
1087
|
# map_name: "ResourceName", # required
|
735
1088
|
# pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1089
|
+
# tags: {
|
1090
|
+
# "TagKey" => "TagValue",
|
1091
|
+
# },
|
736
1092
|
# })
|
737
1093
|
#
|
738
1094
|
# @example Response structure
|
@@ -750,57 +1106,65 @@ module Aws::LocationService
|
|
750
1106
|
req.send_request(options)
|
751
1107
|
end
|
752
1108
|
|
753
|
-
# Creates a
|
754
|
-
#
|
755
|
-
# provider.
|
1109
|
+
# Creates a place index resource in your AWS account, which supports
|
1110
|
+
# functions with geospatial data sourced from your chosen data provider.
|
756
1111
|
#
|
757
|
-
#
|
758
|
-
#
|
759
|
-
# outside the AWS region you are currently using.
|
1112
|
+
# @option params [required, String] :data_source
|
1113
|
+
# Specifies the data provider of geospatial data.
|
760
1114
|
#
|
761
|
-
#
|
762
|
-
#
|
763
|
-
# Service Terms][1] for Amazon Location Service.
|
1115
|
+
# <note markdown="1"> This field is case-sensitive. Enter the valid values as shown. For
|
1116
|
+
# example, entering `HERE` returns an error.
|
764
1117
|
#
|
765
|
-
#
|
1118
|
+
# </note>
|
766
1119
|
#
|
1120
|
+
# Valid values include:
|
767
1121
|
#
|
1122
|
+
# * `Esri` – For additional information about [Esri][1]'s coverage in
|
1123
|
+
# your region of interest, see [Esri details on geocoding
|
1124
|
+
# coverage][2].
|
1125
|
+
#
|
1126
|
+
# * `Here` – For additional information about [HERE Technologies][3]'s
|
1127
|
+
# coverage in your region of interest, see [HERE details on goecoding
|
1128
|
+
# coverage][4].
|
1129
|
+
#
|
1130
|
+
# Place index resources using HERE Technologies as a data provider
|
1131
|
+
# can't [store results][5] for locations in Japan. For more
|
1132
|
+
# information, see the [AWS Service Terms][6] for Amazon Location
|
1133
|
+
# Service.
|
1134
|
+
#
|
1135
|
+
# For additional information , see [Data providers][7] on the *Amazon
|
1136
|
+
# Location Service Developer Guide*.
|
768
1137
|
#
|
769
|
-
# [1]: https://aws.amazon.com/service-terms/
|
770
1138
|
#
|
771
|
-
#
|
772
|
-
#
|
1139
|
+
#
|
1140
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/esri.html
|
1141
|
+
# [2]: https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm
|
1142
|
+
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/HERE.html
|
1143
|
+
# [4]: https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html
|
1144
|
+
# [5]: https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html
|
1145
|
+
# [6]: https://aws.amazon.com/service-terms/
|
1146
|
+
# [7]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
|
773
1147
|
#
|
774
1148
|
# @option params [Types::DataSourceConfiguration] :data_source_configuration
|
775
|
-
# Specifies the data storage option
|
1149
|
+
# Specifies the data storage option requesting Places.
|
776
1150
|
#
|
777
1151
|
# @option params [String] :description
|
778
|
-
# The optional description for the
|
1152
|
+
# The optional description for the place index resource.
|
779
1153
|
#
|
780
1154
|
# @option params [required, String] :index_name
|
781
|
-
# The name of the
|
1155
|
+
# The name of the place index resource.
|
782
1156
|
#
|
783
1157
|
# Requirements:
|
784
1158
|
#
|
785
|
-
# * Contain only alphanumeric characters (A
|
786
|
-
# and underscores (\_)
|
1159
|
+
# * Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-),
|
1160
|
+
# periods (.), and underscores (\_).
|
787
1161
|
#
|
788
|
-
# * Must be a unique
|
1162
|
+
# * Must be a unique place index resource name.
|
789
1163
|
#
|
790
1164
|
# * No spaces allowed. For example, `ExamplePlaceIndex`.
|
791
1165
|
#
|
792
1166
|
# @option params [required, String] :pricing_plan
|
793
|
-
# Specifies the pricing plan for your
|
794
|
-
# three pricing plan options:
|
795
|
-
#
|
796
|
-
# * `RequestBasedUsage` — Selects the "Request-Based Usage" pricing
|
797
|
-
# plan.
|
798
|
-
#
|
799
|
-
# * `MobileAssetTracking` — Selects the "Mobile Asset Tracking"
|
800
|
-
# pricing plan.
|
801
|
-
#
|
802
|
-
# * `MobileAssetManagement` — Selects the "Mobile Asset Management"
|
803
|
-
# pricing plan.
|
1167
|
+
# Specifies the pricing plan for your place index resource.
|
804
1168
|
#
|
805
1169
|
# For additional details and restrictions on each pricing plan option,
|
806
1170
|
# see the [Amazon Location Service pricing page][1].
|
@@ -809,6 +1173,26 @@ module Aws::LocationService
|
|
809
1173
|
#
|
810
1174
|
# [1]: https://aws.amazon.com/location/pricing/
|
811
1175
|
#
|
1176
|
+
# @option params [Hash<String,String>] :tags
|
1177
|
+
# Applies one or more tags to the place index resource. A tag is a
|
1178
|
+
# key-value pair helps manage, identify, search, and filter your
|
1179
|
+
# resources by labelling them.
|
1180
|
+
#
|
1181
|
+
# Format: `"key" : "value"`
|
1182
|
+
#
|
1183
|
+
# Restrictions:
|
1184
|
+
#
|
1185
|
+
# * Maximum 50 tags per resource
|
1186
|
+
#
|
1187
|
+
# * Each resource tag must be unique with a maximum of one value.
|
1188
|
+
#
|
1189
|
+
# * Maximum key length: 128 Unicode characters in UTF-8
|
1190
|
+
#
|
1191
|
+
# * Maximum value length: 256 Unicode characters in UTF-8
|
1192
|
+
#
|
1193
|
+
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1194
|
+
# characters: + - = . \_ : / @.
|
1195
|
+
#
|
812
1196
|
# @return [Types::CreatePlaceIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
813
1197
|
#
|
814
1198
|
# * {Types::CreatePlaceIndexResponse#create_time #create_time} => Time
|
@@ -825,6 +1209,9 @@ module Aws::LocationService
|
|
825
1209
|
# description: "ResourceDescription",
|
826
1210
|
# index_name: "ResourceName", # required
|
827
1211
|
# pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1212
|
+
# tags: {
|
1213
|
+
# "TagKey" => "TagValue",
|
1214
|
+
# },
|
828
1215
|
# })
|
829
1216
|
#
|
830
1217
|
# @example Response structure
|
@@ -842,89 +1229,255 @@ module Aws::LocationService
|
|
842
1229
|
req.send_request(options)
|
843
1230
|
end
|
844
1231
|
|
845
|
-
# Creates a
|
846
|
-
# retrieve current and historical location of devices.
|
1232
|
+
# Creates a route calculator resource in your AWS account.
|
847
1233
|
#
|
848
|
-
#
|
849
|
-
#
|
1234
|
+
# You can send requests to a route calculator resource to estimate
|
1235
|
+
# travel time, distance, and get directions. A route calculator sources
|
1236
|
+
# traffic and road network data from your chosen data provider.
|
1237
|
+
#
|
1238
|
+
# @option params [required, String] :calculator_name
|
1239
|
+
# The name of the route calculator resource.
|
1240
|
+
#
|
1241
|
+
# Requirements:
|
1242
|
+
#
|
1243
|
+
# * Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-),
|
1244
|
+
# periods (.), and underscores (\_).
|
1245
|
+
#
|
1246
|
+
# * Must be a unique Route calculator resource name.
|
1247
|
+
#
|
1248
|
+
# * No spaces allowed. For example, `ExampleRouteCalculator`.
|
1249
|
+
#
|
1250
|
+
# @option params [required, String] :data_source
|
1251
|
+
# Specifies the data provider of traffic and road network data.
|
1252
|
+
#
|
1253
|
+
# <note markdown="1"> This field is case-sensitive. Enter the valid values as shown. For
|
1254
|
+
# example, entering `HERE` returns an error.
|
1255
|
+
#
|
1256
|
+
# </note>
|
1257
|
+
#
|
1258
|
+
# Valid values include:
|
1259
|
+
#
|
1260
|
+
# * `Esri` – For additional information about [Esri][1]'s coverage in
|
1261
|
+
# your region of interest, see [Esri details on street networks and
|
1262
|
+
# traffic coverage][2].
|
1263
|
+
#
|
1264
|
+
# * `Here` – For additional information about [HERE Technologies][3]'s
|
1265
|
+
# coverage in your region of interest, see [HERE car routing
|
1266
|
+
# coverage][4] and [HERE truck routing coverage][5].
|
1267
|
+
#
|
1268
|
+
# For additional information , see [Data providers][6] on the *Amazon
|
1269
|
+
# Location Service Developer Guide*.
|
850
1270
|
#
|
851
|
-
# @option params [required, String] :pricing_plan
|
852
|
-
# Specifies the pricing plan for your tracker resource. There's three
|
853
|
-
# pricing plan options:
|
854
1271
|
#
|
855
|
-
# * `RequestBasedUsage` — Selects the "Request-Based Usage" pricing
|
856
|
-
# plan.
|
857
1272
|
#
|
858
|
-
#
|
859
|
-
#
|
1273
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/esri.html
|
1274
|
+
# [2]: https://doc.arcgis.com/en/arcgis-online/reference/network-coverage.htm
|
1275
|
+
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/HERE.html
|
1276
|
+
# [4]: https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/car-routing.html
|
1277
|
+
# [5]: https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/truck-routing.html
|
1278
|
+
# [6]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
|
860
1279
|
#
|
861
|
-
#
|
862
|
-
#
|
1280
|
+
# @option params [String] :description
|
1281
|
+
# The optional description for the route calculator resource.
|
1282
|
+
#
|
1283
|
+
# @option params [required, String] :pricing_plan
|
1284
|
+
# Specifies the pricing plan for your route calculator resource.
|
863
1285
|
#
|
864
1286
|
# For additional details and restrictions on each pricing plan option,
|
865
|
-
# see
|
1287
|
+
# see [Amazon Location Service pricing][1].
|
866
1288
|
#
|
867
1289
|
#
|
868
1290
|
#
|
869
1291
|
# [1]: https://aws.amazon.com/location/pricing/
|
870
1292
|
#
|
871
|
-
# @option params [
|
872
|
-
#
|
1293
|
+
# @option params [Hash<String,String>] :tags
|
1294
|
+
# Applies one or more tags to the route calculator resource. A tag is a
|
1295
|
+
# key-value pair helps manage, identify, search, and filter your
|
1296
|
+
# resources by labelling them.
|
873
1297
|
#
|
874
|
-
#
|
1298
|
+
# * For example: \\\{ `"tag1" : "value1"`, `"tag2" : "value2"`\\}
|
1299
|
+
#
|
1300
|
+
# ^
|
875
1301
|
#
|
876
|
-
#
|
877
|
-
# and underscores (\_).
|
1302
|
+
# Format: `"key" : "value"`
|
878
1303
|
#
|
879
|
-
#
|
1304
|
+
# Restrictions:
|
880
1305
|
#
|
881
|
-
# *
|
1306
|
+
# * Maximum 50 tags per resource
|
882
1307
|
#
|
883
|
-
#
|
1308
|
+
# * Each resource tag must be unique with a maximum of one value.
|
884
1309
|
#
|
885
|
-
# *
|
886
|
-
#
|
887
|
-
# *
|
1310
|
+
# * Maximum key length: 128 Unicode characters in UTF-8
|
1311
|
+
#
|
1312
|
+
# * Maximum value length: 256 Unicode characters in UTF-8
|
1313
|
+
#
|
1314
|
+
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1315
|
+
# characters: + - = . \_ : / @.
|
1316
|
+
#
|
1317
|
+
# @return [Types::CreateRouteCalculatorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1318
|
+
#
|
1319
|
+
# * {Types::CreateRouteCalculatorResponse#calculator_arn #calculator_arn} => String
|
1320
|
+
# * {Types::CreateRouteCalculatorResponse#calculator_name #calculator_name} => String
|
1321
|
+
# * {Types::CreateRouteCalculatorResponse#create_time #create_time} => Time
|
888
1322
|
#
|
889
1323
|
# @example Request syntax with placeholder values
|
890
1324
|
#
|
891
|
-
# resp = client.
|
1325
|
+
# resp = client.create_route_calculator({
|
1326
|
+
# calculator_name: "ResourceName", # required
|
1327
|
+
# data_source: "String", # required
|
892
1328
|
# description: "ResourceDescription",
|
893
1329
|
# pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
894
|
-
#
|
1330
|
+
# tags: {
|
1331
|
+
# "TagKey" => "TagValue",
|
1332
|
+
# },
|
895
1333
|
# })
|
896
1334
|
#
|
897
1335
|
# @example Response structure
|
898
1336
|
#
|
1337
|
+
# resp.calculator_arn #=> String
|
1338
|
+
# resp.calculator_name #=> String
|
899
1339
|
# resp.create_time #=> Time
|
900
|
-
# resp.tracker_arn #=> String
|
901
|
-
# resp.tracker_name #=> String
|
902
1340
|
#
|
903
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/
|
1341
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateRouteCalculator AWS API Documentation
|
904
1342
|
#
|
905
|
-
# @overload
|
1343
|
+
# @overload create_route_calculator(params = {})
|
906
1344
|
# @param [Hash] params ({})
|
907
|
-
def
|
908
|
-
req = build_request(:
|
1345
|
+
def create_route_calculator(params = {}, options = {})
|
1346
|
+
req = build_request(:create_route_calculator, params)
|
909
1347
|
req.send_request(options)
|
910
1348
|
end
|
911
1349
|
|
912
|
-
#
|
1350
|
+
# Creates a tracker resource in your AWS account, which lets you
|
1351
|
+
# retrieve current and historical location of devices.
|
913
1352
|
#
|
914
|
-
#
|
915
|
-
#
|
916
|
-
# resource, the devices will no longer be monitored.
|
1353
|
+
# @option params [String] :description
|
1354
|
+
# An optional description for the tracker resource.
|
917
1355
|
#
|
918
|
-
#
|
1356
|
+
# @option params [String] :kms_key_id
|
1357
|
+
# A key identifier for an [AWS KMS customer managed key][1]. Enter a key
|
1358
|
+
# ID, key ARN, alias name, or alias ARN.
|
919
1359
|
#
|
920
|
-
# @option params [required, String] :collection_name
|
921
|
-
# The name of the geofence collection to be deleted.
|
922
1360
|
#
|
923
|
-
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
924
1361
|
#
|
925
|
-
#
|
1362
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
|
926
1363
|
#
|
927
|
-
#
|
1364
|
+
# @option params [required, String] :pricing_plan
|
1365
|
+
# Specifies the pricing plan for the tracker resource.
|
1366
|
+
#
|
1367
|
+
# For additional details and restrictions on each pricing plan option,
|
1368
|
+
# see the [Amazon Location Service pricing page][1].
|
1369
|
+
#
|
1370
|
+
#
|
1371
|
+
#
|
1372
|
+
# [1]: https://aws.amazon.com/location/pricing/
|
1373
|
+
#
|
1374
|
+
# @option params [String] :pricing_plan_data_source
|
1375
|
+
# Specifies the data provider for the tracker resource.
|
1376
|
+
#
|
1377
|
+
# * Required value for the following pricing plans: `MobileAssetTracking
|
1378
|
+
# `\| `MobileAssetManagement`
|
1379
|
+
#
|
1380
|
+
# ^
|
1381
|
+
#
|
1382
|
+
# For more information about [Data Providers][1], and [Pricing
|
1383
|
+
# plans][2], see the Amazon Location Service product page.
|
1384
|
+
#
|
1385
|
+
# <note markdown="1"> Amazon Location Service only uses `PricingPlanDataSource` to calculate
|
1386
|
+
# billing for your tracker resource. Your data will not be shared with
|
1387
|
+
# the data provider, and will remain in your AWS account or Region
|
1388
|
+
# unless you move it.
|
1389
|
+
#
|
1390
|
+
# </note>
|
1391
|
+
#
|
1392
|
+
# Valid Values: `Esri` \| `Here`
|
1393
|
+
#
|
1394
|
+
#
|
1395
|
+
#
|
1396
|
+
# [1]: https://aws.amazon.com/location/data-providers/
|
1397
|
+
# [2]: https://aws.amazon.com/location/pricing/
|
1398
|
+
#
|
1399
|
+
# @option params [Hash<String,String>] :tags
|
1400
|
+
# Applies one or more tags to the tracker resource. A tag is a key-value
|
1401
|
+
# pair helps manage, identify, search, and filter your resources by
|
1402
|
+
# labelling them.
|
1403
|
+
#
|
1404
|
+
# Format: `"key" : "value"`
|
1405
|
+
#
|
1406
|
+
# Restrictions:
|
1407
|
+
#
|
1408
|
+
# * Maximum 50 tags per resource
|
1409
|
+
#
|
1410
|
+
# * Each resource tag must be unique with a maximum of one value.
|
1411
|
+
#
|
1412
|
+
# * Maximum key length: 128 Unicode characters in UTF-8
|
1413
|
+
#
|
1414
|
+
# * Maximum value length: 256 Unicode characters in UTF-8
|
1415
|
+
#
|
1416
|
+
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1417
|
+
# characters: + - = . \_ : / @.
|
1418
|
+
#
|
1419
|
+
# @option params [required, String] :tracker_name
|
1420
|
+
# The name for the tracker resource.
|
1421
|
+
#
|
1422
|
+
# Requirements:
|
1423
|
+
#
|
1424
|
+
# * Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-),
|
1425
|
+
# periods (.), and underscores (\_).
|
1426
|
+
#
|
1427
|
+
# * Must be a unique tracker resource name.
|
1428
|
+
#
|
1429
|
+
# * No spaces allowed. For example, `ExampleTracker`.
|
1430
|
+
#
|
1431
|
+
# @return [Types::CreateTrackerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1432
|
+
#
|
1433
|
+
# * {Types::CreateTrackerResponse#create_time #create_time} => Time
|
1434
|
+
# * {Types::CreateTrackerResponse#tracker_arn #tracker_arn} => String
|
1435
|
+
# * {Types::CreateTrackerResponse#tracker_name #tracker_name} => String
|
1436
|
+
#
|
1437
|
+
# @example Request syntax with placeholder values
|
1438
|
+
#
|
1439
|
+
# resp = client.create_tracker({
|
1440
|
+
# description: "ResourceDescription",
|
1441
|
+
# kms_key_id: "KmsKeyId",
|
1442
|
+
# pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1443
|
+
# pricing_plan_data_source: "String",
|
1444
|
+
# tags: {
|
1445
|
+
# "TagKey" => "TagValue",
|
1446
|
+
# },
|
1447
|
+
# tracker_name: "ResourceName", # required
|
1448
|
+
# })
|
1449
|
+
#
|
1450
|
+
# @example Response structure
|
1451
|
+
#
|
1452
|
+
# resp.create_time #=> Time
|
1453
|
+
# resp.tracker_arn #=> String
|
1454
|
+
# resp.tracker_name #=> String
|
1455
|
+
#
|
1456
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateTracker AWS API Documentation
|
1457
|
+
#
|
1458
|
+
# @overload create_tracker(params = {})
|
1459
|
+
# @param [Hash] params ({})
|
1460
|
+
def create_tracker(params = {}, options = {})
|
1461
|
+
req = build_request(:create_tracker, params)
|
1462
|
+
req.send_request(options)
|
1463
|
+
end
|
1464
|
+
|
1465
|
+
# Deletes a geofence collection from your AWS account.
|
1466
|
+
#
|
1467
|
+
# <note markdown="1"> This operation deletes the resource permanently. If the geofence
|
1468
|
+
# collection is the target of a tracker resource, the devices will no
|
1469
|
+
# longer be monitored.
|
1470
|
+
#
|
1471
|
+
# </note>
|
1472
|
+
#
|
1473
|
+
# @option params [required, String] :collection_name
|
1474
|
+
# The name of the geofence collection to be deleted.
|
1475
|
+
#
|
1476
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1477
|
+
#
|
1478
|
+
# @example Request syntax with placeholder values
|
1479
|
+
#
|
1480
|
+
# resp = client.delete_geofence_collection({
|
928
1481
|
# collection_name: "ResourceName", # required
|
929
1482
|
# })
|
930
1483
|
#
|
@@ -939,9 +1492,8 @@ module Aws::LocationService
|
|
939
1492
|
|
940
1493
|
# Deletes a map resource from your AWS account.
|
941
1494
|
#
|
942
|
-
# <note markdown="1"> This
|
943
|
-
#
|
944
|
-
# render.
|
1495
|
+
# <note markdown="1"> This operation deletes the resource permanently. If the map is being
|
1496
|
+
# used in an application, the map may not render.
|
945
1497
|
#
|
946
1498
|
# </note>
|
947
1499
|
#
|
@@ -965,15 +1517,14 @@ module Aws::LocationService
|
|
965
1517
|
req.send_request(options)
|
966
1518
|
end
|
967
1519
|
|
968
|
-
# Deletes a
|
1520
|
+
# Deletes a place index resource from your AWS account.
|
969
1521
|
#
|
970
|
-
# <note markdown="1"> This
|
971
|
-
# action.
|
1522
|
+
# <note markdown="1"> This operation deletes the resource permanently.
|
972
1523
|
#
|
973
1524
|
# </note>
|
974
1525
|
#
|
975
1526
|
# @option params [required, String] :index_name
|
976
|
-
# The name of the
|
1527
|
+
# The name of the place index resource to be deleted.
|
977
1528
|
#
|
978
1529
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
979
1530
|
#
|
@@ -992,12 +1543,37 @@ module Aws::LocationService
|
|
992
1543
|
req.send_request(options)
|
993
1544
|
end
|
994
1545
|
|
1546
|
+
# Deletes a route calculator resource from your AWS account.
|
1547
|
+
#
|
1548
|
+
# <note markdown="1"> This operation deletes the resource permanently.
|
1549
|
+
#
|
1550
|
+
# </note>
|
1551
|
+
#
|
1552
|
+
# @option params [required, String] :calculator_name
|
1553
|
+
# The name of the route calculator resource to be deleted.
|
1554
|
+
#
|
1555
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1556
|
+
#
|
1557
|
+
# @example Request syntax with placeholder values
|
1558
|
+
#
|
1559
|
+
# resp = client.delete_route_calculator({
|
1560
|
+
# calculator_name: "ResourceName", # required
|
1561
|
+
# })
|
1562
|
+
#
|
1563
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteRouteCalculator AWS API Documentation
|
1564
|
+
#
|
1565
|
+
# @overload delete_route_calculator(params = {})
|
1566
|
+
# @param [Hash] params ({})
|
1567
|
+
def delete_route_calculator(params = {}, options = {})
|
1568
|
+
req = build_request(:delete_route_calculator, params)
|
1569
|
+
req.send_request(options)
|
1570
|
+
end
|
1571
|
+
|
995
1572
|
# Deletes a tracker resource from your AWS account.
|
996
1573
|
#
|
997
|
-
# <note markdown="1"> This
|
998
|
-
#
|
999
|
-
#
|
1000
|
-
# applications.
|
1574
|
+
# <note markdown="1"> This operation deletes the resource permanently. If the tracker
|
1575
|
+
# resource is in use, you may encounter an error. Make sure that the
|
1576
|
+
# target resource isn't a dependency for your applications.
|
1001
1577
|
#
|
1002
1578
|
# </note>
|
1003
1579
|
#
|
@@ -1032,6 +1608,10 @@ module Aws::LocationService
|
|
1032
1608
|
# * {Types::DescribeGeofenceCollectionResponse#collection_name #collection_name} => String
|
1033
1609
|
# * {Types::DescribeGeofenceCollectionResponse#create_time #create_time} => Time
|
1034
1610
|
# * {Types::DescribeGeofenceCollectionResponse#description #description} => String
|
1611
|
+
# * {Types::DescribeGeofenceCollectionResponse#kms_key_id #kms_key_id} => String
|
1612
|
+
# * {Types::DescribeGeofenceCollectionResponse#pricing_plan #pricing_plan} => String
|
1613
|
+
# * {Types::DescribeGeofenceCollectionResponse#pricing_plan_data_source #pricing_plan_data_source} => String
|
1614
|
+
# * {Types::DescribeGeofenceCollectionResponse#tags #tags} => Hash<String,String>
|
1035
1615
|
# * {Types::DescribeGeofenceCollectionResponse#update_time #update_time} => Time
|
1036
1616
|
#
|
1037
1617
|
# @example Request syntax with placeholder values
|
@@ -1046,6 +1626,11 @@ module Aws::LocationService
|
|
1046
1626
|
# resp.collection_name #=> String
|
1047
1627
|
# resp.create_time #=> Time
|
1048
1628
|
# resp.description #=> String
|
1629
|
+
# resp.kms_key_id #=> String
|
1630
|
+
# resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
1631
|
+
# resp.pricing_plan_data_source #=> String
|
1632
|
+
# resp.tags #=> Hash
|
1633
|
+
# resp.tags["TagKey"] #=> String
|
1049
1634
|
# resp.update_time #=> Time
|
1050
1635
|
#
|
1051
1636
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeGeofenceCollection AWS API Documentation
|
@@ -1070,6 +1655,8 @@ module Aws::LocationService
|
|
1070
1655
|
# * {Types::DescribeMapResponse#description #description} => String
|
1071
1656
|
# * {Types::DescribeMapResponse#map_arn #map_arn} => String
|
1072
1657
|
# * {Types::DescribeMapResponse#map_name #map_name} => String
|
1658
|
+
# * {Types::DescribeMapResponse#pricing_plan #pricing_plan} => String
|
1659
|
+
# * {Types::DescribeMapResponse#tags #tags} => Hash<String,String>
|
1073
1660
|
# * {Types::DescribeMapResponse#update_time #update_time} => Time
|
1074
1661
|
#
|
1075
1662
|
# @example Request syntax with placeholder values
|
@@ -1086,6 +1673,9 @@ module Aws::LocationService
|
|
1086
1673
|
# resp.description #=> String
|
1087
1674
|
# resp.map_arn #=> String
|
1088
1675
|
# resp.map_name #=> String
|
1676
|
+
# resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
1677
|
+
# resp.tags #=> Hash
|
1678
|
+
# resp.tags["TagKey"] #=> String
|
1089
1679
|
# resp.update_time #=> Time
|
1090
1680
|
#
|
1091
1681
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeMap AWS API Documentation
|
@@ -1097,10 +1687,10 @@ module Aws::LocationService
|
|
1097
1687
|
req.send_request(options)
|
1098
1688
|
end
|
1099
1689
|
|
1100
|
-
# Retrieves the
|
1690
|
+
# Retrieves the place index resource details.
|
1101
1691
|
#
|
1102
1692
|
# @option params [required, String] :index_name
|
1103
|
-
# The name of the
|
1693
|
+
# The name of the place index resource.
|
1104
1694
|
#
|
1105
1695
|
# @return [Types::DescribePlaceIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1106
1696
|
#
|
@@ -1110,6 +1700,8 @@ module Aws::LocationService
|
|
1110
1700
|
# * {Types::DescribePlaceIndexResponse#description #description} => String
|
1111
1701
|
# * {Types::DescribePlaceIndexResponse#index_arn #index_arn} => String
|
1112
1702
|
# * {Types::DescribePlaceIndexResponse#index_name #index_name} => String
|
1703
|
+
# * {Types::DescribePlaceIndexResponse#pricing_plan #pricing_plan} => String
|
1704
|
+
# * {Types::DescribePlaceIndexResponse#tags #tags} => Hash<String,String>
|
1113
1705
|
# * {Types::DescribePlaceIndexResponse#update_time #update_time} => Time
|
1114
1706
|
#
|
1115
1707
|
# @example Request syntax with placeholder values
|
@@ -1126,6 +1718,9 @@ module Aws::LocationService
|
|
1126
1718
|
# resp.description #=> String
|
1127
1719
|
# resp.index_arn #=> String
|
1128
1720
|
# resp.index_name #=> String
|
1721
|
+
# resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
1722
|
+
# resp.tags #=> Hash
|
1723
|
+
# resp.tags["TagKey"] #=> String
|
1129
1724
|
# resp.update_time #=> Time
|
1130
1725
|
#
|
1131
1726
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribePlaceIndex AWS API Documentation
|
@@ -1137,6 +1732,49 @@ module Aws::LocationService
|
|
1137
1732
|
req.send_request(options)
|
1138
1733
|
end
|
1139
1734
|
|
1735
|
+
# Retrieves the route calculator resource details.
|
1736
|
+
#
|
1737
|
+
# @option params [required, String] :calculator_name
|
1738
|
+
# The name of the route calculator resource.
|
1739
|
+
#
|
1740
|
+
# @return [Types::DescribeRouteCalculatorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1741
|
+
#
|
1742
|
+
# * {Types::DescribeRouteCalculatorResponse#calculator_arn #calculator_arn} => String
|
1743
|
+
# * {Types::DescribeRouteCalculatorResponse#calculator_name #calculator_name} => String
|
1744
|
+
# * {Types::DescribeRouteCalculatorResponse#create_time #create_time} => Time
|
1745
|
+
# * {Types::DescribeRouteCalculatorResponse#data_source #data_source} => String
|
1746
|
+
# * {Types::DescribeRouteCalculatorResponse#description #description} => String
|
1747
|
+
# * {Types::DescribeRouteCalculatorResponse#pricing_plan #pricing_plan} => String
|
1748
|
+
# * {Types::DescribeRouteCalculatorResponse#tags #tags} => Hash<String,String>
|
1749
|
+
# * {Types::DescribeRouteCalculatorResponse#update_time #update_time} => Time
|
1750
|
+
#
|
1751
|
+
# @example Request syntax with placeholder values
|
1752
|
+
#
|
1753
|
+
# resp = client.describe_route_calculator({
|
1754
|
+
# calculator_name: "ResourceName", # required
|
1755
|
+
# })
|
1756
|
+
#
|
1757
|
+
# @example Response structure
|
1758
|
+
#
|
1759
|
+
# resp.calculator_arn #=> String
|
1760
|
+
# resp.calculator_name #=> String
|
1761
|
+
# resp.create_time #=> Time
|
1762
|
+
# resp.data_source #=> String
|
1763
|
+
# resp.description #=> String
|
1764
|
+
# resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
1765
|
+
# resp.tags #=> Hash
|
1766
|
+
# resp.tags["TagKey"] #=> String
|
1767
|
+
# resp.update_time #=> Time
|
1768
|
+
#
|
1769
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeRouteCalculator AWS API Documentation
|
1770
|
+
#
|
1771
|
+
# @overload describe_route_calculator(params = {})
|
1772
|
+
# @param [Hash] params ({})
|
1773
|
+
def describe_route_calculator(params = {}, options = {})
|
1774
|
+
req = build_request(:describe_route_calculator, params)
|
1775
|
+
req.send_request(options)
|
1776
|
+
end
|
1777
|
+
|
1140
1778
|
# Retrieves the tracker resource details.
|
1141
1779
|
#
|
1142
1780
|
# @option params [required, String] :tracker_name
|
@@ -1146,6 +1784,10 @@ module Aws::LocationService
|
|
1146
1784
|
#
|
1147
1785
|
# * {Types::DescribeTrackerResponse#create_time #create_time} => Time
|
1148
1786
|
# * {Types::DescribeTrackerResponse#description #description} => String
|
1787
|
+
# * {Types::DescribeTrackerResponse#kms_key_id #kms_key_id} => String
|
1788
|
+
# * {Types::DescribeTrackerResponse#pricing_plan #pricing_plan} => String
|
1789
|
+
# * {Types::DescribeTrackerResponse#pricing_plan_data_source #pricing_plan_data_source} => String
|
1790
|
+
# * {Types::DescribeTrackerResponse#tags #tags} => Hash<String,String>
|
1149
1791
|
# * {Types::DescribeTrackerResponse#tracker_arn #tracker_arn} => String
|
1150
1792
|
# * {Types::DescribeTrackerResponse#tracker_name #tracker_name} => String
|
1151
1793
|
# * {Types::DescribeTrackerResponse#update_time #update_time} => Time
|
@@ -1160,6 +1802,11 @@ module Aws::LocationService
|
|
1160
1802
|
#
|
1161
1803
|
# resp.create_time #=> Time
|
1162
1804
|
# resp.description #=> String
|
1805
|
+
# resp.kms_key_id #=> String
|
1806
|
+
# resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
1807
|
+
# resp.pricing_plan_data_source #=> String
|
1808
|
+
# resp.tags #=> Hash
|
1809
|
+
# resp.tags["TagKey"] #=> String
|
1163
1810
|
# resp.tracker_arn #=> String
|
1164
1811
|
# resp.tracker_name #=> String
|
1165
1812
|
# resp.update_time #=> Time
|
@@ -1173,7 +1820,7 @@ module Aws::LocationService
|
|
1173
1820
|
req.send_request(options)
|
1174
1821
|
end
|
1175
1822
|
|
1176
|
-
# Removes the association
|
1823
|
+
# Removes the association between a tracker resource and a geofence
|
1177
1824
|
# collection.
|
1178
1825
|
#
|
1179
1826
|
# <note markdown="1"> Once you unlink a tracker resource from a geofence collection, the
|
@@ -1188,7 +1835,7 @@ module Aws::LocationService
|
|
1188
1835
|
# a resource across all AWS.
|
1189
1836
|
#
|
1190
1837
|
# * Format example:
|
1191
|
-
# `arn:
|
1838
|
+
# `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer`
|
1192
1839
|
#
|
1193
1840
|
# ^
|
1194
1841
|
#
|
@@ -1213,14 +1860,15 @@ module Aws::LocationService
|
|
1213
1860
|
req.send_request(options)
|
1214
1861
|
end
|
1215
1862
|
|
1216
|
-
# Retrieves
|
1863
|
+
# Retrieves a device's most recent position according to its sample
|
1864
|
+
# time.
|
1217
1865
|
#
|
1218
|
-
# <note markdown="1">
|
1866
|
+
# <note markdown="1"> Device positions are deleted after 30 days.
|
1219
1867
|
#
|
1220
1868
|
# </note>
|
1221
1869
|
#
|
1222
1870
|
# @option params [required, String] :device_id
|
1223
|
-
# The device whose position you want to
|
1871
|
+
# The device whose position you want to retrieve.
|
1224
1872
|
#
|
1225
1873
|
# @option params [required, String] :tracker_name
|
1226
1874
|
# The tracker resource receiving the position update.
|
@@ -1259,7 +1907,7 @@ module Aws::LocationService
|
|
1259
1907
|
# Retrieves the device position history from a tracker resource within a
|
1260
1908
|
# specified range of time.
|
1261
1909
|
#
|
1262
|
-
# <note markdown="1">
|
1910
|
+
# <note markdown="1"> Device positions are deleted after 30 days.
|
1263
1911
|
#
|
1264
1912
|
# </note>
|
1265
1913
|
#
|
@@ -1268,9 +1916,12 @@ module Aws::LocationService
|
|
1268
1916
|
#
|
1269
1917
|
# @option params [Time,DateTime,Date,Integer,String] :end_time_exclusive
|
1270
1918
|
# Specify the end time for the position history in [ ISO 8601][1]
|
1271
|
-
# format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
1919
|
+
# format: `YYYY-MM-DDThh:mm:ss.sssZ`. By default, the value will be the
|
1920
|
+
# time that the request is made.
|
1921
|
+
#
|
1922
|
+
# Requirement:
|
1272
1923
|
#
|
1273
|
-
# * The
|
1924
|
+
# * The time specified for `EndTimeExclusive` must be after the time for
|
1274
1925
|
# `StartTimeInclusive`.
|
1275
1926
|
#
|
1276
1927
|
# ^
|
@@ -1287,10 +1938,13 @@ module Aws::LocationService
|
|
1287
1938
|
#
|
1288
1939
|
# @option params [Time,DateTime,Date,Integer,String] :start_time_inclusive
|
1289
1940
|
# Specify the start time for the position history in [ ISO 8601][1]
|
1290
|
-
# format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
1941
|
+
# format: `YYYY-MM-DDThh:mm:ss.sssZ`. By default, the value will be 24
|
1942
|
+
# hours prior to the time that the request is made.
|
1291
1943
|
#
|
1292
|
-
#
|
1293
|
-
#
|
1944
|
+
# Requirement:
|
1945
|
+
#
|
1946
|
+
# * The time specified for `StartTimeInclusive` must be before
|
1947
|
+
# `EndTimeExclusive`.
|
1294
1948
|
#
|
1295
1949
|
# ^
|
1296
1950
|
#
|
@@ -1385,11 +2039,40 @@ module Aws::LocationService
|
|
1385
2039
|
#
|
1386
2040
|
# @option params [required, String] :font_stack
|
1387
2041
|
# A comma-separated list of fonts to load glyphs from in order of
|
1388
|
-
# preference
|
2042
|
+
# preference. For example, `Noto Sans Regular, Arial Unicode`.
|
2043
|
+
#
|
2044
|
+
# Valid fonts for [Esri][1] styles:
|
2045
|
+
#
|
2046
|
+
# * VectorEsriDarkGrayCanvas – `Ubuntu Medium Italic` \| `Ubuntu Medium`
|
2047
|
+
# \| `Ubuntu Italic` \| `Ubuntu Regular` \| `Ubuntu Bold`
|
2048
|
+
#
|
2049
|
+
# * VectorEsriLightGrayCanvas – `Ubuntu Italic` \| `Ubuntu Regular` \|
|
2050
|
+
# `Ubuntu Light` \| `Ubuntu Bold`
|
2051
|
+
#
|
2052
|
+
# * VectorEsriTopographic – `Noto Sans Italic` \| `Noto Sans Regular` \|
|
2053
|
+
# `Noto Sans Bold` \| `Noto Serif Regular` \| `Roboto Condensed Light
|
2054
|
+
# Italic`
|
2055
|
+
#
|
2056
|
+
# * VectorEsriStreets – `Arial Regular` \| `Arial Italic` \| `Arial
|
2057
|
+
# Bold`
|
2058
|
+
#
|
2059
|
+
# * VectorEsriNavigation – `Arial Regular` \| `Arial Italic` \| `Arial
|
2060
|
+
# Bold`
|
2061
|
+
#
|
2062
|
+
# Valid fonts for [HERE Technologies][2] styles:
|
2063
|
+
#
|
2064
|
+
# * `VectorHereBerlin` – `Fira GO Regular` \| `Fira GO Bold`
|
2065
|
+
#
|
2066
|
+
# ^
|
2067
|
+
#
|
2068
|
+
#
|
2069
|
+
#
|
2070
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/esri.html
|
2071
|
+
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/HERE.html
|
1389
2072
|
#
|
1390
2073
|
# @option params [required, String] :font_unicode_range
|
1391
2074
|
# A Unicode range of characters to download glyphs for. Each response
|
1392
|
-
# will contain 256 characters. For example, 0
|
2075
|
+
# will contain 256 characters. For example, 0–255 includes all
|
1393
2076
|
# characters from range `U+0000` to `00FF`. Must be aligned to multiples
|
1394
2077
|
# of 256.
|
1395
2078
|
#
|
@@ -1507,7 +2190,7 @@ module Aws::LocationService
|
|
1507
2190
|
end
|
1508
2191
|
|
1509
2192
|
# Retrieves a vector data tile from the map resource. Map tiles are used
|
1510
|
-
# by clients to render a map.
|
2193
|
+
# by clients to render a map. they're addressed using a grid
|
1511
2194
|
# arrangement with an X coordinate, Y coordinate, and Z (zoom) level.
|
1512
2195
|
#
|
1513
2196
|
# The origin (0, 0) is the top left of the map. Increasing the zoom
|
@@ -1555,6 +2238,55 @@ module Aws::LocationService
|
|
1555
2238
|
req.send_request(options, &block)
|
1556
2239
|
end
|
1557
2240
|
|
2241
|
+
# A batch request to retrieve all device positions.
|
2242
|
+
#
|
2243
|
+
# @option params [Integer] :max_results
|
2244
|
+
# An optional limit for the number of entries returned in a single call.
|
2245
|
+
#
|
2246
|
+
# Default value: `100`
|
2247
|
+
#
|
2248
|
+
# @option params [String] :next_token
|
2249
|
+
# The pagination token specifying which page of results to return in the
|
2250
|
+
# response. If no token is provided, the default page is the first page.
|
2251
|
+
#
|
2252
|
+
# Default value: `null`
|
2253
|
+
#
|
2254
|
+
# @option params [required, String] :tracker_name
|
2255
|
+
# The tracker resource containing the requested devices.
|
2256
|
+
#
|
2257
|
+
# @return [Types::ListDevicePositionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2258
|
+
#
|
2259
|
+
# * {Types::ListDevicePositionsResponse#entries #data.entries} => Array<Types::ListDevicePositionsResponseEntry> (This method conflicts with a method on Response, call it through the data member)
|
2260
|
+
# * {Types::ListDevicePositionsResponse#next_token #next_token} => String
|
2261
|
+
#
|
2262
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2263
|
+
#
|
2264
|
+
# @example Request syntax with placeholder values
|
2265
|
+
#
|
2266
|
+
# resp = client.list_device_positions({
|
2267
|
+
# max_results: 1,
|
2268
|
+
# next_token: "Token",
|
2269
|
+
# tracker_name: "ResourceName", # required
|
2270
|
+
# })
|
2271
|
+
#
|
2272
|
+
# @example Response structure
|
2273
|
+
#
|
2274
|
+
# resp.data.entries #=> Array
|
2275
|
+
# resp.data.entries[0].device_id #=> String
|
2276
|
+
# resp.data.entries[0].position #=> Array
|
2277
|
+
# resp.data.entries[0].position[0] #=> Float
|
2278
|
+
# resp.data.entries[0].sample_time #=> Time
|
2279
|
+
# resp.next_token #=> String
|
2280
|
+
#
|
2281
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListDevicePositions AWS API Documentation
|
2282
|
+
#
|
2283
|
+
# @overload list_device_positions(params = {})
|
2284
|
+
# @param [Hash] params ({})
|
2285
|
+
def list_device_positions(params = {}, options = {})
|
2286
|
+
req = build_request(:list_device_positions, params)
|
2287
|
+
req.send_request(options)
|
2288
|
+
end
|
2289
|
+
|
1558
2290
|
# Lists geofence collections in your AWS account.
|
1559
2291
|
#
|
1560
2292
|
# @option params [Integer] :max_results
|
@@ -1571,7 +2303,7 @@ module Aws::LocationService
|
|
1571
2303
|
#
|
1572
2304
|
# @return [Types::ListGeofenceCollectionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1573
2305
|
#
|
1574
|
-
# * {Types::ListGeofenceCollectionsResponse#entries #entries} => Array<Types::ListGeofenceCollectionsResponseEntry>
|
2306
|
+
# * {Types::ListGeofenceCollectionsResponse#entries #data.entries} => Array<Types::ListGeofenceCollectionsResponseEntry> (This method conflicts with a method on Response, call it through the data member)
|
1575
2307
|
# * {Types::ListGeofenceCollectionsResponse#next_token #next_token} => String
|
1576
2308
|
#
|
1577
2309
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
@@ -1585,11 +2317,13 @@ module Aws::LocationService
|
|
1585
2317
|
#
|
1586
2318
|
# @example Response structure
|
1587
2319
|
#
|
1588
|
-
# resp.entries #=> Array
|
1589
|
-
# resp.entries[0].collection_name #=> String
|
1590
|
-
# resp.entries[0].create_time #=> Time
|
1591
|
-
# resp.entries[0].description #=> String
|
1592
|
-
# resp.entries[0].
|
2320
|
+
# resp.data.entries #=> Array
|
2321
|
+
# resp.data.entries[0].collection_name #=> String
|
2322
|
+
# resp.data.entries[0].create_time #=> Time
|
2323
|
+
# resp.data.entries[0].description #=> String
|
2324
|
+
# resp.data.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
2325
|
+
# resp.data.entries[0].pricing_plan_data_source #=> String
|
2326
|
+
# resp.data.entries[0].update_time #=> Time
|
1593
2327
|
# resp.next_token #=> String
|
1594
2328
|
#
|
1595
2329
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListGeofenceCollections AWS API Documentation
|
@@ -1614,7 +2348,7 @@ module Aws::LocationService
|
|
1614
2348
|
#
|
1615
2349
|
# @return [Types::ListGeofencesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1616
2350
|
#
|
1617
|
-
# * {Types::ListGeofencesResponse#entries #entries} => Array<Types::ListGeofenceResponseEntry>
|
2351
|
+
# * {Types::ListGeofencesResponse#entries #data.entries} => Array<Types::ListGeofenceResponseEntry> (This method conflicts with a method on Response, call it through the data member)
|
1618
2352
|
# * {Types::ListGeofencesResponse#next_token #next_token} => String
|
1619
2353
|
#
|
1620
2354
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
@@ -1628,15 +2362,15 @@ module Aws::LocationService
|
|
1628
2362
|
#
|
1629
2363
|
# @example Response structure
|
1630
2364
|
#
|
1631
|
-
# resp.entries #=> Array
|
1632
|
-
# resp.entries[0].create_time #=> Time
|
1633
|
-
# resp.entries[0].geofence_id #=> String
|
1634
|
-
# resp.entries[0].geometry.polygon #=> Array
|
1635
|
-
# resp.entries[0].geometry.polygon[0] #=> Array
|
1636
|
-
# resp.entries[0].geometry.polygon[0][0] #=> Array
|
1637
|
-
# resp.entries[0].geometry.polygon[0][0][0] #=> Float
|
1638
|
-
# resp.entries[0].status #=> String
|
1639
|
-
# resp.entries[0].update_time #=> Time
|
2365
|
+
# resp.data.entries #=> Array
|
2366
|
+
# resp.data.entries[0].create_time #=> Time
|
2367
|
+
# resp.data.entries[0].geofence_id #=> String
|
2368
|
+
# resp.data.entries[0].geometry.polygon #=> Array
|
2369
|
+
# resp.data.entries[0].geometry.polygon[0] #=> Array
|
2370
|
+
# resp.data.entries[0].geometry.polygon[0][0] #=> Array
|
2371
|
+
# resp.data.entries[0].geometry.polygon[0][0][0] #=> Float
|
2372
|
+
# resp.data.entries[0].status #=> String
|
2373
|
+
# resp.data.entries[0].update_time #=> Time
|
1640
2374
|
# resp.next_token #=> String
|
1641
2375
|
#
|
1642
2376
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListGeofences AWS API Documentation
|
@@ -1664,7 +2398,7 @@ module Aws::LocationService
|
|
1664
2398
|
#
|
1665
2399
|
# @return [Types::ListMapsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1666
2400
|
#
|
1667
|
-
# * {Types::ListMapsResponse#entries #entries} => Array<Types::ListMapsResponseEntry>
|
2401
|
+
# * {Types::ListMapsResponse#entries #data.entries} => Array<Types::ListMapsResponseEntry> (This method conflicts with a method on Response, call it through the data member)
|
1668
2402
|
# * {Types::ListMapsResponse#next_token #next_token} => String
|
1669
2403
|
#
|
1670
2404
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
@@ -1678,12 +2412,13 @@ module Aws::LocationService
|
|
1678
2412
|
#
|
1679
2413
|
# @example Response structure
|
1680
2414
|
#
|
1681
|
-
# resp.entries #=> Array
|
1682
|
-
# resp.entries[0].create_time #=> Time
|
1683
|
-
# resp.entries[0].data_source #=> String
|
1684
|
-
# resp.entries[0].description #=> String
|
1685
|
-
# resp.entries[0].map_name #=> String
|
1686
|
-
# resp.entries[0].
|
2415
|
+
# resp.data.entries #=> Array
|
2416
|
+
# resp.data.entries[0].create_time #=> Time
|
2417
|
+
# resp.data.entries[0].data_source #=> String
|
2418
|
+
# resp.data.entries[0].description #=> String
|
2419
|
+
# resp.data.entries[0].map_name #=> String
|
2420
|
+
# resp.data.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
2421
|
+
# resp.data.entries[0].update_time #=> Time
|
1687
2422
|
# resp.next_token #=> String
|
1688
2423
|
#
|
1689
2424
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListMaps AWS API Documentation
|
@@ -1695,7 +2430,7 @@ module Aws::LocationService
|
|
1695
2430
|
req.send_request(options)
|
1696
2431
|
end
|
1697
2432
|
|
1698
|
-
# Lists
|
2433
|
+
# Lists place index resources in your AWS account.
|
1699
2434
|
#
|
1700
2435
|
# @option params [Integer] :max_results
|
1701
2436
|
# An optional limit for the maximum number of results returned in a
|
@@ -1711,7 +2446,7 @@ module Aws::LocationService
|
|
1711
2446
|
#
|
1712
2447
|
# @return [Types::ListPlaceIndexesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1713
2448
|
#
|
1714
|
-
# * {Types::ListPlaceIndexesResponse#entries #entries} => Array<Types::ListPlaceIndexesResponseEntry>
|
2449
|
+
# * {Types::ListPlaceIndexesResponse#entries #data.entries} => Array<Types::ListPlaceIndexesResponseEntry> (This method conflicts with a method on Response, call it through the data member)
|
1715
2450
|
# * {Types::ListPlaceIndexesResponse#next_token #next_token} => String
|
1716
2451
|
#
|
1717
2452
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
@@ -1725,12 +2460,13 @@ module Aws::LocationService
|
|
1725
2460
|
#
|
1726
2461
|
# @example Response structure
|
1727
2462
|
#
|
1728
|
-
# resp.entries #=> Array
|
1729
|
-
# resp.entries[0].create_time #=> Time
|
1730
|
-
# resp.entries[0].data_source #=> String
|
1731
|
-
# resp.entries[0].description #=> String
|
1732
|
-
# resp.entries[0].index_name #=> String
|
1733
|
-
# resp.entries[0].
|
2463
|
+
# resp.data.entries #=> Array
|
2464
|
+
# resp.data.entries[0].create_time #=> Time
|
2465
|
+
# resp.data.entries[0].data_source #=> String
|
2466
|
+
# resp.data.entries[0].description #=> String
|
2467
|
+
# resp.data.entries[0].index_name #=> String
|
2468
|
+
# resp.data.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
2469
|
+
# resp.data.entries[0].update_time #=> Time
|
1734
2470
|
# resp.next_token #=> String
|
1735
2471
|
#
|
1736
2472
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListPlaceIndexes AWS API Documentation
|
@@ -1742,6 +2478,89 @@ module Aws::LocationService
|
|
1742
2478
|
req.send_request(options)
|
1743
2479
|
end
|
1744
2480
|
|
2481
|
+
# Lists route calculator resources in your AWS account.
|
2482
|
+
#
|
2483
|
+
# @option params [Integer] :max_results
|
2484
|
+
# An optional maximum number of results returned in a single call.
|
2485
|
+
#
|
2486
|
+
# Default Value: `100`
|
2487
|
+
#
|
2488
|
+
# @option params [String] :next_token
|
2489
|
+
# The pagination token specifying which page of results to return in the
|
2490
|
+
# response. If no token is provided, the default page is the first page.
|
2491
|
+
#
|
2492
|
+
# Default Value: `null`
|
2493
|
+
#
|
2494
|
+
# @return [Types::ListRouteCalculatorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2495
|
+
#
|
2496
|
+
# * {Types::ListRouteCalculatorsResponse#entries #data.entries} => Array<Types::ListRouteCalculatorsResponseEntry> (This method conflicts with a method on Response, call it through the data member)
|
2497
|
+
# * {Types::ListRouteCalculatorsResponse#next_token #next_token} => String
|
2498
|
+
#
|
2499
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2500
|
+
#
|
2501
|
+
# @example Request syntax with placeholder values
|
2502
|
+
#
|
2503
|
+
# resp = client.list_route_calculators({
|
2504
|
+
# max_results: 1,
|
2505
|
+
# next_token: "Token",
|
2506
|
+
# })
|
2507
|
+
#
|
2508
|
+
# @example Response structure
|
2509
|
+
#
|
2510
|
+
# resp.data.entries #=> Array
|
2511
|
+
# resp.data.entries[0].calculator_name #=> String
|
2512
|
+
# resp.data.entries[0].create_time #=> Time
|
2513
|
+
# resp.data.entries[0].data_source #=> String
|
2514
|
+
# resp.data.entries[0].description #=> String
|
2515
|
+
# resp.data.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
2516
|
+
# resp.data.entries[0].update_time #=> Time
|
2517
|
+
# resp.next_token #=> String
|
2518
|
+
#
|
2519
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListRouteCalculators AWS API Documentation
|
2520
|
+
#
|
2521
|
+
# @overload list_route_calculators(params = {})
|
2522
|
+
# @param [Hash] params ({})
|
2523
|
+
def list_route_calculators(params = {}, options = {})
|
2524
|
+
req = build_request(:list_route_calculators, params)
|
2525
|
+
req.send_request(options)
|
2526
|
+
end
|
2527
|
+
|
2528
|
+
# Returns a list of tags that are applied to the specified Amazon
|
2529
|
+
# Location resource.
|
2530
|
+
#
|
2531
|
+
# @option params [required, String] :resource_arn
|
2532
|
+
# The Amazon Resource Name (ARN) of the resource whose tags you want to
|
2533
|
+
# retrieve.
|
2534
|
+
#
|
2535
|
+
# * Format example:
|
2536
|
+
# `arn:aws:geo:region:account-id:resourcetype/ExampleResource`
|
2537
|
+
#
|
2538
|
+
# ^
|
2539
|
+
#
|
2540
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2541
|
+
#
|
2542
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Hash<String,String>
|
2543
|
+
#
|
2544
|
+
# @example Request syntax with placeholder values
|
2545
|
+
#
|
2546
|
+
# resp = client.list_tags_for_resource({
|
2547
|
+
# resource_arn: "Arn", # required
|
2548
|
+
# })
|
2549
|
+
#
|
2550
|
+
# @example Response structure
|
2551
|
+
#
|
2552
|
+
# resp.tags #=> Hash
|
2553
|
+
# resp.tags["TagKey"] #=> String
|
2554
|
+
#
|
2555
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListTagsForResource AWS API Documentation
|
2556
|
+
#
|
2557
|
+
# @overload list_tags_for_resource(params = {})
|
2558
|
+
# @param [Hash] params ({})
|
2559
|
+
def list_tags_for_resource(params = {}, options = {})
|
2560
|
+
req = build_request(:list_tags_for_resource, params)
|
2561
|
+
req.send_request(options)
|
2562
|
+
end
|
2563
|
+
|
1745
2564
|
# Lists geofence collections currently associated to the given tracker
|
1746
2565
|
# resource.
|
1747
2566
|
#
|
@@ -1807,7 +2626,7 @@ module Aws::LocationService
|
|
1807
2626
|
#
|
1808
2627
|
# @return [Types::ListTrackersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1809
2628
|
#
|
1810
|
-
# * {Types::ListTrackersResponse#entries #entries} => Array<Types::ListTrackersResponseEntry>
|
2629
|
+
# * {Types::ListTrackersResponse#entries #data.entries} => Array<Types::ListTrackersResponseEntry> (This method conflicts with a method on Response, call it through the data member)
|
1811
2630
|
# * {Types::ListTrackersResponse#next_token #next_token} => String
|
1812
2631
|
#
|
1813
2632
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
@@ -1821,11 +2640,13 @@ module Aws::LocationService
|
|
1821
2640
|
#
|
1822
2641
|
# @example Response structure
|
1823
2642
|
#
|
1824
|
-
# resp.entries #=> Array
|
1825
|
-
# resp.entries[0].create_time #=> Time
|
1826
|
-
# resp.entries[0].description #=> String
|
1827
|
-
# resp.entries[0].
|
1828
|
-
# resp.entries[0].
|
2643
|
+
# resp.data.entries #=> Array
|
2644
|
+
# resp.data.entries[0].create_time #=> Time
|
2645
|
+
# resp.data.entries[0].description #=> String
|
2646
|
+
# resp.data.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
2647
|
+
# resp.data.entries[0].pricing_plan_data_source #=> String
|
2648
|
+
# resp.data.entries[0].tracker_name #=> String
|
2649
|
+
# resp.data.entries[0].update_time #=> Time
|
1829
2650
|
# resp.next_token #=> String
|
1830
2651
|
#
|
1831
2652
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListTrackers AWS API Documentation
|
@@ -1837,9 +2658,9 @@ module Aws::LocationService
|
|
1837
2658
|
req.send_request(options)
|
1838
2659
|
end
|
1839
2660
|
|
1840
|
-
# Stores a geofence
|
1841
|
-
# geometry of an existing geofence if a geofence ID is included in
|
1842
|
-
# request.
|
2661
|
+
# Stores a geofence geometry in a given geofence collection, or updates
|
2662
|
+
# the geometry of an existing geofence if a geofence ID is included in
|
2663
|
+
# the request.
|
1843
2664
|
#
|
1844
2665
|
# @option params [required, String] :collection_name
|
1845
2666
|
# The geofence collection to store the geofence in.
|
@@ -1850,6 +2671,14 @@ module Aws::LocationService
|
|
1850
2671
|
# @option params [required, Types::GeofenceGeometry] :geometry
|
1851
2672
|
# Contains the polygon details to specify the position of the geofence.
|
1852
2673
|
#
|
2674
|
+
# <note markdown="1"> Each [geofence polygon][1] can have a maximum of 1,000 vertices.
|
2675
|
+
#
|
2676
|
+
# </note>
|
2677
|
+
#
|
2678
|
+
#
|
2679
|
+
#
|
2680
|
+
# [1]: https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html
|
2681
|
+
#
|
1853
2682
|
# @return [Types::PutGeofenceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1854
2683
|
#
|
1855
2684
|
# * {Types::PutGeofenceResponse#create_time #create_time} => Time
|
@@ -1889,22 +2718,8 @@ module Aws::LocationService
|
|
1889
2718
|
# Allows you to search for Places or points of interest near a given
|
1890
2719
|
# position.
|
1891
2720
|
#
|
1892
|
-
# <note markdown="1"> By using Places, you agree that AWS may transmit your API queries to
|
1893
|
-
# your selected third party provider for processing, which may be
|
1894
|
-
# outside the AWS region you are currently using.
|
1895
|
-
#
|
1896
|
-
# Because of licensing limitations, you may not use HERE to store
|
1897
|
-
# results for locations in Japan. For more information, see the [AWS
|
1898
|
-
# Service Terms][1] for Amazon Location Service.
|
1899
|
-
#
|
1900
|
-
# </note>
|
1901
|
-
#
|
1902
|
-
#
|
1903
|
-
#
|
1904
|
-
# [1]: https://aws.amazon.com/service-terms/
|
1905
|
-
#
|
1906
2721
|
# @option params [required, String] :index_name
|
1907
|
-
# The name of the
|
2722
|
+
# The name of the place index resource you want to use for the search.
|
1908
2723
|
#
|
1909
2724
|
# @option params [Integer] :max_results
|
1910
2725
|
# An optional paramer. The maximum number of results returned per
|
@@ -1975,22 +2790,6 @@ module Aws::LocationService
|
|
1975
2790
|
#
|
1976
2791
|
# </note>
|
1977
2792
|
#
|
1978
|
-
# <note markdown="1"> By using Places, you agree that AWS may transmit your API queries to
|
1979
|
-
# your selected third party provider for processing, which may be
|
1980
|
-
# outside the AWS region you are currently using.
|
1981
|
-
#
|
1982
|
-
# Also, when using HERE as your data provider, you may not (a) use HERE
|
1983
|
-
# Places for Asset Management, or (b) select the `Storage` option for
|
1984
|
-
# the `IntendedUse` parameter when requesting Places in Japan. For more
|
1985
|
-
# information, see the [AWS Service Terms][1] for Amazon Location
|
1986
|
-
# Service.
|
1987
|
-
#
|
1988
|
-
# </note>
|
1989
|
-
#
|
1990
|
-
#
|
1991
|
-
#
|
1992
|
-
# [1]: https://aws.amazon.com/service-terms/
|
1993
|
-
#
|
1994
2793
|
# @option params [Array<Float>] :bias_position
|
1995
2794
|
# Searches for results closest to the given position. An optional
|
1996
2795
|
# parameter defined by longitude, and latitude.
|
@@ -2039,7 +2838,7 @@ module Aws::LocationService
|
|
2039
2838
|
# [1]: https://www.iso.org/iso-3166-country-codes.html
|
2040
2839
|
#
|
2041
2840
|
# @option params [required, String] :index_name
|
2042
|
-
# The name of the
|
2841
|
+
# The name of the place index resource you want to use for the search.
|
2043
2842
|
#
|
2044
2843
|
# @option params [Integer] :max_results
|
2045
2844
|
# An optional parameter. The maximum number of results returned per
|
@@ -2102,6 +2901,372 @@ module Aws::LocationService
|
|
2102
2901
|
req.send_request(options)
|
2103
2902
|
end
|
2104
2903
|
|
2904
|
+
# Assigns one or more tags (key-value pairs) to the specified Amazon
|
2905
|
+
# Location Service resource.
|
2906
|
+
#
|
2907
|
+
# <p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.</p> <p>You can use the <code>TagResource</code> operation with an Amazon Location Service resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the tags already associated with the resource. If you specify a tag key that's already associated with the resource, the new tag value that you specify replaces the previous value for that tag. </p> <p>You can associate up to 50 tags with a resource.</p>
|
2908
|
+
#
|
2909
|
+
# @option params [required, String] :resource_arn
|
2910
|
+
# The Amazon Resource Name (ARN) of the resource whose tags you want to
|
2911
|
+
# update.
|
2912
|
+
#
|
2913
|
+
# * Format example:
|
2914
|
+
# `arn:aws:geo:region:account-id:resourcetype/ExampleResource`
|
2915
|
+
#
|
2916
|
+
# ^
|
2917
|
+
#
|
2918
|
+
# @option params [required, Hash<String,String>] :tags
|
2919
|
+
# Tags that have been applied to the specified resource. Tags are mapped
|
2920
|
+
# from the tag key to the tag value: `"TagKey" : "TagValue"`.
|
2921
|
+
#
|
2922
|
+
# * Format example: `\{"tag1" : "value1", "tag2" : "value2"\} `
|
2923
|
+
#
|
2924
|
+
# ^
|
2925
|
+
#
|
2926
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2927
|
+
#
|
2928
|
+
# @example Request syntax with placeholder values
|
2929
|
+
#
|
2930
|
+
# resp = client.tag_resource({
|
2931
|
+
# resource_arn: "Arn", # required
|
2932
|
+
# tags: { # required
|
2933
|
+
# "TagKey" => "TagValue",
|
2934
|
+
# },
|
2935
|
+
# })
|
2936
|
+
#
|
2937
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/TagResource AWS API Documentation
|
2938
|
+
#
|
2939
|
+
# @overload tag_resource(params = {})
|
2940
|
+
# @param [Hash] params ({})
|
2941
|
+
def tag_resource(params = {}, options = {})
|
2942
|
+
req = build_request(:tag_resource, params)
|
2943
|
+
req.send_request(options)
|
2944
|
+
end
|
2945
|
+
|
2946
|
+
# Removes one or more tags from the specified Amazon Location resource.
|
2947
|
+
#
|
2948
|
+
# @option params [required, String] :resource_arn
|
2949
|
+
# The Amazon Resource Name (ARN) of the resource from which you want to
|
2950
|
+
# remove tags.
|
2951
|
+
#
|
2952
|
+
# * Format example:
|
2953
|
+
# `arn:aws:geo:region:account-id:resourcetype/ExampleResource`
|
2954
|
+
#
|
2955
|
+
# ^
|
2956
|
+
#
|
2957
|
+
# @option params [required, Array<String>] :tag_keys
|
2958
|
+
# The list of tag keys to remove from the specified resource.
|
2959
|
+
#
|
2960
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2961
|
+
#
|
2962
|
+
# @example Request syntax with placeholder values
|
2963
|
+
#
|
2964
|
+
# resp = client.untag_resource({
|
2965
|
+
# resource_arn: "Arn", # required
|
2966
|
+
# tag_keys: ["String"], # required
|
2967
|
+
# })
|
2968
|
+
#
|
2969
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UntagResource AWS API Documentation
|
2970
|
+
#
|
2971
|
+
# @overload untag_resource(params = {})
|
2972
|
+
# @param [Hash] params ({})
|
2973
|
+
def untag_resource(params = {}, options = {})
|
2974
|
+
req = build_request(:untag_resource, params)
|
2975
|
+
req.send_request(options)
|
2976
|
+
end
|
2977
|
+
|
2978
|
+
# Updates the specified properties of a given geofence collection.
|
2979
|
+
#
|
2980
|
+
# @option params [required, String] :collection_name
|
2981
|
+
# The name of the geofence collection to update.
|
2982
|
+
#
|
2983
|
+
# @option params [String] :description
|
2984
|
+
# Updates the description for the geofence collection.
|
2985
|
+
#
|
2986
|
+
# @option params [String] :pricing_plan
|
2987
|
+
# Updates the pricing plan for the geofence collection.
|
2988
|
+
#
|
2989
|
+
# For more information about each pricing plan option restrictions, see
|
2990
|
+
# [Amazon Location Service pricing][1].
|
2991
|
+
#
|
2992
|
+
#
|
2993
|
+
#
|
2994
|
+
# [1]: https://aws.amazon.com/location/pricing/
|
2995
|
+
#
|
2996
|
+
# @option params [String] :pricing_plan_data_source
|
2997
|
+
# Updates the data provider for the geofence collection.
|
2998
|
+
#
|
2999
|
+
# A required value for the following pricing plans:
|
3000
|
+
# `MobileAssetTracking`\| `MobileAssetManagement`
|
3001
|
+
#
|
3002
|
+
# For more information about [data providers][1] and [pricing plans][2],
|
3003
|
+
# see the Amazon Location Service product page.
|
3004
|
+
#
|
3005
|
+
# <note markdown="1"> This can only be updated when updating the `PricingPlan` in the same
|
3006
|
+
# request.
|
3007
|
+
#
|
3008
|
+
# Amazon Location Service uses `PricingPlanDataSource` to calculate
|
3009
|
+
# billing for your geofence collection. Your data won't be shared with
|
3010
|
+
# the data provider, and will remain in your AWS account and Region
|
3011
|
+
# unless you move it.
|
3012
|
+
#
|
3013
|
+
# </note>
|
3014
|
+
#
|
3015
|
+
#
|
3016
|
+
#
|
3017
|
+
# [1]: https://aws.amazon.com/location/data-providers/
|
3018
|
+
# [2]: https://aws.amazon.com/location/pricing/
|
3019
|
+
#
|
3020
|
+
# @return [Types::UpdateGeofenceCollectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3021
|
+
#
|
3022
|
+
# * {Types::UpdateGeofenceCollectionResponse#collection_arn #collection_arn} => String
|
3023
|
+
# * {Types::UpdateGeofenceCollectionResponse#collection_name #collection_name} => String
|
3024
|
+
# * {Types::UpdateGeofenceCollectionResponse#update_time #update_time} => Time
|
3025
|
+
#
|
3026
|
+
# @example Request syntax with placeholder values
|
3027
|
+
#
|
3028
|
+
# resp = client.update_geofence_collection({
|
3029
|
+
# collection_name: "ResourceName", # required
|
3030
|
+
# description: "ResourceDescription",
|
3031
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
3032
|
+
# pricing_plan_data_source: "String",
|
3033
|
+
# })
|
3034
|
+
#
|
3035
|
+
# @example Response structure
|
3036
|
+
#
|
3037
|
+
# resp.collection_arn #=> String
|
3038
|
+
# resp.collection_name #=> String
|
3039
|
+
# resp.update_time #=> Time
|
3040
|
+
#
|
3041
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateGeofenceCollection AWS API Documentation
|
3042
|
+
#
|
3043
|
+
# @overload update_geofence_collection(params = {})
|
3044
|
+
# @param [Hash] params ({})
|
3045
|
+
def update_geofence_collection(params = {}, options = {})
|
3046
|
+
req = build_request(:update_geofence_collection, params)
|
3047
|
+
req.send_request(options)
|
3048
|
+
end
|
3049
|
+
|
3050
|
+
# Updates the specified properties of a given map resource.
|
3051
|
+
#
|
3052
|
+
# @option params [String] :description
|
3053
|
+
# Updates the description for the map resource.
|
3054
|
+
#
|
3055
|
+
# @option params [required, String] :map_name
|
3056
|
+
# The name of the map resource to update.
|
3057
|
+
#
|
3058
|
+
# @option params [String] :pricing_plan
|
3059
|
+
# Updates the pricing plan for the map resource.
|
3060
|
+
#
|
3061
|
+
# For more information about each pricing plan option restrictions, see
|
3062
|
+
# [Amazon Location Service pricing][1].
|
3063
|
+
#
|
3064
|
+
#
|
3065
|
+
#
|
3066
|
+
# [1]: https://aws.amazon.com/location/pricing/
|
3067
|
+
#
|
3068
|
+
# @return [Types::UpdateMapResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3069
|
+
#
|
3070
|
+
# * {Types::UpdateMapResponse#map_arn #map_arn} => String
|
3071
|
+
# * {Types::UpdateMapResponse#map_name #map_name} => String
|
3072
|
+
# * {Types::UpdateMapResponse#update_time #update_time} => Time
|
3073
|
+
#
|
3074
|
+
# @example Request syntax with placeholder values
|
3075
|
+
#
|
3076
|
+
# resp = client.update_map({
|
3077
|
+
# description: "ResourceDescription",
|
3078
|
+
# map_name: "ResourceName", # required
|
3079
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
3080
|
+
# })
|
3081
|
+
#
|
3082
|
+
# @example Response structure
|
3083
|
+
#
|
3084
|
+
# resp.map_arn #=> String
|
3085
|
+
# resp.map_name #=> String
|
3086
|
+
# resp.update_time #=> Time
|
3087
|
+
#
|
3088
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateMap AWS API Documentation
|
3089
|
+
#
|
3090
|
+
# @overload update_map(params = {})
|
3091
|
+
# @param [Hash] params ({})
|
3092
|
+
def update_map(params = {}, options = {})
|
3093
|
+
req = build_request(:update_map, params)
|
3094
|
+
req.send_request(options)
|
3095
|
+
end
|
3096
|
+
|
3097
|
+
# Updates the specified properties of a given place index resource.
|
3098
|
+
#
|
3099
|
+
# @option params [Types::DataSourceConfiguration] :data_source_configuration
|
3100
|
+
# Updates the data storage option for the place index resource.
|
3101
|
+
#
|
3102
|
+
# @option params [String] :description
|
3103
|
+
# Updates the description for the place index resource.
|
3104
|
+
#
|
3105
|
+
# @option params [required, String] :index_name
|
3106
|
+
# The name of the place index resource to update.
|
3107
|
+
#
|
3108
|
+
# @option params [String] :pricing_plan
|
3109
|
+
# Updates the pricing plan for the place index resource.
|
3110
|
+
#
|
3111
|
+
# For more information about each pricing plan option restrictions, see
|
3112
|
+
# [Amazon Location Service pricing][1].
|
3113
|
+
#
|
3114
|
+
#
|
3115
|
+
#
|
3116
|
+
# [1]: https://aws.amazon.com/location/pricing/
|
3117
|
+
#
|
3118
|
+
# @return [Types::UpdatePlaceIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3119
|
+
#
|
3120
|
+
# * {Types::UpdatePlaceIndexResponse#index_arn #index_arn} => String
|
3121
|
+
# * {Types::UpdatePlaceIndexResponse#index_name #index_name} => String
|
3122
|
+
# * {Types::UpdatePlaceIndexResponse#update_time #update_time} => Time
|
3123
|
+
#
|
3124
|
+
# @example Request syntax with placeholder values
|
3125
|
+
#
|
3126
|
+
# resp = client.update_place_index({
|
3127
|
+
# data_source_configuration: {
|
3128
|
+
# intended_use: "SingleUse", # accepts SingleUse, Storage
|
3129
|
+
# },
|
3130
|
+
# description: "ResourceDescription",
|
3131
|
+
# index_name: "ResourceName", # required
|
3132
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
3133
|
+
# })
|
3134
|
+
#
|
3135
|
+
# @example Response structure
|
3136
|
+
#
|
3137
|
+
# resp.index_arn #=> String
|
3138
|
+
# resp.index_name #=> String
|
3139
|
+
# resp.update_time #=> Time
|
3140
|
+
#
|
3141
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdatePlaceIndex AWS API Documentation
|
3142
|
+
#
|
3143
|
+
# @overload update_place_index(params = {})
|
3144
|
+
# @param [Hash] params ({})
|
3145
|
+
def update_place_index(params = {}, options = {})
|
3146
|
+
req = build_request(:update_place_index, params)
|
3147
|
+
req.send_request(options)
|
3148
|
+
end
|
3149
|
+
|
3150
|
+
# Updates the specified properties for a given route calculator
|
3151
|
+
# resource.
|
3152
|
+
#
|
3153
|
+
# @option params [required, String] :calculator_name
|
3154
|
+
# The name of the route calculator resource to update.
|
3155
|
+
#
|
3156
|
+
# @option params [String] :description
|
3157
|
+
# Updates the description for the route calculator resource.
|
3158
|
+
#
|
3159
|
+
# @option params [String] :pricing_plan
|
3160
|
+
# Updates the pricing plan for the route calculator resource.
|
3161
|
+
#
|
3162
|
+
# For more information about each pricing plan option restrictions, see
|
3163
|
+
# [Amazon Location Service pricing][1].
|
3164
|
+
#
|
3165
|
+
#
|
3166
|
+
#
|
3167
|
+
# [1]: https://aws.amazon.com/location/pricing/
|
3168
|
+
#
|
3169
|
+
# @return [Types::UpdateRouteCalculatorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3170
|
+
#
|
3171
|
+
# * {Types::UpdateRouteCalculatorResponse#calculator_arn #calculator_arn} => String
|
3172
|
+
# * {Types::UpdateRouteCalculatorResponse#calculator_name #calculator_name} => String
|
3173
|
+
# * {Types::UpdateRouteCalculatorResponse#update_time #update_time} => Time
|
3174
|
+
#
|
3175
|
+
# @example Request syntax with placeholder values
|
3176
|
+
#
|
3177
|
+
# resp = client.update_route_calculator({
|
3178
|
+
# calculator_name: "ResourceName", # required
|
3179
|
+
# description: "ResourceDescription",
|
3180
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
3181
|
+
# })
|
3182
|
+
#
|
3183
|
+
# @example Response structure
|
3184
|
+
#
|
3185
|
+
# resp.calculator_arn #=> String
|
3186
|
+
# resp.calculator_name #=> String
|
3187
|
+
# resp.update_time #=> Time
|
3188
|
+
#
|
3189
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateRouteCalculator AWS API Documentation
|
3190
|
+
#
|
3191
|
+
# @overload update_route_calculator(params = {})
|
3192
|
+
# @param [Hash] params ({})
|
3193
|
+
def update_route_calculator(params = {}, options = {})
|
3194
|
+
req = build_request(:update_route_calculator, params)
|
3195
|
+
req.send_request(options)
|
3196
|
+
end
|
3197
|
+
|
3198
|
+
# Updates the specified properties of a given tracker resource.
|
3199
|
+
#
|
3200
|
+
# @option params [String] :description
|
3201
|
+
# Updates the description for the tracker resource.
|
3202
|
+
#
|
3203
|
+
# @option params [String] :pricing_plan
|
3204
|
+
# Updates the pricing plan for the tracker resource.
|
3205
|
+
#
|
3206
|
+
# For more information about each pricing plan option restrictions, see
|
3207
|
+
# [Amazon Location Service pricing][1].
|
3208
|
+
#
|
3209
|
+
#
|
3210
|
+
#
|
3211
|
+
# [1]: https://aws.amazon.com/location/pricing/
|
3212
|
+
#
|
3213
|
+
# @option params [String] :pricing_plan_data_source
|
3214
|
+
# Updates the data provider for the tracker resource.
|
3215
|
+
#
|
3216
|
+
# A required value for the following pricing plans:
|
3217
|
+
# `MobileAssetTracking`\| `MobileAssetManagement`
|
3218
|
+
#
|
3219
|
+
# For more information about [data providers][1] and [pricing plans][2],
|
3220
|
+
# see the Amazon Location Service product page
|
3221
|
+
#
|
3222
|
+
# <note markdown="1"> This can only be updated when updating the `PricingPlan` in the same
|
3223
|
+
# request.
|
3224
|
+
#
|
3225
|
+
# Amazon Location Service uses `PricingPlanDataSource` to calculate
|
3226
|
+
# billing for your tracker resource. Your data won't be shared with the
|
3227
|
+
# data provider, and will remain in your AWS account and Region unless
|
3228
|
+
# you move it.
|
3229
|
+
#
|
3230
|
+
# </note>
|
3231
|
+
#
|
3232
|
+
#
|
3233
|
+
#
|
3234
|
+
# [1]: https://aws.amazon.com/location/data-providers/
|
3235
|
+
# [2]: https://aws.amazon.com/location/pricing/
|
3236
|
+
#
|
3237
|
+
# @option params [required, String] :tracker_name
|
3238
|
+
# The name of the tracker resource to update.
|
3239
|
+
#
|
3240
|
+
# @return [Types::UpdateTrackerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3241
|
+
#
|
3242
|
+
# * {Types::UpdateTrackerResponse#tracker_arn #tracker_arn} => String
|
3243
|
+
# * {Types::UpdateTrackerResponse#tracker_name #tracker_name} => String
|
3244
|
+
# * {Types::UpdateTrackerResponse#update_time #update_time} => Time
|
3245
|
+
#
|
3246
|
+
# @example Request syntax with placeholder values
|
3247
|
+
#
|
3248
|
+
# resp = client.update_tracker({
|
3249
|
+
# description: "ResourceDescription",
|
3250
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
3251
|
+
# pricing_plan_data_source: "String",
|
3252
|
+
# tracker_name: "ResourceName", # required
|
3253
|
+
# })
|
3254
|
+
#
|
3255
|
+
# @example Response structure
|
3256
|
+
#
|
3257
|
+
# resp.tracker_arn #=> String
|
3258
|
+
# resp.tracker_name #=> String
|
3259
|
+
# resp.update_time #=> Time
|
3260
|
+
#
|
3261
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateTracker AWS API Documentation
|
3262
|
+
#
|
3263
|
+
# @overload update_tracker(params = {})
|
3264
|
+
# @param [Hash] params ({})
|
3265
|
+
def update_tracker(params = {}, options = {})
|
3266
|
+
req = build_request(:update_tracker, params)
|
3267
|
+
req.send_request(options)
|
3268
|
+
end
|
3269
|
+
|
2105
3270
|
# @!endgroup
|
2106
3271
|
|
2107
3272
|
# @param params ({})
|
@@ -2115,7 +3280,7 @@ module Aws::LocationService
|
|
2115
3280
|
params: params,
|
2116
3281
|
config: config)
|
2117
3282
|
context[:gem_name] = 'aws-sdk-locationservice'
|
2118
|
-
context[:gem_version] = '1.
|
3283
|
+
context[:gem_version] = '1.5.0'
|
2119
3284
|
Seahorse::Client::Request.new(handlers, context)
|
2120
3285
|
end
|
2121
3286
|
|