aws-sdk-locationservice 1.27.0 → 1.29.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 +12 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-locationservice/client.rb +412 -38
- data/lib/aws-sdk-locationservice/client_api.rb +195 -0
- data/lib/aws-sdk-locationservice/endpoint_parameters.rb +0 -3
- data/lib/aws-sdk-locationservice/endpoint_provider.rb +38 -96
- data/lib/aws-sdk-locationservice/endpoints.rb +70 -0
- data/lib/aws-sdk-locationservice/plugins/endpoints.rb +10 -0
- data/lib/aws-sdk-locationservice/types.rb +611 -40
- data/lib/aws-sdk-locationservice.rb +1 -1
- metadata +2 -2
@@ -24,10 +24,114 @@ module Aws::LocationService
|
|
24
24
|
include Aws::Structure
|
25
25
|
end
|
26
26
|
|
27
|
+
# Options for filtering API keys.
|
28
|
+
#
|
29
|
+
# @!attribute [rw] key_status
|
30
|
+
# Filter on `Active` or `Expired` API keys.
|
31
|
+
# @return [String]
|
32
|
+
#
|
33
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ApiKeyFilter AWS API Documentation
|
34
|
+
#
|
35
|
+
class ApiKeyFilter < Struct.new(
|
36
|
+
:key_status)
|
37
|
+
SENSITIVE = []
|
38
|
+
include Aws::Structure
|
39
|
+
end
|
40
|
+
|
41
|
+
# API Restrictions on the allowed actions, resources, and referers for
|
42
|
+
# an API key resource.
|
43
|
+
#
|
44
|
+
# @!attribute [rw] allow_actions
|
45
|
+
# A list of allowed actions that an API key resource grants
|
46
|
+
# permissions to perform
|
47
|
+
#
|
48
|
+
# <note markdown="1"> Currently, the only valid action is `geo:GetMap*` as an input to the
|
49
|
+
# list. For example, `["geo:GetMap*"]` is valid but
|
50
|
+
# `["geo:GetMapTile"]` is not.
|
51
|
+
#
|
52
|
+
# </note>
|
53
|
+
# @return [Array<String>]
|
54
|
+
#
|
55
|
+
# @!attribute [rw] allow_referers
|
56
|
+
# An optional list of allowed HTTP referers for which requests must
|
57
|
+
# originate from. Requests using this API key from other domains will
|
58
|
+
# not be allowed.
|
59
|
+
#
|
60
|
+
# Requirements:
|
61
|
+
#
|
62
|
+
# * Contain only alphanumeric characters (A–Z, a–z, 0–9) or any
|
63
|
+
# symbols in this list `` $\-._+!*`(),;/?:@=& ``
|
64
|
+
#
|
65
|
+
# * May contain a percent (%) if followed by 2 hexadecimal digits
|
66
|
+
# (A-F, a-f, 0-9); this is used for URL encoding purposes.
|
67
|
+
#
|
68
|
+
# * May contain wildcard characters question mark (?) and asterisk
|
69
|
+
# (*).
|
70
|
+
#
|
71
|
+
# Question mark (?) will replace any single character (including
|
72
|
+
# hexadecimal digits).
|
73
|
+
#
|
74
|
+
# Asterisk (*) will replace any multiple characters (including
|
75
|
+
# multiple hexadecimal digits).
|
76
|
+
#
|
77
|
+
# * No spaces allowed. For example, `https://example.com`.
|
78
|
+
# @return [Array<String>]
|
79
|
+
#
|
80
|
+
# @!attribute [rw] allow_resources
|
81
|
+
# A list of allowed resource ARNs that a API key bearer can perform
|
82
|
+
# actions on
|
83
|
+
#
|
84
|
+
# For more information about ARN format, see [Amazon Resource Names
|
85
|
+
# (ARNs)][1].
|
86
|
+
#
|
87
|
+
# <note markdown="1"> In this preview, you can allow only map resources.
|
88
|
+
#
|
89
|
+
# </note>
|
90
|
+
#
|
91
|
+
# Requirements:
|
92
|
+
#
|
93
|
+
# * Must be prefixed with `arn`.
|
94
|
+
#
|
95
|
+
# * `partition` and `service` must not be empty and should begin with
|
96
|
+
# only alphanumeric characters (A–Z, a–z, 0–9) and contain only
|
97
|
+
# alphanumeric numbers, hyphens (-) and periods (.).
|
98
|
+
#
|
99
|
+
# * `region` and `account-id` can be empty or should begin with only
|
100
|
+
# alphanumeric characters (A–Z, a–z, 0–9) and contain only
|
101
|
+
# alphanumeric numbers, hyphens (-) and periods (.).
|
102
|
+
#
|
103
|
+
# * `resource-id` can begin with any character except for forward
|
104
|
+
# slash (/) and contain any characters after, including forward
|
105
|
+
# slashes to form a path.
|
106
|
+
#
|
107
|
+
# `resource-id` can also include wildcard characters, denoted by an
|
108
|
+
# asterisk (*).
|
109
|
+
#
|
110
|
+
# * `arn`, `partition`, `service`, `region`, `account-id` and
|
111
|
+
# `resource-id` must be delimited by a colon (:).
|
112
|
+
#
|
113
|
+
# * No spaces allowed. For example,
|
114
|
+
# `arn:aws:geo:region:account-id:map/ExampleMap*`.
|
115
|
+
#
|
116
|
+
#
|
117
|
+
#
|
118
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
119
|
+
# @return [Array<String>]
|
120
|
+
#
|
121
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ApiKeyRestrictions AWS API Documentation
|
122
|
+
#
|
123
|
+
class ApiKeyRestrictions < Struct.new(
|
124
|
+
:allow_actions,
|
125
|
+
:allow_referers,
|
126
|
+
:allow_resources)
|
127
|
+
SENSITIVE = []
|
128
|
+
include Aws::Structure
|
129
|
+
end
|
130
|
+
|
27
131
|
# @!attribute [rw] consumer_arn
|
28
132
|
# The Amazon Resource Name (ARN) for the geofence collection to be
|
29
133
|
# associated to tracker resource. Used when you need to specify a
|
30
|
-
# resource across all
|
134
|
+
# resource across all Amazon Web Services.
|
31
135
|
#
|
32
136
|
# * Format example:
|
33
137
|
# `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer`
|
@@ -1157,8 +1261,8 @@ module Aws::LocationService
|
|
1157
1261
|
# @return [String]
|
1158
1262
|
#
|
1159
1263
|
# @!attribute [rw] kms_key_id
|
1160
|
-
# A key identifier for an [
|
1161
|
-
# key ID, key ARN, alias name, or alias ARN.
|
1264
|
+
# A key identifier for an [Amazon Web Services KMS customer managed
|
1265
|
+
# key][1]. Enter a key ID, key ARN, alias name, or alias ARN.
|
1162
1266
|
#
|
1163
1267
|
#
|
1164
1268
|
#
|
@@ -1212,7 +1316,8 @@ module Aws::LocationService
|
|
1212
1316
|
|
1213
1317
|
# @!attribute [rw] collection_arn
|
1214
1318
|
# The Amazon Resource Name (ARN) for the geofence collection resource.
|
1215
|
-
# Used when you need to specify a resource across all
|
1319
|
+
# Used when you need to specify a resource across all Amazon Web
|
1320
|
+
# Services.
|
1216
1321
|
#
|
1217
1322
|
# * Format example:
|
1218
1323
|
# `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection`
|
@@ -1243,6 +1348,120 @@ module Aws::LocationService
|
|
1243
1348
|
include Aws::Structure
|
1244
1349
|
end
|
1245
1350
|
|
1351
|
+
# @!attribute [rw] description
|
1352
|
+
# An optional description for the API key resource.
|
1353
|
+
# @return [String]
|
1354
|
+
#
|
1355
|
+
# @!attribute [rw] expire_time
|
1356
|
+
# The optional timestamp for when the API key resource will expire in
|
1357
|
+
# [ ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. One of `NoExpiry`
|
1358
|
+
# or `ExpireTime` must be set.
|
1359
|
+
#
|
1360
|
+
#
|
1361
|
+
#
|
1362
|
+
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
1363
|
+
# @return [Time]
|
1364
|
+
#
|
1365
|
+
# @!attribute [rw] key_name
|
1366
|
+
# A custom name for the API key resource.
|
1367
|
+
#
|
1368
|
+
# Requirements:
|
1369
|
+
#
|
1370
|
+
# * Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-),
|
1371
|
+
# periods (.), and underscores (\_).
|
1372
|
+
#
|
1373
|
+
# * Must be a unique API key name.
|
1374
|
+
#
|
1375
|
+
# * No spaces allowed. For example, `ExampleAPIKey`.
|
1376
|
+
# @return [String]
|
1377
|
+
#
|
1378
|
+
# @!attribute [rw] no_expiry
|
1379
|
+
# Optionally set to `true` to set no expiration time for the API key.
|
1380
|
+
# One of `NoExpiry` or `ExpireTime` must be set.
|
1381
|
+
# @return [Boolean]
|
1382
|
+
#
|
1383
|
+
# @!attribute [rw] restrictions
|
1384
|
+
# The API key restrictions for the API key resource.
|
1385
|
+
# @return [Types::ApiKeyRestrictions]
|
1386
|
+
#
|
1387
|
+
# @!attribute [rw] tags
|
1388
|
+
# Applies one or more tags to the map resource. A tag is a key-value
|
1389
|
+
# pair that helps manage, identify, search, and filter your resources
|
1390
|
+
# by labelling them.
|
1391
|
+
#
|
1392
|
+
# Format: `"key" : "value"`
|
1393
|
+
#
|
1394
|
+
# Restrictions:
|
1395
|
+
#
|
1396
|
+
# * Maximum 50 tags per resource
|
1397
|
+
#
|
1398
|
+
# * Each resource tag must be unique with a maximum of one value.
|
1399
|
+
#
|
1400
|
+
# * Maximum key length: 128 Unicode characters in UTF-8
|
1401
|
+
#
|
1402
|
+
# * Maximum value length: 256 Unicode characters in UTF-8
|
1403
|
+
#
|
1404
|
+
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1405
|
+
# characters: + - = . \_ : / @.
|
1406
|
+
#
|
1407
|
+
# * Cannot use "aws:" as a prefix for a key.
|
1408
|
+
# @return [Hash<String,String>]
|
1409
|
+
#
|
1410
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateKeyRequest AWS API Documentation
|
1411
|
+
#
|
1412
|
+
class CreateKeyRequest < Struct.new(
|
1413
|
+
:description,
|
1414
|
+
:expire_time,
|
1415
|
+
:key_name,
|
1416
|
+
:no_expiry,
|
1417
|
+
:restrictions,
|
1418
|
+
:tags)
|
1419
|
+
SENSITIVE = []
|
1420
|
+
include Aws::Structure
|
1421
|
+
end
|
1422
|
+
|
1423
|
+
# @!attribute [rw] create_time
|
1424
|
+
# The timestamp for when the API key resource was created in [ ISO
|
1425
|
+
# 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
1426
|
+
#
|
1427
|
+
#
|
1428
|
+
#
|
1429
|
+
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
1430
|
+
# @return [Time]
|
1431
|
+
#
|
1432
|
+
# @!attribute [rw] key
|
1433
|
+
# The key value/string of an API key. This value is used when making
|
1434
|
+
# API calls to authorize the call. For example, see [GetMapGlyphs][1].
|
1435
|
+
#
|
1436
|
+
#
|
1437
|
+
#
|
1438
|
+
# [1]: https://docs.aws.amazon.com/location/latest/APIReference/API_GetMapGlyphs.html
|
1439
|
+
# @return [String]
|
1440
|
+
#
|
1441
|
+
# @!attribute [rw] key_arn
|
1442
|
+
# The Amazon Resource Name (ARN) for the API key resource. Used when
|
1443
|
+
# you need to specify a resource across all Amazon Web Services.
|
1444
|
+
#
|
1445
|
+
# * Format example: `arn:aws:geo:region:account-id:key/ExampleKey`
|
1446
|
+
#
|
1447
|
+
# ^
|
1448
|
+
# @return [String]
|
1449
|
+
#
|
1450
|
+
# @!attribute [rw] key_name
|
1451
|
+
# The name of the API key resource.
|
1452
|
+
# @return [String]
|
1453
|
+
#
|
1454
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateKeyResponse AWS API Documentation
|
1455
|
+
#
|
1456
|
+
class CreateKeyResponse < Struct.new(
|
1457
|
+
:create_time,
|
1458
|
+
:key,
|
1459
|
+
:key_arn,
|
1460
|
+
:key_name)
|
1461
|
+
SENSITIVE = [:key]
|
1462
|
+
include Aws::Structure
|
1463
|
+
end
|
1464
|
+
|
1246
1465
|
# @!attribute [rw] configuration
|
1247
1466
|
# Specifies the `MapConfiguration`, including the map style, for the
|
1248
1467
|
# map resource that you create. The map style defines the look of maps
|
@@ -1317,7 +1536,7 @@ module Aws::LocationService
|
|
1317
1536
|
#
|
1318
1537
|
# @!attribute [rw] map_arn
|
1319
1538
|
# The Amazon Resource Name (ARN) for the map resource. Used to specify
|
1320
|
-
# a resource across all
|
1539
|
+
# a resource across all Amazon Web Services.
|
1321
1540
|
#
|
1322
1541
|
# * Format example: `arn:aws:geo:region:account-id:map/ExampleMap`
|
1323
1542
|
#
|
@@ -1362,8 +1581,8 @@ module Aws::LocationService
|
|
1362
1581
|
#
|
1363
1582
|
# If you specify HERE Technologies (`Here`) as the data provider,
|
1364
1583
|
# you may not [store results][7] for locations in Japan. For more
|
1365
|
-
# information, see the [
|
1366
|
-
# Service.
|
1584
|
+
# information, see the [Amazon Web Services Service Terms][8] for
|
1585
|
+
# Amazon Location Service.
|
1367
1586
|
#
|
1368
1587
|
# For additional information , see [Data providers][9] on the *Amazon
|
1369
1588
|
# Location Service Developer Guide*.
|
@@ -1377,7 +1596,7 @@ module Aws::LocationService
|
|
1377
1596
|
# [5]: https://docs.aws.amazon.com/location/latest/developerguide/HERE.html
|
1378
1597
|
# [6]: https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html
|
1379
1598
|
# [7]: https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html
|
1380
|
-
# [8]:
|
1599
|
+
# [8]: http://aws.amazon.com/service-terms/
|
1381
1600
|
# [9]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
|
1382
1601
|
# @return [String]
|
1383
1602
|
#
|
@@ -1455,7 +1674,7 @@ module Aws::LocationService
|
|
1455
1674
|
#
|
1456
1675
|
# @!attribute [rw] index_arn
|
1457
1676
|
# The Amazon Resource Name (ARN) for the place index resource. Used to
|
1458
|
-
# specify a resource across
|
1677
|
+
# specify a resource across Amazon Web Services.
|
1459
1678
|
#
|
1460
1679
|
# * Format example:
|
1461
1680
|
# `arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex`
|
@@ -1580,7 +1799,8 @@ module Aws::LocationService
|
|
1580
1799
|
|
1581
1800
|
# @!attribute [rw] calculator_arn
|
1582
1801
|
# The Amazon Resource Name (ARN) for the route calculator resource.
|
1583
|
-
# Use the ARN when you specify a resource across all
|
1802
|
+
# Use the ARN when you specify a resource across all Amazon Web
|
1803
|
+
# Services.
|
1584
1804
|
#
|
1585
1805
|
# * Format example:
|
1586
1806
|
# `arn:aws:geo:region:account-id:route-calculator/ExampleCalculator`
|
@@ -1624,8 +1844,8 @@ module Aws::LocationService
|
|
1624
1844
|
# @return [String]
|
1625
1845
|
#
|
1626
1846
|
# @!attribute [rw] kms_key_id
|
1627
|
-
# A key identifier for an [
|
1628
|
-
# key ID, key ARN, alias name, or alias ARN.
|
1847
|
+
# A key identifier for an [Amazon Web Services KMS customer managed
|
1848
|
+
# key][1]. Enter a key ID, key ARN, alias name, or alias ARN.
|
1629
1849
|
#
|
1630
1850
|
#
|
1631
1851
|
#
|
@@ -1734,7 +1954,7 @@ module Aws::LocationService
|
|
1734
1954
|
#
|
1735
1955
|
# @!attribute [rw] tracker_arn
|
1736
1956
|
# The Amazon Resource Name (ARN) for the tracker resource. Used when
|
1737
|
-
# you need to specify a resource across all
|
1957
|
+
# you need to specify a resource across all Amazon Web Services.
|
1738
1958
|
#
|
1739
1959
|
# * Format example:
|
1740
1960
|
# `arn:aws:geo:region:account-id:tracker/ExampleTracker`
|
@@ -1814,6 +2034,22 @@ module Aws::LocationService
|
|
1814
2034
|
#
|
1815
2035
|
class DeleteGeofenceCollectionResponse < Aws::EmptyStructure; end
|
1816
2036
|
|
2037
|
+
# @!attribute [rw] key_name
|
2038
|
+
# The name of the API key to delete.
|
2039
|
+
# @return [String]
|
2040
|
+
#
|
2041
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteKeyRequest AWS API Documentation
|
2042
|
+
#
|
2043
|
+
class DeleteKeyRequest < Struct.new(
|
2044
|
+
:key_name)
|
2045
|
+
SENSITIVE = []
|
2046
|
+
include Aws::Structure
|
2047
|
+
end
|
2048
|
+
|
2049
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteKeyResponse AWS API Documentation
|
2050
|
+
#
|
2051
|
+
class DeleteKeyResponse < Aws::EmptyStructure; end
|
2052
|
+
|
1817
2053
|
# @!attribute [rw] map_name
|
1818
2054
|
# The name of the map resource to be deleted.
|
1819
2055
|
# @return [String]
|
@@ -1892,7 +2128,8 @@ module Aws::LocationService
|
|
1892
2128
|
|
1893
2129
|
# @!attribute [rw] collection_arn
|
1894
2130
|
# The Amazon Resource Name (ARN) for the geofence collection resource.
|
1895
|
-
# Used when you need to specify a resource across all
|
2131
|
+
# Used when you need to specify a resource across all Amazon Web
|
2132
|
+
# Services.
|
1896
2133
|
#
|
1897
2134
|
# * Format example:
|
1898
2135
|
# `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection`
|
@@ -1918,8 +2155,8 @@ module Aws::LocationService
|
|
1918
2155
|
# @return [String]
|
1919
2156
|
#
|
1920
2157
|
# @!attribute [rw] kms_key_id
|
1921
|
-
# A key identifier for an [
|
1922
|
-
# to the Amazon Location resource
|
2158
|
+
# A key identifier for an [Amazon Web Services KMS customer managed
|
2159
|
+
# key][1] assigned to the Amazon Location resource
|
1923
2160
|
#
|
1924
2161
|
#
|
1925
2162
|
#
|
@@ -1963,6 +2200,91 @@ module Aws::LocationService
|
|
1963
2200
|
include Aws::Structure
|
1964
2201
|
end
|
1965
2202
|
|
2203
|
+
# @!attribute [rw] key_name
|
2204
|
+
# The name of the API key resource.
|
2205
|
+
# @return [String]
|
2206
|
+
#
|
2207
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeKeyRequest AWS API Documentation
|
2208
|
+
#
|
2209
|
+
class DescribeKeyRequest < Struct.new(
|
2210
|
+
:key_name)
|
2211
|
+
SENSITIVE = []
|
2212
|
+
include Aws::Structure
|
2213
|
+
end
|
2214
|
+
|
2215
|
+
# @!attribute [rw] create_time
|
2216
|
+
# The timestamp for when the API key resource was created in [ ISO
|
2217
|
+
# 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
2218
|
+
#
|
2219
|
+
#
|
2220
|
+
#
|
2221
|
+
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
2222
|
+
# @return [Time]
|
2223
|
+
#
|
2224
|
+
# @!attribute [rw] description
|
2225
|
+
# The optional description for the API key resource.
|
2226
|
+
# @return [String]
|
2227
|
+
#
|
2228
|
+
# @!attribute [rw] expire_time
|
2229
|
+
# The timestamp for when the API key resource will expire in [ ISO
|
2230
|
+
# 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
2231
|
+
#
|
2232
|
+
#
|
2233
|
+
#
|
2234
|
+
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
2235
|
+
# @return [Time]
|
2236
|
+
#
|
2237
|
+
# @!attribute [rw] key
|
2238
|
+
# The key value/string of an API key.
|
2239
|
+
# @return [String]
|
2240
|
+
#
|
2241
|
+
# @!attribute [rw] key_arn
|
2242
|
+
# The Amazon Resource Name (ARN) for the API key resource. Used when
|
2243
|
+
# you need to specify a resource across all Amazon Web Services.
|
2244
|
+
#
|
2245
|
+
# * Format example: `arn:aws:geo:region:account-id:key/ExampleKey`
|
2246
|
+
#
|
2247
|
+
# ^
|
2248
|
+
# @return [String]
|
2249
|
+
#
|
2250
|
+
# @!attribute [rw] key_name
|
2251
|
+
# The name of the API key resource.
|
2252
|
+
# @return [String]
|
2253
|
+
#
|
2254
|
+
# @!attribute [rw] restrictions
|
2255
|
+
# API Restrictions on the allowed actions, resources, and referers for
|
2256
|
+
# an API key resource.
|
2257
|
+
# @return [Types::ApiKeyRestrictions]
|
2258
|
+
#
|
2259
|
+
# @!attribute [rw] tags
|
2260
|
+
# Tags associated with the API key resource.
|
2261
|
+
# @return [Hash<String,String>]
|
2262
|
+
#
|
2263
|
+
# @!attribute [rw] update_time
|
2264
|
+
# The timestamp for when the API key resource was last updated in [
|
2265
|
+
# ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
2266
|
+
#
|
2267
|
+
#
|
2268
|
+
#
|
2269
|
+
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
2270
|
+
# @return [Time]
|
2271
|
+
#
|
2272
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeKeyResponse AWS API Documentation
|
2273
|
+
#
|
2274
|
+
class DescribeKeyResponse < Struct.new(
|
2275
|
+
:create_time,
|
2276
|
+
:description,
|
2277
|
+
:expire_time,
|
2278
|
+
:key,
|
2279
|
+
:key_arn,
|
2280
|
+
:key_name,
|
2281
|
+
:restrictions,
|
2282
|
+
:tags,
|
2283
|
+
:update_time)
|
2284
|
+
SENSITIVE = [:key]
|
2285
|
+
include Aws::Structure
|
2286
|
+
end
|
2287
|
+
|
1966
2288
|
# @!attribute [rw] map_name
|
1967
2289
|
# The name of the map resource.
|
1968
2290
|
# @return [String]
|
@@ -1998,7 +2320,7 @@ module Aws::LocationService
|
|
1998
2320
|
#
|
1999
2321
|
# @!attribute [rw] map_arn
|
2000
2322
|
# The Amazon Resource Name (ARN) for the map resource. Used to specify
|
2001
|
-
# a resource across all
|
2323
|
+
# a resource across all Amazon Web Services.
|
2002
2324
|
#
|
2003
2325
|
# * Format example: `arn:aws:geo:region:account-id:map/ExampleMap`
|
2004
2326
|
#
|
@@ -2091,7 +2413,7 @@ module Aws::LocationService
|
|
2091
2413
|
#
|
2092
2414
|
# @!attribute [rw] index_arn
|
2093
2415
|
# The Amazon Resource Name (ARN) for the place index resource. Used to
|
2094
|
-
# specify a resource across
|
2416
|
+
# specify a resource across Amazon Web Services.
|
2095
2417
|
#
|
2096
2418
|
# * Format example:
|
2097
2419
|
# `arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex`
|
@@ -2150,7 +2472,7 @@ module Aws::LocationService
|
|
2150
2472
|
|
2151
2473
|
# @!attribute [rw] calculator_arn
|
2152
2474
|
# The Amazon Resource Name (ARN) for the Route calculator resource.
|
2153
|
-
# Use the ARN when you specify a resource across
|
2475
|
+
# Use the ARN when you specify a resource across Amazon Web Services.
|
2154
2476
|
#
|
2155
2477
|
# * Format example:
|
2156
2478
|
# `arn:aws:geo:region:account-id:route-calculator/ExampleCalculator`
|
@@ -2259,8 +2581,8 @@ module Aws::LocationService
|
|
2259
2581
|
# @return [String]
|
2260
2582
|
#
|
2261
2583
|
# @!attribute [rw] kms_key_id
|
2262
|
-
# A key identifier for an [
|
2263
|
-
# to the Amazon Location resource.
|
2584
|
+
# A key identifier for an [Amazon Web Services KMS customer managed
|
2585
|
+
# key][1] assigned to the Amazon Location resource.
|
2264
2586
|
#
|
2265
2587
|
#
|
2266
2588
|
#
|
@@ -2285,7 +2607,7 @@ module Aws::LocationService
|
|
2285
2607
|
#
|
2286
2608
|
# @!attribute [rw] tracker_arn
|
2287
2609
|
# The Amazon Resource Name (ARN) for the tracker resource. Used when
|
2288
|
-
# you need to specify a resource across all
|
2610
|
+
# you need to specify a resource across all Amazon Web Services.
|
2289
2611
|
#
|
2290
2612
|
# * Format example:
|
2291
2613
|
# `arn:aws:geo:region:account-id:tracker/ExampleTracker`
|
@@ -2423,7 +2745,7 @@ module Aws::LocationService
|
|
2423
2745
|
# @!attribute [rw] consumer_arn
|
2424
2746
|
# The Amazon Resource Name (ARN) for the geofence collection to be
|
2425
2747
|
# disassociated from the tracker resource. Used when you need to
|
2426
|
-
# specify a resource across all
|
2748
|
+
# specify a resource across all Amazon Web Services.
|
2427
2749
|
#
|
2428
2750
|
# * Format example:
|
2429
2751
|
# `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer`
|
@@ -2792,6 +3114,14 @@ module Aws::LocationService
|
|
2792
3114
|
# multiples of 256.
|
2793
3115
|
# @return [String]
|
2794
3116
|
#
|
3117
|
+
# @!attribute [rw] key
|
3118
|
+
# The optional [API key][1] to authorize the request.
|
3119
|
+
#
|
3120
|
+
#
|
3121
|
+
#
|
3122
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
|
3123
|
+
# @return [String]
|
3124
|
+
#
|
2795
3125
|
# @!attribute [rw] map_name
|
2796
3126
|
# The map resource associated with the glyph file.
|
2797
3127
|
# @return [String]
|
@@ -2801,13 +3131,18 @@ module Aws::LocationService
|
|
2801
3131
|
class GetMapGlyphsRequest < Struct.new(
|
2802
3132
|
:font_stack,
|
2803
3133
|
:font_unicode_range,
|
3134
|
+
:key,
|
2804
3135
|
:map_name)
|
2805
|
-
SENSITIVE = []
|
3136
|
+
SENSITIVE = [:key]
|
2806
3137
|
include Aws::Structure
|
2807
3138
|
end
|
2808
3139
|
|
2809
3140
|
# @!attribute [rw] blob
|
2810
|
-
# The
|
3141
|
+
# The glyph, as binary blob.
|
3142
|
+
# @return [String]
|
3143
|
+
#
|
3144
|
+
# @!attribute [rw] cache_control
|
3145
|
+
# The HTTP Cache-Control directive for the value.
|
2811
3146
|
# @return [String]
|
2812
3147
|
#
|
2813
3148
|
# @!attribute [rw] content_type
|
@@ -2818,6 +3153,7 @@ module Aws::LocationService
|
|
2818
3153
|
#
|
2819
3154
|
class GetMapGlyphsResponse < Struct.new(
|
2820
3155
|
:blob,
|
3156
|
+
:cache_control,
|
2821
3157
|
:content_type)
|
2822
3158
|
SENSITIVE = []
|
2823
3159
|
include Aws::Structure
|
@@ -2839,6 +3175,14 @@ module Aws::LocationService
|
|
2839
3175
|
# * `sprites@2x.json` for high pixel density displays
|
2840
3176
|
# @return [String]
|
2841
3177
|
#
|
3178
|
+
# @!attribute [rw] key
|
3179
|
+
# The optional [API key][1] to authorize the request.
|
3180
|
+
#
|
3181
|
+
#
|
3182
|
+
#
|
3183
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
|
3184
|
+
# @return [String]
|
3185
|
+
#
|
2842
3186
|
# @!attribute [rw] map_name
|
2843
3187
|
# The map resource associated with the sprite file.
|
2844
3188
|
# @return [String]
|
@@ -2847,8 +3191,9 @@ module Aws::LocationService
|
|
2847
3191
|
#
|
2848
3192
|
class GetMapSpritesRequest < Struct.new(
|
2849
3193
|
:file_name,
|
3194
|
+
:key,
|
2850
3195
|
:map_name)
|
2851
|
-
SENSITIVE = []
|
3196
|
+
SENSITIVE = [:key]
|
2852
3197
|
include Aws::Structure
|
2853
3198
|
end
|
2854
3199
|
|
@@ -2856,6 +3201,10 @@ module Aws::LocationService
|
|
2856
3201
|
# Contains the body of the sprite sheet or JSON offset file.
|
2857
3202
|
# @return [String]
|
2858
3203
|
#
|
3204
|
+
# @!attribute [rw] cache_control
|
3205
|
+
# The HTTP Cache-Control directive for the value.
|
3206
|
+
# @return [String]
|
3207
|
+
#
|
2859
3208
|
# @!attribute [rw] content_type
|
2860
3209
|
# The content type of the sprite sheet and offsets. For example, the
|
2861
3210
|
# sprite sheet content type is `image/png`, and the sprite offset JSON
|
@@ -2866,11 +3215,20 @@ module Aws::LocationService
|
|
2866
3215
|
#
|
2867
3216
|
class GetMapSpritesResponse < Struct.new(
|
2868
3217
|
:blob,
|
3218
|
+
:cache_control,
|
2869
3219
|
:content_type)
|
2870
3220
|
SENSITIVE = []
|
2871
3221
|
include Aws::Structure
|
2872
3222
|
end
|
2873
3223
|
|
3224
|
+
# @!attribute [rw] key
|
3225
|
+
# The optional [API key][1] to authorize the request.
|
3226
|
+
#
|
3227
|
+
#
|
3228
|
+
#
|
3229
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
|
3230
|
+
# @return [String]
|
3231
|
+
#
|
2874
3232
|
# @!attribute [rw] map_name
|
2875
3233
|
# The map resource to retrieve the style descriptor from.
|
2876
3234
|
# @return [String]
|
@@ -2878,8 +3236,9 @@ module Aws::LocationService
|
|
2878
3236
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapStyleDescriptorRequest AWS API Documentation
|
2879
3237
|
#
|
2880
3238
|
class GetMapStyleDescriptorRequest < Struct.new(
|
3239
|
+
:key,
|
2881
3240
|
:map_name)
|
2882
|
-
SENSITIVE = []
|
3241
|
+
SENSITIVE = [:key]
|
2883
3242
|
include Aws::Structure
|
2884
3243
|
end
|
2885
3244
|
|
@@ -2887,6 +3246,10 @@ module Aws::LocationService
|
|
2887
3246
|
# Contains the body of the style descriptor.
|
2888
3247
|
# @return [String]
|
2889
3248
|
#
|
3249
|
+
# @!attribute [rw] cache_control
|
3250
|
+
# The HTTP Cache-Control directive for the value.
|
3251
|
+
# @return [String]
|
3252
|
+
#
|
2890
3253
|
# @!attribute [rw] content_type
|
2891
3254
|
# The style descriptor's content type. For example,
|
2892
3255
|
# `application/json`.
|
@@ -2896,11 +3259,20 @@ module Aws::LocationService
|
|
2896
3259
|
#
|
2897
3260
|
class GetMapStyleDescriptorResponse < Struct.new(
|
2898
3261
|
:blob,
|
3262
|
+
:cache_control,
|
2899
3263
|
:content_type)
|
2900
3264
|
SENSITIVE = []
|
2901
3265
|
include Aws::Structure
|
2902
3266
|
end
|
2903
3267
|
|
3268
|
+
# @!attribute [rw] key
|
3269
|
+
# The optional [API key][1] to authorize the request.
|
3270
|
+
#
|
3271
|
+
#
|
3272
|
+
#
|
3273
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
|
3274
|
+
# @return [String]
|
3275
|
+
#
|
2904
3276
|
# @!attribute [rw] map_name
|
2905
3277
|
# The map resource to retrieve the map tiles from.
|
2906
3278
|
# @return [String]
|
@@ -2920,11 +3292,12 @@ module Aws::LocationService
|
|
2920
3292
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapTileRequest AWS API Documentation
|
2921
3293
|
#
|
2922
3294
|
class GetMapTileRequest < Struct.new(
|
3295
|
+
:key,
|
2923
3296
|
:map_name,
|
2924
3297
|
:x,
|
2925
3298
|
:y,
|
2926
3299
|
:z)
|
2927
|
-
SENSITIVE = []
|
3300
|
+
SENSITIVE = [:key]
|
2928
3301
|
include Aws::Structure
|
2929
3302
|
end
|
2930
3303
|
|
@@ -2932,6 +3305,10 @@ module Aws::LocationService
|
|
2932
3305
|
# Contains Mapbox Vector Tile (MVT) data.
|
2933
3306
|
# @return [String]
|
2934
3307
|
#
|
3308
|
+
# @!attribute [rw] cache_control
|
3309
|
+
# The HTTP Cache-Control directive for the value.
|
3310
|
+
# @return [String]
|
3311
|
+
#
|
2935
3312
|
# @!attribute [rw] content_type
|
2936
3313
|
# The map tile's content type. For example,
|
2937
3314
|
# `application/vnd.mapbox-vector-tile`.
|
@@ -2941,6 +3318,7 @@ module Aws::LocationService
|
|
2941
3318
|
#
|
2942
3319
|
class GetMapTileResponse < Struct.new(
|
2943
3320
|
:blob,
|
3321
|
+
:cache_control,
|
2944
3322
|
:content_type)
|
2945
3323
|
SENSITIVE = []
|
2946
3324
|
include Aws::Structure
|
@@ -3248,7 +3626,8 @@ module Aws::LocationService
|
|
3248
3626
|
end
|
3249
3627
|
|
3250
3628
|
# @!attribute [rw] entries
|
3251
|
-
# Lists the geofence collections that exist in your
|
3629
|
+
# Lists the geofence collections that exist in your Amazon Web
|
3630
|
+
# Services account.
|
3252
3631
|
# @return [Array<Types::ListGeofenceCollectionsResponseEntry>]
|
3253
3632
|
#
|
3254
3633
|
# @!attribute [rw] next_token
|
@@ -3419,6 +3798,111 @@ module Aws::LocationService
|
|
3419
3798
|
include Aws::Structure
|
3420
3799
|
end
|
3421
3800
|
|
3801
|
+
# @!attribute [rw] filter
|
3802
|
+
# Optionally filter the list to only `Active` or `Expired` API keys.
|
3803
|
+
# @return [Types::ApiKeyFilter]
|
3804
|
+
#
|
3805
|
+
# @!attribute [rw] max_results
|
3806
|
+
# An optional limit for the number of resources returned in a single
|
3807
|
+
# call.
|
3808
|
+
#
|
3809
|
+
# Default value: `100`
|
3810
|
+
# @return [Integer]
|
3811
|
+
#
|
3812
|
+
# @!attribute [rw] next_token
|
3813
|
+
# The pagination token specifying which page of results to return in
|
3814
|
+
# the response. If no token is provided, the default page is the first
|
3815
|
+
# page.
|
3816
|
+
#
|
3817
|
+
# Default value: `null`
|
3818
|
+
# @return [String]
|
3819
|
+
#
|
3820
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListKeysRequest AWS API Documentation
|
3821
|
+
#
|
3822
|
+
class ListKeysRequest < Struct.new(
|
3823
|
+
:filter,
|
3824
|
+
:max_results,
|
3825
|
+
:next_token)
|
3826
|
+
SENSITIVE = []
|
3827
|
+
include Aws::Structure
|
3828
|
+
end
|
3829
|
+
|
3830
|
+
# @!attribute [rw] entries
|
3831
|
+
# Contains API key resources in your Amazon Web Services account.
|
3832
|
+
# Details include API key name, allowed referers and timestamp for
|
3833
|
+
# when the API key will expire.
|
3834
|
+
# @return [Array<Types::ListKeysResponseEntry>]
|
3835
|
+
#
|
3836
|
+
# @!attribute [rw] next_token
|
3837
|
+
# A pagination token indicating there are additional pages available.
|
3838
|
+
# You can use the token in a following request to fetch the next set
|
3839
|
+
# of results.
|
3840
|
+
# @return [String]
|
3841
|
+
#
|
3842
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListKeysResponse AWS API Documentation
|
3843
|
+
#
|
3844
|
+
class ListKeysResponse < Struct.new(
|
3845
|
+
:entries,
|
3846
|
+
:next_token)
|
3847
|
+
SENSITIVE = []
|
3848
|
+
include Aws::Structure
|
3849
|
+
end
|
3850
|
+
|
3851
|
+
# An API key resource listed in your Amazon Web Services account.
|
3852
|
+
#
|
3853
|
+
# @!attribute [rw] create_time
|
3854
|
+
# The timestamp of when the API key was created, in [ ISO 8601][1]
|
3855
|
+
# format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
3856
|
+
#
|
3857
|
+
#
|
3858
|
+
#
|
3859
|
+
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
3860
|
+
# @return [Time]
|
3861
|
+
#
|
3862
|
+
# @!attribute [rw] description
|
3863
|
+
# The optional description for the API key resource.
|
3864
|
+
# @return [String]
|
3865
|
+
#
|
3866
|
+
# @!attribute [rw] expire_time
|
3867
|
+
# The timestamp for when the API key resource will expire, in [ ISO
|
3868
|
+
# 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
3869
|
+
#
|
3870
|
+
#
|
3871
|
+
#
|
3872
|
+
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
3873
|
+
# @return [Time]
|
3874
|
+
#
|
3875
|
+
# @!attribute [rw] key_name
|
3876
|
+
# The name of the API key resource.
|
3877
|
+
# @return [String]
|
3878
|
+
#
|
3879
|
+
# @!attribute [rw] restrictions
|
3880
|
+
# API Restrictions on the allowed actions, resources, and referers for
|
3881
|
+
# an API key resource.
|
3882
|
+
# @return [Types::ApiKeyRestrictions]
|
3883
|
+
#
|
3884
|
+
# @!attribute [rw] update_time
|
3885
|
+
# The timestamp of when the API key was last updated, in [ ISO
|
3886
|
+
# 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
3887
|
+
#
|
3888
|
+
#
|
3889
|
+
#
|
3890
|
+
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
3891
|
+
# @return [Time]
|
3892
|
+
#
|
3893
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListKeysResponseEntry AWS API Documentation
|
3894
|
+
#
|
3895
|
+
class ListKeysResponseEntry < Struct.new(
|
3896
|
+
:create_time,
|
3897
|
+
:description,
|
3898
|
+
:expire_time,
|
3899
|
+
:key_name,
|
3900
|
+
:restrictions,
|
3901
|
+
:update_time)
|
3902
|
+
SENSITIVE = []
|
3903
|
+
include Aws::Structure
|
3904
|
+
end
|
3905
|
+
|
3422
3906
|
# @!attribute [rw] max_results
|
3423
3907
|
# An optional limit for the number of resources returned in a single
|
3424
3908
|
# call.
|
@@ -3444,7 +3928,7 @@ module Aws::LocationService
|
|
3444
3928
|
end
|
3445
3929
|
|
3446
3930
|
# @!attribute [rw] entries
|
3447
|
-
# Contains a list of maps in your
|
3931
|
+
# Contains a list of maps in your Amazon Web Services account
|
3448
3932
|
# @return [Array<Types::ListMapsResponseEntry>]
|
3449
3933
|
#
|
3450
3934
|
# @!attribute [rw] next_token
|
@@ -3462,7 +3946,8 @@ module Aws::LocationService
|
|
3462
3946
|
include Aws::Structure
|
3463
3947
|
end
|
3464
3948
|
|
3465
|
-
# Contains details of an existing map resource in your
|
3949
|
+
# Contains details of an existing map resource in your Amazon Web
|
3950
|
+
# Services account.
|
3466
3951
|
#
|
3467
3952
|
# @!attribute [rw] create_time
|
3468
3953
|
# The timestamp for when the map resource was created in [ISO 8601][1]
|
@@ -3536,7 +4021,8 @@ module Aws::LocationService
|
|
3536
4021
|
end
|
3537
4022
|
|
3538
4023
|
# @!attribute [rw] entries
|
3539
|
-
# Lists the place index resources that exist in your
|
4024
|
+
# Lists the place index resources that exist in your Amazon Web
|
4025
|
+
# Services account
|
3540
4026
|
# @return [Array<Types::ListPlaceIndexesResponseEntry>]
|
3541
4027
|
#
|
3542
4028
|
# @!attribute [rw] next_token
|
@@ -3554,7 +4040,7 @@ module Aws::LocationService
|
|
3554
4040
|
include Aws::Structure
|
3555
4041
|
end
|
3556
4042
|
|
3557
|
-
# A place index resource listed in your
|
4043
|
+
# A place index resource listed in your Amazon Web Services account.
|
3558
4044
|
#
|
3559
4045
|
# @!attribute [rw] create_time
|
3560
4046
|
# The timestamp for when the place index resource was created in [ISO
|
@@ -3641,7 +4127,8 @@ module Aws::LocationService
|
|
3641
4127
|
end
|
3642
4128
|
|
3643
4129
|
# @!attribute [rw] entries
|
3644
|
-
# Lists the route calculator resources that exist in your
|
4130
|
+
# Lists the route calculator resources that exist in your Amazon Web
|
4131
|
+
# Services account
|
3645
4132
|
# @return [Array<Types::ListRouteCalculatorsResponseEntry>]
|
3646
4133
|
#
|
3647
4134
|
# @!attribute [rw] next_token
|
@@ -3659,7 +4146,8 @@ module Aws::LocationService
|
|
3659
4146
|
include Aws::Structure
|
3660
4147
|
end
|
3661
4148
|
|
3662
|
-
# A route calculator resource listed in your
|
4149
|
+
# A route calculator resource listed in your Amazon Web Services
|
4150
|
+
# account.
|
3663
4151
|
#
|
3664
4152
|
# @!attribute [rw] calculator_name
|
3665
4153
|
# The name of the route calculator resource.
|
@@ -3840,9 +4328,9 @@ module Aws::LocationService
|
|
3840
4328
|
end
|
3841
4329
|
|
3842
4330
|
# @!attribute [rw] entries
|
3843
|
-
# Contains tracker resources in your
|
3844
|
-
# tracker name, description and timestamps for when
|
3845
|
-
# created and last updated.
|
4331
|
+
# Contains tracker resources in your Amazon Web Services account.
|
4332
|
+
# Details include tracker name, description and timestamps for when
|
4333
|
+
# the tracker was created and last updated.
|
3846
4334
|
# @return [Array<Types::ListTrackersResponseEntry>]
|
3847
4335
|
#
|
3848
4336
|
# @!attribute [rw] next_token
|
@@ -5294,7 +5782,7 @@ module Aws::LocationService
|
|
5294
5782
|
|
5295
5783
|
# @!attribute [rw] collection_arn
|
5296
5784
|
# The Amazon Resource Name (ARN) of the updated geofence collection.
|
5297
|
-
# Used to specify a resource across
|
5785
|
+
# Used to specify a resource across Amazon Web Services.
|
5298
5786
|
#
|
5299
5787
|
# * Format example:
|
5300
5788
|
# `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection`
|
@@ -5325,6 +5813,89 @@ module Aws::LocationService
|
|
5325
5813
|
include Aws::Structure
|
5326
5814
|
end
|
5327
5815
|
|
5816
|
+
# @!attribute [rw] description
|
5817
|
+
# Updates the description for the API key resource.
|
5818
|
+
# @return [String]
|
5819
|
+
#
|
5820
|
+
# @!attribute [rw] expire_time
|
5821
|
+
# Updates the timestamp for when the API key resource will expire in [
|
5822
|
+
# ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
5823
|
+
#
|
5824
|
+
#
|
5825
|
+
#
|
5826
|
+
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
5827
|
+
# @return [Time]
|
5828
|
+
#
|
5829
|
+
# @!attribute [rw] force_update
|
5830
|
+
# The boolean flag to be included for updating `ExpireTime` or
|
5831
|
+
# `Restrictions` details.
|
5832
|
+
#
|
5833
|
+
# Must be set to `true` to update an API key resource that has been
|
5834
|
+
# used in the past 7 days.
|
5835
|
+
#
|
5836
|
+
# `False` if force update is not preferred
|
5837
|
+
#
|
5838
|
+
# Default value: `False`
|
5839
|
+
# @return [Boolean]
|
5840
|
+
#
|
5841
|
+
# @!attribute [rw] key_name
|
5842
|
+
# The name of the API key resource to update.
|
5843
|
+
# @return [String]
|
5844
|
+
#
|
5845
|
+
# @!attribute [rw] no_expiry
|
5846
|
+
# Whether the API key should expire. Set to `true` to set the API key
|
5847
|
+
# to have no expiration time.
|
5848
|
+
# @return [Boolean]
|
5849
|
+
#
|
5850
|
+
# @!attribute [rw] restrictions
|
5851
|
+
# Updates the API key restrictions for the API key resource.
|
5852
|
+
# @return [Types::ApiKeyRestrictions]
|
5853
|
+
#
|
5854
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateKeyRequest AWS API Documentation
|
5855
|
+
#
|
5856
|
+
class UpdateKeyRequest < Struct.new(
|
5857
|
+
:description,
|
5858
|
+
:expire_time,
|
5859
|
+
:force_update,
|
5860
|
+
:key_name,
|
5861
|
+
:no_expiry,
|
5862
|
+
:restrictions)
|
5863
|
+
SENSITIVE = []
|
5864
|
+
include Aws::Structure
|
5865
|
+
end
|
5866
|
+
|
5867
|
+
# @!attribute [rw] key_arn
|
5868
|
+
# The Amazon Resource Name (ARN) for the API key resource. Used when
|
5869
|
+
# you need to specify a resource across all Amazon Web Services.
|
5870
|
+
#
|
5871
|
+
# * Format example: `arn:aws:geo:region:account-id:key/ExampleKey`
|
5872
|
+
#
|
5873
|
+
# ^
|
5874
|
+
# @return [String]
|
5875
|
+
#
|
5876
|
+
# @!attribute [rw] key_name
|
5877
|
+
# The name of the API key resource.
|
5878
|
+
# @return [String]
|
5879
|
+
#
|
5880
|
+
# @!attribute [rw] update_time
|
5881
|
+
# The timestamp for when the API key resource was last updated in [
|
5882
|
+
# ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
5883
|
+
#
|
5884
|
+
#
|
5885
|
+
#
|
5886
|
+
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
5887
|
+
# @return [Time]
|
5888
|
+
#
|
5889
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateKeyResponse AWS API Documentation
|
5890
|
+
#
|
5891
|
+
class UpdateKeyResponse < Struct.new(
|
5892
|
+
:key_arn,
|
5893
|
+
:key_name,
|
5894
|
+
:update_time)
|
5895
|
+
SENSITIVE = []
|
5896
|
+
include Aws::Structure
|
5897
|
+
end
|
5898
|
+
|
5328
5899
|
# @!attribute [rw] description
|
5329
5900
|
# Updates the description for the map resource.
|
5330
5901
|
# @return [String]
|
@@ -5410,7 +5981,7 @@ module Aws::LocationService
|
|
5410
5981
|
|
5411
5982
|
# @!attribute [rw] index_arn
|
5412
5983
|
# The Amazon Resource Name (ARN) of the upated place index resource.
|
5413
|
-
# Used to specify a resource across
|
5984
|
+
# Used to specify a resource across Amazon Web Services.
|
5414
5985
|
#
|
5415
5986
|
# * Format example: `arn:aws:geo:region:account-id:place-
|
5416
5987
|
# index/ExamplePlaceIndex`
|