aws-sdk-locationservice 1.28.0 → 1.30.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -384,7 +384,7 @@ module Aws::LocationService
384
384
  # @option params [required, String] :consumer_arn
385
385
  # The Amazon Resource Name (ARN) for the geofence collection to be
386
386
  # associated to tracker resource. Used when you need to specify a
387
- # resource across all AWS.
387
+ # resource across all Amazon Web Services.
388
388
  #
389
389
  # * Format example:
390
390
  # `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer`
@@ -1284,8 +1284,8 @@ module Aws::LocationService
1284
1284
  # An optional description for the geofence collection.
1285
1285
  #
1286
1286
  # @option params [String] :kms_key_id
1287
- # A key identifier for an [AWS KMS customer managed key][1]. Enter a key
1288
- # ID, key ARN, alias name, or alias ARN.
1287
+ # A key identifier for an [Amazon Web Services KMS customer managed
1288
+ # key][1]. Enter a key ID, key ARN, alias name, or alias ARN.
1289
1289
  #
1290
1290
  #
1291
1291
  #
@@ -1354,13 +1354,119 @@ module Aws::LocationService
1354
1354
  req.send_request(options)
1355
1355
  end
1356
1356
 
1357
- # Creates a map resource in your AWS account, which provides map tiles
1358
- # of different styles sourced from global location data providers.
1357
+ # Creates an API key resource in your Amazon Web Services account, which
1358
+ # lets you grant `geo:GetMap*` actions for Amazon Location Map resources
1359
+ # to the API key bearer.
1360
+ #
1361
+ # The API keys feature is in preview. We may add, change, or remove
1362
+ # features before announcing general availability. For more information,
1363
+ # see [Using API keys][1].
1364
+ #
1365
+ #
1366
+ #
1367
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
1368
+ #
1369
+ # @option params [String] :description
1370
+ # An optional description for the API key resource.
1371
+ #
1372
+ # @option params [Time,DateTime,Date,Integer,String] :expire_time
1373
+ # The optional timestamp for when the API key resource will expire in [
1374
+ # ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. One of `NoExpiry` or
1375
+ # `ExpireTime` must be set.
1376
+ #
1377
+ #
1378
+ #
1379
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
1380
+ #
1381
+ # @option params [required, String] :key_name
1382
+ # A custom name for the API key resource.
1383
+ #
1384
+ # Requirements:
1385
+ #
1386
+ # * Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-),
1387
+ # periods (.), and underscores (\_).
1388
+ #
1389
+ # * Must be a unique API key name.
1390
+ #
1391
+ # * No spaces allowed. For example, `ExampleAPIKey`.
1392
+ #
1393
+ # @option params [Boolean] :no_expiry
1394
+ # Optionally set to `true` to set no expiration time for the API key.
1395
+ # One of `NoExpiry` or `ExpireTime` must be set.
1396
+ #
1397
+ # @option params [required, Types::ApiKeyRestrictions] :restrictions
1398
+ # The API key restrictions for the API key resource.
1399
+ #
1400
+ # @option params [Hash<String,String>] :tags
1401
+ # Applies one or more tags to the map resource. A tag is a key-value
1402
+ # pair that helps manage, identify, search, and filter your resources by
1403
+ # labelling them.
1404
+ #
1405
+ # Format: `"key" : "value"`
1406
+ #
1407
+ # Restrictions:
1408
+ #
1409
+ # * Maximum 50 tags per resource
1410
+ #
1411
+ # * Each resource tag must be unique with a maximum of one value.
1412
+ #
1413
+ # * Maximum key length: 128 Unicode characters in UTF-8
1414
+ #
1415
+ # * Maximum value length: 256 Unicode characters in UTF-8
1416
+ #
1417
+ # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
1418
+ # characters: + - = . \_ : / @.
1419
+ #
1420
+ # * Cannot use "aws:" as a prefix for a key.
1421
+ #
1422
+ # @return [Types::CreateKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1423
+ #
1424
+ # * {Types::CreateKeyResponse#create_time #create_time} => Time
1425
+ # * {Types::CreateKeyResponse#key #key} => String
1426
+ # * {Types::CreateKeyResponse#key_arn #key_arn} => String
1427
+ # * {Types::CreateKeyResponse#key_name #key_name} => String
1428
+ #
1429
+ # @example Request syntax with placeholder values
1430
+ #
1431
+ # resp = client.create_key({
1432
+ # description: "ResourceDescription",
1433
+ # expire_time: Time.now,
1434
+ # key_name: "ResourceName", # required
1435
+ # no_expiry: false,
1436
+ # restrictions: { # required
1437
+ # allow_actions: ["ApiKeyAction"], # required
1438
+ # allow_referers: ["RefererPattern"],
1439
+ # allow_resources: ["GeoArn"], # required
1440
+ # },
1441
+ # tags: {
1442
+ # "TagKey" => "TagValue",
1443
+ # },
1444
+ # })
1445
+ #
1446
+ # @example Response structure
1447
+ #
1448
+ # resp.create_time #=> Time
1449
+ # resp.key #=> String
1450
+ # resp.key_arn #=> String
1451
+ # resp.key_name #=> String
1452
+ #
1453
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateKey AWS API Documentation
1454
+ #
1455
+ # @overload create_key(params = {})
1456
+ # @param [Hash] params ({})
1457
+ def create_key(params = {}, options = {})
1458
+ req = build_request(:create_key, params)
1459
+ req.send_request(options)
1460
+ end
1461
+
1462
+ # Creates a map resource in your Amazon Web Services account, which
1463
+ # provides map tiles of different styles sourced from global location
1464
+ # data providers.
1359
1465
  #
1360
1466
  # <note markdown="1"> If your application is tracking or routing assets you use in your
1361
1467
  # business, such as delivery vehicles or employees, you must not use
1362
- # Esri as your geolocation provider. See section 82 of the [AWS service
1363
- # terms][1] for more details.
1468
+ # Esri as your geolocation provider. See section 82 of the [Amazon Web
1469
+ # Services service terms][1] for more details.
1364
1470
  #
1365
1471
  # </note>
1366
1472
  #
@@ -1449,17 +1555,17 @@ module Aws::LocationService
1449
1555
  req.send_request(options)
1450
1556
  end
1451
1557
 
1452
- # Creates a place index resource in your AWS account. Use a place index
1453
- # resource to geocode addresses and other text queries by using the
1454
- # `SearchPlaceIndexForText` operation, and reverse geocode coordinates
1455
- # by using the `SearchPlaceIndexForPosition` operation, and enable
1456
- # autosuggestions by using the `SearchPlaceIndexForSuggestions`
1558
+ # Creates a place index resource in your Amazon Web Services account.
1559
+ # Use a place index resource to geocode addresses and other text queries
1560
+ # by using the `SearchPlaceIndexForText` operation, and reverse geocode
1561
+ # coordinates by using the `SearchPlaceIndexForPosition` operation, and
1562
+ # enable autosuggestions by using the `SearchPlaceIndexForSuggestions`
1457
1563
  # operation.
1458
1564
  #
1459
1565
  # <note markdown="1"> If your application is tracking or routing assets you use in your
1460
1566
  # business, such as delivery vehicles or employees, you must not use
1461
- # Esri as your geolocation provider. See section 82 of the [AWS service
1462
- # terms][1] for more details.
1567
+ # Esri as your geolocation provider. See section 82 of the [Amazon Web
1568
+ # Services service terms][1] for more details.
1463
1569
  #
1464
1570
  # </note>
1465
1571
  #
@@ -1491,8 +1597,8 @@ module Aws::LocationService
1491
1597
  #
1492
1598
  # If you specify HERE Technologies (`Here`) as the data provider, you
1493
1599
  # may not [store results][7] for locations in Japan. For more
1494
- # information, see the [AWS Service Terms][8] for Amazon Location
1495
- # Service.
1600
+ # information, see the [Amazon Web Services Service Terms][8] for
1601
+ # Amazon Location Service.
1496
1602
  #
1497
1603
  # For additional information , see [Data providers][9] on the *Amazon
1498
1604
  # Location Service Developer Guide*.
@@ -1506,7 +1612,7 @@ module Aws::LocationService
1506
1612
  # [5]: https://docs.aws.amazon.com/location/latest/developerguide/HERE.html
1507
1613
  # [6]: https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html
1508
1614
  # [7]: https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html
1509
- # [8]: https://aws.amazon.com/service-terms/
1615
+ # [8]: http://aws.amazon.com/service-terms/
1510
1616
  # [9]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
1511
1617
  #
1512
1618
  # @option params [Types::DataSourceConfiguration] :data_source_configuration
@@ -1590,7 +1696,8 @@ module Aws::LocationService
1590
1696
  req.send_request(options)
1591
1697
  end
1592
1698
 
1593
- # Creates a route calculator resource in your AWS account.
1699
+ # Creates a route calculator resource in your Amazon Web Services
1700
+ # account.
1594
1701
  #
1595
1702
  # You can send requests to a route calculator resource to estimate
1596
1703
  # travel time, distance, and get directions. A route calculator sources
@@ -1598,8 +1705,8 @@ module Aws::LocationService
1598
1705
  #
1599
1706
  # <note markdown="1"> If your application is tracking or routing assets you use in your
1600
1707
  # business, such as delivery vehicles or employees, you must not use
1601
- # Esri as your geolocation provider. See section 82 of the [AWS service
1602
- # terms][1] for more details.
1708
+ # Esri as your geolocation provider. See section 82 of the [Amazon Web
1709
+ # Services service terms][1] for more details.
1603
1710
  #
1604
1711
  # </note>
1605
1712
  #
@@ -1724,15 +1831,15 @@ module Aws::LocationService
1724
1831
  req.send_request(options)
1725
1832
  end
1726
1833
 
1727
- # Creates a tracker resource in your AWS account, which lets you
1728
- # retrieve current and historical location of devices.
1834
+ # Creates a tracker resource in your Amazon Web Services account, which
1835
+ # lets you retrieve current and historical location of devices.
1729
1836
  #
1730
1837
  # @option params [String] :description
1731
1838
  # An optional description for the tracker resource.
1732
1839
  #
1733
1840
  # @option params [String] :kms_key_id
1734
- # A key identifier for an [AWS KMS customer managed key][1]. Enter a key
1735
- # ID, key ARN, alias name, or alias ARN.
1841
+ # A key identifier for an [Amazon Web Services KMS customer managed
1842
+ # key][1]. Enter a key ID, key ARN, alias name, or alias ARN.
1736
1843
  #
1737
1844
  #
1738
1845
  #
@@ -1845,7 +1952,7 @@ module Aws::LocationService
1845
1952
  req.send_request(options)
1846
1953
  end
1847
1954
 
1848
- # Deletes a geofence collection from your AWS account.
1955
+ # Deletes a geofence collection from your Amazon Web Services account.
1849
1956
  #
1850
1957
  # <note markdown="1"> This operation deletes the resource permanently. If the geofence
1851
1958
  # collection is the target of a tracker resource, the devices will no
@@ -1873,7 +1980,30 @@ module Aws::LocationService
1873
1980
  req.send_request(options)
1874
1981
  end
1875
1982
 
1876
- # Deletes a map resource from your AWS account.
1983
+ # Deletes the specified API key. The API key must have been deactivated
1984
+ # more than 90 days previously.
1985
+ #
1986
+ # @option params [required, String] :key_name
1987
+ # The name of the API key to delete.
1988
+ #
1989
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1990
+ #
1991
+ # @example Request syntax with placeholder values
1992
+ #
1993
+ # resp = client.delete_key({
1994
+ # key_name: "ResourceName", # required
1995
+ # })
1996
+ #
1997
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteKey AWS API Documentation
1998
+ #
1999
+ # @overload delete_key(params = {})
2000
+ # @param [Hash] params ({})
2001
+ def delete_key(params = {}, options = {})
2002
+ req = build_request(:delete_key, params)
2003
+ req.send_request(options)
2004
+ end
2005
+
2006
+ # Deletes a map resource from your Amazon Web Services account.
1877
2007
  #
1878
2008
  # <note markdown="1"> This operation deletes the resource permanently. If the map is being
1879
2009
  # used in an application, the map may not render.
@@ -1900,7 +2030,7 @@ module Aws::LocationService
1900
2030
  req.send_request(options)
1901
2031
  end
1902
2032
 
1903
- # Deletes a place index resource from your AWS account.
2033
+ # Deletes a place index resource from your Amazon Web Services account.
1904
2034
  #
1905
2035
  # <note markdown="1"> This operation deletes the resource permanently.
1906
2036
  #
@@ -1926,7 +2056,8 @@ module Aws::LocationService
1926
2056
  req.send_request(options)
1927
2057
  end
1928
2058
 
1929
- # Deletes a route calculator resource from your AWS account.
2059
+ # Deletes a route calculator resource from your Amazon Web Services
2060
+ # account.
1930
2061
  #
1931
2062
  # <note markdown="1"> This operation deletes the resource permanently.
1932
2063
  #
@@ -1952,7 +2083,7 @@ module Aws::LocationService
1952
2083
  req.send_request(options)
1953
2084
  end
1954
2085
 
1955
- # Deletes a tracker resource from your AWS account.
2086
+ # Deletes a tracker resource from your Amazon Web Services account.
1956
2087
  #
1957
2088
  # <note markdown="1"> This operation deletes the resource permanently. If the tracker
1958
2089
  # resource is in use, you may encounter an error. Make sure that the
@@ -2025,6 +2156,64 @@ module Aws::LocationService
2025
2156
  req.send_request(options)
2026
2157
  end
2027
2158
 
2159
+ # Retrieves the API key resource details.
2160
+ #
2161
+ # The API keys feature is in preview. We may add, change, or remove
2162
+ # features before announcing general availability. For more information,
2163
+ # see [Using API keys][1].
2164
+ #
2165
+ #
2166
+ #
2167
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
2168
+ #
2169
+ # @option params [required, String] :key_name
2170
+ # The name of the API key resource.
2171
+ #
2172
+ # @return [Types::DescribeKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2173
+ #
2174
+ # * {Types::DescribeKeyResponse#create_time #create_time} => Time
2175
+ # * {Types::DescribeKeyResponse#description #description} => String
2176
+ # * {Types::DescribeKeyResponse#expire_time #expire_time} => Time
2177
+ # * {Types::DescribeKeyResponse#key #key} => String
2178
+ # * {Types::DescribeKeyResponse#key_arn #key_arn} => String
2179
+ # * {Types::DescribeKeyResponse#key_name #key_name} => String
2180
+ # * {Types::DescribeKeyResponse#restrictions #restrictions} => Types::ApiKeyRestrictions
2181
+ # * {Types::DescribeKeyResponse#tags #tags} => Hash&lt;String,String&gt;
2182
+ # * {Types::DescribeKeyResponse#update_time #update_time} => Time
2183
+ #
2184
+ # @example Request syntax with placeholder values
2185
+ #
2186
+ # resp = client.describe_key({
2187
+ # key_name: "ResourceName", # required
2188
+ # })
2189
+ #
2190
+ # @example Response structure
2191
+ #
2192
+ # resp.create_time #=> Time
2193
+ # resp.description #=> String
2194
+ # resp.expire_time #=> Time
2195
+ # resp.key #=> String
2196
+ # resp.key_arn #=> String
2197
+ # resp.key_name #=> String
2198
+ # resp.restrictions.allow_actions #=> Array
2199
+ # resp.restrictions.allow_actions[0] #=> String
2200
+ # resp.restrictions.allow_referers #=> Array
2201
+ # resp.restrictions.allow_referers[0] #=> String
2202
+ # resp.restrictions.allow_resources #=> Array
2203
+ # resp.restrictions.allow_resources[0] #=> String
2204
+ # resp.tags #=> Hash
2205
+ # resp.tags["TagKey"] #=> String
2206
+ # resp.update_time #=> Time
2207
+ #
2208
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeKey AWS API Documentation
2209
+ #
2210
+ # @overload describe_key(params = {})
2211
+ # @param [Hash] params ({})
2212
+ def describe_key(params = {}, options = {})
2213
+ req = build_request(:describe_key, params)
2214
+ req.send_request(options)
2215
+ end
2216
+
2028
2217
  # Retrieves the map resource details.
2029
2218
  #
2030
2219
  # @option params [required, String] :map_name
@@ -2217,7 +2406,7 @@ module Aws::LocationService
2217
2406
  # @option params [required, String] :consumer_arn
2218
2407
  # The Amazon Resource Name (ARN) for the geofence collection to be
2219
2408
  # disassociated from the tracker resource. Used when you need to specify
2220
- # a resource across all AWS.
2409
+ # a resource across all Amazon Web Services.
2221
2410
  #
2222
2411
  # * Format example:
2223
2412
  # `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer`
@@ -2478,19 +2667,21 @@ module Aws::LocationService
2478
2667
  #
2479
2668
  # ^
2480
2669
  #
2481
- # Valid font stacks for [Open Data (Preview)][4] styles:
2670
+ # Valid font stacks for [Open Data][4] styles:
2482
2671
  #
2483
- # * VectorOpenDataStandardLight – `Amazon Ember Regular,Noto Sans
2484
- # Regular` \| `Amazon Ember Bold,Noto Sans Bold` \| `Amazon Ember
2485
- # Medium,Noto Sans Medium` \| `Amazon Ember Regular Italic,Noto Sans
2486
- # Italic` \| `Amazon Ember Condensed RC Regular,Noto Sans Regular` \|
2487
- # `Amazon Ember Condensed RC Bold,Noto Sans Bold`
2672
+ # * VectorOpenDataStandardLight, VectorOpenDataStandardDark,
2673
+ # VectorOpenDataVisualizationLight, VectorOpenDataVisualizationDark
2674
+ # `Amazon Ember Regular,Noto Sans Regular` \| `Amazon Ember Bold,Noto
2675
+ # Sans Bold` \| `Amazon Ember Medium,Noto Sans Medium` \| `Amazon
2676
+ # Ember Regular Italic,Noto Sans Italic` \| `Amazon Ember Condensed RC
2677
+ # Regular,Noto Sans Regular` \| `Amazon Ember Condensed RC Bold,Noto
2678
+ # Sans Bold`
2488
2679
  #
2489
2680
  # ^
2490
2681
  #
2491
- # <note markdown="1"> The fonts used by `VectorOpenDataStandardLight` are combined fonts
2492
- # that use `Amazon Ember` for most glyphs but `Noto Sans` for glyphs
2493
- # unsupported by `Amazon Ember`.
2682
+ # <note markdown="1"> The fonts used by the Open Data map styles are combined fonts that use
2683
+ # `Amazon Ember` for most glyphs but `Noto Sans` for glyphs unsupported
2684
+ # by `Amazon Ember`.
2494
2685
  #
2495
2686
  # </note>
2496
2687
  #
@@ -2507,12 +2698,20 @@ module Aws::LocationService
2507
2698
  # characters from range `U+0000` to `00FF`. Must be aligned to multiples
2508
2699
  # of 256.
2509
2700
  #
2701
+ # @option params [String] :key
2702
+ # The optional [API key][1] to authorize the request.
2703
+ #
2704
+ #
2705
+ #
2706
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
2707
+ #
2510
2708
  # @option params [required, String] :map_name
2511
2709
  # The map resource associated with the glyph file.
2512
2710
  #
2513
2711
  # @return [Types::GetMapGlyphsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2514
2712
  #
2515
2713
  # * {Types::GetMapGlyphsResponse#blob #blob} => IO
2714
+ # * {Types::GetMapGlyphsResponse#cache_control #cache_control} => String
2516
2715
  # * {Types::GetMapGlyphsResponse#content_type #content_type} => String
2517
2716
  #
2518
2717
  # @example Request syntax with placeholder values
@@ -2520,12 +2719,14 @@ module Aws::LocationService
2520
2719
  # resp = client.get_map_glyphs({
2521
2720
  # font_stack: "String", # required
2522
2721
  # font_unicode_range: "GetMapGlyphsRequestFontUnicodeRangeString", # required
2722
+ # key: "ApiKey",
2523
2723
  # map_name: "ResourceName", # required
2524
2724
  # })
2525
2725
  #
2526
2726
  # @example Response structure
2527
2727
  #
2528
2728
  # resp.blob #=> IO
2729
+ # resp.cache_control #=> String
2529
2730
  # resp.content_type #=> String
2530
2731
  #
2531
2732
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapGlyphs AWS API Documentation
@@ -2556,24 +2757,34 @@ module Aws::LocationService
2556
2757
  #
2557
2758
  # * `sprites@2x.json` for high pixel density displays
2558
2759
  #
2760
+ # @option params [String] :key
2761
+ # The optional [API key][1] to authorize the request.
2762
+ #
2763
+ #
2764
+ #
2765
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
2766
+ #
2559
2767
  # @option params [required, String] :map_name
2560
2768
  # The map resource associated with the sprite file.
2561
2769
  #
2562
2770
  # @return [Types::GetMapSpritesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2563
2771
  #
2564
2772
  # * {Types::GetMapSpritesResponse#blob #blob} => IO
2773
+ # * {Types::GetMapSpritesResponse#cache_control #cache_control} => String
2565
2774
  # * {Types::GetMapSpritesResponse#content_type #content_type} => String
2566
2775
  #
2567
2776
  # @example Request syntax with placeholder values
2568
2777
  #
2569
2778
  # resp = client.get_map_sprites({
2570
2779
  # file_name: "GetMapSpritesRequestFileNameString", # required
2780
+ # key: "ApiKey",
2571
2781
  # map_name: "ResourceName", # required
2572
2782
  # })
2573
2783
  #
2574
2784
  # @example Response structure
2575
2785
  #
2576
2786
  # resp.blob #=> IO
2787
+ # resp.cache_control #=> String
2577
2788
  # resp.content_type #=> String
2578
2789
  #
2579
2790
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapSprites AWS API Documentation
@@ -2592,23 +2803,33 @@ module Aws::LocationService
2592
2803
  # data in, and the style for the data. Style descriptors follow the
2593
2804
  # Mapbox Style Specification.
2594
2805
  #
2806
+ # @option params [String] :key
2807
+ # The optional [API key][1] to authorize the request.
2808
+ #
2809
+ #
2810
+ #
2811
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
2812
+ #
2595
2813
  # @option params [required, String] :map_name
2596
2814
  # The map resource to retrieve the style descriptor from.
2597
2815
  #
2598
2816
  # @return [Types::GetMapStyleDescriptorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2599
2817
  #
2600
2818
  # * {Types::GetMapStyleDescriptorResponse#blob #blob} => IO
2819
+ # * {Types::GetMapStyleDescriptorResponse#cache_control #cache_control} => String
2601
2820
  # * {Types::GetMapStyleDescriptorResponse#content_type #content_type} => String
2602
2821
  #
2603
2822
  # @example Request syntax with placeholder values
2604
2823
  #
2605
2824
  # resp = client.get_map_style_descriptor({
2825
+ # key: "ApiKey",
2606
2826
  # map_name: "ResourceName", # required
2607
2827
  # })
2608
2828
  #
2609
2829
  # @example Response structure
2610
2830
  #
2611
2831
  # resp.blob #=> IO
2832
+ # resp.cache_control #=> String
2612
2833
  # resp.content_type #=> String
2613
2834
  #
2614
2835
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapStyleDescriptor AWS API Documentation
@@ -2629,6 +2850,13 @@ module Aws::LocationService
2629
2850
  # data for the entire world at (0/0/0) will be split into 4 tiles at
2630
2851
  # zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).
2631
2852
  #
2853
+ # @option params [String] :key
2854
+ # The optional [API key][1] to authorize the request.
2855
+ #
2856
+ #
2857
+ #
2858
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
2859
+ #
2632
2860
  # @option params [required, String] :map_name
2633
2861
  # The map resource to retrieve the map tiles from.
2634
2862
  #
@@ -2644,11 +2872,13 @@ module Aws::LocationService
2644
2872
  # @return [Types::GetMapTileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2645
2873
  #
2646
2874
  # * {Types::GetMapTileResponse#blob #blob} => IO
2875
+ # * {Types::GetMapTileResponse#cache_control #cache_control} => String
2647
2876
  # * {Types::GetMapTileResponse#content_type #content_type} => String
2648
2877
  #
2649
2878
  # @example Request syntax with placeholder values
2650
2879
  #
2651
2880
  # resp = client.get_map_tile({
2881
+ # key: "ApiKey",
2652
2882
  # map_name: "ResourceName", # required
2653
2883
  # x: "GetMapTileRequestXString", # required
2654
2884
  # y: "GetMapTileRequestYString", # required
@@ -2658,6 +2888,7 @@ module Aws::LocationService
2658
2888
  # @example Response structure
2659
2889
  #
2660
2890
  # resp.blob #=> IO
2891
+ # resp.cache_control #=> String
2661
2892
  # resp.content_type #=> String
2662
2893
  #
2663
2894
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapTile AWS API Documentation
@@ -2675,9 +2906,9 @@ module Aws::LocationService
2675
2906
  # <note markdown="1"> A PlaceId is valid only if all of the following are the same in the
2676
2907
  # original search request and the call to `GetPlace`.
2677
2908
  #
2678
- # * Customer AWS account
2909
+ # * Customer Amazon Web Services account
2679
2910
  #
2680
- # * AWS Region
2911
+ # * Amazon Web Services Region
2681
2912
  #
2682
2913
  # * Data provider specified in the place index resource
2683
2914
  #
@@ -2806,7 +3037,7 @@ module Aws::LocationService
2806
3037
  req.send_request(options)
2807
3038
  end
2808
3039
 
2809
- # Lists geofence collections in your AWS account.
3040
+ # Lists geofence collections in your Amazon Web Services account.
2810
3041
  #
2811
3042
  # @option params [Integer] :max_results
2812
3043
  # An optional limit for the number of resources returned in a single
@@ -2911,7 +3142,74 @@ module Aws::LocationService
2911
3142
  req.send_request(options)
2912
3143
  end
2913
3144
 
2914
- # Lists map resources in your AWS account.
3145
+ # Lists API key resources in your Amazon Web Services account.
3146
+ #
3147
+ # The API keys feature is in preview. We may add, change, or remove
3148
+ # features before announcing general availability. For more information,
3149
+ # see [Using API keys][1].
3150
+ #
3151
+ #
3152
+ #
3153
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
3154
+ #
3155
+ # @option params [Types::ApiKeyFilter] :filter
3156
+ # Optionally filter the list to only `Active` or `Expired` API keys.
3157
+ #
3158
+ # @option params [Integer] :max_results
3159
+ # An optional limit for the number of resources returned in a single
3160
+ # call.
3161
+ #
3162
+ # Default value: `100`
3163
+ #
3164
+ # @option params [String] :next_token
3165
+ # The pagination token specifying which page of results to return in the
3166
+ # response. If no token is provided, the default page is the first page.
3167
+ #
3168
+ # Default value: `null`
3169
+ #
3170
+ # @return [Types::ListKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3171
+ #
3172
+ # * {Types::ListKeysResponse#entries #data.entries} => Array&lt;Types::ListKeysResponseEntry&gt; (This method conflicts with a method on Response, call it through the data member)
3173
+ # * {Types::ListKeysResponse#next_token #next_token} => String
3174
+ #
3175
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3176
+ #
3177
+ # @example Request syntax with placeholder values
3178
+ #
3179
+ # resp = client.list_keys({
3180
+ # filter: {
3181
+ # key_status: "Active", # accepts Active, Expired
3182
+ # },
3183
+ # max_results: 1,
3184
+ # next_token: "Token",
3185
+ # })
3186
+ #
3187
+ # @example Response structure
3188
+ #
3189
+ # resp.data.entries #=> Array
3190
+ # resp.data.entries[0].create_time #=> Time
3191
+ # resp.data.entries[0].description #=> String
3192
+ # resp.data.entries[0].expire_time #=> Time
3193
+ # resp.data.entries[0].key_name #=> String
3194
+ # resp.data.entries[0].restrictions.allow_actions #=> Array
3195
+ # resp.data.entries[0].restrictions.allow_actions[0] #=> String
3196
+ # resp.data.entries[0].restrictions.allow_referers #=> Array
3197
+ # resp.data.entries[0].restrictions.allow_referers[0] #=> String
3198
+ # resp.data.entries[0].restrictions.allow_resources #=> Array
3199
+ # resp.data.entries[0].restrictions.allow_resources[0] #=> String
3200
+ # resp.data.entries[0].update_time #=> Time
3201
+ # resp.next_token #=> String
3202
+ #
3203
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListKeys AWS API Documentation
3204
+ #
3205
+ # @overload list_keys(params = {})
3206
+ # @param [Hash] params ({})
3207
+ def list_keys(params = {}, options = {})
3208
+ req = build_request(:list_keys, params)
3209
+ req.send_request(options)
3210
+ end
3211
+
3212
+ # Lists map resources in your Amazon Web Services account.
2915
3213
  #
2916
3214
  # @option params [Integer] :max_results
2917
3215
  # An optional limit for the number of resources returned in a single
@@ -2959,7 +3257,7 @@ module Aws::LocationService
2959
3257
  req.send_request(options)
2960
3258
  end
2961
3259
 
2962
- # Lists place index resources in your AWS account.
3260
+ # Lists place index resources in your Amazon Web Services account.
2963
3261
  #
2964
3262
  # @option params [Integer] :max_results
2965
3263
  # An optional limit for the maximum number of results returned in a
@@ -3007,7 +3305,7 @@ module Aws::LocationService
3007
3305
  req.send_request(options)
3008
3306
  end
3009
3307
 
3010
- # Lists route calculator resources in your AWS account.
3308
+ # Lists route calculator resources in your Amazon Web Services account.
3011
3309
  #
3012
3310
  # @option params [Integer] :max_results
3013
3311
  # An optional maximum number of results returned in a single call.
@@ -3139,7 +3437,7 @@ module Aws::LocationService
3139
3437
  req.send_request(options)
3140
3438
  end
3141
3439
 
3142
- # Lists tracker resources in your AWS account.
3440
+ # Lists tracker resources in your Amazon Web Services account.
3143
3441
  #
3144
3442
  # @option params [Integer] :max_results
3145
3443
  # An optional limit for the number of resources returned in a single
@@ -3795,6 +4093,84 @@ module Aws::LocationService
3795
4093
  req.send_request(options)
3796
4094
  end
3797
4095
 
4096
+ # Updates the specified properties of a given API key resource.
4097
+ #
4098
+ # The API keys feature is in preview. We may add, change, or remove
4099
+ # features before announcing general availability. For more information,
4100
+ # see [Using API keys][1].
4101
+ #
4102
+ #
4103
+ #
4104
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
4105
+ #
4106
+ # @option params [String] :description
4107
+ # Updates the description for the API key resource.
4108
+ #
4109
+ # @option params [Time,DateTime,Date,Integer,String] :expire_time
4110
+ # Updates the timestamp for when the API key resource will expire in [
4111
+ # ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
4112
+ #
4113
+ #
4114
+ #
4115
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
4116
+ #
4117
+ # @option params [Boolean] :force_update
4118
+ # The boolean flag to be included for updating `ExpireTime` or
4119
+ # `Restrictions` details.
4120
+ #
4121
+ # Must be set to `true` to update an API key resource that has been used
4122
+ # in the past 7 days.
4123
+ #
4124
+ # `False` if force update is not preferred
4125
+ #
4126
+ # Default value: `False`
4127
+ #
4128
+ # @option params [required, String] :key_name
4129
+ # The name of the API key resource to update.
4130
+ #
4131
+ # @option params [Boolean] :no_expiry
4132
+ # Whether the API key should expire. Set to `true` to set the API key to
4133
+ # have no expiration time.
4134
+ #
4135
+ # @option params [Types::ApiKeyRestrictions] :restrictions
4136
+ # Updates the API key restrictions for the API key resource.
4137
+ #
4138
+ # @return [Types::UpdateKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4139
+ #
4140
+ # * {Types::UpdateKeyResponse#key_arn #key_arn} => String
4141
+ # * {Types::UpdateKeyResponse#key_name #key_name} => String
4142
+ # * {Types::UpdateKeyResponse#update_time #update_time} => Time
4143
+ #
4144
+ # @example Request syntax with placeholder values
4145
+ #
4146
+ # resp = client.update_key({
4147
+ # description: "ResourceDescription",
4148
+ # expire_time: Time.now,
4149
+ # force_update: false,
4150
+ # key_name: "ResourceName", # required
4151
+ # no_expiry: false,
4152
+ # restrictions: {
4153
+ # allow_actions: ["ApiKeyAction"], # required
4154
+ # allow_referers: ["RefererPattern"],
4155
+ # allow_resources: ["GeoArn"], # required
4156
+ # },
4157
+ # })
4158
+ #
4159
+ # @example Response structure
4160
+ #
4161
+ # resp.key_arn #=> String
4162
+ # resp.key_name #=> String
4163
+ # resp.update_time #=> Time
4164
+ #
4165
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateKey AWS API Documentation
4166
+ #
4167
+ # @overload update_key(params = {})
4168
+ # @param [Hash] params ({})
4169
+ def update_key(params = {}, options = {})
4170
+ req = build_request(:update_key, params)
4171
+ req.send_request(options)
4172
+ end
4173
+
3798
4174
  # Updates the specified properties of a given map resource.
3799
4175
  #
3800
4176
  # @option params [String] :description
@@ -4012,7 +4388,7 @@ module Aws::LocationService
4012
4388
  params: params,
4013
4389
  config: config)
4014
4390
  context[:gem_name] = 'aws-sdk-locationservice'
4015
- context[:gem_version] = '1.28.0'
4391
+ context[:gem_version] = '1.30.0'
4016
4392
  Seahorse::Client::Request.new(handlers, context)
4017
4393
  end
4018
4394