@aws-sdk/client-location 3.276.0 → 3.278.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.
- package/dist-cjs/Location.js +75 -0
- package/dist-cjs/commands/CreateKeyCommand.js +46 -0
- package/dist-cjs/commands/DeleteKeyCommand.js +46 -0
- package/dist-cjs/commands/DescribeKeyCommand.js +46 -0
- package/dist-cjs/commands/ListKeysCommand.js +46 -0
- package/dist-cjs/commands/UpdateKeyCommand.js +46 -0
- package/dist-cjs/commands/index.js +5 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +80 -22
- package/dist-cjs/pagination/ListKeysPaginator.js +36 -0
- package/dist-cjs/pagination/index.js +1 -0
- package/dist-cjs/protocols/Aws_restJson1.js +544 -3
- package/dist-es/Location.js +75 -0
- package/dist-es/commands/CreateKeyCommand.js +42 -0
- package/dist-es/commands/DeleteKeyCommand.js +42 -0
- package/dist-es/commands/DescribeKeyCommand.js +42 -0
- package/dist-es/commands/ListKeysCommand.js +42 -0
- package/dist-es/commands/UpdateKeyCommand.js +42 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +60 -15
- package/dist-es/pagination/ListKeysPaginator.js +32 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +531 -0
- package/dist-types/Location.d.ts +82 -24
- package/dist-types/LocationClient.d.ts +7 -2
- package/dist-types/commands/CreateKeyCommand.d.ts +44 -0
- package/dist-types/commands/CreateMapCommand.d.ts +2 -2
- package/dist-types/commands/CreatePlaceIndexCommand.d.ts +2 -2
- package/dist-types/commands/CreateRouteCalculatorCommand.d.ts +2 -2
- package/dist-types/commands/CreateTrackerCommand.d.ts +1 -1
- package/dist-types/commands/DeleteGeofenceCollectionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteKeyCommand.d.ts +38 -0
- package/dist-types/commands/DeleteMapCommand.d.ts +1 -1
- package/dist-types/commands/DeletePlaceIndexCommand.d.ts +1 -1
- package/dist-types/commands/DeleteRouteCalculatorCommand.d.ts +1 -1
- package/dist-types/commands/DeleteTrackerCommand.d.ts +1 -1
- package/dist-types/commands/DescribeKeyCommand.d.ts +42 -0
- package/dist-types/commands/GetPlaceCommand.d.ts +2 -2
- package/dist-types/commands/ListGeofenceCollectionsCommand.d.ts +1 -1
- package/dist-types/commands/ListKeysCommand.d.ts +42 -0
- package/dist-types/commands/ListMapsCommand.d.ts +1 -1
- package/dist-types/commands/ListPlaceIndexesCommand.d.ts +1 -1
- package/dist-types/commands/ListRouteCalculatorsCommand.d.ts +1 -1
- package/dist-types/commands/ListTrackersCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +5 -5
- package/dist-types/commands/UpdateKeyCommand.d.ts +42 -0
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +548 -67
- package/dist-types/pagination/ListKeysPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +15 -0
- package/dist-types/ts3.4/Location.d.ts +85 -0
- package/dist-types/ts3.4/LocationClient.d.ts +30 -0
- package/dist-types/ts3.4/commands/CreateKeyCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/DeleteKeyCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/DescribeKeyCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/ListKeysCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/UpdateKeyCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +131 -15
- package/dist-types/ts3.4/pagination/ListKeysPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +60 -0
- package/package.json +4 -4
|
@@ -13,25 +13,15 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
13
13
|
*/
|
|
14
14
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
15
15
|
}
|
|
16
|
-
export
|
|
16
|
+
export declare type Status = "Active" | "Expired";
|
|
17
|
+
/**
|
|
18
|
+
* <p>Options for filtering API keys.</p>
|
|
19
|
+
*/
|
|
20
|
+
export interface ApiKeyFilter {
|
|
17
21
|
/**
|
|
18
|
-
* <p>
|
|
22
|
+
* <p>Filter on <code>Active</code> or <code>Expired</code> API keys.</p>
|
|
19
23
|
*/
|
|
20
|
-
|
|
21
|
-
/**
|
|
22
|
-
* <p>The Amazon Resource Name (ARN) for the geofence collection to be associated to tracker
|
|
23
|
-
* resource. Used when you need to specify a resource across all AWS.</p>
|
|
24
|
-
* <ul>
|
|
25
|
-
* <li>
|
|
26
|
-
* <p>Format example:
|
|
27
|
-
* <code>arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer</code>
|
|
28
|
-
* </p>
|
|
29
|
-
* </li>
|
|
30
|
-
* </ul>
|
|
31
|
-
*/
|
|
32
|
-
ConsumerArn: string | undefined;
|
|
33
|
-
}
|
|
34
|
-
export interface AssociateTrackerConsumerResponse {
|
|
24
|
+
KeyStatus?: Status | string;
|
|
35
25
|
}
|
|
36
26
|
/**
|
|
37
27
|
* <p>The request was unsuccessful because of a conflict.</p>
|
|
@@ -45,6 +35,190 @@ export declare class ConflictException extends __BaseException {
|
|
|
45
35
|
*/
|
|
46
36
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
47
37
|
}
|
|
38
|
+
/**
|
|
39
|
+
* <p>API Restrictions on the allowed actions, resources, and referers for an API key
|
|
40
|
+
* resource.</p>
|
|
41
|
+
*/
|
|
42
|
+
export interface ApiKeyRestrictions {
|
|
43
|
+
/**
|
|
44
|
+
* <p>A list of allowed actions that an API key resource grants permissions to
|
|
45
|
+
* perform</p>
|
|
46
|
+
* <note>
|
|
47
|
+
* <p>Currently, the only valid action is <code>geo:GetMap*</code> as an input to the
|
|
48
|
+
* list. For example, <code>["geo:GetMap*"]</code> is valid but
|
|
49
|
+
* <code>["geo:GetMapTile"]</code> is not.</p>
|
|
50
|
+
* </note>
|
|
51
|
+
*/
|
|
52
|
+
AllowActions: string[] | undefined;
|
|
53
|
+
/**
|
|
54
|
+
* <p>A list of allowed resource ARNs that a API key bearer can perform actions on</p>
|
|
55
|
+
* <p>For more information about ARN format, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names
|
|
56
|
+
* (ARNs)</a>.</p>
|
|
57
|
+
* <note>
|
|
58
|
+
* <p>In this preview, you can allow only map resources.</p>
|
|
59
|
+
* </note>
|
|
60
|
+
* <p>Requirements:</p>
|
|
61
|
+
* <ul>
|
|
62
|
+
* <li>
|
|
63
|
+
* <p>Must be prefixed with <code>arn</code>.</p>
|
|
64
|
+
* </li>
|
|
65
|
+
* <li>
|
|
66
|
+
* <p>
|
|
67
|
+
* <code>partition</code> and <code>service</code> must not be empty and should
|
|
68
|
+
* begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only
|
|
69
|
+
* alphanumeric numbers, hyphens (-) and periods (.).</p>
|
|
70
|
+
* </li>
|
|
71
|
+
* <li>
|
|
72
|
+
* <p>
|
|
73
|
+
* <code>region</code> and <code>account-id</code> can be empty or should begin
|
|
74
|
+
* with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric
|
|
75
|
+
* numbers, hyphens (-) and periods (.).</p>
|
|
76
|
+
* </li>
|
|
77
|
+
* <li>
|
|
78
|
+
* <p>
|
|
79
|
+
* <code>resource-id</code> can begin with any character except for forward slash
|
|
80
|
+
* (/) and contain any characters after, including forward slashes to form a
|
|
81
|
+
* path.</p>
|
|
82
|
+
* <p>
|
|
83
|
+
* <code>resource-id</code> can also include wildcard characters, denoted by an
|
|
84
|
+
* asterisk (*).</p>
|
|
85
|
+
* </li>
|
|
86
|
+
* <li>
|
|
87
|
+
* <p>
|
|
88
|
+
* <code>arn</code>, <code>partition</code>, <code>service</code>,
|
|
89
|
+
* <code>region</code>, <code>account-id</code> and <code>resource-id</code>
|
|
90
|
+
* must be delimited by a colon (:).</p>
|
|
91
|
+
* </li>
|
|
92
|
+
* <li>
|
|
93
|
+
* <p>No spaces allowed. For example,
|
|
94
|
+
* <code>arn:aws:geo:region:<i>account-id</i>:map/ExampleMap*</code>.</p>
|
|
95
|
+
* </li>
|
|
96
|
+
* </ul>
|
|
97
|
+
*/
|
|
98
|
+
AllowResources: string[] | undefined;
|
|
99
|
+
/**
|
|
100
|
+
* <p>An optional list of allowed HTTP referers for which requests must originate from.
|
|
101
|
+
* Requests using this API key from other domains will not be allowed.</p>
|
|
102
|
+
* <p>Requirements:</p>
|
|
103
|
+
* <ul>
|
|
104
|
+
* <li>
|
|
105
|
+
* <p>Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this
|
|
106
|
+
* list <code>$\-._+!*`(),;/?:@=&</code>
|
|
107
|
+
* </p>
|
|
108
|
+
* </li>
|
|
109
|
+
* <li>
|
|
110
|
+
* <p>May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9);
|
|
111
|
+
* this is used for URL encoding purposes.</p>
|
|
112
|
+
* </li>
|
|
113
|
+
* <li>
|
|
114
|
+
* <p>May contain wildcard characters question mark (?) and asterisk (*).</p>
|
|
115
|
+
* <p>Question mark (?) will replace any single character (including hexadecimal
|
|
116
|
+
* digits).</p>
|
|
117
|
+
* <p>Asterisk (*) will replace any multiple characters (including multiple
|
|
118
|
+
* hexadecimal digits).</p>
|
|
119
|
+
* </li>
|
|
120
|
+
* <li>
|
|
121
|
+
* <p>No spaces allowed. For example, <code>https://example.com</code>.</p>
|
|
122
|
+
* </li>
|
|
123
|
+
* </ul>
|
|
124
|
+
*/
|
|
125
|
+
AllowReferers?: string[];
|
|
126
|
+
}
|
|
127
|
+
export interface CreateKeyRequest {
|
|
128
|
+
/**
|
|
129
|
+
* <p>A custom name for the API key resource.</p>
|
|
130
|
+
* <p>Requirements:</p>
|
|
131
|
+
* <ul>
|
|
132
|
+
* <li>
|
|
133
|
+
* <p>Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods
|
|
134
|
+
* (.), and underscores (_). </p>
|
|
135
|
+
* </li>
|
|
136
|
+
* <li>
|
|
137
|
+
* <p>Must be a unique API key name.</p>
|
|
138
|
+
* </li>
|
|
139
|
+
* <li>
|
|
140
|
+
* <p>No spaces allowed. For example, <code>ExampleAPIKey</code>.</p>
|
|
141
|
+
* </li>
|
|
142
|
+
* </ul>
|
|
143
|
+
*/
|
|
144
|
+
KeyName: string | undefined;
|
|
145
|
+
/**
|
|
146
|
+
* <p>The API key restrictions for the API key resource.</p>
|
|
147
|
+
*/
|
|
148
|
+
Restrictions: ApiKeyRestrictions | undefined;
|
|
149
|
+
/**
|
|
150
|
+
* <p>An optional description for the API key resource.</p>
|
|
151
|
+
*/
|
|
152
|
+
Description?: string;
|
|
153
|
+
/**
|
|
154
|
+
* <p>The optional timestamp for when the API key resource will expire in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
|
|
155
|
+
* format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. One of <code>NoExpiry</code> or
|
|
156
|
+
* <code>ExpireTime</code> must be set.</p>
|
|
157
|
+
*/
|
|
158
|
+
ExpireTime?: Date;
|
|
159
|
+
/**
|
|
160
|
+
* <p>Optionally set to <code>true</code> to set no expiration time for the API key. One of
|
|
161
|
+
* <code>NoExpiry</code> or <code>ExpireTime</code> must be set.</p>
|
|
162
|
+
*/
|
|
163
|
+
NoExpiry?: boolean;
|
|
164
|
+
/**
|
|
165
|
+
* <p>Applies one or more tags to the map resource. A tag is a key-value pair that helps
|
|
166
|
+
* manage, identify, search, and filter your resources by labelling them.</p>
|
|
167
|
+
* <p>Format: <code>"key" : "value"</code>
|
|
168
|
+
* </p>
|
|
169
|
+
* <p>Restrictions:</p>
|
|
170
|
+
* <ul>
|
|
171
|
+
* <li>
|
|
172
|
+
* <p>Maximum 50 tags per resource</p>
|
|
173
|
+
* </li>
|
|
174
|
+
* <li>
|
|
175
|
+
* <p>Each resource tag must be unique with a maximum of one value.</p>
|
|
176
|
+
* </li>
|
|
177
|
+
* <li>
|
|
178
|
+
* <p>Maximum key length: 128 Unicode characters in UTF-8</p>
|
|
179
|
+
* </li>
|
|
180
|
+
* <li>
|
|
181
|
+
* <p>Maximum value length: 256 Unicode characters in UTF-8</p>
|
|
182
|
+
* </li>
|
|
183
|
+
* <li>
|
|
184
|
+
* <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters:
|
|
185
|
+
* + - = . _ : / @. </p>
|
|
186
|
+
* </li>
|
|
187
|
+
* <li>
|
|
188
|
+
* <p>Cannot use "aws:" as a prefix for a key.</p>
|
|
189
|
+
* </li>
|
|
190
|
+
* </ul>
|
|
191
|
+
*/
|
|
192
|
+
Tags?: Record<string, string>;
|
|
193
|
+
}
|
|
194
|
+
export interface CreateKeyResponse {
|
|
195
|
+
/**
|
|
196
|
+
* <p>The key value/string of an API key. This value is used when making API calls to
|
|
197
|
+
* authorize the call. For example, see <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_GetMapGlyphs.html">GetMapGlyphs</a>.</p>
|
|
198
|
+
*/
|
|
199
|
+
Key: string | undefined;
|
|
200
|
+
/**
|
|
201
|
+
* <p>The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify
|
|
202
|
+
* a resource across all Amazon Web Services.</p>
|
|
203
|
+
* <ul>
|
|
204
|
+
* <li>
|
|
205
|
+
* <p>Format example:
|
|
206
|
+
* <code>arn:aws:geo:region:account-id:key/ExampleKey</code>
|
|
207
|
+
* </p>
|
|
208
|
+
* </li>
|
|
209
|
+
* </ul>
|
|
210
|
+
*/
|
|
211
|
+
KeyArn: string | undefined;
|
|
212
|
+
/**
|
|
213
|
+
* <p>The name of the API key resource.</p>
|
|
214
|
+
*/
|
|
215
|
+
KeyName: string | undefined;
|
|
216
|
+
/**
|
|
217
|
+
* <p>The timestamp for when the API key resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
|
|
218
|
+
* format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
|
|
219
|
+
*/
|
|
220
|
+
CreateTime: Date | undefined;
|
|
221
|
+
}
|
|
48
222
|
/**
|
|
49
223
|
* <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
|
|
50
224
|
*/
|
|
@@ -58,18 +232,6 @@ export declare class InternalServerException extends __BaseException {
|
|
|
58
232
|
*/
|
|
59
233
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
60
234
|
}
|
|
61
|
-
/**
|
|
62
|
-
* <p>The resource that you've entered was not found in your AWS account.</p>
|
|
63
|
-
*/
|
|
64
|
-
export declare class ResourceNotFoundException extends __BaseException {
|
|
65
|
-
readonly name: "ResourceNotFoundException";
|
|
66
|
-
readonly $fault: "client";
|
|
67
|
-
Message: string | undefined;
|
|
68
|
-
/**
|
|
69
|
-
* @internal
|
|
70
|
-
*/
|
|
71
|
-
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
72
|
-
}
|
|
73
235
|
/**
|
|
74
236
|
* <p>The operation was denied because the request would exceed the maximum <a href="https://docs.aws.amazon.com/location/latest/developerguide/location-quotas.html">quota</a>
|
|
75
237
|
* set for Amazon Location Service.</p>
|
|
@@ -134,6 +296,225 @@ export declare class ValidationException extends __BaseException {
|
|
|
134
296
|
*/
|
|
135
297
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
136
298
|
}
|
|
299
|
+
export interface DeleteKeyRequest {
|
|
300
|
+
/**
|
|
301
|
+
* <p>The name of the API key to delete.</p>
|
|
302
|
+
*/
|
|
303
|
+
KeyName: string | undefined;
|
|
304
|
+
}
|
|
305
|
+
export interface DeleteKeyResponse {
|
|
306
|
+
}
|
|
307
|
+
/**
|
|
308
|
+
* <p>The resource that you've entered was not found in your AWS account.</p>
|
|
309
|
+
*/
|
|
310
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
311
|
+
readonly name: "ResourceNotFoundException";
|
|
312
|
+
readonly $fault: "client";
|
|
313
|
+
Message: string | undefined;
|
|
314
|
+
/**
|
|
315
|
+
* @internal
|
|
316
|
+
*/
|
|
317
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
318
|
+
}
|
|
319
|
+
export interface DescribeKeyRequest {
|
|
320
|
+
/**
|
|
321
|
+
* <p>The name of the API key resource.</p>
|
|
322
|
+
*/
|
|
323
|
+
KeyName: string | undefined;
|
|
324
|
+
}
|
|
325
|
+
export interface DescribeKeyResponse {
|
|
326
|
+
/**
|
|
327
|
+
* <p>The key value/string of an API key.</p>
|
|
328
|
+
*/
|
|
329
|
+
Key: string | undefined;
|
|
330
|
+
/**
|
|
331
|
+
* <p>The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify
|
|
332
|
+
* a resource across all Amazon Web Services.</p>
|
|
333
|
+
* <ul>
|
|
334
|
+
* <li>
|
|
335
|
+
* <p>Format example:
|
|
336
|
+
* <code>arn:aws:geo:region:account-id:key/ExampleKey</code>
|
|
337
|
+
* </p>
|
|
338
|
+
* </li>
|
|
339
|
+
* </ul>
|
|
340
|
+
*/
|
|
341
|
+
KeyArn: string | undefined;
|
|
342
|
+
/**
|
|
343
|
+
* <p>The name of the API key resource.</p>
|
|
344
|
+
*/
|
|
345
|
+
KeyName: string | undefined;
|
|
346
|
+
/**
|
|
347
|
+
* <p>API Restrictions on the allowed actions, resources, and referers for an API key
|
|
348
|
+
* resource.</p>
|
|
349
|
+
*/
|
|
350
|
+
Restrictions: ApiKeyRestrictions | undefined;
|
|
351
|
+
/**
|
|
352
|
+
* <p>The timestamp for when the API key resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
|
|
353
|
+
* format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
|
|
354
|
+
*/
|
|
355
|
+
CreateTime: Date | undefined;
|
|
356
|
+
/**
|
|
357
|
+
* <p>The timestamp for when the API key resource will expire in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
|
|
358
|
+
* format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
|
|
359
|
+
*/
|
|
360
|
+
ExpireTime: Date | undefined;
|
|
361
|
+
/**
|
|
362
|
+
* <p>The timestamp for when the API key resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
|
|
363
|
+
* format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
|
|
364
|
+
*/
|
|
365
|
+
UpdateTime: Date | undefined;
|
|
366
|
+
/**
|
|
367
|
+
* <p>The optional description for the API key resource.</p>
|
|
368
|
+
*/
|
|
369
|
+
Description?: string;
|
|
370
|
+
/**
|
|
371
|
+
* <p>Tags associated with the API key resource.</p>
|
|
372
|
+
*/
|
|
373
|
+
Tags?: Record<string, string>;
|
|
374
|
+
}
|
|
375
|
+
export interface ListKeysRequest {
|
|
376
|
+
/**
|
|
377
|
+
* <p>An optional limit for the number of resources returned in a single call. </p>
|
|
378
|
+
* <p>Default value: <code>100</code>
|
|
379
|
+
* </p>
|
|
380
|
+
*/
|
|
381
|
+
MaxResults?: number;
|
|
382
|
+
/**
|
|
383
|
+
* <p>The pagination token specifying which page of results to return in the response. If no
|
|
384
|
+
* token is provided, the default page is the first page. </p>
|
|
385
|
+
* <p>Default value: <code>null</code>
|
|
386
|
+
* </p>
|
|
387
|
+
*/
|
|
388
|
+
NextToken?: string;
|
|
389
|
+
/**
|
|
390
|
+
* <p>Optionally filter the list to only <code>Active</code> or <code>Expired</code> API
|
|
391
|
+
* keys.</p>
|
|
392
|
+
*/
|
|
393
|
+
Filter?: ApiKeyFilter;
|
|
394
|
+
}
|
|
395
|
+
/**
|
|
396
|
+
* <p>An API key resource listed in your Amazon Web Services account.</p>
|
|
397
|
+
*/
|
|
398
|
+
export interface ListKeysResponseEntry {
|
|
399
|
+
/**
|
|
400
|
+
* <p>The name of the API key resource.</p>
|
|
401
|
+
*/
|
|
402
|
+
KeyName: string | undefined;
|
|
403
|
+
/**
|
|
404
|
+
* <p>The timestamp for when the API key resource will expire, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
|
|
405
|
+
* format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
|
|
406
|
+
*/
|
|
407
|
+
ExpireTime: Date | undefined;
|
|
408
|
+
/**
|
|
409
|
+
* <p>The optional description for the API key resource.</p>
|
|
410
|
+
*/
|
|
411
|
+
Description?: string;
|
|
412
|
+
/**
|
|
413
|
+
* <p>API Restrictions on the allowed actions, resources, and referers for an API key
|
|
414
|
+
* resource.</p>
|
|
415
|
+
*/
|
|
416
|
+
Restrictions: ApiKeyRestrictions | undefined;
|
|
417
|
+
/**
|
|
418
|
+
* <p>The timestamp of when the API key was created, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
|
|
419
|
+
* format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
|
|
420
|
+
*/
|
|
421
|
+
CreateTime: Date | undefined;
|
|
422
|
+
/**
|
|
423
|
+
* <p>The timestamp of when the API key was last updated, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
|
|
424
|
+
* format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
|
|
425
|
+
*/
|
|
426
|
+
UpdateTime: Date | undefined;
|
|
427
|
+
}
|
|
428
|
+
export interface ListKeysResponse {
|
|
429
|
+
/**
|
|
430
|
+
* <p>Contains API key resources in your Amazon Web Services account. Details include API key
|
|
431
|
+
* name, allowed referers and timestamp for when the API key will expire.</p>
|
|
432
|
+
*/
|
|
433
|
+
Entries: ListKeysResponseEntry[] | undefined;
|
|
434
|
+
/**
|
|
435
|
+
* <p>A pagination token indicating there are additional pages available. You can use the
|
|
436
|
+
* token in a following request to fetch the next set of results. </p>
|
|
437
|
+
*/
|
|
438
|
+
NextToken?: string;
|
|
439
|
+
}
|
|
440
|
+
export interface UpdateKeyRequest {
|
|
441
|
+
/**
|
|
442
|
+
* <p>The name of the API key resource to update.</p>
|
|
443
|
+
*/
|
|
444
|
+
KeyName: string | undefined;
|
|
445
|
+
/**
|
|
446
|
+
* <p>Updates the description for the API key resource.</p>
|
|
447
|
+
*/
|
|
448
|
+
Description?: string;
|
|
449
|
+
/**
|
|
450
|
+
* <p>Updates the timestamp for when the API key resource will expire in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
|
|
451
|
+
* format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
|
|
452
|
+
*/
|
|
453
|
+
ExpireTime?: Date;
|
|
454
|
+
/**
|
|
455
|
+
* <p>Whether the API key should expire. Set to <code>true</code> to set the API key to have
|
|
456
|
+
* no expiration time.</p>
|
|
457
|
+
*/
|
|
458
|
+
NoExpiry?: boolean;
|
|
459
|
+
/**
|
|
460
|
+
* <p>The boolean flag to be included for updating <code>ExpireTime</code> or
|
|
461
|
+
* <code>Restrictions</code> details.</p>
|
|
462
|
+
* <p>Must be set to <code>true</code> to update an API key resource that has been used in
|
|
463
|
+
* the past 7 days.</p>
|
|
464
|
+
* <p>
|
|
465
|
+
* <code>False</code> if force update is not preferred</p>
|
|
466
|
+
* <p>Default value: <code>False</code>
|
|
467
|
+
* </p>
|
|
468
|
+
*/
|
|
469
|
+
ForceUpdate?: boolean;
|
|
470
|
+
/**
|
|
471
|
+
* <p>Updates the API key restrictions for the API key resource.</p>
|
|
472
|
+
*/
|
|
473
|
+
Restrictions?: ApiKeyRestrictions;
|
|
474
|
+
}
|
|
475
|
+
export interface UpdateKeyResponse {
|
|
476
|
+
/**
|
|
477
|
+
* <p>The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify
|
|
478
|
+
* a resource across all Amazon Web Services.</p>
|
|
479
|
+
* <ul>
|
|
480
|
+
* <li>
|
|
481
|
+
* <p>Format example:
|
|
482
|
+
* <code>arn:aws:geo:region:account-id:key/ExampleKey</code>
|
|
483
|
+
* </p>
|
|
484
|
+
* </li>
|
|
485
|
+
* </ul>
|
|
486
|
+
*/
|
|
487
|
+
KeyArn: string | undefined;
|
|
488
|
+
/**
|
|
489
|
+
* <p>The name of the API key resource.</p>
|
|
490
|
+
*/
|
|
491
|
+
KeyName: string | undefined;
|
|
492
|
+
/**
|
|
493
|
+
* <p>The timestamp for when the API key resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
|
|
494
|
+
* format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
|
|
495
|
+
*/
|
|
496
|
+
UpdateTime: Date | undefined;
|
|
497
|
+
}
|
|
498
|
+
export interface AssociateTrackerConsumerRequest {
|
|
499
|
+
/**
|
|
500
|
+
* <p>The name of the tracker resource to be associated with a geofence collection.</p>
|
|
501
|
+
*/
|
|
502
|
+
TrackerName: string | undefined;
|
|
503
|
+
/**
|
|
504
|
+
* <p>The Amazon Resource Name (ARN) for the geofence collection to be associated to tracker
|
|
505
|
+
* resource. Used when you need to specify a resource across all Amazon Web Services.</p>
|
|
506
|
+
* <ul>
|
|
507
|
+
* <li>
|
|
508
|
+
* <p>Format example:
|
|
509
|
+
* <code>arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer</code>
|
|
510
|
+
* </p>
|
|
511
|
+
* </li>
|
|
512
|
+
* </ul>
|
|
513
|
+
*/
|
|
514
|
+
ConsumerArn: string | undefined;
|
|
515
|
+
}
|
|
516
|
+
export interface AssociateTrackerConsumerResponse {
|
|
517
|
+
}
|
|
137
518
|
export interface BatchDeleteDevicePositionHistoryRequest {
|
|
138
519
|
/**
|
|
139
520
|
* <p>The name of the tracker resource to delete the device position history from.</p>
|
|
@@ -1406,7 +1787,9 @@ export interface CreateGeofenceCollectionRequest {
|
|
|
1406
1787
|
*/
|
|
1407
1788
|
Tags?: Record<string, string>;
|
|
1408
1789
|
/**
|
|
1409
|
-
* <p>A key identifier for an
|
|
1790
|
+
* <p>A key identifier for an
|
|
1791
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services
|
|
1792
|
+
* KMS customer managed key</a>. Enter a key ID, key ARN, alias name, or alias ARN.
|
|
1410
1793
|
* </p>
|
|
1411
1794
|
*/
|
|
1412
1795
|
KmsKeyId?: string;
|
|
@@ -1418,7 +1801,7 @@ export interface CreateGeofenceCollectionResponse {
|
|
|
1418
1801
|
CollectionName: string | undefined;
|
|
1419
1802
|
/**
|
|
1420
1803
|
* <p>The Amazon Resource Name (ARN) for the geofence collection resource. Used when you
|
|
1421
|
-
* need to specify a resource across all
|
|
1804
|
+
* need to specify a resource across all Amazon Web Services. </p>
|
|
1422
1805
|
* <ul>
|
|
1423
1806
|
* <li>
|
|
1424
1807
|
* <p>Format example:
|
|
@@ -1639,7 +2022,7 @@ export interface CreateMapResponse {
|
|
|
1639
2022
|
MapName: string | undefined;
|
|
1640
2023
|
/**
|
|
1641
2024
|
* <p>The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across
|
|
1642
|
-
* all
|
|
2025
|
+
* all Amazon Web Services.</p>
|
|
1643
2026
|
* <ul>
|
|
1644
2027
|
* <li>
|
|
1645
2028
|
* <p>Format example:
|
|
@@ -1738,7 +2121,7 @@ export interface CreatePlaceIndexRequest {
|
|
|
1738
2121
|
* <important>
|
|
1739
2122
|
* <p>If you specify HERE Technologies (<code>Here</code>) as the data provider,
|
|
1740
2123
|
* you may not <a href="https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html">store results</a> for locations in Japan. For more information, see
|
|
1741
|
-
* the <a href="
|
|
2124
|
+
* the <a href="http://aws.amazon.com/service-terms/">Amazon Web Services Service
|
|
1742
2125
|
* Terms</a> for Amazon Location Service.</p>
|
|
1743
2126
|
* </important>
|
|
1744
2127
|
* </li>
|
|
@@ -1799,7 +2182,7 @@ export interface CreatePlaceIndexResponse {
|
|
|
1799
2182
|
IndexName: string | undefined;
|
|
1800
2183
|
/**
|
|
1801
2184
|
* <p>The Amazon Resource Name (ARN) for the place index resource. Used to specify a
|
|
1802
|
-
* resource across
|
|
2185
|
+
* resource across Amazon Web Services. </p>
|
|
1803
2186
|
* <ul>
|
|
1804
2187
|
* <li>
|
|
1805
2188
|
* <p>Format example:
|
|
@@ -1923,7 +2306,7 @@ export interface CreateRouteCalculatorResponse {
|
|
|
1923
2306
|
CalculatorName: string | undefined;
|
|
1924
2307
|
/**
|
|
1925
2308
|
* <p>The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you
|
|
1926
|
-
* specify a resource across all
|
|
2309
|
+
* specify a resource across all Amazon Web Services.</p>
|
|
1927
2310
|
* <ul>
|
|
1928
2311
|
* <li>
|
|
1929
2312
|
* <p>Format example:
|
|
@@ -1971,7 +2354,9 @@ export interface CreateTrackerRequest {
|
|
|
1971
2354
|
*/
|
|
1972
2355
|
PricingPlan?: PricingPlan | string;
|
|
1973
2356
|
/**
|
|
1974
|
-
* <p>A key identifier for an
|
|
2357
|
+
* <p>A key identifier for an
|
|
2358
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services
|
|
2359
|
+
* KMS customer managed key</a>. Enter a key ID, key ARN, alias name, or alias ARN.</p>
|
|
1975
2360
|
*/
|
|
1976
2361
|
KmsKeyId?: string;
|
|
1977
2362
|
/**
|
|
@@ -2055,7 +2440,7 @@ export interface CreateTrackerResponse {
|
|
|
2055
2440
|
TrackerName: string | undefined;
|
|
2056
2441
|
/**
|
|
2057
2442
|
* <p>The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify
|
|
2058
|
-
* a resource across all
|
|
2443
|
+
* a resource across all Amazon Web Services.</p>
|
|
2059
2444
|
* <ul>
|
|
2060
2445
|
* <li>
|
|
2061
2446
|
* <p>Format example:
|
|
@@ -2124,7 +2509,7 @@ export interface DescribeGeofenceCollectionResponse {
|
|
|
2124
2509
|
CollectionName: string | undefined;
|
|
2125
2510
|
/**
|
|
2126
2511
|
* <p>The Amazon Resource Name (ARN) for the geofence collection resource. Used when you
|
|
2127
|
-
* need to specify a resource across all
|
|
2512
|
+
* need to specify a resource across all Amazon Web Services. </p>
|
|
2128
2513
|
* <ul>
|
|
2129
2514
|
* <li>
|
|
2130
2515
|
* <p>Format example:
|
|
@@ -2151,7 +2536,9 @@ export interface DescribeGeofenceCollectionResponse {
|
|
|
2151
2536
|
*/
|
|
2152
2537
|
PricingPlanDataSource?: string;
|
|
2153
2538
|
/**
|
|
2154
|
-
* <p>A key identifier for an
|
|
2539
|
+
* <p>A key identifier for an
|
|
2540
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services
|
|
2541
|
+
* KMS customer managed key</a> assigned to the Amazon Location resource</p>
|
|
2155
2542
|
*/
|
|
2156
2543
|
KmsKeyId?: string;
|
|
2157
2544
|
/**
|
|
@@ -2184,7 +2571,7 @@ export interface DescribeMapResponse {
|
|
|
2184
2571
|
MapName: string | undefined;
|
|
2185
2572
|
/**
|
|
2186
2573
|
* <p>The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across
|
|
2187
|
-
* all
|
|
2574
|
+
* all Amazon Web Services.</p>
|
|
2188
2575
|
* <ul>
|
|
2189
2576
|
* <li>
|
|
2190
2577
|
* <p>Format example:
|
|
@@ -2240,7 +2627,7 @@ export interface DescribePlaceIndexResponse {
|
|
|
2240
2627
|
IndexName: string | undefined;
|
|
2241
2628
|
/**
|
|
2242
2629
|
* <p>The Amazon Resource Name (ARN) for the place index resource. Used to specify a
|
|
2243
|
-
* resource across
|
|
2630
|
+
* resource across Amazon Web Services. </p>
|
|
2244
2631
|
* <ul>
|
|
2245
2632
|
* <li>
|
|
2246
2633
|
* <p>Format example:
|
|
@@ -2314,7 +2701,7 @@ export interface DescribeRouteCalculatorResponse {
|
|
|
2314
2701
|
CalculatorName: string | undefined;
|
|
2315
2702
|
/**
|
|
2316
2703
|
* <p>The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you
|
|
2317
|
-
* specify a resource across
|
|
2704
|
+
* specify a resource across Amazon Web Services.</p>
|
|
2318
2705
|
* <ul>
|
|
2319
2706
|
* <li>
|
|
2320
2707
|
* <p>Format example:
|
|
@@ -2397,7 +2784,7 @@ export interface DescribeTrackerResponse {
|
|
|
2397
2784
|
TrackerName: string | undefined;
|
|
2398
2785
|
/**
|
|
2399
2786
|
* <p>The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify
|
|
2400
|
-
* a resource across all
|
|
2787
|
+
* a resource across all Amazon Web Services.</p>
|
|
2401
2788
|
* <ul>
|
|
2402
2789
|
* <li>
|
|
2403
2790
|
* <p>Format example:
|
|
@@ -2438,7 +2825,8 @@ export interface DescribeTrackerResponse {
|
|
|
2438
2825
|
*/
|
|
2439
2826
|
UpdateTime: Date | undefined;
|
|
2440
2827
|
/**
|
|
2441
|
-
* <p>A key identifier for an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">
|
|
2828
|
+
* <p>A key identifier for an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services
|
|
2829
|
+
* KMS customer managed key</a> assigned to the Amazon Location resource.</p>
|
|
2442
2830
|
*/
|
|
2443
2831
|
KmsKeyId?: string;
|
|
2444
2832
|
/**
|
|
@@ -2453,7 +2841,7 @@ export interface DisassociateTrackerConsumerRequest {
|
|
|
2453
2841
|
TrackerName: string | undefined;
|
|
2454
2842
|
/**
|
|
2455
2843
|
* <p>The Amazon Resource Name (ARN) for the geofence collection to be disassociated from
|
|
2456
|
-
* the tracker resource. Used when you need to specify a resource across all
|
|
2844
|
+
* the tracker resource. Used when you need to specify a resource across all Amazon Web Services. </p>
|
|
2457
2845
|
* <ul>
|
|
2458
2846
|
* <li>
|
|
2459
2847
|
* <p>Format example:
|
|
@@ -2471,7 +2859,8 @@ export interface ListTagsForResourceRequest {
|
|
|
2471
2859
|
* <p>The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.</p>
|
|
2472
2860
|
* <ul>
|
|
2473
2861
|
* <li>
|
|
2474
|
-
* <p>Format example:
|
|
2862
|
+
* <p>Format example:
|
|
2863
|
+
* <code>arn:aws:geo:region:account-id:resourcetype/ExampleResource</code>
|
|
2475
2864
|
* </p>
|
|
2476
2865
|
* </li>
|
|
2477
2866
|
* </ul>
|
|
@@ -2480,7 +2869,8 @@ export interface ListTagsForResourceRequest {
|
|
|
2480
2869
|
}
|
|
2481
2870
|
export interface ListTagsForResourceResponse {
|
|
2482
2871
|
/**
|
|
2483
|
-
* <p>Tags that have been applied to the specified resource. Tags are mapped from the tag
|
|
2872
|
+
* <p>Tags that have been applied to the specified resource. Tags are mapped from the tag
|
|
2873
|
+
* key to the tag value: <code>"TagKey" : "TagValue"</code>.</p>
|
|
2484
2874
|
* <ul>
|
|
2485
2875
|
* <li>
|
|
2486
2876
|
* <p>Format example: <code>{"tag1" : "value1", "tag2" : "value2"} </code>
|
|
@@ -2495,15 +2885,16 @@ export interface TagResourceRequest {
|
|
|
2495
2885
|
* <p>The Amazon Resource Name (ARN) of the resource whose tags you want to update.</p>
|
|
2496
2886
|
* <ul>
|
|
2497
2887
|
* <li>
|
|
2498
|
-
* <p>Format example:
|
|
2888
|
+
* <p>Format example:
|
|
2889
|
+
* <code>arn:aws:geo:region:account-id:resourcetype/ExampleResource</code>
|
|
2499
2890
|
* </p>
|
|
2500
2891
|
* </li>
|
|
2501
2892
|
* </ul>
|
|
2502
2893
|
*/
|
|
2503
2894
|
ResourceArn: string | undefined;
|
|
2504
2895
|
/**
|
|
2505
|
-
* <p>Applies one or more tags to specific resource. A tag is a key-value pair that helps
|
|
2506
|
-
* manage, identify, search, and filter your resources.</p>
|
|
2896
|
+
* <p>Applies one or more tags to specific resource. A tag is a key-value pair that helps
|
|
2897
|
+
* you manage, identify, search, and filter your resources.</p>
|
|
2507
2898
|
* <p>Format: <code>"key" : "value"</code>
|
|
2508
2899
|
* </p>
|
|
2509
2900
|
* <p>Restrictions:</p>
|
|
@@ -2521,8 +2912,8 @@ export interface TagResourceRequest {
|
|
|
2521
2912
|
* <p>Maximum value length: 256 Unicode characters in UTF-8.</p>
|
|
2522
2913
|
* </li>
|
|
2523
2914
|
* <li>
|
|
2524
|
-
* <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters:
|
|
2525
|
-
* = . _ : / @</p>
|
|
2915
|
+
* <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters:
|
|
2916
|
+
* + - = . _ : / @</p>
|
|
2526
2917
|
* </li>
|
|
2527
2918
|
* <li>
|
|
2528
2919
|
* <p>Cannot use "aws:" as a prefix for a key.</p>
|
|
@@ -2535,10 +2926,12 @@ export interface TagResourceResponse {
|
|
|
2535
2926
|
}
|
|
2536
2927
|
export interface UntagResourceRequest {
|
|
2537
2928
|
/**
|
|
2538
|
-
* <p>The Amazon Resource Name (ARN) of the resource from which you want to remove
|
|
2929
|
+
* <p>The Amazon Resource Name (ARN) of the resource from which you want to remove
|
|
2930
|
+
* tags.</p>
|
|
2539
2931
|
* <ul>
|
|
2540
2932
|
* <li>
|
|
2541
|
-
* <p>Format example:
|
|
2933
|
+
* <p>Format example:
|
|
2934
|
+
* <code>arn:aws:geo:region:account-id:resourcetype/ExampleResource</code>
|
|
2542
2935
|
* </p>
|
|
2543
2936
|
* </li>
|
|
2544
2937
|
* </ul>
|
|
@@ -2666,7 +3059,7 @@ export interface ListGeofenceCollectionsResponseEntry {
|
|
|
2666
3059
|
}
|
|
2667
3060
|
export interface ListGeofenceCollectionsResponse {
|
|
2668
3061
|
/**
|
|
2669
|
-
* <p>Lists the geofence collections that exist in your
|
|
3062
|
+
* <p>Lists the geofence collections that exist in your Amazon Web Services account.</p>
|
|
2670
3063
|
*/
|
|
2671
3064
|
Entries: ListGeofenceCollectionsResponseEntry[] | undefined;
|
|
2672
3065
|
/**
|
|
@@ -2826,7 +3219,7 @@ export interface UpdateGeofenceCollectionResponse {
|
|
|
2826
3219
|
CollectionName: string | undefined;
|
|
2827
3220
|
/**
|
|
2828
3221
|
* <p>The Amazon Resource Name (ARN) of the updated geofence collection. Used to specify a
|
|
2829
|
-
* resource across
|
|
3222
|
+
* resource across Amazon Web Services.</p>
|
|
2830
3223
|
* <ul>
|
|
2831
3224
|
* <li>
|
|
2832
3225
|
* <p>Format example:
|
|
@@ -3031,16 +3424,25 @@ export interface GetMapGlyphsRequest {
|
|
|
3031
3424
|
* <code>00FF</code>. Must be aligned to multiples of 256.</p>
|
|
3032
3425
|
*/
|
|
3033
3426
|
FontUnicodeRange: string | undefined;
|
|
3427
|
+
/**
|
|
3428
|
+
* <p>The optional <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">API key</a> to authorize
|
|
3429
|
+
* the request.</p>
|
|
3430
|
+
*/
|
|
3431
|
+
Key?: string;
|
|
3034
3432
|
}
|
|
3035
3433
|
export interface GetMapGlyphsResponse {
|
|
3036
3434
|
/**
|
|
3037
|
-
* <p>The
|
|
3435
|
+
* <p>The glyph, as binary blob.</p>
|
|
3038
3436
|
*/
|
|
3039
3437
|
Blob?: Uint8Array;
|
|
3040
3438
|
/**
|
|
3041
3439
|
* <p>The map glyph content type. For example, <code>application/octet-stream</code>.</p>
|
|
3042
3440
|
*/
|
|
3043
3441
|
ContentType?: string;
|
|
3442
|
+
/**
|
|
3443
|
+
* <p>The HTTP Cache-Control directive for the value.</p>
|
|
3444
|
+
*/
|
|
3445
|
+
CacheControl?: string;
|
|
3044
3446
|
}
|
|
3045
3447
|
export interface GetMapSpritesRequest {
|
|
3046
3448
|
/**
|
|
@@ -3074,6 +3476,11 @@ export interface GetMapSpritesRequest {
|
|
|
3074
3476
|
* </ul>
|
|
3075
3477
|
*/
|
|
3076
3478
|
FileName: string | undefined;
|
|
3479
|
+
/**
|
|
3480
|
+
* <p>The optional <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">API key</a> to authorize
|
|
3481
|
+
* the request.</p>
|
|
3482
|
+
*/
|
|
3483
|
+
Key?: string;
|
|
3077
3484
|
}
|
|
3078
3485
|
export interface GetMapSpritesResponse {
|
|
3079
3486
|
/**
|
|
@@ -3086,12 +3493,21 @@ export interface GetMapSpritesResponse {
|
|
|
3086
3493
|
* <code>application/json</code>. </p>
|
|
3087
3494
|
*/
|
|
3088
3495
|
ContentType?: string;
|
|
3496
|
+
/**
|
|
3497
|
+
* <p>The HTTP Cache-Control directive for the value.</p>
|
|
3498
|
+
*/
|
|
3499
|
+
CacheControl?: string;
|
|
3089
3500
|
}
|
|
3090
3501
|
export interface GetMapStyleDescriptorRequest {
|
|
3091
3502
|
/**
|
|
3092
3503
|
* <p>The map resource to retrieve the style descriptor from.</p>
|
|
3093
3504
|
*/
|
|
3094
3505
|
MapName: string | undefined;
|
|
3506
|
+
/**
|
|
3507
|
+
* <p>The optional <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">API key</a> to authorize
|
|
3508
|
+
* the request.</p>
|
|
3509
|
+
*/
|
|
3510
|
+
Key?: string;
|
|
3095
3511
|
}
|
|
3096
3512
|
export interface GetMapStyleDescriptorResponse {
|
|
3097
3513
|
/**
|
|
@@ -3103,6 +3519,10 @@ export interface GetMapStyleDescriptorResponse {
|
|
|
3103
3519
|
* <code>application/json</code>.</p>
|
|
3104
3520
|
*/
|
|
3105
3521
|
ContentType?: string;
|
|
3522
|
+
/**
|
|
3523
|
+
* <p>The HTTP Cache-Control directive for the value.</p>
|
|
3524
|
+
*/
|
|
3525
|
+
CacheControl?: string;
|
|
3106
3526
|
}
|
|
3107
3527
|
export interface GetMapTileRequest {
|
|
3108
3528
|
/**
|
|
@@ -3121,6 +3541,11 @@ export interface GetMapTileRequest {
|
|
|
3121
3541
|
* <p>The Y axis value for the map tile. </p>
|
|
3122
3542
|
*/
|
|
3123
3543
|
Y: string | undefined;
|
|
3544
|
+
/**
|
|
3545
|
+
* <p>The optional <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">API key</a> to authorize
|
|
3546
|
+
* the request.</p>
|
|
3547
|
+
*/
|
|
3548
|
+
Key?: string;
|
|
3124
3549
|
}
|
|
3125
3550
|
export interface GetMapTileResponse {
|
|
3126
3551
|
/**
|
|
@@ -3132,6 +3557,10 @@ export interface GetMapTileResponse {
|
|
|
3132
3557
|
* <code>application/vnd.mapbox-vector-tile</code>.</p>
|
|
3133
3558
|
*/
|
|
3134
3559
|
ContentType?: string;
|
|
3560
|
+
/**
|
|
3561
|
+
* <p>The HTTP Cache-Control directive for the value.</p>
|
|
3562
|
+
*/
|
|
3563
|
+
CacheControl?: string;
|
|
3135
3564
|
}
|
|
3136
3565
|
export interface GetPlaceRequest {
|
|
3137
3566
|
/**
|
|
@@ -3361,7 +3790,7 @@ export interface ListMapsRequest {
|
|
|
3361
3790
|
NextToken?: string;
|
|
3362
3791
|
}
|
|
3363
3792
|
/**
|
|
3364
|
-
* <p>Contains details of an existing map resource in your
|
|
3793
|
+
* <p>Contains details of an existing map resource in your Amazon Web Services account.</p>
|
|
3365
3794
|
*/
|
|
3366
3795
|
export interface ListMapsResponseEntry {
|
|
3367
3796
|
/**
|
|
@@ -3395,7 +3824,7 @@ export interface ListMapsResponseEntry {
|
|
|
3395
3824
|
}
|
|
3396
3825
|
export interface ListMapsResponse {
|
|
3397
3826
|
/**
|
|
3398
|
-
* <p>Contains a list of maps in your
|
|
3827
|
+
* <p>Contains a list of maps in your Amazon Web Services account</p>
|
|
3399
3828
|
*/
|
|
3400
3829
|
Entries: ListMapsResponseEntry[] | undefined;
|
|
3401
3830
|
/**
|
|
@@ -3419,7 +3848,7 @@ export interface ListPlaceIndexesRequest {
|
|
|
3419
3848
|
NextToken?: string;
|
|
3420
3849
|
}
|
|
3421
3850
|
/**
|
|
3422
|
-
* <p>A place index resource listed in your
|
|
3851
|
+
* <p>A place index resource listed in your Amazon Web Services account.</p>
|
|
3423
3852
|
*/
|
|
3424
3853
|
export interface ListPlaceIndexesResponseEntry {
|
|
3425
3854
|
/**
|
|
@@ -3471,7 +3900,7 @@ export interface ListPlaceIndexesResponseEntry {
|
|
|
3471
3900
|
}
|
|
3472
3901
|
export interface ListPlaceIndexesResponse {
|
|
3473
3902
|
/**
|
|
3474
|
-
* <p>Lists the place index resources that exist in your
|
|
3903
|
+
* <p>Lists the place index resources that exist in your Amazon Web Services account</p>
|
|
3475
3904
|
*/
|
|
3476
3905
|
Entries: ListPlaceIndexesResponseEntry[] | undefined;
|
|
3477
3906
|
/**
|
|
@@ -3496,7 +3925,7 @@ export interface ListRouteCalculatorsRequest {
|
|
|
3496
3925
|
NextToken?: string;
|
|
3497
3926
|
}
|
|
3498
3927
|
/**
|
|
3499
|
-
* <p>A route calculator resource listed in your
|
|
3928
|
+
* <p>A route calculator resource listed in your Amazon Web Services account.</p>
|
|
3500
3929
|
*/
|
|
3501
3930
|
export interface ListRouteCalculatorsResponseEntry {
|
|
3502
3931
|
/**
|
|
@@ -3561,7 +3990,7 @@ export interface ListRouteCalculatorsResponseEntry {
|
|
|
3561
3990
|
}
|
|
3562
3991
|
export interface ListRouteCalculatorsResponse {
|
|
3563
3992
|
/**
|
|
3564
|
-
* <p>Lists the route calculator resources that exist in your
|
|
3993
|
+
* <p>Lists the route calculator resources that exist in your Amazon Web Services account</p>
|
|
3565
3994
|
*/
|
|
3566
3995
|
Entries: ListRouteCalculatorsResponseEntry[] | undefined;
|
|
3567
3996
|
/**
|
|
@@ -3652,7 +4081,7 @@ export interface ListTrackersResponseEntry {
|
|
|
3652
4081
|
}
|
|
3653
4082
|
export interface ListTrackersResponse {
|
|
3654
4083
|
/**
|
|
3655
|
-
* <p>Contains tracker resources in your
|
|
4084
|
+
* <p>Contains tracker resources in your Amazon Web Services account. Details include tracker name,
|
|
3656
4085
|
* description and timestamps for when the tracker was created and last updated.</p>
|
|
3657
4086
|
*/
|
|
3658
4087
|
Entries: ListTrackersResponseEntry[] | undefined;
|
|
@@ -4208,7 +4637,7 @@ export interface UpdatePlaceIndexResponse {
|
|
|
4208
4637
|
IndexName: string | undefined;
|
|
4209
4638
|
/**
|
|
4210
4639
|
* <p>The Amazon Resource Name (ARN) of the upated place index resource. Used to specify a
|
|
4211
|
-
* resource across
|
|
4640
|
+
* resource across Amazon Web Services.</p>
|
|
4212
4641
|
* <ul>
|
|
4213
4642
|
* <li>
|
|
4214
4643
|
* <p>Format example: <code>arn:aws:geo:region:account-id:place-
|
|
@@ -4345,15 +4774,67 @@ export interface UpdateTrackerResponse {
|
|
|
4345
4774
|
/**
|
|
4346
4775
|
* @internal
|
|
4347
4776
|
*/
|
|
4348
|
-
export declare const
|
|
4777
|
+
export declare const ApiKeyFilterFilterSensitiveLog: (obj: ApiKeyFilter) => any;
|
|
4349
4778
|
/**
|
|
4350
4779
|
* @internal
|
|
4351
4780
|
*/
|
|
4352
|
-
export declare const
|
|
4781
|
+
export declare const ApiKeyRestrictionsFilterSensitiveLog: (obj: ApiKeyRestrictions) => any;
|
|
4782
|
+
/**
|
|
4783
|
+
* @internal
|
|
4784
|
+
*/
|
|
4785
|
+
export declare const CreateKeyRequestFilterSensitiveLog: (obj: CreateKeyRequest) => any;
|
|
4786
|
+
/**
|
|
4787
|
+
* @internal
|
|
4788
|
+
*/
|
|
4789
|
+
export declare const CreateKeyResponseFilterSensitiveLog: (obj: CreateKeyResponse) => any;
|
|
4353
4790
|
/**
|
|
4354
4791
|
* @internal
|
|
4355
4792
|
*/
|
|
4356
4793
|
export declare const ValidationExceptionFieldFilterSensitiveLog: (obj: ValidationExceptionField) => any;
|
|
4794
|
+
/**
|
|
4795
|
+
* @internal
|
|
4796
|
+
*/
|
|
4797
|
+
export declare const DeleteKeyRequestFilterSensitiveLog: (obj: DeleteKeyRequest) => any;
|
|
4798
|
+
/**
|
|
4799
|
+
* @internal
|
|
4800
|
+
*/
|
|
4801
|
+
export declare const DeleteKeyResponseFilterSensitiveLog: (obj: DeleteKeyResponse) => any;
|
|
4802
|
+
/**
|
|
4803
|
+
* @internal
|
|
4804
|
+
*/
|
|
4805
|
+
export declare const DescribeKeyRequestFilterSensitiveLog: (obj: DescribeKeyRequest) => any;
|
|
4806
|
+
/**
|
|
4807
|
+
* @internal
|
|
4808
|
+
*/
|
|
4809
|
+
export declare const DescribeKeyResponseFilterSensitiveLog: (obj: DescribeKeyResponse) => any;
|
|
4810
|
+
/**
|
|
4811
|
+
* @internal
|
|
4812
|
+
*/
|
|
4813
|
+
export declare const ListKeysRequestFilterSensitiveLog: (obj: ListKeysRequest) => any;
|
|
4814
|
+
/**
|
|
4815
|
+
* @internal
|
|
4816
|
+
*/
|
|
4817
|
+
export declare const ListKeysResponseEntryFilterSensitiveLog: (obj: ListKeysResponseEntry) => any;
|
|
4818
|
+
/**
|
|
4819
|
+
* @internal
|
|
4820
|
+
*/
|
|
4821
|
+
export declare const ListKeysResponseFilterSensitiveLog: (obj: ListKeysResponse) => any;
|
|
4822
|
+
/**
|
|
4823
|
+
* @internal
|
|
4824
|
+
*/
|
|
4825
|
+
export declare const UpdateKeyRequestFilterSensitiveLog: (obj: UpdateKeyRequest) => any;
|
|
4826
|
+
/**
|
|
4827
|
+
* @internal
|
|
4828
|
+
*/
|
|
4829
|
+
export declare const UpdateKeyResponseFilterSensitiveLog: (obj: UpdateKeyResponse) => any;
|
|
4830
|
+
/**
|
|
4831
|
+
* @internal
|
|
4832
|
+
*/
|
|
4833
|
+
export declare const AssociateTrackerConsumerRequestFilterSensitiveLog: (obj: AssociateTrackerConsumerRequest) => any;
|
|
4834
|
+
/**
|
|
4835
|
+
* @internal
|
|
4836
|
+
*/
|
|
4837
|
+
export declare const AssociateTrackerConsumerResponseFilterSensitiveLog: (obj: AssociateTrackerConsumerResponse) => any;
|
|
4357
4838
|
/**
|
|
4358
4839
|
* @internal
|
|
4359
4840
|
*/
|