aws-sdk-locationservice 1.22.0 → 1.24.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-locationservice/client.rb +120 -6
- data/lib/aws-sdk-locationservice/client_api.rb +42 -3
- data/lib/aws-sdk-locationservice/types.rb +219 -17
- data/lib/aws-sdk-locationservice.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e0f85bf02c0d6d0d6493c104f83eb10459d5492c572cd859ab28f831fd60b1fe
|
4
|
+
data.tar.gz: 2406f353903c1a1de829240a93622205796d7543c1dec87381ce70ef2c02ff39
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ceb7c58310dff12b43a28a9320c9009cfa578a4e483d39fd7fa0aae1369dc5fb9b7d8ebc6eb2d54e4fbde28f390b04f9b70907b0b8be3b9055fe065f1e05fda0
|
7
|
+
data.tar.gz: 4b5ec4e884a42cc784fe34a2f9e0936e9b829f80ab88d1535b9a7889c9bcb5ec8a160f6bd36264a7b1d470d9ca5bf73d80a0df5841400c8458eb1bc080f95b5b
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.24.0 (2022-09-27)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release adds place IDs, which are unique identifiers of places, along with a new GetPlace operation, which can be used with place IDs to find a place again later. UnitNumber and UnitType are also added as new properties of places.
|
8
|
+
|
9
|
+
1.23.0 (2022-08-09)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Amazon Location Service now allows circular geofences in BatchPutGeofence, PutGeofence, and GetGeofence APIs.
|
13
|
+
|
4
14
|
1.22.0 (2022-05-06)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.24.0
|
@@ -626,6 +626,10 @@ module Aws::LocationService
|
|
626
626
|
# {
|
627
627
|
# geofence_id: "Id", # required
|
628
628
|
# geometry: { # required
|
629
|
+
# circle: {
|
630
|
+
# center: [1.0], # required
|
631
|
+
# radius: 1.0, # required
|
632
|
+
# },
|
629
633
|
# polygon: [
|
630
634
|
# [
|
631
635
|
# [1.0],
|
@@ -755,6 +759,11 @@ module Aws::LocationService
|
|
755
759
|
# specify additional route preferences in `CarModeOptions` if
|
756
760
|
# traveling by `Car`, or `TruckModeOptions` if traveling by `Truck`.
|
757
761
|
#
|
762
|
+
# <note markdown="1"> If you specify `walking` for the travel mode and your data provider
|
763
|
+
# is Esri, the start and destination must be within 40km.
|
764
|
+
#
|
765
|
+
# </note>
|
766
|
+
#
|
758
767
|
#
|
759
768
|
#
|
760
769
|
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html
|
@@ -857,7 +866,8 @@ module Aws::LocationService
|
|
857
866
|
#
|
858
867
|
# @option params [String] :travel_mode
|
859
868
|
# Specifies the mode of transport when calculating a route. Used in
|
860
|
-
# estimating the speed of travel and road compatibility.
|
869
|
+
# estimating the speed of travel and road compatibility. You can choose
|
870
|
+
# `Car`, `Truck`, or `Walking` as options for the `TravelMode`.
|
861
871
|
#
|
862
872
|
# The `TravelMode` you specify also determines how you specify route
|
863
873
|
# preferences:
|
@@ -2347,6 +2357,9 @@ module Aws::LocationService
|
|
2347
2357
|
#
|
2348
2358
|
# resp.create_time #=> Time
|
2349
2359
|
# resp.geofence_id #=> String
|
2360
|
+
# resp.geometry.circle.center #=> Array
|
2361
|
+
# resp.geometry.circle.center[0] #=> Float
|
2362
|
+
# resp.geometry.circle.radius #=> Float
|
2350
2363
|
# resp.geometry.polygon #=> Array
|
2351
2364
|
# resp.geometry.polygon[0] #=> Array
|
2352
2365
|
# resp.geometry.polygon[0][0] #=> Array
|
@@ -2389,7 +2402,7 @@ module Aws::LocationService
|
|
2389
2402
|
#
|
2390
2403
|
# Valid font stacks for [HERE Technologies][2] styles:
|
2391
2404
|
#
|
2392
|
-
# *
|
2405
|
+
# * VectorHereContrast – `Fira GO Regular` \| `Fira GO Bold`
|
2393
2406
|
#
|
2394
2407
|
# * VectorHereExplore, VectorHereExploreTruck – `Firo GO Italic` \|
|
2395
2408
|
# `Fira GO Map` \| `Fira GO Map Bold` \| `Noto Sans CJK JP Bold` \|
|
@@ -2448,7 +2461,7 @@ module Aws::LocationService
|
|
2448
2461
|
#
|
2449
2462
|
# * `sprites@2x.png` for high pixel density displays
|
2450
2463
|
#
|
2451
|
-
# For the JSON document
|
2464
|
+
# For the JSON document containing image offsets. Use the following file
|
2452
2465
|
# names:
|
2453
2466
|
#
|
2454
2467
|
# * `sprites.json`
|
@@ -2568,6 +2581,91 @@ module Aws::LocationService
|
|
2568
2581
|
req.send_request(options, &block)
|
2569
2582
|
end
|
2570
2583
|
|
2584
|
+
# Finds a place by its unique ID. A `PlaceId` is returned by other
|
2585
|
+
# search operations.
|
2586
|
+
#
|
2587
|
+
# <note markdown="1"> A PlaceId is valid only if all of the following are the same in the
|
2588
|
+
# original search request and the call to `GetPlace`.
|
2589
|
+
#
|
2590
|
+
# * Customer AWS account
|
2591
|
+
#
|
2592
|
+
# * AWS Region
|
2593
|
+
#
|
2594
|
+
# * Data provider specified in the place index resource
|
2595
|
+
#
|
2596
|
+
# </note>
|
2597
|
+
#
|
2598
|
+
# @option params [required, String] :index_name
|
2599
|
+
# The name of the place index resource that you want to use for the
|
2600
|
+
# search.
|
2601
|
+
#
|
2602
|
+
# @option params [String] :language
|
2603
|
+
# The preferred language used to return results. The value must be a
|
2604
|
+
# valid [BCP 47][1] language tag, for example, `en` for English.
|
2605
|
+
#
|
2606
|
+
# This setting affects the languages used in the results, but not the
|
2607
|
+
# results themselves. If no language is specified, or not supported for
|
2608
|
+
# a particular result, the partner automatically chooses a language for
|
2609
|
+
# the result.
|
2610
|
+
#
|
2611
|
+
# For an example, we'll use the Greek language. You search for a
|
2612
|
+
# location around Athens, Greece, with the `language` parameter set to
|
2613
|
+
# `en`. The `city` in the results will most likely be returned as
|
2614
|
+
# `Athens`.
|
2615
|
+
#
|
2616
|
+
# If you set the `language` parameter to `el`, for Greek, then the
|
2617
|
+
# `city` in the results will more likely be returned as `Αθήνα`.
|
2618
|
+
#
|
2619
|
+
# If the data provider does not have a value for Greek, the result will
|
2620
|
+
# be in a language that the provider does support.
|
2621
|
+
#
|
2622
|
+
#
|
2623
|
+
#
|
2624
|
+
# [1]: https://tools.ietf.org/search/bcp47
|
2625
|
+
#
|
2626
|
+
# @option params [required, String] :place_id
|
2627
|
+
# The identifier of the place to find.
|
2628
|
+
#
|
2629
|
+
# @return [Types::GetPlaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2630
|
+
#
|
2631
|
+
# * {Types::GetPlaceResponse#place #place} => Types::Place
|
2632
|
+
#
|
2633
|
+
# @example Request syntax with placeholder values
|
2634
|
+
#
|
2635
|
+
# resp = client.get_place({
|
2636
|
+
# index_name: "ResourceName", # required
|
2637
|
+
# language: "LanguageTag",
|
2638
|
+
# place_id: "PlaceId", # required
|
2639
|
+
# })
|
2640
|
+
#
|
2641
|
+
# @example Response structure
|
2642
|
+
#
|
2643
|
+
# resp.place.address_number #=> String
|
2644
|
+
# resp.place.country #=> String
|
2645
|
+
# resp.place.geometry.point #=> Array
|
2646
|
+
# resp.place.geometry.point[0] #=> Float
|
2647
|
+
# resp.place.interpolated #=> Boolean
|
2648
|
+
# resp.place.label #=> String
|
2649
|
+
# resp.place.municipality #=> String
|
2650
|
+
# resp.place.neighborhood #=> String
|
2651
|
+
# resp.place.postal_code #=> String
|
2652
|
+
# resp.place.region #=> String
|
2653
|
+
# resp.place.street #=> String
|
2654
|
+
# resp.place.sub_region #=> String
|
2655
|
+
# resp.place.time_zone.name #=> String
|
2656
|
+
# resp.place.time_zone.offset #=> Integer
|
2657
|
+
# resp.place.unit_number #=> String
|
2658
|
+
# resp.place.unit_type #=> String
|
2659
|
+
#
|
2660
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetPlace AWS API Documentation
|
2661
|
+
#
|
2662
|
+
# @overload get_place(params = {})
|
2663
|
+
# @param [Hash] params ({})
|
2664
|
+
def get_place(params = {}, options = {})
|
2665
|
+
req = build_request(:get_place, params)
|
2666
|
+
req.send_request(options)
|
2667
|
+
end
|
2668
|
+
|
2571
2669
|
# A batch request to retrieve all device positions.
|
2572
2670
|
#
|
2573
2671
|
# @option params [Integer] :max_results
|
@@ -2705,6 +2803,9 @@ module Aws::LocationService
|
|
2705
2803
|
# resp.data.entries #=> Array
|
2706
2804
|
# resp.data.entries[0].create_time #=> Time
|
2707
2805
|
# resp.data.entries[0].geofence_id #=> String
|
2806
|
+
# resp.data.entries[0].geometry.circle.center #=> Array
|
2807
|
+
# resp.data.entries[0].geometry.circle.center[0] #=> Float
|
2808
|
+
# resp.data.entries[0].geometry.circle.radius #=> Float
|
2708
2809
|
# resp.data.entries[0].geometry.polygon #=> Array
|
2709
2810
|
# resp.data.entries[0].geometry.polygon[0] #=> Array
|
2710
2811
|
# resp.data.entries[0].geometry.polygon[0][0] #=> Array
|
@@ -3009,9 +3110,11 @@ module Aws::LocationService
|
|
3009
3110
|
# An identifier for the geofence. For example, `ExampleGeofence-1`.
|
3010
3111
|
#
|
3011
3112
|
# @option params [required, Types::GeofenceGeometry] :geometry
|
3012
|
-
# Contains the
|
3113
|
+
# Contains the details to specify the position of the geofence. Can be
|
3114
|
+
# either a polygon or a circle. Including both will return a validation
|
3115
|
+
# error.
|
3013
3116
|
#
|
3014
|
-
# <note markdown="1"> Each [geofence polygon][1] can have a maximum of 1,000 vertices.
|
3117
|
+
# <note markdown="1"> Each [ geofence polygon][1] can have a maximum of 1,000 vertices.
|
3015
3118
|
#
|
3016
3119
|
# </note>
|
3017
3120
|
#
|
@@ -3031,6 +3134,10 @@ module Aws::LocationService
|
|
3031
3134
|
# collection_name: "ResourceName", # required
|
3032
3135
|
# geofence_id: "Id", # required
|
3033
3136
|
# geometry: { # required
|
3137
|
+
# circle: {
|
3138
|
+
# center: [1.0], # required
|
3139
|
+
# radius: 1.0, # required
|
3140
|
+
# },
|
3034
3141
|
# polygon: [
|
3035
3142
|
# [
|
3036
3143
|
# [1.0],
|
@@ -3133,6 +3240,9 @@ module Aws::LocationService
|
|
3133
3240
|
# resp.results[0].place.sub_region #=> String
|
3134
3241
|
# resp.results[0].place.time_zone.name #=> String
|
3135
3242
|
# resp.results[0].place.time_zone.offset #=> Integer
|
3243
|
+
# resp.results[0].place.unit_number #=> String
|
3244
|
+
# resp.results[0].place.unit_type #=> String
|
3245
|
+
# resp.results[0].place_id #=> String
|
3136
3246
|
# resp.summary.data_source #=> String
|
3137
3247
|
# resp.summary.language #=> String
|
3138
3248
|
# resp.summary.max_results #=> Integer
|
@@ -3268,6 +3378,7 @@ module Aws::LocationService
|
|
3268
3378
|
# @example Response structure
|
3269
3379
|
#
|
3270
3380
|
# resp.results #=> Array
|
3381
|
+
# resp.results[0].place_id #=> String
|
3271
3382
|
# resp.results[0].text #=> String
|
3272
3383
|
# resp.summary.bias_position #=> Array
|
3273
3384
|
# resp.summary.bias_position[0] #=> Float
|
@@ -3425,6 +3536,9 @@ module Aws::LocationService
|
|
3425
3536
|
# resp.results[0].place.sub_region #=> String
|
3426
3537
|
# resp.results[0].place.time_zone.name #=> String
|
3427
3538
|
# resp.results[0].place.time_zone.offset #=> Integer
|
3539
|
+
# resp.results[0].place.unit_number #=> String
|
3540
|
+
# resp.results[0].place.unit_type #=> String
|
3541
|
+
# resp.results[0].place_id #=> String
|
3428
3542
|
# resp.results[0].relevance #=> Float
|
3429
3543
|
# resp.summary.bias_position #=> Array
|
3430
3544
|
# resp.summary.bias_position[0] #=> Float
|
@@ -3799,7 +3913,7 @@ module Aws::LocationService
|
|
3799
3913
|
params: params,
|
3800
3914
|
config: config)
|
3801
3915
|
context[:gem_name] = 'aws-sdk-locationservice'
|
3802
|
-
context[:gem_version] = '1.
|
3916
|
+
context[:gem_version] = '1.24.0'
|
3803
3917
|
Seahorse::Client::Request.new(handlers, context)
|
3804
3918
|
end
|
3805
3919
|
|
@@ -74,6 +74,7 @@ module Aws::LocationService
|
|
74
74
|
CalculateRouteSummaryDistanceDouble = Shapes::FloatShape.new(name: 'CalculateRouteSummaryDistanceDouble')
|
75
75
|
CalculateRouteSummaryDurationSecondsDouble = Shapes::FloatShape.new(name: 'CalculateRouteSummaryDurationSecondsDouble')
|
76
76
|
CalculateRouteTruckModeOptions = Shapes::StructureShape.new(name: 'CalculateRouteTruckModeOptions')
|
77
|
+
Circle = Shapes::StructureShape.new(name: 'Circle')
|
77
78
|
ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
|
78
79
|
CountryCode = Shapes::StringShape.new(name: 'CountryCode')
|
79
80
|
CountryCodeList = Shapes::ListShape.new(name: 'CountryCodeList')
|
@@ -116,6 +117,7 @@ module Aws::LocationService
|
|
116
117
|
DisassociateTrackerConsumerResponse = Shapes::StructureShape.new(name: 'DisassociateTrackerConsumerResponse')
|
117
118
|
DistanceUnit = Shapes::StringShape.new(name: 'DistanceUnit')
|
118
119
|
Double = Shapes::FloatShape.new(name: 'Double')
|
120
|
+
GeoArn = Shapes::StringShape.new(name: 'GeoArn')
|
119
121
|
GeofenceGeometry = Shapes::StructureShape.new(name: 'GeofenceGeometry')
|
120
122
|
GetDevicePositionHistoryRequest = Shapes::StructureShape.new(name: 'GetDevicePositionHistoryRequest')
|
121
123
|
GetDevicePositionHistoryRequestMaxResultsInteger = Shapes::IntegerShape.new(name: 'GetDevicePositionHistoryRequestMaxResultsInteger')
|
@@ -137,6 +139,8 @@ module Aws::LocationService
|
|
137
139
|
GetMapTileRequestYString = Shapes::StringShape.new(name: 'GetMapTileRequestYString')
|
138
140
|
GetMapTileRequestZString = Shapes::StringShape.new(name: 'GetMapTileRequestZString')
|
139
141
|
GetMapTileResponse = Shapes::StructureShape.new(name: 'GetMapTileResponse')
|
142
|
+
GetPlaceRequest = Shapes::StructureShape.new(name: 'GetPlaceRequest')
|
143
|
+
GetPlaceResponse = Shapes::StructureShape.new(name: 'GetPlaceResponse')
|
140
144
|
Id = Shapes::StringShape.new(name: 'Id')
|
141
145
|
Integer = Shapes::IntegerShape.new(name: 'Integer')
|
142
146
|
IntendedUse = Shapes::StringShape.new(name: 'IntendedUse')
|
@@ -195,6 +199,7 @@ module Aws::LocationService
|
|
195
199
|
MapStyle = Shapes::StringShape.new(name: 'MapStyle')
|
196
200
|
Place = Shapes::StructureShape.new(name: 'Place')
|
197
201
|
PlaceGeometry = Shapes::StructureShape.new(name: 'PlaceGeometry')
|
202
|
+
PlaceId = Shapes::StringShape.new(name: 'PlaceId')
|
198
203
|
PlaceIndexSearchResultLimit = Shapes::IntegerShape.new(name: 'PlaceIndexSearchResultLimit')
|
199
204
|
Position = Shapes::ListShape.new(name: 'Position')
|
200
205
|
PositionFiltering = Shapes::StringShape.new(name: 'PositionFiltering')
|
@@ -469,6 +474,10 @@ module Aws::LocationService
|
|
469
474
|
CalculateRouteTruckModeOptions.add_member(:weight, Shapes::ShapeRef.new(shape: TruckWeight, location_name: "Weight"))
|
470
475
|
CalculateRouteTruckModeOptions.struct_class = Types::CalculateRouteTruckModeOptions
|
471
476
|
|
477
|
+
Circle.add_member(:center, Shapes::ShapeRef.new(shape: Position, required: true, location_name: "Center"))
|
478
|
+
Circle.add_member(:radius, Shapes::ShapeRef.new(shape: Double, required: true, location_name: "Radius"))
|
479
|
+
Circle.struct_class = Types::Circle
|
480
|
+
|
472
481
|
ConflictException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
|
473
482
|
ConflictException.struct_class = Types::ConflictException
|
474
483
|
|
@@ -495,7 +504,7 @@ module Aws::LocationService
|
|
495
504
|
CreateMapRequest.struct_class = Types::CreateMapRequest
|
496
505
|
|
497
506
|
CreateMapResponse.add_member(:create_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "CreateTime"))
|
498
|
-
CreateMapResponse.add_member(:map_arn, Shapes::ShapeRef.new(shape:
|
507
|
+
CreateMapResponse.add_member(:map_arn, Shapes::ShapeRef.new(shape: GeoArn, required: true, location_name: "MapArn"))
|
499
508
|
CreateMapResponse.add_member(:map_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "MapName"))
|
500
509
|
CreateMapResponse.struct_class = Types::CreateMapResponse
|
501
510
|
|
@@ -587,7 +596,7 @@ module Aws::LocationService
|
|
587
596
|
DescribeMapResponse.add_member(:create_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "CreateTime"))
|
588
597
|
DescribeMapResponse.add_member(:data_source, Shapes::ShapeRef.new(shape: String, required: true, location_name: "DataSource"))
|
589
598
|
DescribeMapResponse.add_member(:description, Shapes::ShapeRef.new(shape: ResourceDescription, required: true, location_name: "Description"))
|
590
|
-
DescribeMapResponse.add_member(:map_arn, Shapes::ShapeRef.new(shape:
|
599
|
+
DescribeMapResponse.add_member(:map_arn, Shapes::ShapeRef.new(shape: GeoArn, required: true, location_name: "MapArn"))
|
591
600
|
DescribeMapResponse.add_member(:map_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "MapName"))
|
592
601
|
DescribeMapResponse.add_member(:pricing_plan, Shapes::ShapeRef.new(shape: PricingPlan, deprecated: true, location_name: "PricingPlan", metadata: {"deprecatedMessage"=>"Deprecated. Always returns RequestBasedUsage."}))
|
593
602
|
DescribeMapResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
|
@@ -659,6 +668,7 @@ module Aws::LocationService
|
|
659
668
|
|
660
669
|
DisassociateTrackerConsumerResponse.struct_class = Types::DisassociateTrackerConsumerResponse
|
661
670
|
|
671
|
+
GeofenceGeometry.add_member(:circle, Shapes::ShapeRef.new(shape: Circle, location_name: "Circle"))
|
662
672
|
GeofenceGeometry.add_member(:polygon, Shapes::ShapeRef.new(shape: LinearRings, location_name: "Polygon"))
|
663
673
|
GeofenceGeometry.struct_class = Types::GeofenceGeometry
|
664
674
|
|
@@ -739,6 +749,14 @@ module Aws::LocationService
|
|
739
749
|
GetMapTileResponse[:payload] = :blob
|
740
750
|
GetMapTileResponse[:payload_member] = GetMapTileResponse.member(:blob)
|
741
751
|
|
752
|
+
GetPlaceRequest.add_member(:index_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location: "uri", location_name: "IndexName"))
|
753
|
+
GetPlaceRequest.add_member(:language, Shapes::ShapeRef.new(shape: LanguageTag, location: "querystring", location_name: "language"))
|
754
|
+
GetPlaceRequest.add_member(:place_id, Shapes::ShapeRef.new(shape: PlaceId, required: true, location: "uri", location_name: "PlaceId"))
|
755
|
+
GetPlaceRequest.struct_class = Types::GetPlaceRequest
|
756
|
+
|
757
|
+
GetPlaceResponse.add_member(:place, Shapes::ShapeRef.new(shape: Place, required: true, location_name: "Place"))
|
758
|
+
GetPlaceResponse.struct_class = Types::GetPlaceResponse
|
759
|
+
|
742
760
|
InternalServerException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
|
743
761
|
InternalServerException.struct_class = Types::InternalServerException
|
744
762
|
|
@@ -917,6 +935,8 @@ module Aws::LocationService
|
|
917
935
|
Place.add_member(:street, Shapes::ShapeRef.new(shape: String, location_name: "Street"))
|
918
936
|
Place.add_member(:sub_region, Shapes::ShapeRef.new(shape: String, location_name: "SubRegion"))
|
919
937
|
Place.add_member(:time_zone, Shapes::ShapeRef.new(shape: TimeZone, location_name: "TimeZone"))
|
938
|
+
Place.add_member(:unit_number, Shapes::ShapeRef.new(shape: String, location_name: "UnitNumber"))
|
939
|
+
Place.add_member(:unit_type, Shapes::ShapeRef.new(shape: String, location_name: "UnitType"))
|
920
940
|
Place.struct_class = Types::Place
|
921
941
|
|
922
942
|
PlaceGeometry.add_member(:point, Shapes::ShapeRef.new(shape: Position, location_name: "Point"))
|
@@ -958,10 +978,12 @@ module Aws::LocationService
|
|
958
978
|
|
959
979
|
SearchForPositionResult.add_member(:distance, Shapes::ShapeRef.new(shape: SearchForPositionResultDistanceDouble, required: true, location_name: "Distance"))
|
960
980
|
SearchForPositionResult.add_member(:place, Shapes::ShapeRef.new(shape: Place, required: true, location_name: "Place"))
|
981
|
+
SearchForPositionResult.add_member(:place_id, Shapes::ShapeRef.new(shape: PlaceId, location_name: "PlaceId"))
|
961
982
|
SearchForPositionResult.struct_class = Types::SearchForPositionResult
|
962
983
|
|
963
984
|
SearchForPositionResultList.member = Shapes::ShapeRef.new(shape: SearchForPositionResult)
|
964
985
|
|
986
|
+
SearchForSuggestionsResult.add_member(:place_id, Shapes::ShapeRef.new(shape: PlaceId, location_name: "PlaceId"))
|
965
987
|
SearchForSuggestionsResult.add_member(:text, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Text"))
|
966
988
|
SearchForSuggestionsResult.struct_class = Types::SearchForSuggestionsResult
|
967
989
|
|
@@ -969,6 +991,7 @@ module Aws::LocationService
|
|
969
991
|
|
970
992
|
SearchForTextResult.add_member(:distance, Shapes::ShapeRef.new(shape: SearchForTextResultDistanceDouble, location_name: "Distance"))
|
971
993
|
SearchForTextResult.add_member(:place, Shapes::ShapeRef.new(shape: Place, required: true, location_name: "Place"))
|
994
|
+
SearchForTextResult.add_member(:place_id, Shapes::ShapeRef.new(shape: PlaceId, location_name: "PlaceId"))
|
972
995
|
SearchForTextResult.add_member(:relevance, Shapes::ShapeRef.new(shape: SearchForTextResultRelevanceDouble, location_name: "Relevance"))
|
973
996
|
SearchForTextResult.struct_class = Types::SearchForTextResult
|
974
997
|
|
@@ -1097,7 +1120,7 @@ module Aws::LocationService
|
|
1097
1120
|
UpdateMapRequest.add_member(:pricing_plan, Shapes::ShapeRef.new(shape: PricingPlan, deprecated: true, location_name: "PricingPlan", metadata: {"deprecatedMessage"=>"Deprecated. If included, the only allowed value is RequestBasedUsage."}))
|
1098
1121
|
UpdateMapRequest.struct_class = Types::UpdateMapRequest
|
1099
1122
|
|
1100
|
-
UpdateMapResponse.add_member(:map_arn, Shapes::ShapeRef.new(shape:
|
1123
|
+
UpdateMapResponse.add_member(:map_arn, Shapes::ShapeRef.new(shape: GeoArn, required: true, location_name: "MapArn"))
|
1101
1124
|
UpdateMapResponse.add_member(:map_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "MapName"))
|
1102
1125
|
UpdateMapResponse.add_member(:update_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "UpdateTime"))
|
1103
1126
|
UpdateMapResponse.struct_class = Types::UpdateMapResponse
|
@@ -1684,6 +1707,22 @@ module Aws::LocationService
|
|
1684
1707
|
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1685
1708
|
end)
|
1686
1709
|
|
1710
|
+
api.add_operation(:get_place, Seahorse::Model::Operation.new.tap do |o|
|
1711
|
+
o.name = "GetPlace"
|
1712
|
+
o.http_method = "GET"
|
1713
|
+
o.http_request_uri = "/places/v0/indexes/{IndexName}/places/{PlaceId}"
|
1714
|
+
o.endpoint_pattern = {
|
1715
|
+
"hostPrefix" => "places.",
|
1716
|
+
}
|
1717
|
+
o.input = Shapes::ShapeRef.new(shape: GetPlaceRequest)
|
1718
|
+
o.output = Shapes::ShapeRef.new(shape: GetPlaceResponse)
|
1719
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1720
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1721
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1722
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1723
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1724
|
+
end)
|
1725
|
+
|
1687
1726
|
api.add_operation(:list_device_positions, Seahorse::Model::Operation.new.tap do |o|
|
1688
1727
|
o.name = "ListDevicePositions"
|
1689
1728
|
o.http_method = "POST"
|
@@ -380,6 +380,10 @@ module Aws::LocationService
|
|
380
380
|
# {
|
381
381
|
# geofence_id: "Id", # required
|
382
382
|
# geometry: { # required
|
383
|
+
# circle: {
|
384
|
+
# center: [1.0], # required
|
385
|
+
# radius: 1.0, # required
|
386
|
+
# },
|
383
387
|
# polygon: [
|
384
388
|
# [
|
385
389
|
# [1.0],
|
@@ -415,6 +419,10 @@ module Aws::LocationService
|
|
415
419
|
# {
|
416
420
|
# geofence_id: "Id", # required
|
417
421
|
# geometry: { # required
|
422
|
+
# circle: {
|
423
|
+
# center: [1.0], # required
|
424
|
+
# radius: 1.0, # required
|
425
|
+
# },
|
418
426
|
# polygon: [
|
419
427
|
# [
|
420
428
|
# [1.0],
|
@@ -429,10 +437,11 @@ module Aws::LocationService
|
|
429
437
|
# @return [String]
|
430
438
|
#
|
431
439
|
# @!attribute [rw] geometry
|
432
|
-
# Contains the
|
433
|
-
#
|
440
|
+
# Contains the details of the position of the geofence. Can be either
|
441
|
+
# a polygon or a circle. Including both will return a validation
|
442
|
+
# error.
|
434
443
|
#
|
435
|
-
# <note markdown="1"> Each [geofence polygon][1] can have a maximum of 1,000 vertices.
|
444
|
+
# <note markdown="1"> Each [ geofence polygon][1] can have a maximum of 1,000 vertices.
|
436
445
|
#
|
437
446
|
# </note>
|
438
447
|
#
|
@@ -1019,7 +1028,8 @@ module Aws::LocationService
|
|
1019
1028
|
#
|
1020
1029
|
# @!attribute [rw] travel_mode
|
1021
1030
|
# Specifies the mode of transport when calculating a route. Used in
|
1022
|
-
# estimating the speed of travel and road compatibility.
|
1031
|
+
# estimating the speed of travel and road compatibility. You can
|
1032
|
+
# choose `Car`, `Truck`, or `Walking` as options for the `TravelMode`.
|
1023
1033
|
#
|
1024
1034
|
# The `TravelMode` you specify also determines how you specify route
|
1025
1035
|
# preferences:
|
@@ -1266,6 +1276,39 @@ module Aws::LocationService
|
|
1266
1276
|
include Aws::Structure
|
1267
1277
|
end
|
1268
1278
|
|
1279
|
+
# A circle on the earth, as defined by a center point and a radius.
|
1280
|
+
#
|
1281
|
+
# @note When making an API call, you may pass Circle
|
1282
|
+
# data as a hash:
|
1283
|
+
#
|
1284
|
+
# {
|
1285
|
+
# center: [1.0], # required
|
1286
|
+
# radius: 1.0, # required
|
1287
|
+
# }
|
1288
|
+
#
|
1289
|
+
# @!attribute [rw] center
|
1290
|
+
# A single point geometry, specifying the center of the circle, using
|
1291
|
+
# [WGS 84][1] coordinates, in the form `[longitude, latitude]`.
|
1292
|
+
#
|
1293
|
+
#
|
1294
|
+
#
|
1295
|
+
# [1]: https://gisgeography.com/wgs84-world-geodetic-system/
|
1296
|
+
# @return [Array<Float>]
|
1297
|
+
#
|
1298
|
+
# @!attribute [rw] radius
|
1299
|
+
# The radius of the circle in meters. Must be greater than zero and no
|
1300
|
+
# larger than 100,000 (100 kilometers).
|
1301
|
+
# @return [Float]
|
1302
|
+
#
|
1303
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/Circle AWS API Documentation
|
1304
|
+
#
|
1305
|
+
class Circle < Struct.new(
|
1306
|
+
:center,
|
1307
|
+
:radius)
|
1308
|
+
SENSITIVE = [:center]
|
1309
|
+
include Aws::Structure
|
1310
|
+
end
|
1311
|
+
|
1269
1312
|
# The request was unsuccessful because of a conflict.
|
1270
1313
|
#
|
1271
1314
|
# @!attribute [rw] message
|
@@ -2745,6 +2788,10 @@ module Aws::LocationService
|
|
2745
2788
|
|
2746
2789
|
# Contains the geofence geometry details.
|
2747
2790
|
#
|
2791
|
+
# A geofence geometry is made up of either a polygon or a circle. Can be
|
2792
|
+
# either a polygon or a circle. Including both will return a validation
|
2793
|
+
# error.
|
2794
|
+
#
|
2748
2795
|
# <note markdown="1"> Amazon Location doesn't currently support polygons with holes,
|
2749
2796
|
# multipolygons, polygons that are wound clockwise, or that cross the
|
2750
2797
|
# antimeridian.
|
@@ -2755,6 +2802,10 @@ module Aws::LocationService
|
|
2755
2802
|
# data as a hash:
|
2756
2803
|
#
|
2757
2804
|
# {
|
2805
|
+
# circle: {
|
2806
|
+
# center: [1.0], # required
|
2807
|
+
# radius: 1.0, # required
|
2808
|
+
# },
|
2758
2809
|
# polygon: [
|
2759
2810
|
# [
|
2760
2811
|
# [1.0],
|
@@ -2762,6 +2813,10 @@ module Aws::LocationService
|
|
2762
2813
|
# ],
|
2763
2814
|
# }
|
2764
2815
|
#
|
2816
|
+
# @!attribute [rw] circle
|
2817
|
+
# A circle on the earth, as defined by a center point and a radius.
|
2818
|
+
# @return [Types::Circle]
|
2819
|
+
#
|
2765
2820
|
# @!attribute [rw] polygon
|
2766
2821
|
# An array of 1 or more linear rings. A linear ring is an array of 4
|
2767
2822
|
# or more vertices, where the first and last vertex are the same to
|
@@ -2775,13 +2830,16 @@ module Aws::LocationService
|
|
2775
2830
|
# side is the polygon's exterior. Inner rings must list their
|
2776
2831
|
# vertices in clockwise order, where the left side is the polygon's
|
2777
2832
|
# interior.
|
2833
|
+
#
|
2834
|
+
# A geofence polygon can consist of between 4 and 1,000 vertices.
|
2778
2835
|
# @return [Array<Array<Array<Float>>>]
|
2779
2836
|
#
|
2780
2837
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GeofenceGeometry AWS API Documentation
|
2781
2838
|
#
|
2782
2839
|
class GeofenceGeometry < Struct.new(
|
2840
|
+
:circle,
|
2783
2841
|
:polygon)
|
2784
|
-
SENSITIVE = []
|
2842
|
+
SENSITIVE = [:circle]
|
2785
2843
|
include Aws::Structure
|
2786
2844
|
end
|
2787
2845
|
|
@@ -2998,7 +3056,8 @@ module Aws::LocationService
|
|
2998
3056
|
# @return [String]
|
2999
3057
|
#
|
3000
3058
|
# @!attribute [rw] geometry
|
3001
|
-
# Contains the geofence geometry details describing a polygon
|
3059
|
+
# Contains the geofence geometry details describing a polygon or a
|
3060
|
+
# circle.
|
3002
3061
|
# @return [Types::GeofenceGeometry]
|
3003
3062
|
#
|
3004
3063
|
# @!attribute [rw] status
|
@@ -3070,7 +3129,7 @@ module Aws::LocationService
|
|
3070
3129
|
#
|
3071
3130
|
# Valid font stacks for [HERE Technologies][2] styles:
|
3072
3131
|
#
|
3073
|
-
# *
|
3132
|
+
# * VectorHereContrast – `Fira GO Regular` \| `Fira GO Bold`
|
3074
3133
|
#
|
3075
3134
|
# * VectorHereExplore, VectorHereExploreTruck – `Firo GO Italic` \|
|
3076
3135
|
# `Fira GO Map` \| `Fira GO Map Bold` \| `Noto Sans CJK JP Bold` \|
|
@@ -3136,8 +3195,8 @@ module Aws::LocationService
|
|
3136
3195
|
#
|
3137
3196
|
# * `sprites@2x.png` for high pixel density displays
|
3138
3197
|
#
|
3139
|
-
# For the JSON document
|
3140
|
-
# names:
|
3198
|
+
# For the JSON document containing image offsets. Use the following
|
3199
|
+
# file names:
|
3141
3200
|
#
|
3142
3201
|
# * `sprites.json`
|
3143
3202
|
#
|
@@ -3268,6 +3327,71 @@ module Aws::LocationService
|
|
3268
3327
|
include Aws::Structure
|
3269
3328
|
end
|
3270
3329
|
|
3330
|
+
# @note When making an API call, you may pass GetPlaceRequest
|
3331
|
+
# data as a hash:
|
3332
|
+
#
|
3333
|
+
# {
|
3334
|
+
# index_name: "ResourceName", # required
|
3335
|
+
# language: "LanguageTag",
|
3336
|
+
# place_id: "PlaceId", # required
|
3337
|
+
# }
|
3338
|
+
#
|
3339
|
+
# @!attribute [rw] index_name
|
3340
|
+
# The name of the place index resource that you want to use for the
|
3341
|
+
# search.
|
3342
|
+
# @return [String]
|
3343
|
+
#
|
3344
|
+
# @!attribute [rw] language
|
3345
|
+
# The preferred language used to return results. The value must be a
|
3346
|
+
# valid [BCP 47][1] language tag, for example, `en` for English.
|
3347
|
+
#
|
3348
|
+
# This setting affects the languages used in the results, but not the
|
3349
|
+
# results themselves. If no language is specified, or not supported
|
3350
|
+
# for a particular result, the partner automatically chooses a
|
3351
|
+
# language for the result.
|
3352
|
+
#
|
3353
|
+
# For an example, we'll use the Greek language. You search for a
|
3354
|
+
# location around Athens, Greece, with the `language` parameter set to
|
3355
|
+
# `en`. The `city` in the results will most likely be returned as
|
3356
|
+
# `Athens`.
|
3357
|
+
#
|
3358
|
+
# If you set the `language` parameter to `el`, for Greek, then the
|
3359
|
+
# `city` in the results will more likely be returned as `Αθήνα`.
|
3360
|
+
#
|
3361
|
+
# If the data provider does not have a value for Greek, the result
|
3362
|
+
# will be in a language that the provider does support.
|
3363
|
+
#
|
3364
|
+
#
|
3365
|
+
#
|
3366
|
+
# [1]: https://tools.ietf.org/search/bcp47
|
3367
|
+
# @return [String]
|
3368
|
+
#
|
3369
|
+
# @!attribute [rw] place_id
|
3370
|
+
# The identifier of the place to find.
|
3371
|
+
# @return [String]
|
3372
|
+
#
|
3373
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetPlaceRequest AWS API Documentation
|
3374
|
+
#
|
3375
|
+
class GetPlaceRequest < Struct.new(
|
3376
|
+
:index_name,
|
3377
|
+
:language,
|
3378
|
+
:place_id)
|
3379
|
+
SENSITIVE = []
|
3380
|
+
include Aws::Structure
|
3381
|
+
end
|
3382
|
+
|
3383
|
+
# @!attribute [rw] place
|
3384
|
+
# Details about the result, such as its address and position.
|
3385
|
+
# @return [Types::Place]
|
3386
|
+
#
|
3387
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetPlaceResponse AWS API Documentation
|
3388
|
+
#
|
3389
|
+
class GetPlaceResponse < Struct.new(
|
3390
|
+
:place)
|
3391
|
+
SENSITIVE = []
|
3392
|
+
include Aws::Structure
|
3393
|
+
end
|
3394
|
+
|
3271
3395
|
# The request has failed to process because of an unknown server error,
|
3272
3396
|
# exception, or failure.
|
3273
3397
|
#
|
@@ -3614,7 +3738,8 @@ module Aws::LocationService
|
|
3614
3738
|
# @return [String]
|
3615
3739
|
#
|
3616
3740
|
# @!attribute [rw] geometry
|
3617
|
-
# Contains the geofence geometry details describing a polygon
|
3741
|
+
# Contains the geofence geometry details describing a polygon or a
|
3742
|
+
# circle.
|
3618
3743
|
# @return [Types::GeofenceGeometry]
|
3619
3744
|
#
|
3620
3745
|
# @!attribute [rw] status
|
@@ -4288,8 +4413,9 @@ module Aws::LocationService
|
|
4288
4413
|
#
|
4289
4414
|
# Valid [HERE Technologies map styles][2]\:
|
4290
4415
|
#
|
4291
|
-
# * `
|
4292
|
-
# detailed base map of the world that blends 3D and 2D
|
4416
|
+
# * `VectorHereContrast` – The HERE Contrast (Berlin) map style is a
|
4417
|
+
# high contrast detailed base map of the world that blends 3D and 2D
|
4418
|
+
# rendering.
|
4293
4419
|
#
|
4294
4420
|
# * `VectorHereExplore` – A default HERE map style containing a
|
4295
4421
|
# neutral, global map and its features including roads, buildings,
|
@@ -4301,6 +4427,12 @@ module Aws::LocationService
|
|
4301
4427
|
# symbolized with highlighted segments and icons on top of HERE
|
4302
4428
|
# Explore to support use cases within transport and logistics.
|
4303
4429
|
#
|
4430
|
+
# <note markdown="1"> The `VectorHereContrast` style has been renamed from
|
4431
|
+
# `VectorHereBerlin`. `VectorHereBerlin` has been deprecated, but will
|
4432
|
+
# continue to work in applications that use it.
|
4433
|
+
#
|
4434
|
+
# </note>
|
4435
|
+
#
|
4304
4436
|
#
|
4305
4437
|
#
|
4306
4438
|
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/esri.html
|
@@ -4390,6 +4522,21 @@ module Aws::LocationService
|
|
4390
4522
|
# using Here as the selected partner.
|
4391
4523
|
# @return [Types::TimeZone]
|
4392
4524
|
#
|
4525
|
+
# @!attribute [rw] unit_number
|
4526
|
+
# For addresses with multiple units, the unit identifier. Can include
|
4527
|
+
# numbers and letters, for example `3B` or `Unit 123`.
|
4528
|
+
#
|
4529
|
+
# <note markdown="1"> Returned only for a place index that uses Esri as a data provider.
|
4530
|
+
# Is not returned for `SearchPlaceIndexForPosition`.
|
4531
|
+
#
|
4532
|
+
# </note>
|
4533
|
+
# @return [String]
|
4534
|
+
#
|
4535
|
+
# @!attribute [rw] unit_type
|
4536
|
+
# For addresses with a `UnitNumber`, the type of unit. For example,
|
4537
|
+
# `Apartment`.
|
4538
|
+
# @return [String]
|
4539
|
+
#
|
4393
4540
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/Place AWS API Documentation
|
4394
4541
|
#
|
4395
4542
|
class Place < Struct.new(
|
@@ -4404,7 +4551,9 @@ module Aws::LocationService
|
|
4404
4551
|
:region,
|
4405
4552
|
:street,
|
4406
4553
|
:sub_region,
|
4407
|
-
:time_zone
|
4554
|
+
:time_zone,
|
4555
|
+
:unit_number,
|
4556
|
+
:unit_type)
|
4408
4557
|
SENSITIVE = []
|
4409
4558
|
include Aws::Structure
|
4410
4559
|
end
|
@@ -4461,6 +4610,10 @@ module Aws::LocationService
|
|
4461
4610
|
# collection_name: "ResourceName", # required
|
4462
4611
|
# geofence_id: "Id", # required
|
4463
4612
|
# geometry: { # required
|
4613
|
+
# circle: {
|
4614
|
+
# center: [1.0], # required
|
4615
|
+
# radius: 1.0, # required
|
4616
|
+
# },
|
4464
4617
|
# polygon: [
|
4465
4618
|
# [
|
4466
4619
|
# [1.0],
|
@@ -4478,10 +4631,11 @@ module Aws::LocationService
|
|
4478
4631
|
# @return [String]
|
4479
4632
|
#
|
4480
4633
|
# @!attribute [rw] geometry
|
4481
|
-
# Contains the
|
4482
|
-
#
|
4634
|
+
# Contains the details to specify the position of the geofence. Can be
|
4635
|
+
# either a polygon or a circle. Including both will return a
|
4636
|
+
# validation error.
|
4483
4637
|
#
|
4484
|
-
# <note markdown="1"> Each [geofence polygon][1] can have a maximum of 1,000 vertices.
|
4638
|
+
# <note markdown="1"> Each [ geofence polygon][1] can have a maximum of 1,000 vertices.
|
4485
4639
|
#
|
4486
4640
|
# </note>
|
4487
4641
|
#
|
@@ -4645,11 +4799,22 @@ module Aws::LocationService
|
|
4645
4799
|
# Details about the search result, such as its address and position.
|
4646
4800
|
# @return [Types::Place]
|
4647
4801
|
#
|
4802
|
+
# @!attribute [rw] place_id
|
4803
|
+
# The unique identifier of the place. You can use this with the
|
4804
|
+
# `GetPlace` operation to find the place again later.
|
4805
|
+
#
|
4806
|
+
# <note markdown="1"> For `SearchPlaceIndexForPosition` operations, the `PlaceId` is
|
4807
|
+
# returned only by place indexes that use HERE as a data provider.
|
4808
|
+
#
|
4809
|
+
# </note>
|
4810
|
+
# @return [String]
|
4811
|
+
#
|
4648
4812
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchForPositionResult AWS API Documentation
|
4649
4813
|
#
|
4650
4814
|
class SearchForPositionResult < Struct.new(
|
4651
4815
|
:distance,
|
4652
|
-
:place
|
4816
|
+
:place,
|
4817
|
+
:place_id)
|
4653
4818
|
SENSITIVE = []
|
4654
4819
|
include Aws::Structure
|
4655
4820
|
end
|
@@ -4657,6 +4822,16 @@ module Aws::LocationService
|
|
4657
4822
|
# Contains a place suggestion resulting from a place suggestion query
|
4658
4823
|
# that is run on a place index resource.
|
4659
4824
|
#
|
4825
|
+
# @!attribute [rw] place_id
|
4826
|
+
# The unique identifier of the place. You can use this with the
|
4827
|
+
# `GetPlace` operation to find the place again later.
|
4828
|
+
#
|
4829
|
+
# <note markdown="1"> For `SearchPlaceIndexForSuggestions` operations, the `PlaceId` is
|
4830
|
+
# returned by place indexes that use HERE or Esri as data providers.
|
4831
|
+
#
|
4832
|
+
# </note>
|
4833
|
+
# @return [String]
|
4834
|
+
#
|
4660
4835
|
# @!attribute [rw] text
|
4661
4836
|
# The text of the place suggestion, typically formatted as an address
|
4662
4837
|
# string.
|
@@ -4665,6 +4840,7 @@ module Aws::LocationService
|
|
4665
4840
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchForSuggestionsResult AWS API Documentation
|
4666
4841
|
#
|
4667
4842
|
class SearchForSuggestionsResult < Struct.new(
|
4843
|
+
:place_id,
|
4668
4844
|
:text)
|
4669
4845
|
SENSITIVE = []
|
4670
4846
|
include Aws::Structure
|
@@ -4688,6 +4864,16 @@ module Aws::LocationService
|
|
4688
4864
|
# Details about the search result, such as its address and position.
|
4689
4865
|
# @return [Types::Place]
|
4690
4866
|
#
|
4867
|
+
# @!attribute [rw] place_id
|
4868
|
+
# The unique identifier of the place. You can use this with the
|
4869
|
+
# `GetPlace` operation to find the place again later.
|
4870
|
+
#
|
4871
|
+
# <note markdown="1"> For `SearchPlaceIndexForText` operations, the `PlaceId` is returned
|
4872
|
+
# only by place indexes that use HERE as a data provider.
|
4873
|
+
#
|
4874
|
+
# </note>
|
4875
|
+
# @return [String]
|
4876
|
+
#
|
4691
4877
|
# @!attribute [rw] relevance
|
4692
4878
|
# The relative confidence in the match for a result among the results
|
4693
4879
|
# returned. For example, if more fields for an address match
|
@@ -4702,6 +4888,7 @@ module Aws::LocationService
|
|
4702
4888
|
class SearchForTextResult < Struct.new(
|
4703
4889
|
:distance,
|
4704
4890
|
:place,
|
4891
|
+
:place_id,
|
4705
4892
|
:relevance)
|
4706
4893
|
SENSITIVE = []
|
4707
4894
|
include Aws::Structure
|
@@ -5466,6 +5653,11 @@ module Aws::LocationService
|
|
5466
5653
|
# * For example, `4.5`.
|
5467
5654
|
#
|
5468
5655
|
# ^
|
5656
|
+
#
|
5657
|
+
# <note markdown="1"> For routes calculated with a HERE resource, this value must be
|
5658
|
+
# between 0 and 50 meters.
|
5659
|
+
#
|
5660
|
+
# </note>
|
5469
5661
|
# @return [Float]
|
5470
5662
|
#
|
5471
5663
|
# @!attribute [rw] length
|
@@ -5474,6 +5666,11 @@ module Aws::LocationService
|
|
5474
5666
|
# * For example, `15.5`.
|
5475
5667
|
#
|
5476
5668
|
# ^
|
5669
|
+
#
|
5670
|
+
# <note markdown="1"> For routes calculated with a HERE resource, this value must be
|
5671
|
+
# between 0 and 300 meters.
|
5672
|
+
#
|
5673
|
+
# </note>
|
5477
5674
|
# @return [Float]
|
5478
5675
|
#
|
5479
5676
|
# @!attribute [rw] unit
|
@@ -5488,6 +5685,11 @@ module Aws::LocationService
|
|
5488
5685
|
# * For example, `4.5`.
|
5489
5686
|
#
|
5490
5687
|
# ^
|
5688
|
+
#
|
5689
|
+
# <note markdown="1"> For routes calculated with a HERE resource, this value must be
|
5690
|
+
# between 0 and 50 meters.
|
5691
|
+
#
|
5692
|
+
# </note>
|
5491
5693
|
# @return [Float]
|
5492
5694
|
#
|
5493
5695
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/TruckDimensions AWS API Documentation
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-locationservice
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.24.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-09-27 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|