aws-sdk-locationservice 1.23.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-locationservice/client.rb +94 -2
- data/lib/aws-sdk-locationservice/client_api.rb +36 -3
- data/lib/aws-sdk-locationservice/types.rb +119 -4
- 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,11 @@
|
|
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
|
+
|
4
9
|
1.23.0 (2022-08-09)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.24.0
|
@@ -2461,7 +2461,7 @@ module Aws::LocationService
|
|
2461
2461
|
#
|
2462
2462
|
# * `sprites@2x.png` for high pixel density displays
|
2463
2463
|
#
|
2464
|
-
# For the JSON document
|
2464
|
+
# For the JSON document containing image offsets. Use the following file
|
2465
2465
|
# names:
|
2466
2466
|
#
|
2467
2467
|
# * `sprites.json`
|
@@ -2581,6 +2581,91 @@ module Aws::LocationService
|
|
2581
2581
|
req.send_request(options, &block)
|
2582
2582
|
end
|
2583
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
|
+
|
2584
2669
|
# A batch request to retrieve all device positions.
|
2585
2670
|
#
|
2586
2671
|
# @option params [Integer] :max_results
|
@@ -3155,6 +3240,9 @@ module Aws::LocationService
|
|
3155
3240
|
# resp.results[0].place.sub_region #=> String
|
3156
3241
|
# resp.results[0].place.time_zone.name #=> String
|
3157
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
|
3158
3246
|
# resp.summary.data_source #=> String
|
3159
3247
|
# resp.summary.language #=> String
|
3160
3248
|
# resp.summary.max_results #=> Integer
|
@@ -3290,6 +3378,7 @@ module Aws::LocationService
|
|
3290
3378
|
# @example Response structure
|
3291
3379
|
#
|
3292
3380
|
# resp.results #=> Array
|
3381
|
+
# resp.results[0].place_id #=> String
|
3293
3382
|
# resp.results[0].text #=> String
|
3294
3383
|
# resp.summary.bias_position #=> Array
|
3295
3384
|
# resp.summary.bias_position[0] #=> Float
|
@@ -3447,6 +3536,9 @@ module Aws::LocationService
|
|
3447
3536
|
# resp.results[0].place.sub_region #=> String
|
3448
3537
|
# resp.results[0].place.time_zone.name #=> String
|
3449
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
|
3450
3542
|
# resp.results[0].relevance #=> Float
|
3451
3543
|
# resp.summary.bias_position #=> Array
|
3452
3544
|
# resp.summary.bias_position[0] #=> Float
|
@@ -3821,7 +3913,7 @@ module Aws::LocationService
|
|
3821
3913
|
params: params,
|
3822
3914
|
config: config)
|
3823
3915
|
context[:gem_name] = 'aws-sdk-locationservice'
|
3824
|
-
context[:gem_version] = '1.
|
3916
|
+
context[:gem_version] = '1.24.0'
|
3825
3917
|
Seahorse::Client::Request.new(handlers, context)
|
3826
3918
|
end
|
3827
3919
|
|
@@ -117,6 +117,7 @@ module Aws::LocationService
|
|
117
117
|
DisassociateTrackerConsumerResponse = Shapes::StructureShape.new(name: 'DisassociateTrackerConsumerResponse')
|
118
118
|
DistanceUnit = Shapes::StringShape.new(name: 'DistanceUnit')
|
119
119
|
Double = Shapes::FloatShape.new(name: 'Double')
|
120
|
+
GeoArn = Shapes::StringShape.new(name: 'GeoArn')
|
120
121
|
GeofenceGeometry = Shapes::StructureShape.new(name: 'GeofenceGeometry')
|
121
122
|
GetDevicePositionHistoryRequest = Shapes::StructureShape.new(name: 'GetDevicePositionHistoryRequest')
|
122
123
|
GetDevicePositionHistoryRequestMaxResultsInteger = Shapes::IntegerShape.new(name: 'GetDevicePositionHistoryRequestMaxResultsInteger')
|
@@ -138,6 +139,8 @@ module Aws::LocationService
|
|
138
139
|
GetMapTileRequestYString = Shapes::StringShape.new(name: 'GetMapTileRequestYString')
|
139
140
|
GetMapTileRequestZString = Shapes::StringShape.new(name: 'GetMapTileRequestZString')
|
140
141
|
GetMapTileResponse = Shapes::StructureShape.new(name: 'GetMapTileResponse')
|
142
|
+
GetPlaceRequest = Shapes::StructureShape.new(name: 'GetPlaceRequest')
|
143
|
+
GetPlaceResponse = Shapes::StructureShape.new(name: 'GetPlaceResponse')
|
141
144
|
Id = Shapes::StringShape.new(name: 'Id')
|
142
145
|
Integer = Shapes::IntegerShape.new(name: 'Integer')
|
143
146
|
IntendedUse = Shapes::StringShape.new(name: 'IntendedUse')
|
@@ -196,6 +199,7 @@ module Aws::LocationService
|
|
196
199
|
MapStyle = Shapes::StringShape.new(name: 'MapStyle')
|
197
200
|
Place = Shapes::StructureShape.new(name: 'Place')
|
198
201
|
PlaceGeometry = Shapes::StructureShape.new(name: 'PlaceGeometry')
|
202
|
+
PlaceId = Shapes::StringShape.new(name: 'PlaceId')
|
199
203
|
PlaceIndexSearchResultLimit = Shapes::IntegerShape.new(name: 'PlaceIndexSearchResultLimit')
|
200
204
|
Position = Shapes::ListShape.new(name: 'Position')
|
201
205
|
PositionFiltering = Shapes::StringShape.new(name: 'PositionFiltering')
|
@@ -500,7 +504,7 @@ module Aws::LocationService
|
|
500
504
|
CreateMapRequest.struct_class = Types::CreateMapRequest
|
501
505
|
|
502
506
|
CreateMapResponse.add_member(:create_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "CreateTime"))
|
503
|
-
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"))
|
504
508
|
CreateMapResponse.add_member(:map_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "MapName"))
|
505
509
|
CreateMapResponse.struct_class = Types::CreateMapResponse
|
506
510
|
|
@@ -592,7 +596,7 @@ module Aws::LocationService
|
|
592
596
|
DescribeMapResponse.add_member(:create_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "CreateTime"))
|
593
597
|
DescribeMapResponse.add_member(:data_source, Shapes::ShapeRef.new(shape: String, required: true, location_name: "DataSource"))
|
594
598
|
DescribeMapResponse.add_member(:description, Shapes::ShapeRef.new(shape: ResourceDescription, required: true, location_name: "Description"))
|
595
|
-
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"))
|
596
600
|
DescribeMapResponse.add_member(:map_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "MapName"))
|
597
601
|
DescribeMapResponse.add_member(:pricing_plan, Shapes::ShapeRef.new(shape: PricingPlan, deprecated: true, location_name: "PricingPlan", metadata: {"deprecatedMessage"=>"Deprecated. Always returns RequestBasedUsage."}))
|
598
602
|
DescribeMapResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
|
@@ -745,6 +749,14 @@ module Aws::LocationService
|
|
745
749
|
GetMapTileResponse[:payload] = :blob
|
746
750
|
GetMapTileResponse[:payload_member] = GetMapTileResponse.member(:blob)
|
747
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
|
+
|
748
760
|
InternalServerException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
|
749
761
|
InternalServerException.struct_class = Types::InternalServerException
|
750
762
|
|
@@ -923,6 +935,8 @@ module Aws::LocationService
|
|
923
935
|
Place.add_member(:street, Shapes::ShapeRef.new(shape: String, location_name: "Street"))
|
924
936
|
Place.add_member(:sub_region, Shapes::ShapeRef.new(shape: String, location_name: "SubRegion"))
|
925
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"))
|
926
940
|
Place.struct_class = Types::Place
|
927
941
|
|
928
942
|
PlaceGeometry.add_member(:point, Shapes::ShapeRef.new(shape: Position, location_name: "Point"))
|
@@ -964,10 +978,12 @@ module Aws::LocationService
|
|
964
978
|
|
965
979
|
SearchForPositionResult.add_member(:distance, Shapes::ShapeRef.new(shape: SearchForPositionResultDistanceDouble, required: true, location_name: "Distance"))
|
966
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"))
|
967
982
|
SearchForPositionResult.struct_class = Types::SearchForPositionResult
|
968
983
|
|
969
984
|
SearchForPositionResultList.member = Shapes::ShapeRef.new(shape: SearchForPositionResult)
|
970
985
|
|
986
|
+
SearchForSuggestionsResult.add_member(:place_id, Shapes::ShapeRef.new(shape: PlaceId, location_name: "PlaceId"))
|
971
987
|
SearchForSuggestionsResult.add_member(:text, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Text"))
|
972
988
|
SearchForSuggestionsResult.struct_class = Types::SearchForSuggestionsResult
|
973
989
|
|
@@ -975,6 +991,7 @@ module Aws::LocationService
|
|
975
991
|
|
976
992
|
SearchForTextResult.add_member(:distance, Shapes::ShapeRef.new(shape: SearchForTextResultDistanceDouble, location_name: "Distance"))
|
977
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"))
|
978
995
|
SearchForTextResult.add_member(:relevance, Shapes::ShapeRef.new(shape: SearchForTextResultRelevanceDouble, location_name: "Relevance"))
|
979
996
|
SearchForTextResult.struct_class = Types::SearchForTextResult
|
980
997
|
|
@@ -1103,7 +1120,7 @@ module Aws::LocationService
|
|
1103
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."}))
|
1104
1121
|
UpdateMapRequest.struct_class = Types::UpdateMapRequest
|
1105
1122
|
|
1106
|
-
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"))
|
1107
1124
|
UpdateMapResponse.add_member(:map_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "MapName"))
|
1108
1125
|
UpdateMapResponse.add_member(:update_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "UpdateTime"))
|
1109
1126
|
UpdateMapResponse.struct_class = Types::UpdateMapResponse
|
@@ -1690,6 +1707,22 @@ module Aws::LocationService
|
|
1690
1707
|
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1691
1708
|
end)
|
1692
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
|
+
|
1693
1726
|
api.add_operation(:list_device_positions, Seahorse::Model::Operation.new.tap do |o|
|
1694
1727
|
o.name = "ListDevicePositions"
|
1695
1728
|
o.http_method = "POST"
|
@@ -3195,8 +3195,8 @@ module Aws::LocationService
|
|
3195
3195
|
#
|
3196
3196
|
# * `sprites@2x.png` for high pixel density displays
|
3197
3197
|
#
|
3198
|
-
# For the JSON document
|
3199
|
-
# names:
|
3198
|
+
# For the JSON document containing image offsets. Use the following
|
3199
|
+
# file names:
|
3200
3200
|
#
|
3201
3201
|
# * `sprites.json`
|
3202
3202
|
#
|
@@ -3327,6 +3327,71 @@ module Aws::LocationService
|
|
3327
3327
|
include Aws::Structure
|
3328
3328
|
end
|
3329
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
|
+
|
3330
3395
|
# The request has failed to process because of an unknown server error,
|
3331
3396
|
# exception, or failure.
|
3332
3397
|
#
|
@@ -4457,6 +4522,21 @@ module Aws::LocationService
|
|
4457
4522
|
# using Here as the selected partner.
|
4458
4523
|
# @return [Types::TimeZone]
|
4459
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
|
+
#
|
4460
4540
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/Place AWS API Documentation
|
4461
4541
|
#
|
4462
4542
|
class Place < Struct.new(
|
@@ -4471,7 +4551,9 @@ module Aws::LocationService
|
|
4471
4551
|
:region,
|
4472
4552
|
:street,
|
4473
4553
|
:sub_region,
|
4474
|
-
:time_zone
|
4554
|
+
:time_zone,
|
4555
|
+
:unit_number,
|
4556
|
+
:unit_type)
|
4475
4557
|
SENSITIVE = []
|
4476
4558
|
include Aws::Structure
|
4477
4559
|
end
|
@@ -4717,11 +4799,22 @@ module Aws::LocationService
|
|
4717
4799
|
# Details about the search result, such as its address and position.
|
4718
4800
|
# @return [Types::Place]
|
4719
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
|
+
#
|
4720
4812
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchForPositionResult AWS API Documentation
|
4721
4813
|
#
|
4722
4814
|
class SearchForPositionResult < Struct.new(
|
4723
4815
|
:distance,
|
4724
|
-
:place
|
4816
|
+
:place,
|
4817
|
+
:place_id)
|
4725
4818
|
SENSITIVE = []
|
4726
4819
|
include Aws::Structure
|
4727
4820
|
end
|
@@ -4729,6 +4822,16 @@ module Aws::LocationService
|
|
4729
4822
|
# Contains a place suggestion resulting from a place suggestion query
|
4730
4823
|
# that is run on a place index resource.
|
4731
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
|
+
#
|
4732
4835
|
# @!attribute [rw] text
|
4733
4836
|
# The text of the place suggestion, typically formatted as an address
|
4734
4837
|
# string.
|
@@ -4737,6 +4840,7 @@ module Aws::LocationService
|
|
4737
4840
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchForSuggestionsResult AWS API Documentation
|
4738
4841
|
#
|
4739
4842
|
class SearchForSuggestionsResult < Struct.new(
|
4843
|
+
:place_id,
|
4740
4844
|
:text)
|
4741
4845
|
SENSITIVE = []
|
4742
4846
|
include Aws::Structure
|
@@ -4760,6 +4864,16 @@ module Aws::LocationService
|
|
4760
4864
|
# Details about the search result, such as its address and position.
|
4761
4865
|
# @return [Types::Place]
|
4762
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
|
+
#
|
4763
4877
|
# @!attribute [rw] relevance
|
4764
4878
|
# The relative confidence in the match for a result among the results
|
4765
4879
|
# returned. For example, if more fields for an address match
|
@@ -4774,6 +4888,7 @@ module Aws::LocationService
|
|
4774
4888
|
class SearchForTextResult < Struct.new(
|
4775
4889
|
:distance,
|
4776
4890
|
:place,
|
4891
|
+
:place_id,
|
4777
4892
|
:relevance)
|
4778
4893
|
SENSITIVE = []
|
4779
4894
|
include Aws::Structure
|
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
|