aws-sdk-locationservice 1.11.0 → 1.12.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -646,7 +646,7 @@ module Aws::LocationService
646
646
  #
647
647
  # @!attribute [rw] calculator_name
648
648
  # The name of the route calculator resource that you want to use to
649
- # calculate a route.
649
+ # calculate the route.
650
650
  # @return [String]
651
651
  #
652
652
  # @!attribute [rw] car_mode_options
@@ -691,7 +691,7 @@ module Aws::LocationService
691
691
  #
692
692
  # @!attribute [rw] departure_time
693
693
  # Specifies the desired time of departure. Uses the given time to
694
- # calculate a route. Otherwise, the best time of day to travel with
694
+ # calculate the route. Otherwise, the best time of day to travel with
695
695
  # the best traffic conditions is used to calculate the route.
696
696
  #
697
697
  # <note markdown="1"> Setting a departure time in the past returns a `400
@@ -892,7 +892,7 @@ module Aws::LocationService
892
892
  # @return [Float]
893
893
  #
894
894
  # @!attribute [rw] distance_unit
895
- # The unit of measurement for the distance.
895
+ # The unit of measurement for route distances.
896
896
  # @return [String]
897
897
  #
898
898
  # @!attribute [rw] duration_seconds
@@ -1103,6 +1103,8 @@ module Aws::LocationService
1103
1103
  #
1104
1104
  # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
1105
1105
  # characters: + - = . \_ : / @.
1106
+ #
1107
+ # * Cannot use "aws:" as a prefix for a key.
1106
1108
  # @return [Hash<String,String>]
1107
1109
  #
1108
1110
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateGeofenceCollectionRequest AWS API Documentation
@@ -1217,6 +1219,8 @@ module Aws::LocationService
1217
1219
  #
1218
1220
  # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
1219
1221
  # characters: + - = . \_ : / @.
1222
+ #
1223
+ # * Cannot use "aws:" as a prefix for a key.
1220
1224
  # @return [Hash<String,String>]
1221
1225
  #
1222
1226
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateMapRequest AWS API Documentation
@@ -1280,7 +1284,7 @@ module Aws::LocationService
1280
1284
  # }
1281
1285
  #
1282
1286
  # @!attribute [rw] data_source
1283
- # Specifies the data provider of geospatial data.
1287
+ # Specifies the geospatial data provider for the new place index.
1284
1288
  #
1285
1289
  # <note markdown="1"> This field is case-sensitive. Enter the valid values as shown. For
1286
1290
  # example, entering `HERE` returns an error.
@@ -1297,8 +1301,8 @@ module Aws::LocationService
1297
1301
  # coverage in your region of interest, see [HERE details on
1298
1302
  # goecoding coverage][4].
1299
1303
  #
1300
- # Place index resources using HERE Technologies as a data provider
1301
- # can't [store results][5] for locations in Japan. For more
1304
+ # If you specify HERE Technologies (`Here`) as the data provider,
1305
+ # you may not [store results][5] for locations in Japan. For more
1302
1306
  # information, see the [AWS Service Terms][6] for Amazon Location
1303
1307
  # Service.
1304
1308
  #
@@ -1350,23 +1354,26 @@ module Aws::LocationService
1350
1354
  #
1351
1355
  # @!attribute [rw] tags
1352
1356
  # Applies one or more tags to the place index resource. A tag is a
1353
- # key-value pair helps manage, identify, search, and filter your
1354
- # resources by labelling them.
1357
+ # key-value pair that helps you manage, identify, search, and filter
1358
+ # your resources.
1355
1359
  #
1356
1360
  # Format: `"key" : "value"`
1357
1361
  #
1358
1362
  # Restrictions:
1359
1363
  #
1360
- # * Maximum 50 tags per resource
1364
+ # * Maximum 50 tags per resource.
1361
1365
  #
1362
- # * Each resource tag must be unique with a maximum of one value.
1366
+ # * Each tag key must be unique and must have exactly one associated
1367
+ # value.
1363
1368
  #
1364
- # * Maximum key length: 128 Unicode characters in UTF-8
1369
+ # * Maximum key length: 128 Unicode characters in UTF-8.
1365
1370
  #
1366
- # * Maximum value length: 256 Unicode characters in UTF-8
1371
+ # * Maximum value length: 256 Unicode characters in UTF-8.
1367
1372
  #
1368
1373
  # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
1369
- # characters: + - = . \_ : / @.
1374
+ # characters: + - = . \_ : / @
1375
+ #
1376
+ # * Cannot use "aws:" as a prefix for a key.
1370
1377
  # @return [Hash<String,String>]
1371
1378
  #
1372
1379
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreatePlaceIndexRequest AWS API Documentation
@@ -1512,6 +1519,8 @@ module Aws::LocationService
1512
1519
  #
1513
1520
  # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
1514
1521
  # characters: + - = . \_ : / @.
1522
+ #
1523
+ # * Cannot use "aws:" as a prefix for a key.
1515
1524
  # @return [Hash<String,String>]
1516
1525
  #
1517
1526
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateRouteCalculatorRequest AWS API Documentation
@@ -1573,7 +1582,7 @@ module Aws::LocationService
1573
1582
  # {
1574
1583
  # description: "ResourceDescription",
1575
1584
  # kms_key_id: "KmsKeyId",
1576
- # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased
1585
+ # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
1577
1586
  # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1578
1587
  # pricing_plan_data_source: "String",
1579
1588
  # tags: {
@@ -1607,11 +1616,11 @@ module Aws::LocationService
1607
1616
  #
1608
1617
  # * `DistanceBased` - If the device has moved less than 30 m (98.4
1609
1618
  # ft), location updates are ignored. Location updates within this
1610
- # distance are neither evaluated against linked geofence
1611
- # collections, nor stored. This helps control costs by reducing the
1612
- # number of geofence evaluations and device positions to retrieve.
1613
- # Distance-based filtering can also reduce the jitter effect when
1614
- # displaying device trajectory on a map.
1619
+ # area are neither evaluated against linked geofence collections,
1620
+ # nor stored. This helps control costs by reducing the number of
1621
+ # geofence evaluations and historical device positions to paginate
1622
+ # through. Distance-based filtering can also reduce the effects of
1623
+ # GPS noise when displaying device trajectories on a map.
1615
1624
  #
1616
1625
  # This field is optional. If not specified, the default value is
1617
1626
  # `TimeBased`.
@@ -1673,6 +1682,8 @@ module Aws::LocationService
1673
1682
  #
1674
1683
  # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
1675
1684
  # characters: + - = . \_ : / @.
1685
+ #
1686
+ # * Cannot use "aws:" as a prefix for a key.
1676
1687
  # @return [Hash<String,String>]
1677
1688
  #
1678
1689
  # @!attribute [rw] tracker_name
@@ -2115,14 +2126,14 @@ module Aws::LocationService
2115
2126
  # @return [Time]
2116
2127
  #
2117
2128
  # @!attribute [rw] data_source
2118
- # The data provider of geospatial data. Indicates one of the available
2119
- # providers:
2129
+ # The data provider of geospatial data. Values can be one of the
2130
+ # following:
2120
2131
  #
2121
2132
  # * `Esri`
2122
2133
  #
2123
2134
  # * `Here`
2124
2135
  #
2125
- # For additional details on data providers, see [Amazon Location
2136
+ # For more information about data providers, see [Amazon Location
2126
2137
  # Service data providers][1].
2127
2138
  #
2128
2139
  #
@@ -3603,9 +3614,9 @@ module Aws::LocationService
3603
3614
  # @return [Array<Types::ListPlaceIndexesResponseEntry>]
3604
3615
  #
3605
3616
  # @!attribute [rw] next_token
3606
- # A pagination token indicating there are additional pages available.
3607
- # You can use the token in a following request to fetch the next set
3608
- # of results.
3617
+ # A pagination token indicating that there are additional pages
3618
+ # available. You can use the token in a new request to fetch the next
3619
+ # page of results.
3609
3620
  # @return [String]
3610
3621
  #
3611
3622
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListPlaceIndexesResponse AWS API Documentation
@@ -3629,14 +3640,14 @@ module Aws::LocationService
3629
3640
  # @return [Time]
3630
3641
  #
3631
3642
  # @!attribute [rw] data_source
3632
- # The data provider of geospatial data. Indicates one of the available
3633
- # providers:
3643
+ # The data provider of geospatial data. Values can be one of the
3644
+ # following:
3634
3645
  #
3635
3646
  # * `Esri`
3636
3647
  #
3637
3648
  # * `Here`
3638
3649
  #
3639
- # For additional details on data providers, see [Amazon Location
3650
+ # For more information about data providers, see [Amazon Location
3640
3651
  # Service data providers][1].
3641
3652
  #
3642
3653
  #
@@ -4110,6 +4121,19 @@ module Aws::LocationService
4110
4121
  # Places uses a point geometry to specify a location or a Place.
4111
4122
  # @return [Types::PlaceGeometry]
4112
4123
  #
4124
+ # @!attribute [rw] interpolated
4125
+ # `True` if the result is interpolated from other known places.
4126
+ #
4127
+ # `False` if the Place is a known place.
4128
+ #
4129
+ # Not returned when the partner does not provide the information.
4130
+ #
4131
+ # For example, returns `False` for an address location that is found
4132
+ # in the partner data, but returns `True` if an address does not exist
4133
+ # in the partner data and its location is calculated by interpolating
4134
+ # between other known addresses.
4135
+ # @return [Boolean]
4136
+ #
4113
4137
  # @!attribute [rw] label
4114
4138
  # The full name and address of the point of interest such as a city,
4115
4139
  # region, or country. For example, `123 Any Street, Any Town, USA`.
@@ -4140,23 +4164,30 @@ module Aws::LocationService
4140
4164
  # @return [String]
4141
4165
  #
4142
4166
  # @!attribute [rw] sub_region
4143
- # A country, or an area that's part of a larger region . For example,
4167
+ # A country, or an area that's part of a larger region. For example,
4144
4168
  # `Metro Vancouver`.
4145
4169
  # @return [String]
4146
4170
  #
4171
+ # @!attribute [rw] time_zone
4172
+ # The time zone in which the `Place` is located. Returned only when
4173
+ # using Here as the selected partner.
4174
+ # @return [Types::TimeZone]
4175
+ #
4147
4176
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/Place AWS API Documentation
4148
4177
  #
4149
4178
  class Place < Struct.new(
4150
4179
  :address_number,
4151
4180
  :country,
4152
4181
  :geometry,
4182
+ :interpolated,
4153
4183
  :label,
4154
4184
  :municipality,
4155
4185
  :neighborhood,
4156
4186
  :postal_code,
4157
4187
  :region,
4158
4188
  :street,
4159
- :sub_region)
4189
+ :sub_region,
4190
+ :time_zone)
4160
4191
  SENSITIVE = []
4161
4192
  include Aws::Structure
4162
4193
  end
@@ -4275,32 +4306,65 @@ module Aws::LocationService
4275
4306
  include Aws::Structure
4276
4307
  end
4277
4308
 
4278
- # Specifies a single point of interest, or Place as a result of a search
4279
- # query obtained from a dataset configured in the place index resource.
4309
+ # Contains a search result from a position search query that is run on a
4310
+ # place index resource.
4311
+ #
4312
+ # @!attribute [rw] distance
4313
+ # The distance in meters of a great-circle arc between the query
4314
+ # position and the result.
4315
+ #
4316
+ # <note markdown="1"> A great-circle arc is the shortest path on a sphere, in this case
4317
+ # the Earth. This returns the shortest distance between two locations.
4318
+ #
4319
+ # </note>
4320
+ # @return [Float]
4280
4321
  #
4281
4322
  # @!attribute [rw] place
4282
- # Contains details about the relevant point of interest.
4323
+ # Details about the search result, such as its address and position.
4283
4324
  # @return [Types::Place]
4284
4325
  #
4285
4326
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchForPositionResult AWS API Documentation
4286
4327
  #
4287
4328
  class SearchForPositionResult < Struct.new(
4329
+ :distance,
4288
4330
  :place)
4289
4331
  SENSITIVE = []
4290
4332
  include Aws::Structure
4291
4333
  end
4292
4334
 
4293
- # Contains relevant Places returned by calling
4294
- # `SearchPlaceIndexForText`.
4335
+ # Contains a search result from a text search query that is run on a
4336
+ # place index resource.
4337
+ #
4338
+ # @!attribute [rw] distance
4339
+ # The distance in meters of a great-circle arc between the bias
4340
+ # position specified and the result. `Distance` will be returned only
4341
+ # if a bias position was specified in the query.
4342
+ #
4343
+ # <note markdown="1"> A great-circle arc is the shortest path on a sphere, in this case
4344
+ # the Earth. This returns the shortest distance between two locations.
4345
+ #
4346
+ # </note>
4347
+ # @return [Float]
4295
4348
  #
4296
4349
  # @!attribute [rw] place
4297
- # Contains details about the relevant point of interest.
4350
+ # Details about the search result, such as its address and position.
4298
4351
  # @return [Types::Place]
4299
4352
  #
4353
+ # @!attribute [rw] relevance
4354
+ # The relative confidence in the match for a result among the results
4355
+ # returned. For example, if more fields for an address match
4356
+ # (including house number, street, city, country/region, and postal
4357
+ # code), the relevance score is closer to 1.
4358
+ #
4359
+ # Returned only when the partner selected is Esri.
4360
+ # @return [Float]
4361
+ #
4300
4362
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchForTextResult AWS API Documentation
4301
4363
  #
4302
4364
  class SearchForTextResult < Struct.new(
4303
- :place)
4365
+ :distance,
4366
+ :place,
4367
+ :relevance)
4304
4368
  SENSITIVE = []
4305
4369
  include Aws::Structure
4306
4370
  end
@@ -4310,6 +4374,7 @@ module Aws::LocationService
4310
4374
  #
4311
4375
  # {
4312
4376
  # index_name: "ResourceName", # required
4377
+ # language: "LanguageTag",
4313
4378
  # max_results: 1,
4314
4379
  # position: [1.0], # required
4315
4380
  # }
@@ -4318,28 +4383,43 @@ module Aws::LocationService
4318
4383
  # The name of the place index resource you want to use for the search.
4319
4384
  # @return [String]
4320
4385
  #
4386
+ # @!attribute [rw] language
4387
+ # The preferred language used to return results. The value must be a
4388
+ # valid [BCP 47][1] language tag, for example, `en` for English.
4389
+ #
4390
+ # This setting affects the languages used in the results. It does not
4391
+ # change which results are returned. If the language is not specified,
4392
+ # or not supported for a particular result, the partner automatically
4393
+ # chooses a language for the result.
4394
+ #
4395
+ #
4396
+ #
4397
+ # [1]: https://tools.ietf.org/search/bcp47
4398
+ # @return [String]
4399
+ #
4321
4400
  # @!attribute [rw] max_results
4322
- # An optional paramer. The maximum number of results returned per
4401
+ # An optional parameter. The maximum number of results returned per
4323
4402
  # request.
4324
4403
  #
4325
4404
  # Default value: `50`
4326
4405
  # @return [Integer]
4327
4406
  #
4328
4407
  # @!attribute [rw] position
4329
- # Specifies a coordinate for the query defined by a longitude, and
4330
- # latitude.
4331
- #
4332
- # * The first position is the X coordinate, or longitude.
4408
+ # Specifies the longitude and latitude of the position to query.
4333
4409
  #
4334
- # * The second position is the Y coordinate, or latitude.
4410
+ # This parameter must contain a pair of numbers. The first number
4411
+ # represents the X coordinate, or longitude; the second number
4412
+ # represents the Y coordinate, or latitude.
4335
4413
  #
4336
- # For example, `position=xLongitude&position=yLatitude` .
4414
+ # For example, `[-123.1174, 49.2847]` represents a position with
4415
+ # longitude `-123.1174` and latitude `49.2847`.
4337
4416
  # @return [Array<Float>]
4338
4417
  #
4339
4418
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForPositionRequest AWS API Documentation
4340
4419
  #
4341
4420
  class SearchPlaceIndexForPositionRequest < Struct.new(
4342
4421
  :index_name,
4422
+ :language,
4343
4423
  :max_results,
4344
4424
  :position)
4345
4425
  SENSITIVE = [:position]
@@ -4352,7 +4432,9 @@ module Aws::LocationService
4352
4432
  # @return [Array<Types::SearchForPositionResult>]
4353
4433
  #
4354
4434
  # @!attribute [rw] summary
4355
- # Contains a summary of the request.
4435
+ # Contains a summary of the request. Echoes the input values for
4436
+ # `Position`, `Language`, `MaxResults`, and the `DataSource` of the
4437
+ # place index.
4356
4438
  # @return [Types::SearchPlaceIndexForPositionSummary]
4357
4439
  #
4358
4440
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForPositionResponse AWS API Documentation
@@ -4364,18 +4446,17 @@ module Aws::LocationService
4364
4446
  include Aws::Structure
4365
4447
  end
4366
4448
 
4367
- # A summary of the reverse geocoding request sent using
4368
- # `SearchPlaceIndexForPosition`.
4449
+ # A summary of the request sent by using `SearchPlaceIndexForPosition`.
4369
4450
  #
4370
4451
  # @!attribute [rw] data_source
4371
- # The data provider of geospatial data. Indicates one of the available
4372
- # providers:
4452
+ # The geospatial data provider attached to the place index resource
4453
+ # specified in the request. Values can be one of the following:
4373
4454
  #
4374
4455
  # * Esri
4375
4456
  #
4376
- # * HERE
4457
+ # * Here
4377
4458
  #
4378
- # For additional details on data providers, see [Amazon Location
4459
+ # For more information about data providers, see [Amazon Location
4379
4460
  # Service data providers][1].
4380
4461
  #
4381
4462
  #
@@ -4383,21 +4464,32 @@ module Aws::LocationService
4383
4464
  # [1]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
4384
4465
  # @return [String]
4385
4466
  #
4467
+ # @!attribute [rw] language
4468
+ # The preferred language used to return results. Matches the language
4469
+ # in the request. The value is a valid [BCP 47][1] language tag, for
4470
+ # example, `en` for English.
4471
+ #
4472
+ #
4473
+ #
4474
+ # [1]: https://tools.ietf.org/search/bcp47
4475
+ # @return [String]
4476
+ #
4386
4477
  # @!attribute [rw] max_results
4387
- # An optional parameter. The maximum number of results returned per
4478
+ # Contains the optional result count limit that is specified in the
4388
4479
  # request.
4389
4480
  #
4390
4481
  # Default value: `50`
4391
4482
  # @return [Integer]
4392
4483
  #
4393
4484
  # @!attribute [rw] position
4394
- # The position given in the reverse geocoding request.
4485
+ # The position specified in the request.
4395
4486
  # @return [Array<Float>]
4396
4487
  #
4397
4488
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForPositionSummary AWS API Documentation
4398
4489
  #
4399
4490
  class SearchPlaceIndexForPositionSummary < Struct.new(
4400
4491
  :data_source,
4492
+ :language,
4401
4493
  :max_results,
4402
4494
  :position)
4403
4495
  SENSITIVE = [:position]
@@ -4412,52 +4504,56 @@ module Aws::LocationService
4412
4504
  # filter_b_box: [1.0],
4413
4505
  # filter_countries: ["CountryCode"],
4414
4506
  # index_name: "ResourceName", # required
4507
+ # language: "LanguageTag",
4415
4508
  # max_results: 1,
4416
4509
  # text: "SyntheticSearchPlaceIndexForTextRequestString", # required
4417
4510
  # }
4418
4511
  #
4419
4512
  # @!attribute [rw] bias_position
4420
- # Searches for results closest to the given position. An optional
4421
- # parameter defined by longitude, and latitude.
4513
+ # An optional parameter that indicates a preference for places that
4514
+ # are closer to a specified position.
4422
4515
  #
4423
- # * The first `bias` position is the X coordinate, or longitude.
4516
+ # If provided, this parameter must contain a pair of numbers. The
4517
+ # first number represents the X coordinate, or longitude; the second
4518
+ # number represents the Y coordinate, or latitude.
4424
4519
  #
4425
- # * The second `bias` position is the Y coordinate, or latitude.
4520
+ # For example, `[-123.1174, 49.2847]` represents the position with
4521
+ # longitude `-123.1174` and latitude `49.2847`.
4426
4522
  #
4427
- # For example, `bias=xLongitude&bias=yLatitude`.
4523
+ # <note markdown="1"> `BiasPosition` and `FilterBBox` are mutually exclusive. Specifying
4524
+ # both options results in an error.
4525
+ #
4526
+ # </note>
4428
4527
  # @return [Array<Float>]
4429
4528
  #
4430
4529
  # @!attribute [rw] filter_b_box
4431
- # Filters the results by returning only Places within the provided
4432
- # bounding box. An optional parameter.
4530
+ # An optional parameter that limits the search results by returning
4531
+ # only places that are within the provided bounding box.
4433
4532
  #
4434
- # The first 2 `bbox` parameters describe the lower southwest corner:
4435
- #
4436
- # * The first `bbox` position is the X coordinate or longitude of the
4437
- # lower southwest corner.
4533
+ # If provided, this parameter must contain a total of four consecutive
4534
+ # numbers in two pairs. The first pair of numbers represents the X and
4535
+ # Y coordinates (longitude and latitude, respectively) of the
4536
+ # southwest corner of the bounding box; the second pair of numbers
4537
+ # represents the X and Y coordinates (longitude and latitude,
4538
+ # respectively) of the northeast corner of the bounding box.
4438
4539
  #
4439
- # * The second `bbox` position is the Y coordinate or latitude of the
4440
- # lower southwest corner.
4441
- #
4442
- # For example, `bbox=xLongitudeSW&bbox=yLatitudeSW`.
4443
- #
4444
- # The next `bbox` parameters describe the upper northeast corner:
4445
- #
4446
- # * The third `bbox` position is the X coordinate, or longitude of the
4447
- # upper northeast corner.
4540
+ # For example, `[-12.7935, -37.4835, -12.0684, -36.9542]` represents a
4541
+ # bounding box where the southwest corner has longitude `-12.7935` and
4542
+ # latitude `-37.4835`, and the northeast corner has longitude
4543
+ # `-12.0684` and latitude `-36.9542`.
4448
4544
  #
4449
- # * The fourth `bbox` position is the Y coordinate, or longitude of
4450
- # the upper northeast corner.
4545
+ # <note markdown="1"> `FilterBBox` and `BiasPosition` are mutually exclusive. Specifying
4546
+ # both options results in an error.
4451
4547
  #
4452
- # For example, `bbox=xLongitudeNE&bbox=yLatitudeNE`
4548
+ # </note>
4453
4549
  # @return [Array<Float>]
4454
4550
  #
4455
4551
  # @!attribute [rw] filter_countries
4456
- # Limits the search to the given a list of countries/regions. An
4457
- # optional parameter.
4552
+ # An optional parameter that limits the search results by returning
4553
+ # only places that are in a specified list of countries.
4458
4554
  #
4459
- # * Use the [ISO 3166][1] 3-digit country code. For example, Australia
4460
- # uses three upper-case characters: `AUS`.
4555
+ # * Valid values include [ISO 3166][1] 3-digit country codes. For
4556
+ # example, Australia uses three upper-case characters: `AUS`.
4461
4557
  #
4462
4558
  # ^
4463
4559
  #
@@ -4470,6 +4566,20 @@ module Aws::LocationService
4470
4566
  # The name of the place index resource you want to use for the search.
4471
4567
  # @return [String]
4472
4568
  #
4569
+ # @!attribute [rw] language
4570
+ # The preferred language used to return results. The value must be a
4571
+ # valid [BCP 47][1] language tag, for example, `en` for English.
4572
+ #
4573
+ # This setting affects the languages used in the results. It does not
4574
+ # change which results are returned. If the language is not specified,
4575
+ # or not supported for a particular result, the partner automatically
4576
+ # chooses a language for the result.
4577
+ #
4578
+ #
4579
+ #
4580
+ # [1]: https://tools.ietf.org/search/bcp47
4581
+ # @return [String]
4582
+ #
4473
4583
  # @!attribute [rw] max_results
4474
4584
  # An optional parameter. The maximum number of results returned per
4475
4585
  # request.
@@ -4478,7 +4588,7 @@ module Aws::LocationService
4478
4588
  # @return [Integer]
4479
4589
  #
4480
4590
  # @!attribute [rw] text
4481
- # The address, name, city, or region to be used in the search. In
4591
+ # The address, name, city, or region to be used in the search in
4482
4592
  # free-form text format. For example, `123 Any Street`.
4483
4593
  # @return [String]
4484
4594
  #
@@ -4489,6 +4599,7 @@ module Aws::LocationService
4489
4599
  :filter_b_box,
4490
4600
  :filter_countries,
4491
4601
  :index_name,
4602
+ :language,
4492
4603
  :max_results,
4493
4604
  :text)
4494
4605
  SENSITIVE = [:bias_position, :filter_b_box, :text]
@@ -4496,15 +4607,16 @@ module Aws::LocationService
4496
4607
  end
4497
4608
 
4498
4609
  # @!attribute [rw] results
4499
- # A list of Places closest to the specified position. Each result
4500
- # contains additional information about the specific point of
4501
- # interest.
4610
+ # A list of Places matching the input text. Each result contains
4611
+ # additional information about the specific point of interest.
4502
4612
  # @return [Array<Types::SearchForTextResult>]
4503
4613
  #
4504
4614
  # @!attribute [rw] summary
4505
- # Contains a summary of the request. Contains the `BiasPosition`,
4506
- # `DataSource`, `FilterBBox`, `FilterCountries`, `MaxResults`,
4507
- # `ResultBBox`, and `Text`.
4615
+ # Contains a summary of the request. Echoes the input values for
4616
+ # `BiasPosition`, `FilterBBox`, `FilterCountries`, `Language`,
4617
+ # `MaxResults`, and `Text`. Also includes the `DataSource` of the
4618
+ # place index and the bounding box, `ResultBBox`, which surrounds the
4619
+ # search results.
4508
4620
  # @return [Types::SearchPlaceIndexForTextSummary]
4509
4621
  #
4510
4622
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForTextResponse AWS API Documentation
@@ -4516,23 +4628,22 @@ module Aws::LocationService
4516
4628
  include Aws::Structure
4517
4629
  end
4518
4630
 
4519
- # A summary of the geocoding request sent using
4520
- # `SearchPlaceIndexForText`.
4631
+ # A summary of the request sent by using `SearchPlaceIndexForText`.
4521
4632
  #
4522
4633
  # @!attribute [rw] bias_position
4523
- # Contains the coordinates for the bias position entered in the
4524
- # geocoding request.
4634
+ # Contains the coordinates for the optional bias position specified in
4635
+ # the request.
4525
4636
  # @return [Array<Float>]
4526
4637
  #
4527
4638
  # @!attribute [rw] data_source
4528
- # The data provider of geospatial data. Indicates one of the available
4529
- # providers:
4639
+ # The geospatial data provider attached to the place index resource
4640
+ # specified in the request. Values can be one of the following:
4530
4641
  #
4531
4642
  # * Esri
4532
4643
  #
4533
- # * HERE
4644
+ # * Here
4534
4645
  #
4535
- # For additional details on data providers, see [Amazon Location
4646
+ # For more information about data providers, see [Amazon Location
4536
4647
  # Service data providers][1].
4537
4648
  #
4538
4649
  #
@@ -4541,27 +4652,39 @@ module Aws::LocationService
4541
4652
  # @return [String]
4542
4653
  #
4543
4654
  # @!attribute [rw] filter_b_box
4544
- # Contains the coordinates for the optional bounding box coordinated
4545
- # entered in the geocoding request.
4655
+ # Contains the coordinates for the optional bounding box specified in
4656
+ # the request.
4546
4657
  # @return [Array<Float>]
4547
4658
  #
4548
4659
  # @!attribute [rw] filter_countries
4549
- # Contains the country filter entered in the geocoding request.
4660
+ # Contains the optional country filter specified in the request.
4550
4661
  # @return [Array<String>]
4551
4662
  #
4663
+ # @!attribute [rw] language
4664
+ # The preferred language used to return results. Matches the language
4665
+ # in the request. The value is a valid [BCP 47][1] language tag, for
4666
+ # example, `en` for English.
4667
+ #
4668
+ #
4669
+ #
4670
+ # [1]: https://tools.ietf.org/search/bcp47
4671
+ # @return [String]
4672
+ #
4552
4673
  # @!attribute [rw] max_results
4553
- # Contains the maximum number of results indicated for the request.
4674
+ # Contains the optional result count limit specified in the request.
4554
4675
  # @return [Integer]
4555
4676
  #
4556
4677
  # @!attribute [rw] result_b_box
4557
- # A bounding box that contains the search results within the specified
4558
- # area indicated by `FilterBBox`. A subset of bounding box specified
4559
- # using `FilterBBox`.
4678
+ # The bounding box that fully contains all search results.
4679
+ #
4680
+ # <note markdown="1"> If you specified the optional `FilterBBox` parameter in the request,
4681
+ # `ResultBBox` is contained within `FilterBBox`.
4682
+ #
4683
+ # </note>
4560
4684
  # @return [Array<Float>]
4561
4685
  #
4562
4686
  # @!attribute [rw] text
4563
- # The address, name, city or region to be used in the geocoding
4564
- # request. In free-form text format. For example, `Vancouver`.
4687
+ # The search text specified in the request.
4565
4688
  # @return [String]
4566
4689
  #
4567
4690
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForTextSummary AWS API Documentation
@@ -4571,6 +4694,7 @@ module Aws::LocationService
4571
4694
  :data_source,
4572
4695
  :filter_b_box,
4573
4696
  :filter_countries,
4697
+ :language,
4574
4698
  :max_results,
4575
4699
  :result_b_box,
4576
4700
  :text)
@@ -4666,12 +4790,27 @@ module Aws::LocationService
4666
4790
  # @return [String]
4667
4791
  #
4668
4792
  # @!attribute [rw] tags
4669
- # Tags that have been applied to the specified resource. Tags are
4670
- # mapped from the tag key to the tag value: `"TagKey" : "TagValue"`.
4793
+ # Applies one or more tags to specific resource. A tag is a key-value
4794
+ # pair that helps you manage, identify, search, and filter your
4795
+ # resources.
4671
4796
  #
4672
- # * Format example: `\{"tag1" : "value1", "tag2" : "value2"\} `
4797
+ # Format: `"key" : "value"`
4673
4798
  #
4674
- # ^
4799
+ # Restrictions:
4800
+ #
4801
+ # * Maximum 50 tags per resource.
4802
+ #
4803
+ # * Each tag key must be unique and must have exactly one associated
4804
+ # value.
4805
+ #
4806
+ # * Maximum key length: 128 Unicode characters in UTF-8.
4807
+ #
4808
+ # * Maximum value length: 256 Unicode characters in UTF-8.
4809
+ #
4810
+ # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
4811
+ # characters: + - = . \_ : / @
4812
+ #
4813
+ # * Cannot use "aws:" as a prefix for a key.
4675
4814
  # @return [Hash<String,String>]
4676
4815
  #
4677
4816
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/TagResourceRequest AWS API Documentation
@@ -4700,6 +4839,31 @@ module Aws::LocationService
4700
4839
  include Aws::Structure
4701
4840
  end
4702
4841
 
4842
+ # Information about a time zone. Includes the name of the time zone and
4843
+ # the offset from UTC in seconds.
4844
+ #
4845
+ # @!attribute [rw] name
4846
+ # The name of the time zone, following the [ IANA time zone
4847
+ # standard][1]. For example, `America/Los_Angeles`.
4848
+ #
4849
+ #
4850
+ #
4851
+ # [1]: https://www.iana.org/time-zones
4852
+ # @return [String]
4853
+ #
4854
+ # @!attribute [rw] offset
4855
+ # The time zone's offset, in seconds, from UTC.
4856
+ # @return [Integer]
4857
+ #
4858
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/TimeZone AWS API Documentation
4859
+ #
4860
+ class TimeZone < Struct.new(
4861
+ :name,
4862
+ :offset)
4863
+ SENSITIVE = []
4864
+ include Aws::Structure
4865
+ end
4866
+
4703
4867
  # Contains details about the truck dimensions in the unit of measurement
4704
4868
  # that you specify. Used to filter out roads that can't support or
4705
4869
  # allow the specified dimensions for requests that specify `TravelMode`
@@ -5149,7 +5313,7 @@ module Aws::LocationService
5149
5313
  #
5150
5314
  # {
5151
5315
  # description: "ResourceDescription",
5152
- # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased
5316
+ # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
5153
5317
  # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
5154
5318
  # pricing_plan_data_source: "String",
5155
5319
  # tracker_name: "ResourceName", # required