@aws-sdk/client-kms 3.295.0 → 3.297.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-types/KMS.d.ts +51 -0
- package/dist-types/KMSClient.d.ts +24 -4
- package/dist-types/commands/CancelKeyDeletionCommand.d.ts +16 -0
- package/dist-types/commands/ConnectCustomKeyStoreCommand.d.ts +16 -0
- package/dist-types/commands/CreateAliasCommand.d.ts +16 -0
- package/dist-types/commands/CreateCustomKeyStoreCommand.d.ts +16 -0
- package/dist-types/commands/CreateGrantCommand.d.ts +16 -0
- package/dist-types/commands/CreateKeyCommand.d.ts +16 -0
- package/dist-types/commands/DecryptCommand.d.ts +16 -0
- package/dist-types/commands/DeleteAliasCommand.d.ts +16 -0
- package/dist-types/commands/DeleteCustomKeyStoreCommand.d.ts +16 -0
- package/dist-types/commands/DeleteImportedKeyMaterialCommand.d.ts +16 -0
- package/dist-types/commands/DescribeCustomKeyStoresCommand.d.ts +16 -0
- package/dist-types/commands/DescribeKeyCommand.d.ts +16 -0
- package/dist-types/commands/DisableKeyCommand.d.ts +16 -0
- package/dist-types/commands/DisableKeyRotationCommand.d.ts +16 -0
- package/dist-types/commands/DisconnectCustomKeyStoreCommand.d.ts +16 -0
- package/dist-types/commands/EnableKeyCommand.d.ts +16 -0
- package/dist-types/commands/EnableKeyRotationCommand.d.ts +16 -0
- package/dist-types/commands/EncryptCommand.d.ts +16 -0
- package/dist-types/commands/GenerateDataKeyCommand.d.ts +16 -0
- package/dist-types/commands/GenerateDataKeyPairCommand.d.ts +16 -0
- package/dist-types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +16 -0
- package/dist-types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +16 -0
- package/dist-types/commands/GenerateMacCommand.d.ts +16 -0
- package/dist-types/commands/GenerateRandomCommand.d.ts +16 -0
- package/dist-types/commands/GetKeyPolicyCommand.d.ts +16 -0
- package/dist-types/commands/GetKeyRotationStatusCommand.d.ts +16 -0
- package/dist-types/commands/GetParametersForImportCommand.d.ts +16 -0
- package/dist-types/commands/GetPublicKeyCommand.d.ts +16 -0
- package/dist-types/commands/ImportKeyMaterialCommand.d.ts +16 -0
- package/dist-types/commands/ListAliasesCommand.d.ts +16 -0
- package/dist-types/commands/ListGrantsCommand.d.ts +16 -0
- package/dist-types/commands/ListKeyPoliciesCommand.d.ts +16 -0
- package/dist-types/commands/ListKeysCommand.d.ts +16 -0
- package/dist-types/commands/ListResourceTagsCommand.d.ts +16 -0
- package/dist-types/commands/ListRetirableGrantsCommand.d.ts +16 -0
- package/dist-types/commands/PutKeyPolicyCommand.d.ts +16 -0
- package/dist-types/commands/ReEncryptCommand.d.ts +16 -0
- package/dist-types/commands/ReplicateKeyCommand.d.ts +16 -0
- package/dist-types/commands/RetireGrantCommand.d.ts +16 -0
- package/dist-types/commands/RevokeGrantCommand.d.ts +16 -0
- package/dist-types/commands/ScheduleKeyDeletionCommand.d.ts +16 -0
- package/dist-types/commands/SignCommand.d.ts +16 -0
- package/dist-types/commands/TagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UpdateAliasCommand.d.ts +16 -0
- package/dist-types/commands/UpdateCustomKeyStoreCommand.d.ts +16 -0
- package/dist-types/commands/UpdateKeyDescriptionCommand.d.ts +16 -0
- package/dist-types/commands/UpdatePrimaryRegionCommand.d.ts +16 -0
- package/dist-types/commands/VerifyCommand.d.ts +16 -0
- package/dist-types/commands/VerifyMacCommand.d.ts +16 -0
- package/dist-types/models/KMSServiceException.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +373 -0
- package/dist-types/pagination/DescribeCustomKeyStoresPaginator.d.ts +3 -0
- package/dist-types/pagination/Interfaces.d.ts +3 -0
- package/dist-types/pagination/ListAliasesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListGrantsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListKeyPoliciesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListKeysPaginator.d.ts +3 -0
- package/dist-types/pagination/ListResourceTagsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListRetirableGrantsPaginator.d.ts +3 -0
- package/package.json +29 -29
|
@@ -1,11 +1,15 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { KMSServiceException as __BaseException } from "./KMSServiceException";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
3
6
|
export declare enum AlgorithmSpec {
|
|
4
7
|
RSAES_OAEP_SHA_1 = "RSAES_OAEP_SHA_1",
|
|
5
8
|
RSAES_OAEP_SHA_256 = "RSAES_OAEP_SHA_256",
|
|
6
9
|
RSAES_PKCS1_V1_5 = "RSAES_PKCS1_V1_5"
|
|
7
10
|
}
|
|
8
11
|
/**
|
|
12
|
+
* @public
|
|
9
13
|
* <p>Contains information about an alias.</p>
|
|
10
14
|
*/
|
|
11
15
|
export interface AliasListEntry {
|
|
@@ -33,6 +37,7 @@ export interface AliasListEntry {
|
|
|
33
37
|
LastUpdatedDate?: Date;
|
|
34
38
|
}
|
|
35
39
|
/**
|
|
40
|
+
* @public
|
|
36
41
|
* <p>The request was rejected because it attempted to create a resource that already
|
|
37
42
|
* exists.</p>
|
|
38
43
|
*/
|
|
@@ -44,6 +49,9 @@ export declare class AlreadyExistsException extends __BaseException {
|
|
|
44
49
|
*/
|
|
45
50
|
constructor(opts: __ExceptionOptionType<AlreadyExistsException, __BaseException>);
|
|
46
51
|
}
|
|
52
|
+
/**
|
|
53
|
+
* @public
|
|
54
|
+
*/
|
|
47
55
|
export interface CancelKeyDeletionRequest {
|
|
48
56
|
/**
|
|
49
57
|
* <p>Identifies the KMS key whose deletion is being canceled.</p>
|
|
@@ -63,6 +71,9 @@ export interface CancelKeyDeletionRequest {
|
|
|
63
71
|
*/
|
|
64
72
|
KeyId: string | undefined;
|
|
65
73
|
}
|
|
74
|
+
/**
|
|
75
|
+
* @public
|
|
76
|
+
*/
|
|
66
77
|
export interface CancelKeyDeletionResponse {
|
|
67
78
|
/**
|
|
68
79
|
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the KMS key whose deletion is canceled.</p>
|
|
@@ -70,6 +81,7 @@ export interface CancelKeyDeletionResponse {
|
|
|
70
81
|
KeyId?: string;
|
|
71
82
|
}
|
|
72
83
|
/**
|
|
84
|
+
* @public
|
|
73
85
|
* <p>The system timed out while trying to fulfill the request. You can retry the
|
|
74
86
|
* request.</p>
|
|
75
87
|
*/
|
|
@@ -82,6 +94,7 @@ export declare class DependencyTimeoutException extends __BaseException {
|
|
|
82
94
|
constructor(opts: __ExceptionOptionType<DependencyTimeoutException, __BaseException>);
|
|
83
95
|
}
|
|
84
96
|
/**
|
|
97
|
+
* @public
|
|
85
98
|
* <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
|
|
86
99
|
* valid.</p>
|
|
87
100
|
*/
|
|
@@ -94,6 +107,7 @@ export declare class InvalidArnException extends __BaseException {
|
|
|
94
107
|
constructor(opts: __ExceptionOptionType<InvalidArnException, __BaseException>);
|
|
95
108
|
}
|
|
96
109
|
/**
|
|
110
|
+
* @public
|
|
97
111
|
* <p>The request was rejected because an internal exception occurred. The request can be
|
|
98
112
|
* retried.</p>
|
|
99
113
|
*/
|
|
@@ -106,6 +120,7 @@ export declare class KMSInternalException extends __BaseException {
|
|
|
106
120
|
constructor(opts: __ExceptionOptionType<KMSInternalException, __BaseException>);
|
|
107
121
|
}
|
|
108
122
|
/**
|
|
123
|
+
* @public
|
|
109
124
|
* <p>The request was rejected because the state of the specified resource is not valid for this
|
|
110
125
|
* request.</p>
|
|
111
126
|
* <p>This exceptions means one of the following:</p>
|
|
@@ -132,6 +147,7 @@ export declare class KMSInvalidStateException extends __BaseException {
|
|
|
132
147
|
constructor(opts: __ExceptionOptionType<KMSInvalidStateException, __BaseException>);
|
|
133
148
|
}
|
|
134
149
|
/**
|
|
150
|
+
* @public
|
|
135
151
|
* <p>The request was rejected because the specified entity or resource could not be
|
|
136
152
|
* found.</p>
|
|
137
153
|
*/
|
|
@@ -144,6 +160,7 @@ export declare class NotFoundException extends __BaseException {
|
|
|
144
160
|
constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
|
|
145
161
|
}
|
|
146
162
|
/**
|
|
163
|
+
* @public
|
|
147
164
|
* <p>The request was rejected because the specified CloudHSM cluster is already associated with an
|
|
148
165
|
* CloudHSM key store in the account, or it shares a backup history with an CloudHSM key store in the
|
|
149
166
|
* account. Each CloudHSM key store in the account must be associated with a different CloudHSM
|
|
@@ -160,6 +177,7 @@ export declare class CloudHsmClusterInUseException extends __BaseException {
|
|
|
160
177
|
constructor(opts: __ExceptionOptionType<CloudHsmClusterInUseException, __BaseException>);
|
|
161
178
|
}
|
|
162
179
|
/**
|
|
180
|
+
* @public
|
|
163
181
|
* <p>The request was rejected because the associated CloudHSM cluster did not meet the
|
|
164
182
|
* configuration requirements for an CloudHSM key store.</p>
|
|
165
183
|
* <ul>
|
|
@@ -202,6 +220,7 @@ export declare class CloudHsmClusterInvalidConfigurationException extends __Base
|
|
|
202
220
|
constructor(opts: __ExceptionOptionType<CloudHsmClusterInvalidConfigurationException, __BaseException>);
|
|
203
221
|
}
|
|
204
222
|
/**
|
|
223
|
+
* @public
|
|
205
224
|
* <p>The request was rejected because the CloudHSM cluster associated with the CloudHSM key store is
|
|
206
225
|
* not active. Initialize and activate the cluster and try the command again. For detailed
|
|
207
226
|
* instructions, see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/getting-started.html">Getting
|
|
@@ -216,6 +235,7 @@ export declare class CloudHsmClusterNotActiveException extends __BaseException {
|
|
|
216
235
|
constructor(opts: __ExceptionOptionType<CloudHsmClusterNotActiveException, __BaseException>);
|
|
217
236
|
}
|
|
218
237
|
/**
|
|
238
|
+
* @public
|
|
219
239
|
* <p>The request was rejected because KMS cannot find the CloudHSM cluster with the specified
|
|
220
240
|
* cluster ID. Retry the request with a different cluster ID.</p>
|
|
221
241
|
*/
|
|
@@ -228,6 +248,7 @@ export declare class CloudHsmClusterNotFoundException extends __BaseException {
|
|
|
228
248
|
constructor(opts: __ExceptionOptionType<CloudHsmClusterNotFoundException, __BaseException>);
|
|
229
249
|
}
|
|
230
250
|
/**
|
|
251
|
+
* @public
|
|
231
252
|
* <p>The request was rejected because the specified CloudHSM cluster has a different cluster
|
|
232
253
|
* certificate than the original cluster. You cannot use the operation to specify an unrelated
|
|
233
254
|
* cluster for an CloudHSM key store.</p>
|
|
@@ -245,6 +266,9 @@ export declare class CloudHsmClusterNotRelatedException extends __BaseException
|
|
|
245
266
|
*/
|
|
246
267
|
constructor(opts: __ExceptionOptionType<CloudHsmClusterNotRelatedException, __BaseException>);
|
|
247
268
|
}
|
|
269
|
+
/**
|
|
270
|
+
* @public
|
|
271
|
+
*/
|
|
248
272
|
export interface ConnectCustomKeyStoreRequest {
|
|
249
273
|
/**
|
|
250
274
|
* <p>Enter the key store ID of the custom key store that you want to connect.
|
|
@@ -252,9 +276,13 @@ export interface ConnectCustomKeyStoreRequest {
|
|
|
252
276
|
*/
|
|
253
277
|
CustomKeyStoreId: string | undefined;
|
|
254
278
|
}
|
|
279
|
+
/**
|
|
280
|
+
* @public
|
|
281
|
+
*/
|
|
255
282
|
export interface ConnectCustomKeyStoreResponse {
|
|
256
283
|
}
|
|
257
284
|
/**
|
|
285
|
+
* @public
|
|
258
286
|
* <p>The request was rejected because of the <code>ConnectionState</code> of the custom key
|
|
259
287
|
* store. To get the <code>ConnectionState</code> of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p>
|
|
260
288
|
* <p>This exception is thrown under the following conditions:</p>
|
|
@@ -299,6 +327,7 @@ export declare class CustomKeyStoreInvalidStateException extends __BaseException
|
|
|
299
327
|
constructor(opts: __ExceptionOptionType<CustomKeyStoreInvalidStateException, __BaseException>);
|
|
300
328
|
}
|
|
301
329
|
/**
|
|
330
|
+
* @public
|
|
302
331
|
* <p>The request was rejected because KMS cannot find a custom key store with the specified
|
|
303
332
|
* key store name or ID.</p>
|
|
304
333
|
*/
|
|
@@ -310,6 +339,9 @@ export declare class CustomKeyStoreNotFoundException extends __BaseException {
|
|
|
310
339
|
*/
|
|
311
340
|
constructor(opts: __ExceptionOptionType<CustomKeyStoreNotFoundException, __BaseException>);
|
|
312
341
|
}
|
|
342
|
+
/**
|
|
343
|
+
* @public
|
|
344
|
+
*/
|
|
313
345
|
export declare enum ConnectionErrorCodeType {
|
|
314
346
|
CLUSTER_NOT_FOUND = "CLUSTER_NOT_FOUND",
|
|
315
347
|
INSUFFICIENT_CLOUDHSM_HSMS = "INSUFFICIENT_CLOUDHSM_HSMS",
|
|
@@ -330,6 +362,9 @@ export declare enum ConnectionErrorCodeType {
|
|
|
330
362
|
XKS_VPC_ENDPOINT_SERVICE_INVALID_CONFIGURATION = "XKS_VPC_ENDPOINT_SERVICE_INVALID_CONFIGURATION",
|
|
331
363
|
XKS_VPC_ENDPOINT_SERVICE_NOT_FOUND = "XKS_VPC_ENDPOINT_SERVICE_NOT_FOUND"
|
|
332
364
|
}
|
|
365
|
+
/**
|
|
366
|
+
* @public
|
|
367
|
+
*/
|
|
333
368
|
export declare enum ConnectionStateType {
|
|
334
369
|
CONNECTED = "CONNECTED",
|
|
335
370
|
CONNECTING = "CONNECTING",
|
|
@@ -337,6 +372,9 @@ export declare enum ConnectionStateType {
|
|
|
337
372
|
DISCONNECTING = "DISCONNECTING",
|
|
338
373
|
FAILED = "FAILED"
|
|
339
374
|
}
|
|
375
|
+
/**
|
|
376
|
+
* @public
|
|
377
|
+
*/
|
|
340
378
|
export interface CreateAliasRequest {
|
|
341
379
|
/**
|
|
342
380
|
* <p>Specifies the alias name. This value must begin with <code>alias/</code> followed by a
|
|
@@ -374,6 +412,7 @@ export interface CreateAliasRequest {
|
|
|
374
412
|
TargetKeyId: string | undefined;
|
|
375
413
|
}
|
|
376
414
|
/**
|
|
415
|
+
* @public
|
|
377
416
|
* <p>The request was rejected because the specified alias name is not valid.</p>
|
|
378
417
|
*/
|
|
379
418
|
export declare class InvalidAliasNameException extends __BaseException {
|
|
@@ -385,6 +424,7 @@ export declare class InvalidAliasNameException extends __BaseException {
|
|
|
385
424
|
constructor(opts: __ExceptionOptionType<InvalidAliasNameException, __BaseException>);
|
|
386
425
|
}
|
|
387
426
|
/**
|
|
427
|
+
* @public
|
|
388
428
|
* <p>The request was rejected because a quota was exceeded. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Quotas</a> in the
|
|
389
429
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
390
430
|
*/
|
|
@@ -396,11 +436,15 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
396
436
|
*/
|
|
397
437
|
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
398
438
|
}
|
|
439
|
+
/**
|
|
440
|
+
* @public
|
|
441
|
+
*/
|
|
399
442
|
export declare enum CustomKeyStoreType {
|
|
400
443
|
AWS_CLOUDHSM = "AWS_CLOUDHSM",
|
|
401
444
|
EXTERNAL_KEY_STORE = "EXTERNAL_KEY_STORE"
|
|
402
445
|
}
|
|
403
446
|
/**
|
|
447
|
+
* @public
|
|
404
448
|
* <p>KMS uses the authentication credential to sign requests that it sends to the external
|
|
405
449
|
* key store proxy (XKS proxy) on your behalf. You establish these credentials on your external
|
|
406
450
|
* key store proxy and report them to KMS.</p>
|
|
@@ -417,10 +461,16 @@ export interface XksProxyAuthenticationCredentialType {
|
|
|
417
461
|
*/
|
|
418
462
|
RawSecretAccessKey: string | undefined;
|
|
419
463
|
}
|
|
464
|
+
/**
|
|
465
|
+
* @public
|
|
466
|
+
*/
|
|
420
467
|
export declare enum XksProxyConnectivityType {
|
|
421
468
|
PUBLIC_ENDPOINT = "PUBLIC_ENDPOINT",
|
|
422
469
|
VPC_ENDPOINT_SERVICE = "VPC_ENDPOINT_SERVICE"
|
|
423
470
|
}
|
|
471
|
+
/**
|
|
472
|
+
* @public
|
|
473
|
+
*/
|
|
424
474
|
export interface CreateCustomKeyStoreRequest {
|
|
425
475
|
/**
|
|
426
476
|
* <p>Specifies a friendly name for the custom key store. The name must be unique in your
|
|
@@ -576,6 +626,9 @@ export interface CreateCustomKeyStoreRequest {
|
|
|
576
626
|
*/
|
|
577
627
|
XksProxyConnectivity?: XksProxyConnectivityType | string;
|
|
578
628
|
}
|
|
629
|
+
/**
|
|
630
|
+
* @public
|
|
631
|
+
*/
|
|
579
632
|
export interface CreateCustomKeyStoreResponse {
|
|
580
633
|
/**
|
|
581
634
|
* <p>A unique identifier for the new custom key store.</p>
|
|
@@ -583,6 +636,7 @@ export interface CreateCustomKeyStoreResponse {
|
|
|
583
636
|
CustomKeyStoreId?: string;
|
|
584
637
|
}
|
|
585
638
|
/**
|
|
639
|
+
* @public
|
|
586
640
|
* <p>The request was rejected because the specified custom key store name is already assigned
|
|
587
641
|
* to another custom key store in the account. Try again with a custom key store name that is
|
|
588
642
|
* unique in the account.</p>
|
|
@@ -596,6 +650,7 @@ export declare class CustomKeyStoreNameInUseException extends __BaseException {
|
|
|
596
650
|
constructor(opts: __ExceptionOptionType<CustomKeyStoreNameInUseException, __BaseException>);
|
|
597
651
|
}
|
|
598
652
|
/**
|
|
653
|
+
* @public
|
|
599
654
|
* <p>The request was rejected because the trust anchor certificate in the request to create an
|
|
600
655
|
* CloudHSM key store is not the trust anchor certificate for the specified CloudHSM cluster.</p>
|
|
601
656
|
* <p>When you <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr">initialize the CloudHSM cluster</a>, you create the trust anchor certificate and save it
|
|
@@ -610,6 +665,7 @@ export declare class IncorrectTrustAnchorException extends __BaseException {
|
|
|
610
665
|
constructor(opts: __ExceptionOptionType<IncorrectTrustAnchorException, __BaseException>);
|
|
611
666
|
}
|
|
612
667
|
/**
|
|
668
|
+
* @public
|
|
613
669
|
* <p>The request was rejected because the proxy credentials failed to authenticate to the
|
|
614
670
|
* specified external key store proxy. The specified external key store proxy rejected a status
|
|
615
671
|
* request from KMS due to invalid credentials. This can indicate an error in the credentials
|
|
@@ -624,6 +680,7 @@ export declare class XksProxyIncorrectAuthenticationCredentialException extends
|
|
|
624
680
|
constructor(opts: __ExceptionOptionType<XksProxyIncorrectAuthenticationCredentialException, __BaseException>);
|
|
625
681
|
}
|
|
626
682
|
/**
|
|
683
|
+
* @public
|
|
627
684
|
* <p>The request was rejected because the Amazon VPC endpoint service configuration does not fulfill
|
|
628
685
|
* the requirements for an external key store proxy. For details, see the exception
|
|
629
686
|
* message.</p>
|
|
@@ -637,6 +694,7 @@ export declare class XksProxyInvalidConfigurationException extends __BaseExcepti
|
|
|
637
694
|
constructor(opts: __ExceptionOptionType<XksProxyInvalidConfigurationException, __BaseException>);
|
|
638
695
|
}
|
|
639
696
|
/**
|
|
697
|
+
* @public
|
|
640
698
|
* <p></p>
|
|
641
699
|
* <p>KMS cannot interpret the response it received from the external key store proxy. The
|
|
642
700
|
* problem might be a poorly constructed response, but it could also be a transient network
|
|
@@ -651,6 +709,7 @@ export declare class XksProxyInvalidResponseException extends __BaseException {
|
|
|
651
709
|
constructor(opts: __ExceptionOptionType<XksProxyInvalidResponseException, __BaseException>);
|
|
652
710
|
}
|
|
653
711
|
/**
|
|
712
|
+
* @public
|
|
654
713
|
* <p>The request was rejected because the concatenation of the <code>XksProxyUriEndpoint</code>
|
|
655
714
|
* is already associated with an external key store in the Amazon Web Services account and Region. Each
|
|
656
715
|
* external key store in an account and Region must use a unique external key store proxy
|
|
@@ -665,6 +724,7 @@ export declare class XksProxyUriEndpointInUseException extends __BaseException {
|
|
|
665
724
|
constructor(opts: __ExceptionOptionType<XksProxyUriEndpointInUseException, __BaseException>);
|
|
666
725
|
}
|
|
667
726
|
/**
|
|
727
|
+
* @public
|
|
668
728
|
* <p>The request was rejected because the concatenation of the <code>XksProxyUriEndpoint</code>
|
|
669
729
|
* and <code>XksProxyUriPath</code> is already associated with an external key store in the
|
|
670
730
|
* Amazon Web Services account and Region. Each external key store in an account and Region must use a unique
|
|
@@ -679,6 +739,7 @@ export declare class XksProxyUriInUseException extends __BaseException {
|
|
|
679
739
|
constructor(opts: __ExceptionOptionType<XksProxyUriInUseException, __BaseException>);
|
|
680
740
|
}
|
|
681
741
|
/**
|
|
742
|
+
* @public
|
|
682
743
|
* <p>KMS was unable to reach the specified <code>XksProxyUriPath</code>. The path must be
|
|
683
744
|
* reachable before you create the external key store or update its settings.</p>
|
|
684
745
|
* <p>This exception is also thrown when the external key store proxy response to a <code>GetHealthStatus</code>
|
|
@@ -693,6 +754,7 @@ export declare class XksProxyUriUnreachableException extends __BaseException {
|
|
|
693
754
|
constructor(opts: __ExceptionOptionType<XksProxyUriUnreachableException, __BaseException>);
|
|
694
755
|
}
|
|
695
756
|
/**
|
|
757
|
+
* @public
|
|
696
758
|
* <p>The request was rejected because the specified Amazon VPC endpoint service is already
|
|
697
759
|
* associated with an external key store in the Amazon Web Services account and Region. Each external key store
|
|
698
760
|
* in an Amazon Web Services account and Region must use a different Amazon VPC endpoint service.</p>
|
|
@@ -706,6 +768,7 @@ export declare class XksProxyVpcEndpointServiceInUseException extends __BaseExce
|
|
|
706
768
|
constructor(opts: __ExceptionOptionType<XksProxyVpcEndpointServiceInUseException, __BaseException>);
|
|
707
769
|
}
|
|
708
770
|
/**
|
|
771
|
+
* @public
|
|
709
772
|
* <p>The request was rejected because the Amazon VPC endpoint service configuration does not fulfill
|
|
710
773
|
* the requirements for an external key store proxy. For details, see the exception message and
|
|
711
774
|
* <a href="kms/latest/developerguide/vpc-connectivity.html#xks-vpc-requirements">review the requirements</a> for Amazon VPC endpoint service connectivity for an external key
|
|
@@ -720,6 +783,7 @@ export declare class XksProxyVpcEndpointServiceInvalidConfigurationException ext
|
|
|
720
783
|
constructor(opts: __ExceptionOptionType<XksProxyVpcEndpointServiceInvalidConfigurationException, __BaseException>);
|
|
721
784
|
}
|
|
722
785
|
/**
|
|
786
|
+
* @public
|
|
723
787
|
* <p>The request was rejected because KMS could not find the specified VPC endpoint service.
|
|
724
788
|
* Use <a>DescribeCustomKeyStores</a> to verify the VPC endpoint service name for the
|
|
725
789
|
* external key store. Also, confirm that the <code>Allow principals</code> list for the VPC
|
|
@@ -735,6 +799,7 @@ export declare class XksProxyVpcEndpointServiceNotFoundException extends __BaseE
|
|
|
735
799
|
constructor(opts: __ExceptionOptionType<XksProxyVpcEndpointServiceNotFoundException, __BaseException>);
|
|
736
800
|
}
|
|
737
801
|
/**
|
|
802
|
+
* @public
|
|
738
803
|
* <p>Use this structure to allow <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> in the grant only when the operation request
|
|
739
804
|
* includes the specified <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">encryption context</a>. </p>
|
|
740
805
|
* <p>KMS applies the grant constraints only to cryptographic operations that support an
|
|
@@ -770,6 +835,9 @@ export interface GrantConstraints {
|
|
|
770
835
|
*/
|
|
771
836
|
EncryptionContextEquals?: Record<string, string>;
|
|
772
837
|
}
|
|
838
|
+
/**
|
|
839
|
+
* @public
|
|
840
|
+
*/
|
|
773
841
|
export declare enum GrantOperation {
|
|
774
842
|
CreateGrant = "CreateGrant",
|
|
775
843
|
Decrypt = "Decrypt",
|
|
@@ -788,6 +856,9 @@ export declare enum GrantOperation {
|
|
|
788
856
|
Verify = "Verify",
|
|
789
857
|
VerifyMac = "VerifyMac"
|
|
790
858
|
}
|
|
859
|
+
/**
|
|
860
|
+
* @public
|
|
861
|
+
*/
|
|
791
862
|
export interface CreateGrantRequest {
|
|
792
863
|
/**
|
|
793
864
|
* <p>Identifies the KMS key for the grant. The grant gives principals permission to use this
|
|
@@ -888,6 +959,9 @@ export interface CreateGrantRequest {
|
|
|
888
959
|
*/
|
|
889
960
|
Name?: string;
|
|
890
961
|
}
|
|
962
|
+
/**
|
|
963
|
+
* @public
|
|
964
|
+
*/
|
|
891
965
|
export interface CreateGrantResponse {
|
|
892
966
|
/**
|
|
893
967
|
* <p>The grant token.</p>
|
|
@@ -902,6 +976,7 @@ export interface CreateGrantResponse {
|
|
|
902
976
|
GrantId?: string;
|
|
903
977
|
}
|
|
904
978
|
/**
|
|
979
|
+
* @public
|
|
905
980
|
* <p>The request was rejected because the specified KMS key is not enabled.</p>
|
|
906
981
|
*/
|
|
907
982
|
export declare class DisabledException extends __BaseException {
|
|
@@ -913,6 +988,7 @@ export declare class DisabledException extends __BaseException {
|
|
|
913
988
|
constructor(opts: __ExceptionOptionType<DisabledException, __BaseException>);
|
|
914
989
|
}
|
|
915
990
|
/**
|
|
991
|
+
* @public
|
|
916
992
|
* <p>The request was rejected because the specified grant token is not valid.</p>
|
|
917
993
|
*/
|
|
918
994
|
export declare class InvalidGrantTokenException extends __BaseException {
|
|
@@ -923,6 +999,9 @@ export declare class InvalidGrantTokenException extends __BaseException {
|
|
|
923
999
|
*/
|
|
924
1000
|
constructor(opts: __ExceptionOptionType<InvalidGrantTokenException, __BaseException>);
|
|
925
1001
|
}
|
|
1002
|
+
/**
|
|
1003
|
+
* @public
|
|
1004
|
+
*/
|
|
926
1005
|
export declare enum CustomerMasterKeySpec {
|
|
927
1006
|
ECC_NIST_P256 = "ECC_NIST_P256",
|
|
928
1007
|
ECC_NIST_P384 = "ECC_NIST_P384",
|
|
@@ -938,6 +1017,9 @@ export declare enum CustomerMasterKeySpec {
|
|
|
938
1017
|
SM2 = "SM2",
|
|
939
1018
|
SYMMETRIC_DEFAULT = "SYMMETRIC_DEFAULT"
|
|
940
1019
|
}
|
|
1020
|
+
/**
|
|
1021
|
+
* @public
|
|
1022
|
+
*/
|
|
941
1023
|
export declare enum KeySpec {
|
|
942
1024
|
ECC_NIST_P256 = "ECC_NIST_P256",
|
|
943
1025
|
ECC_NIST_P384 = "ECC_NIST_P384",
|
|
@@ -953,11 +1035,17 @@ export declare enum KeySpec {
|
|
|
953
1035
|
SM2 = "SM2",
|
|
954
1036
|
SYMMETRIC_DEFAULT = "SYMMETRIC_DEFAULT"
|
|
955
1037
|
}
|
|
1038
|
+
/**
|
|
1039
|
+
* @public
|
|
1040
|
+
*/
|
|
956
1041
|
export declare enum KeyUsageType {
|
|
957
1042
|
ENCRYPT_DECRYPT = "ENCRYPT_DECRYPT",
|
|
958
1043
|
GENERATE_VERIFY_MAC = "GENERATE_VERIFY_MAC",
|
|
959
1044
|
SIGN_VERIFY = "SIGN_VERIFY"
|
|
960
1045
|
}
|
|
1046
|
+
/**
|
|
1047
|
+
* @public
|
|
1048
|
+
*/
|
|
961
1049
|
export declare enum OriginType {
|
|
962
1050
|
AWS_CLOUDHSM = "AWS_CLOUDHSM",
|
|
963
1051
|
AWS_KMS = "AWS_KMS",
|
|
@@ -965,6 +1053,7 @@ export declare enum OriginType {
|
|
|
965
1053
|
EXTERNAL_KEY_STORE = "EXTERNAL_KEY_STORE"
|
|
966
1054
|
}
|
|
967
1055
|
/**
|
|
1056
|
+
* @public
|
|
968
1057
|
* <p>A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are
|
|
969
1058
|
* both required, but tag values can be empty (null) strings.</p>
|
|
970
1059
|
* <p>For information about the rules that apply to tag keys and tag values, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html">User-Defined Tag Restrictions</a> in the <i>Amazon Web Services Billing and Cost Management
|
|
@@ -980,6 +1069,9 @@ export interface Tag {
|
|
|
980
1069
|
*/
|
|
981
1070
|
TagValue: string | undefined;
|
|
982
1071
|
}
|
|
1072
|
+
/**
|
|
1073
|
+
* @public
|
|
1074
|
+
*/
|
|
983
1075
|
export interface CreateKeyRequest {
|
|
984
1076
|
/**
|
|
985
1077
|
* <p>The key policy to attach to the KMS key.</p>
|
|
@@ -1271,20 +1363,32 @@ export interface CreateKeyRequest {
|
|
|
1271
1363
|
*/
|
|
1272
1364
|
XksKeyId?: string;
|
|
1273
1365
|
}
|
|
1366
|
+
/**
|
|
1367
|
+
* @public
|
|
1368
|
+
*/
|
|
1274
1369
|
export declare enum EncryptionAlgorithmSpec {
|
|
1275
1370
|
RSAES_OAEP_SHA_1 = "RSAES_OAEP_SHA_1",
|
|
1276
1371
|
RSAES_OAEP_SHA_256 = "RSAES_OAEP_SHA_256",
|
|
1277
1372
|
SM2PKE = "SM2PKE",
|
|
1278
1373
|
SYMMETRIC_DEFAULT = "SYMMETRIC_DEFAULT"
|
|
1279
1374
|
}
|
|
1375
|
+
/**
|
|
1376
|
+
* @public
|
|
1377
|
+
*/
|
|
1280
1378
|
export declare enum ExpirationModelType {
|
|
1281
1379
|
KEY_MATERIAL_DOES_NOT_EXPIRE = "KEY_MATERIAL_DOES_NOT_EXPIRE",
|
|
1282
1380
|
KEY_MATERIAL_EXPIRES = "KEY_MATERIAL_EXPIRES"
|
|
1283
1381
|
}
|
|
1382
|
+
/**
|
|
1383
|
+
* @public
|
|
1384
|
+
*/
|
|
1284
1385
|
export declare enum KeyManagerType {
|
|
1285
1386
|
AWS = "AWS",
|
|
1286
1387
|
CUSTOMER = "CUSTOMER"
|
|
1287
1388
|
}
|
|
1389
|
+
/**
|
|
1390
|
+
* @public
|
|
1391
|
+
*/
|
|
1288
1392
|
export declare enum KeyState {
|
|
1289
1393
|
Creating = "Creating",
|
|
1290
1394
|
Disabled = "Disabled",
|
|
@@ -1295,17 +1399,24 @@ export declare enum KeyState {
|
|
|
1295
1399
|
Unavailable = "Unavailable",
|
|
1296
1400
|
Updating = "Updating"
|
|
1297
1401
|
}
|
|
1402
|
+
/**
|
|
1403
|
+
* @public
|
|
1404
|
+
*/
|
|
1298
1405
|
export declare enum MacAlgorithmSpec {
|
|
1299
1406
|
HMAC_SHA_224 = "HMAC_SHA_224",
|
|
1300
1407
|
HMAC_SHA_256 = "HMAC_SHA_256",
|
|
1301
1408
|
HMAC_SHA_384 = "HMAC_SHA_384",
|
|
1302
1409
|
HMAC_SHA_512 = "HMAC_SHA_512"
|
|
1303
1410
|
}
|
|
1411
|
+
/**
|
|
1412
|
+
* @public
|
|
1413
|
+
*/
|
|
1304
1414
|
export declare enum MultiRegionKeyType {
|
|
1305
1415
|
PRIMARY = "PRIMARY",
|
|
1306
1416
|
REPLICA = "REPLICA"
|
|
1307
1417
|
}
|
|
1308
1418
|
/**
|
|
1419
|
+
* @public
|
|
1309
1420
|
* <p>Describes the primary or replica key in a multi-Region key.</p>
|
|
1310
1421
|
*/
|
|
1311
1422
|
export interface MultiRegionKey {
|
|
@@ -1319,6 +1430,7 @@ export interface MultiRegionKey {
|
|
|
1319
1430
|
Region?: string;
|
|
1320
1431
|
}
|
|
1321
1432
|
/**
|
|
1433
|
+
* @public
|
|
1322
1434
|
* <p>Describes the configuration of this multi-Region key. This field appears only when the KMS
|
|
1323
1435
|
* key is a primary or replica of a multi-Region key.</p>
|
|
1324
1436
|
* <p>For more information about any listed KMS key, use the <a>DescribeKey</a>
|
|
@@ -1341,6 +1453,9 @@ export interface MultiRegionConfiguration {
|
|
|
1341
1453
|
*/
|
|
1342
1454
|
ReplicaKeys?: MultiRegionKey[];
|
|
1343
1455
|
}
|
|
1456
|
+
/**
|
|
1457
|
+
* @public
|
|
1458
|
+
*/
|
|
1344
1459
|
export declare enum SigningAlgorithmSpec {
|
|
1345
1460
|
ECDSA_SHA_256 = "ECDSA_SHA_256",
|
|
1346
1461
|
ECDSA_SHA_384 = "ECDSA_SHA_384",
|
|
@@ -1354,6 +1469,7 @@ export declare enum SigningAlgorithmSpec {
|
|
|
1354
1469
|
SM2DSA = "SM2DSA"
|
|
1355
1470
|
}
|
|
1356
1471
|
/**
|
|
1472
|
+
* @public
|
|
1357
1473
|
* <p>Information about the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key">external key </a>that is associated with a KMS key in an
|
|
1358
1474
|
* external key store. </p>
|
|
1359
1475
|
* <p>This element appears in a <a>CreateKey</a> or <a>DescribeKey</a>
|
|
@@ -1370,6 +1486,7 @@ export interface XksKeyConfigurationType {
|
|
|
1370
1486
|
Id?: string;
|
|
1371
1487
|
}
|
|
1372
1488
|
/**
|
|
1489
|
+
* @public
|
|
1373
1490
|
* <p>Contains metadata about a KMS key.</p>
|
|
1374
1491
|
* <p>This data type is used as a response element for the <a>CreateKey</a>, <a>DescribeKey</a>, and <a>ReplicateKey</a> operations.</p>
|
|
1375
1492
|
*/
|
|
@@ -1543,6 +1660,9 @@ export interface KeyMetadata {
|
|
|
1543
1660
|
*/
|
|
1544
1661
|
XksKeyConfiguration?: XksKeyConfigurationType;
|
|
1545
1662
|
}
|
|
1663
|
+
/**
|
|
1664
|
+
* @public
|
|
1665
|
+
*/
|
|
1546
1666
|
export interface CreateKeyResponse {
|
|
1547
1667
|
/**
|
|
1548
1668
|
* <p>Metadata associated with the KMS key.</p>
|
|
@@ -1550,6 +1670,7 @@ export interface CreateKeyResponse {
|
|
|
1550
1670
|
KeyMetadata?: KeyMetadata;
|
|
1551
1671
|
}
|
|
1552
1672
|
/**
|
|
1673
|
+
* @public
|
|
1553
1674
|
* <p>The request was rejected because the specified policy is not syntactically or semantically
|
|
1554
1675
|
* correct.</p>
|
|
1555
1676
|
*/
|
|
@@ -1562,6 +1683,7 @@ export declare class MalformedPolicyDocumentException extends __BaseException {
|
|
|
1562
1683
|
constructor(opts: __ExceptionOptionType<MalformedPolicyDocumentException, __BaseException>);
|
|
1563
1684
|
}
|
|
1564
1685
|
/**
|
|
1686
|
+
* @public
|
|
1565
1687
|
* <p>The request was rejected because one or more tags are not valid.</p>
|
|
1566
1688
|
*/
|
|
1567
1689
|
export declare class TagException extends __BaseException {
|
|
@@ -1573,6 +1695,7 @@ export declare class TagException extends __BaseException {
|
|
|
1573
1695
|
constructor(opts: __ExceptionOptionType<TagException, __BaseException>);
|
|
1574
1696
|
}
|
|
1575
1697
|
/**
|
|
1698
|
+
* @public
|
|
1576
1699
|
* <p>The request was rejected because a specified parameter is not supported or a specified
|
|
1577
1700
|
* resource is not valid for this operation.</p>
|
|
1578
1701
|
*/
|
|
@@ -1585,6 +1708,7 @@ export declare class UnsupportedOperationException extends __BaseException {
|
|
|
1585
1708
|
constructor(opts: __ExceptionOptionType<UnsupportedOperationException, __BaseException>);
|
|
1586
1709
|
}
|
|
1587
1710
|
/**
|
|
1711
|
+
* @public
|
|
1588
1712
|
* <p>The request was rejected because the (<code>XksKeyId</code>) is already associated with a
|
|
1589
1713
|
* KMS key in this external key store. Each KMS key in an external key store must be associated
|
|
1590
1714
|
* with a different external key.</p>
|
|
@@ -1598,6 +1722,7 @@ export declare class XksKeyAlreadyInUseException extends __BaseException {
|
|
|
1598
1722
|
constructor(opts: __ExceptionOptionType<XksKeyAlreadyInUseException, __BaseException>);
|
|
1599
1723
|
}
|
|
1600
1724
|
/**
|
|
1725
|
+
* @public
|
|
1601
1726
|
* <p>The request was rejected because the external key specified by the <code>XksKeyId</code>
|
|
1602
1727
|
* parameter did not meet the configuration requirements for an external key store.</p>
|
|
1603
1728
|
* <p>The external key must be an AES-256 symmetric key that is enabled and performs encryption
|
|
@@ -1612,6 +1737,7 @@ export declare class XksKeyInvalidConfigurationException extends __BaseException
|
|
|
1612
1737
|
constructor(opts: __ExceptionOptionType<XksKeyInvalidConfigurationException, __BaseException>);
|
|
1613
1738
|
}
|
|
1614
1739
|
/**
|
|
1740
|
+
* @public
|
|
1615
1741
|
* <p>The request was rejected because the external key store proxy could not find the external key. This
|
|
1616
1742
|
* exception is thrown when the value of the <code>XksKeyId</code> parameter doesn't identify a
|
|
1617
1743
|
* key in the external key manager associated with the external key proxy.</p>
|
|
@@ -1629,6 +1755,7 @@ export declare class XksKeyNotFoundException extends __BaseException {
|
|
|
1629
1755
|
constructor(opts: __ExceptionOptionType<XksKeyNotFoundException, __BaseException>);
|
|
1630
1756
|
}
|
|
1631
1757
|
/**
|
|
1758
|
+
* @public
|
|
1632
1759
|
* <p>The request was rejected because the custom key store contains KMS keys. After verifying
|
|
1633
1760
|
* that you do not need to use the KMS keys, use the <a>ScheduleKeyDeletion</a>
|
|
1634
1761
|
* operation to delete the KMS keys. After they are deleted, you can delete the custom key
|
|
@@ -1643,6 +1770,7 @@ export declare class CustomKeyStoreHasCMKsException extends __BaseException {
|
|
|
1643
1770
|
constructor(opts: __ExceptionOptionType<CustomKeyStoreHasCMKsException, __BaseException>);
|
|
1644
1771
|
}
|
|
1645
1772
|
/**
|
|
1773
|
+
* @public
|
|
1646
1774
|
* <p>Detailed information about the external key store proxy (XKS proxy). Your external key
|
|
1647
1775
|
* store proxy translates KMS requests into a format that your external key manager can
|
|
1648
1776
|
* understand. These fields appear in a <a>DescribeCustomKeyStores</a> response only
|
|
@@ -1678,6 +1806,7 @@ export interface XksProxyConfigurationType {
|
|
|
1678
1806
|
VpcEndpointServiceName?: string;
|
|
1679
1807
|
}
|
|
1680
1808
|
/**
|
|
1809
|
+
* @public
|
|
1681
1810
|
* <p>Contains information about each custom key store in the custom key store list.</p>
|
|
1682
1811
|
*/
|
|
1683
1812
|
export interface CustomKeyStoresListEntry {
|
|
@@ -1932,6 +2061,9 @@ export interface CustomKeyStoresListEntry {
|
|
|
1932
2061
|
*/
|
|
1933
2062
|
XksProxyConfiguration?: XksProxyConfigurationType;
|
|
1934
2063
|
}
|
|
2064
|
+
/**
|
|
2065
|
+
* @public
|
|
2066
|
+
*/
|
|
1935
2067
|
export declare enum DataKeyPairSpec {
|
|
1936
2068
|
ECC_NIST_P256 = "ECC_NIST_P256",
|
|
1937
2069
|
ECC_NIST_P384 = "ECC_NIST_P384",
|
|
@@ -1942,10 +2074,16 @@ export declare enum DataKeyPairSpec {
|
|
|
1942
2074
|
RSA_4096 = "RSA_4096",
|
|
1943
2075
|
SM2 = "SM2"
|
|
1944
2076
|
}
|
|
2077
|
+
/**
|
|
2078
|
+
* @public
|
|
2079
|
+
*/
|
|
1945
2080
|
export declare enum DataKeySpec {
|
|
1946
2081
|
AES_128 = "AES_128",
|
|
1947
2082
|
AES_256 = "AES_256"
|
|
1948
2083
|
}
|
|
2084
|
+
/**
|
|
2085
|
+
* @public
|
|
2086
|
+
*/
|
|
1949
2087
|
export interface DecryptRequest {
|
|
1950
2088
|
/**
|
|
1951
2089
|
* <p>Ciphertext to be decrypted. The blob includes metadata.</p>
|
|
@@ -2009,6 +2147,9 @@ export interface DecryptRequest {
|
|
|
2009
2147
|
*/
|
|
2010
2148
|
EncryptionAlgorithm?: EncryptionAlgorithmSpec | string;
|
|
2011
2149
|
}
|
|
2150
|
+
/**
|
|
2151
|
+
* @public
|
|
2152
|
+
*/
|
|
2012
2153
|
export interface DecryptResponse {
|
|
2013
2154
|
/**
|
|
2014
2155
|
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the KMS key that was used to decrypt the ciphertext.</p>
|
|
@@ -2024,6 +2165,7 @@ export interface DecryptResponse {
|
|
|
2024
2165
|
EncryptionAlgorithm?: EncryptionAlgorithmSpec | string;
|
|
2025
2166
|
}
|
|
2026
2167
|
/**
|
|
2168
|
+
* @public
|
|
2027
2169
|
* <p>The request was rejected because the specified KMS key cannot decrypt the data. The
|
|
2028
2170
|
* <code>KeyId</code> in a <a>Decrypt</a> request and the <code>SourceKeyId</code>
|
|
2029
2171
|
* in a <a>ReEncrypt</a> request must identify the same KMS key that was used to
|
|
@@ -2038,6 +2180,7 @@ export declare class IncorrectKeyException extends __BaseException {
|
|
|
2038
2180
|
constructor(opts: __ExceptionOptionType<IncorrectKeyException, __BaseException>);
|
|
2039
2181
|
}
|
|
2040
2182
|
/**
|
|
2183
|
+
* @public
|
|
2041
2184
|
* <p>From the <a>Decrypt</a> or <a>ReEncrypt</a> operation, the request
|
|
2042
2185
|
* was rejected because the specified ciphertext, or additional authenticated data incorporated
|
|
2043
2186
|
* into the ciphertext, such as the encryption context, is corrupted, missing, or otherwise
|
|
@@ -2054,6 +2197,7 @@ export declare class InvalidCiphertextException extends __BaseException {
|
|
|
2054
2197
|
constructor(opts: __ExceptionOptionType<InvalidCiphertextException, __BaseException>);
|
|
2055
2198
|
}
|
|
2056
2199
|
/**
|
|
2200
|
+
* @public
|
|
2057
2201
|
* <p>The request was rejected for one of the following reasons: </p>
|
|
2058
2202
|
* <ul>
|
|
2059
2203
|
* <li>
|
|
@@ -2083,6 +2227,7 @@ export declare class InvalidKeyUsageException extends __BaseException {
|
|
|
2083
2227
|
constructor(opts: __ExceptionOptionType<InvalidKeyUsageException, __BaseException>);
|
|
2084
2228
|
}
|
|
2085
2229
|
/**
|
|
2230
|
+
* @public
|
|
2086
2231
|
* <p>The request was rejected because the specified KMS key was not available. You can retry
|
|
2087
2232
|
* the request.</p>
|
|
2088
2233
|
*/
|
|
@@ -2094,6 +2239,9 @@ export declare class KeyUnavailableException extends __BaseException {
|
|
|
2094
2239
|
*/
|
|
2095
2240
|
constructor(opts: __ExceptionOptionType<KeyUnavailableException, __BaseException>);
|
|
2096
2241
|
}
|
|
2242
|
+
/**
|
|
2243
|
+
* @public
|
|
2244
|
+
*/
|
|
2097
2245
|
export interface DeleteAliasRequest {
|
|
2098
2246
|
/**
|
|
2099
2247
|
* <p>The alias to be deleted. The alias name must begin with <code>alias/</code> followed by
|
|
@@ -2101,14 +2249,23 @@ export interface DeleteAliasRequest {
|
|
|
2101
2249
|
*/
|
|
2102
2250
|
AliasName: string | undefined;
|
|
2103
2251
|
}
|
|
2252
|
+
/**
|
|
2253
|
+
* @public
|
|
2254
|
+
*/
|
|
2104
2255
|
export interface DeleteCustomKeyStoreRequest {
|
|
2105
2256
|
/**
|
|
2106
2257
|
* <p>Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p>
|
|
2107
2258
|
*/
|
|
2108
2259
|
CustomKeyStoreId: string | undefined;
|
|
2109
2260
|
}
|
|
2261
|
+
/**
|
|
2262
|
+
* @public
|
|
2263
|
+
*/
|
|
2110
2264
|
export interface DeleteCustomKeyStoreResponse {
|
|
2111
2265
|
}
|
|
2266
|
+
/**
|
|
2267
|
+
* @public
|
|
2268
|
+
*/
|
|
2112
2269
|
export interface DeleteImportedKeyMaterialRequest {
|
|
2113
2270
|
/**
|
|
2114
2271
|
* <p>Identifies the KMS key from which you are deleting imported key material. The
|
|
@@ -2129,6 +2286,9 @@ export interface DeleteImportedKeyMaterialRequest {
|
|
|
2129
2286
|
*/
|
|
2130
2287
|
KeyId: string | undefined;
|
|
2131
2288
|
}
|
|
2289
|
+
/**
|
|
2290
|
+
* @public
|
|
2291
|
+
*/
|
|
2132
2292
|
export interface DescribeCustomKeyStoresRequest {
|
|
2133
2293
|
/**
|
|
2134
2294
|
* <p>Gets only information about the specified custom key store. Enter the key store ID.</p>
|
|
@@ -2160,6 +2320,9 @@ export interface DescribeCustomKeyStoresRequest {
|
|
|
2160
2320
|
*/
|
|
2161
2321
|
Marker?: string;
|
|
2162
2322
|
}
|
|
2323
|
+
/**
|
|
2324
|
+
* @public
|
|
2325
|
+
*/
|
|
2163
2326
|
export interface DescribeCustomKeyStoresResponse {
|
|
2164
2327
|
/**
|
|
2165
2328
|
* <p>Contains metadata about each custom key store.</p>
|
|
@@ -2179,6 +2342,7 @@ export interface DescribeCustomKeyStoresResponse {
|
|
|
2179
2342
|
Truncated?: boolean;
|
|
2180
2343
|
}
|
|
2181
2344
|
/**
|
|
2345
|
+
* @public
|
|
2182
2346
|
* <p>The request was rejected because the marker that specifies where pagination should next
|
|
2183
2347
|
* begin is not valid.</p>
|
|
2184
2348
|
*/
|
|
@@ -2190,6 +2354,9 @@ export declare class InvalidMarkerException extends __BaseException {
|
|
|
2190
2354
|
*/
|
|
2191
2355
|
constructor(opts: __ExceptionOptionType<InvalidMarkerException, __BaseException>);
|
|
2192
2356
|
}
|
|
2357
|
+
/**
|
|
2358
|
+
* @public
|
|
2359
|
+
*/
|
|
2193
2360
|
export interface DescribeKeyRequest {
|
|
2194
2361
|
/**
|
|
2195
2362
|
* <p>Describes the specified KMS key. </p>
|
|
@@ -2226,12 +2393,18 @@ export interface DescribeKeyRequest {
|
|
|
2226
2393
|
*/
|
|
2227
2394
|
GrantTokens?: string[];
|
|
2228
2395
|
}
|
|
2396
|
+
/**
|
|
2397
|
+
* @public
|
|
2398
|
+
*/
|
|
2229
2399
|
export interface DescribeKeyResponse {
|
|
2230
2400
|
/**
|
|
2231
2401
|
* <p>Metadata associated with the key.</p>
|
|
2232
2402
|
*/
|
|
2233
2403
|
KeyMetadata?: KeyMetadata;
|
|
2234
2404
|
}
|
|
2405
|
+
/**
|
|
2406
|
+
* @public
|
|
2407
|
+
*/
|
|
2235
2408
|
export interface DisableKeyRequest {
|
|
2236
2409
|
/**
|
|
2237
2410
|
* <p>Identifies the KMS key to disable.</p>
|
|
@@ -2251,6 +2424,9 @@ export interface DisableKeyRequest {
|
|
|
2251
2424
|
*/
|
|
2252
2425
|
KeyId: string | undefined;
|
|
2253
2426
|
}
|
|
2427
|
+
/**
|
|
2428
|
+
* @public
|
|
2429
|
+
*/
|
|
2254
2430
|
export interface DisableKeyRotationRequest {
|
|
2255
2431
|
/**
|
|
2256
2432
|
* <p>Identifies a symmetric encryption KMS key. You cannot enable or disable automatic rotation
|
|
@@ -2273,14 +2449,23 @@ export interface DisableKeyRotationRequest {
|
|
|
2273
2449
|
*/
|
|
2274
2450
|
KeyId: string | undefined;
|
|
2275
2451
|
}
|
|
2452
|
+
/**
|
|
2453
|
+
* @public
|
|
2454
|
+
*/
|
|
2276
2455
|
export interface DisconnectCustomKeyStoreRequest {
|
|
2277
2456
|
/**
|
|
2278
2457
|
* <p>Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p>
|
|
2279
2458
|
*/
|
|
2280
2459
|
CustomKeyStoreId: string | undefined;
|
|
2281
2460
|
}
|
|
2461
|
+
/**
|
|
2462
|
+
* @public
|
|
2463
|
+
*/
|
|
2282
2464
|
export interface DisconnectCustomKeyStoreResponse {
|
|
2283
2465
|
}
|
|
2466
|
+
/**
|
|
2467
|
+
* @public
|
|
2468
|
+
*/
|
|
2284
2469
|
export interface EnableKeyRequest {
|
|
2285
2470
|
/**
|
|
2286
2471
|
* <p>Identifies the KMS key to enable.</p>
|
|
@@ -2300,6 +2485,9 @@ export interface EnableKeyRequest {
|
|
|
2300
2485
|
*/
|
|
2301
2486
|
KeyId: string | undefined;
|
|
2302
2487
|
}
|
|
2488
|
+
/**
|
|
2489
|
+
* @public
|
|
2490
|
+
*/
|
|
2303
2491
|
export interface EnableKeyRotationRequest {
|
|
2304
2492
|
/**
|
|
2305
2493
|
* <p>Identifies a symmetric encryption KMS key. You cannot enable automatic rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">asymmetric KMS keys</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html">HMAC KMS keys</a>, KMS keys with <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key material</a>, or KMS keys in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. To enable or disable automatic rotation of a set of related <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate">multi-Region keys</a>, set the property on the primary key.</p>
|
|
@@ -2319,6 +2507,9 @@ export interface EnableKeyRotationRequest {
|
|
|
2319
2507
|
*/
|
|
2320
2508
|
KeyId: string | undefined;
|
|
2321
2509
|
}
|
|
2510
|
+
/**
|
|
2511
|
+
* @public
|
|
2512
|
+
*/
|
|
2322
2513
|
export interface EncryptRequest {
|
|
2323
2514
|
/**
|
|
2324
2515
|
* <p>Identifies the KMS key to use in the encryption operation. The KMS key must have a
|
|
@@ -2377,6 +2568,9 @@ export interface EncryptRequest {
|
|
|
2377
2568
|
*/
|
|
2378
2569
|
EncryptionAlgorithm?: EncryptionAlgorithmSpec | string;
|
|
2379
2570
|
}
|
|
2571
|
+
/**
|
|
2572
|
+
* @public
|
|
2573
|
+
*/
|
|
2380
2574
|
export interface EncryptResponse {
|
|
2381
2575
|
/**
|
|
2382
2576
|
* <p>The encrypted plaintext. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
|
|
@@ -2392,6 +2586,7 @@ export interface EncryptResponse {
|
|
|
2392
2586
|
EncryptionAlgorithm?: EncryptionAlgorithmSpec | string;
|
|
2393
2587
|
}
|
|
2394
2588
|
/**
|
|
2589
|
+
* @public
|
|
2395
2590
|
* <p>The request was rejected because the specified import token is expired. Use <a>GetParametersForImport</a> to get a new import token and public key, use the new
|
|
2396
2591
|
* public key to encrypt the key material, and then try the request again.</p>
|
|
2397
2592
|
*/
|
|
@@ -2403,6 +2598,9 @@ export declare class ExpiredImportTokenException extends __BaseException {
|
|
|
2403
2598
|
*/
|
|
2404
2599
|
constructor(opts: __ExceptionOptionType<ExpiredImportTokenException, __BaseException>);
|
|
2405
2600
|
}
|
|
2601
|
+
/**
|
|
2602
|
+
* @public
|
|
2603
|
+
*/
|
|
2406
2604
|
export interface GenerateDataKeyRequest {
|
|
2407
2605
|
/**
|
|
2408
2606
|
* <p>Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify
|
|
@@ -2462,6 +2660,9 @@ export interface GenerateDataKeyRequest {
|
|
|
2462
2660
|
*/
|
|
2463
2661
|
GrantTokens?: string[];
|
|
2464
2662
|
}
|
|
2663
|
+
/**
|
|
2664
|
+
* @public
|
|
2665
|
+
*/
|
|
2465
2666
|
export interface GenerateDataKeyResponse {
|
|
2466
2667
|
/**
|
|
2467
2668
|
* <p>The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
|
|
@@ -2477,6 +2678,9 @@ export interface GenerateDataKeyResponse {
|
|
|
2477
2678
|
*/
|
|
2478
2679
|
KeyId?: string;
|
|
2479
2680
|
}
|
|
2681
|
+
/**
|
|
2682
|
+
* @public
|
|
2683
|
+
*/
|
|
2480
2684
|
export interface GenerateDataKeyPairRequest {
|
|
2481
2685
|
/**
|
|
2482
2686
|
* <p>Specifies the encryption context that will be used when encrypting the private key in the
|
|
@@ -2527,6 +2731,9 @@ export interface GenerateDataKeyPairRequest {
|
|
|
2527
2731
|
*/
|
|
2528
2732
|
GrantTokens?: string[];
|
|
2529
2733
|
}
|
|
2734
|
+
/**
|
|
2735
|
+
* @public
|
|
2736
|
+
*/
|
|
2530
2737
|
export interface GenerateDataKeyPairResponse {
|
|
2531
2738
|
/**
|
|
2532
2739
|
* <p>The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
|
|
@@ -2549,6 +2756,9 @@ export interface GenerateDataKeyPairResponse {
|
|
|
2549
2756
|
*/
|
|
2550
2757
|
KeyPairSpec?: DataKeyPairSpec | string;
|
|
2551
2758
|
}
|
|
2759
|
+
/**
|
|
2760
|
+
* @public
|
|
2761
|
+
*/
|
|
2552
2762
|
export interface GenerateDataKeyPairWithoutPlaintextRequest {
|
|
2553
2763
|
/**
|
|
2554
2764
|
* <p>Specifies the encryption context that will be used when encrypting the private key in the
|
|
@@ -2599,6 +2809,9 @@ export interface GenerateDataKeyPairWithoutPlaintextRequest {
|
|
|
2599
2809
|
*/
|
|
2600
2810
|
GrantTokens?: string[];
|
|
2601
2811
|
}
|
|
2812
|
+
/**
|
|
2813
|
+
* @public
|
|
2814
|
+
*/
|
|
2602
2815
|
export interface GenerateDataKeyPairWithoutPlaintextResponse {
|
|
2603
2816
|
/**
|
|
2604
2817
|
* <p>The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
|
|
@@ -2617,6 +2830,9 @@ export interface GenerateDataKeyPairWithoutPlaintextResponse {
|
|
|
2617
2830
|
*/
|
|
2618
2831
|
KeyPairSpec?: DataKeyPairSpec | string;
|
|
2619
2832
|
}
|
|
2833
|
+
/**
|
|
2834
|
+
* @public
|
|
2835
|
+
*/
|
|
2620
2836
|
export interface GenerateDataKeyWithoutPlaintextRequest {
|
|
2621
2837
|
/**
|
|
2622
2838
|
* <p>Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify
|
|
@@ -2672,6 +2888,9 @@ export interface GenerateDataKeyWithoutPlaintextRequest {
|
|
|
2672
2888
|
*/
|
|
2673
2889
|
GrantTokens?: string[];
|
|
2674
2890
|
}
|
|
2891
|
+
/**
|
|
2892
|
+
* @public
|
|
2893
|
+
*/
|
|
2675
2894
|
export interface GenerateDataKeyWithoutPlaintextResponse {
|
|
2676
2895
|
/**
|
|
2677
2896
|
* <p>The encrypted data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
|
|
@@ -2682,6 +2901,9 @@ export interface GenerateDataKeyWithoutPlaintextResponse {
|
|
|
2682
2901
|
*/
|
|
2683
2902
|
KeyId?: string;
|
|
2684
2903
|
}
|
|
2904
|
+
/**
|
|
2905
|
+
* @public
|
|
2906
|
+
*/
|
|
2685
2907
|
export interface GenerateMacRequest {
|
|
2686
2908
|
/**
|
|
2687
2909
|
* <p>The message to be hashed. Specify a message of up to 4,096 bytes. </p>
|
|
@@ -2712,6 +2934,9 @@ export interface GenerateMacRequest {
|
|
|
2712
2934
|
*/
|
|
2713
2935
|
GrantTokens?: string[];
|
|
2714
2936
|
}
|
|
2937
|
+
/**
|
|
2938
|
+
* @public
|
|
2939
|
+
*/
|
|
2715
2940
|
export interface GenerateMacResponse {
|
|
2716
2941
|
/**
|
|
2717
2942
|
* <p>The hash-based message authentication code (HMAC) that was generated for the
|
|
@@ -2728,6 +2953,9 @@ export interface GenerateMacResponse {
|
|
|
2728
2953
|
*/
|
|
2729
2954
|
KeyId?: string;
|
|
2730
2955
|
}
|
|
2956
|
+
/**
|
|
2957
|
+
* @public
|
|
2958
|
+
*/
|
|
2731
2959
|
export interface GenerateRandomRequest {
|
|
2732
2960
|
/**
|
|
2733
2961
|
* <p>The length of the random byte string. This parameter is required.</p>
|
|
@@ -2742,12 +2970,18 @@ export interface GenerateRandomRequest {
|
|
|
2742
2970
|
*/
|
|
2743
2971
|
CustomKeyStoreId?: string;
|
|
2744
2972
|
}
|
|
2973
|
+
/**
|
|
2974
|
+
* @public
|
|
2975
|
+
*/
|
|
2745
2976
|
export interface GenerateRandomResponse {
|
|
2746
2977
|
/**
|
|
2747
2978
|
* <p>The random byte string. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
|
|
2748
2979
|
*/
|
|
2749
2980
|
Plaintext?: Uint8Array;
|
|
2750
2981
|
}
|
|
2982
|
+
/**
|
|
2983
|
+
* @public
|
|
2984
|
+
*/
|
|
2751
2985
|
export interface GetKeyPolicyRequest {
|
|
2752
2986
|
/**
|
|
2753
2987
|
* <p>Gets the key policy for the specified KMS key.</p>
|
|
@@ -2772,12 +3006,18 @@ export interface GetKeyPolicyRequest {
|
|
|
2772
3006
|
*/
|
|
2773
3007
|
PolicyName: string | undefined;
|
|
2774
3008
|
}
|
|
3009
|
+
/**
|
|
3010
|
+
* @public
|
|
3011
|
+
*/
|
|
2775
3012
|
export interface GetKeyPolicyResponse {
|
|
2776
3013
|
/**
|
|
2777
3014
|
* <p>A key policy document in JSON format.</p>
|
|
2778
3015
|
*/
|
|
2779
3016
|
Policy?: string;
|
|
2780
3017
|
}
|
|
3018
|
+
/**
|
|
3019
|
+
* @public
|
|
3020
|
+
*/
|
|
2781
3021
|
export interface GetKeyRotationStatusRequest {
|
|
2782
3022
|
/**
|
|
2783
3023
|
* <p>Gets the rotation status for the specified KMS key.</p>
|
|
@@ -2798,15 +3038,24 @@ export interface GetKeyRotationStatusRequest {
|
|
|
2798
3038
|
*/
|
|
2799
3039
|
KeyId: string | undefined;
|
|
2800
3040
|
}
|
|
3041
|
+
/**
|
|
3042
|
+
* @public
|
|
3043
|
+
*/
|
|
2801
3044
|
export interface GetKeyRotationStatusResponse {
|
|
2802
3045
|
/**
|
|
2803
3046
|
* <p>A Boolean value that specifies whether key rotation is enabled.</p>
|
|
2804
3047
|
*/
|
|
2805
3048
|
KeyRotationEnabled?: boolean;
|
|
2806
3049
|
}
|
|
3050
|
+
/**
|
|
3051
|
+
* @public
|
|
3052
|
+
*/
|
|
2807
3053
|
export declare enum WrappingKeySpec {
|
|
2808
3054
|
RSA_2048 = "RSA_2048"
|
|
2809
3055
|
}
|
|
3056
|
+
/**
|
|
3057
|
+
* @public
|
|
3058
|
+
*/
|
|
2810
3059
|
export interface GetParametersForImportRequest {
|
|
2811
3060
|
/**
|
|
2812
3061
|
* <p>The identifier of the symmetric encryption KMS key into which you will import key
|
|
@@ -2843,6 +3092,9 @@ export interface GetParametersForImportRequest {
|
|
|
2843
3092
|
*/
|
|
2844
3093
|
WrappingKeySpec: WrappingKeySpec | string | undefined;
|
|
2845
3094
|
}
|
|
3095
|
+
/**
|
|
3096
|
+
* @public
|
|
3097
|
+
*/
|
|
2846
3098
|
export interface GetParametersForImportResponse {
|
|
2847
3099
|
/**
|
|
2848
3100
|
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the KMS key to use in a subsequent <a>ImportKeyMaterial</a> request. This is the same KMS key specified in the <code>GetParametersForImport</code>
|
|
@@ -2865,6 +3117,9 @@ export interface GetParametersForImportResponse {
|
|
|
2865
3117
|
*/
|
|
2866
3118
|
ParametersValidTo?: Date;
|
|
2867
3119
|
}
|
|
3120
|
+
/**
|
|
3121
|
+
* @public
|
|
3122
|
+
*/
|
|
2868
3123
|
export interface GetPublicKeyRequest {
|
|
2869
3124
|
/**
|
|
2870
3125
|
* <p>Identifies the asymmetric KMS key that includes the public key.</p>
|
|
@@ -2898,6 +3153,9 @@ export interface GetPublicKeyRequest {
|
|
|
2898
3153
|
*/
|
|
2899
3154
|
GrantTokens?: string[];
|
|
2900
3155
|
}
|
|
3156
|
+
/**
|
|
3157
|
+
* @public
|
|
3158
|
+
*/
|
|
2901
3159
|
export interface GetPublicKeyResponse {
|
|
2902
3160
|
/**
|
|
2903
3161
|
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the asymmetric KMS key from which the public key was
|
|
@@ -2948,6 +3206,7 @@ export interface GetPublicKeyResponse {
|
|
|
2948
3206
|
SigningAlgorithms?: (SigningAlgorithmSpec | string)[];
|
|
2949
3207
|
}
|
|
2950
3208
|
/**
|
|
3209
|
+
* @public
|
|
2951
3210
|
* <p>Contains information about a grant.</p>
|
|
2952
3211
|
*/
|
|
2953
3212
|
export interface GrantListEntry {
|
|
@@ -2994,6 +3253,9 @@ export interface GrantListEntry {
|
|
|
2994
3253
|
*/
|
|
2995
3254
|
Constraints?: GrantConstraints;
|
|
2996
3255
|
}
|
|
3256
|
+
/**
|
|
3257
|
+
* @public
|
|
3258
|
+
*/
|
|
2997
3259
|
export interface ImportKeyMaterialRequest {
|
|
2998
3260
|
/**
|
|
2999
3261
|
* <p>The identifier of the symmetric encryption KMS key that receives the imported key
|
|
@@ -3053,9 +3315,13 @@ export interface ImportKeyMaterialRequest {
|
|
|
3053
3315
|
*/
|
|
3054
3316
|
ExpirationModel?: ExpirationModelType | string;
|
|
3055
3317
|
}
|
|
3318
|
+
/**
|
|
3319
|
+
* @public
|
|
3320
|
+
*/
|
|
3056
3321
|
export interface ImportKeyMaterialResponse {
|
|
3057
3322
|
}
|
|
3058
3323
|
/**
|
|
3324
|
+
* @public
|
|
3059
3325
|
* <p>The request was rejected because the key material in the request is, expired, invalid, or
|
|
3060
3326
|
* is not the same key material that was previously imported into this KMS key.</p>
|
|
3061
3327
|
*/
|
|
@@ -3068,6 +3334,7 @@ export declare class IncorrectKeyMaterialException extends __BaseException {
|
|
|
3068
3334
|
constructor(opts: __ExceptionOptionType<IncorrectKeyMaterialException, __BaseException>);
|
|
3069
3335
|
}
|
|
3070
3336
|
/**
|
|
3337
|
+
* @public
|
|
3071
3338
|
* <p>The request was rejected because the provided import token is invalid or is associated
|
|
3072
3339
|
* with a different KMS key.</p>
|
|
3073
3340
|
*/
|
|
@@ -3080,6 +3347,7 @@ export declare class InvalidImportTokenException extends __BaseException {
|
|
|
3080
3347
|
constructor(opts: __ExceptionOptionType<InvalidImportTokenException, __BaseException>);
|
|
3081
3348
|
}
|
|
3082
3349
|
/**
|
|
3350
|
+
* @public
|
|
3083
3351
|
* <p>The request was rejected because the specified <code>GrantId</code> is not valid.</p>
|
|
3084
3352
|
*/
|
|
3085
3353
|
export declare class InvalidGrantIdException extends __BaseException {
|
|
@@ -3091,6 +3359,7 @@ export declare class InvalidGrantIdException extends __BaseException {
|
|
|
3091
3359
|
constructor(opts: __ExceptionOptionType<InvalidGrantIdException, __BaseException>);
|
|
3092
3360
|
}
|
|
3093
3361
|
/**
|
|
3362
|
+
* @public
|
|
3094
3363
|
* <p>Contains information about each entry in the key list.</p>
|
|
3095
3364
|
*/
|
|
3096
3365
|
export interface KeyListEntry {
|
|
@@ -3104,6 +3373,7 @@ export interface KeyListEntry {
|
|
|
3104
3373
|
KeyArn?: string;
|
|
3105
3374
|
}
|
|
3106
3375
|
/**
|
|
3376
|
+
* @public
|
|
3107
3377
|
* <p>The request was rejected because the HMAC verification failed. HMAC verification fails
|
|
3108
3378
|
* when the HMAC computed by using the specified message, HMAC KMS key, and MAC algorithm does
|
|
3109
3379
|
* not match the HMAC specified in the request.</p>
|
|
@@ -3117,6 +3387,7 @@ export declare class KMSInvalidMacException extends __BaseException {
|
|
|
3117
3387
|
constructor(opts: __ExceptionOptionType<KMSInvalidMacException, __BaseException>);
|
|
3118
3388
|
}
|
|
3119
3389
|
/**
|
|
3390
|
+
* @public
|
|
3120
3391
|
* <p>The request was rejected because the signature verification failed. Signature verification
|
|
3121
3392
|
* fails when it cannot confirm that signature was produced by signing the specified message with
|
|
3122
3393
|
* the specified KMS key and signing algorithm.</p>
|
|
@@ -3129,6 +3400,9 @@ export declare class KMSInvalidSignatureException extends __BaseException {
|
|
|
3129
3400
|
*/
|
|
3130
3401
|
constructor(opts: __ExceptionOptionType<KMSInvalidSignatureException, __BaseException>);
|
|
3131
3402
|
}
|
|
3403
|
+
/**
|
|
3404
|
+
* @public
|
|
3405
|
+
*/
|
|
3132
3406
|
export interface ListAliasesRequest {
|
|
3133
3407
|
/**
|
|
3134
3408
|
* <p>Lists only aliases that are associated with the specified KMS key. Enter a KMS key in your
|
|
@@ -3165,6 +3439,9 @@ export interface ListAliasesRequest {
|
|
|
3165
3439
|
*/
|
|
3166
3440
|
Marker?: string;
|
|
3167
3441
|
}
|
|
3442
|
+
/**
|
|
3443
|
+
* @public
|
|
3444
|
+
*/
|
|
3168
3445
|
export interface ListAliasesResponse {
|
|
3169
3446
|
/**
|
|
3170
3447
|
* <p>A list of aliases.</p>
|
|
@@ -3183,6 +3460,9 @@ export interface ListAliasesResponse {
|
|
|
3183
3460
|
*/
|
|
3184
3461
|
Truncated?: boolean;
|
|
3185
3462
|
}
|
|
3463
|
+
/**
|
|
3464
|
+
* @public
|
|
3465
|
+
*/
|
|
3186
3466
|
export interface ListGrantsRequest {
|
|
3187
3467
|
/**
|
|
3188
3468
|
* <p>Use this parameter to specify the maximum number of items to return. When this
|
|
@@ -3227,6 +3507,9 @@ export interface ListGrantsRequest {
|
|
|
3227
3507
|
*/
|
|
3228
3508
|
GranteePrincipal?: string;
|
|
3229
3509
|
}
|
|
3510
|
+
/**
|
|
3511
|
+
* @public
|
|
3512
|
+
*/
|
|
3230
3513
|
export interface ListGrantsResponse {
|
|
3231
3514
|
/**
|
|
3232
3515
|
* <p>A list of grants.</p>
|
|
@@ -3245,6 +3528,9 @@ export interface ListGrantsResponse {
|
|
|
3245
3528
|
*/
|
|
3246
3529
|
Truncated?: boolean;
|
|
3247
3530
|
}
|
|
3531
|
+
/**
|
|
3532
|
+
* @public
|
|
3533
|
+
*/
|
|
3248
3534
|
export interface ListKeyPoliciesRequest {
|
|
3249
3535
|
/**
|
|
3250
3536
|
* <p>Gets the names of key policies for the specified KMS key.</p>
|
|
@@ -3279,6 +3565,9 @@ export interface ListKeyPoliciesRequest {
|
|
|
3279
3565
|
*/
|
|
3280
3566
|
Marker?: string;
|
|
3281
3567
|
}
|
|
3568
|
+
/**
|
|
3569
|
+
* @public
|
|
3570
|
+
*/
|
|
3282
3571
|
export interface ListKeyPoliciesResponse {
|
|
3283
3572
|
/**
|
|
3284
3573
|
* <p>A list of key policy names. The only valid value is <code>default</code>.</p>
|
|
@@ -3297,6 +3586,9 @@ export interface ListKeyPoliciesResponse {
|
|
|
3297
3586
|
*/
|
|
3298
3587
|
Truncated?: boolean;
|
|
3299
3588
|
}
|
|
3589
|
+
/**
|
|
3590
|
+
* @public
|
|
3591
|
+
*/
|
|
3300
3592
|
export interface ListKeysRequest {
|
|
3301
3593
|
/**
|
|
3302
3594
|
* <p>Use this parameter to specify the maximum number of items to return. When this
|
|
@@ -3313,6 +3605,9 @@ export interface ListKeysRequest {
|
|
|
3313
3605
|
*/
|
|
3314
3606
|
Marker?: string;
|
|
3315
3607
|
}
|
|
3608
|
+
/**
|
|
3609
|
+
* @public
|
|
3610
|
+
*/
|
|
3316
3611
|
export interface ListKeysResponse {
|
|
3317
3612
|
/**
|
|
3318
3613
|
* <p>A list of KMS keys.</p>
|
|
@@ -3331,6 +3626,9 @@ export interface ListKeysResponse {
|
|
|
3331
3626
|
*/
|
|
3332
3627
|
Truncated?: boolean;
|
|
3333
3628
|
}
|
|
3629
|
+
/**
|
|
3630
|
+
* @public
|
|
3631
|
+
*/
|
|
3334
3632
|
export interface ListResourceTagsRequest {
|
|
3335
3633
|
/**
|
|
3336
3634
|
* <p>Gets tags on the specified KMS key.</p>
|
|
@@ -3366,6 +3664,9 @@ export interface ListResourceTagsRequest {
|
|
|
3366
3664
|
*/
|
|
3367
3665
|
Marker?: string;
|
|
3368
3666
|
}
|
|
3667
|
+
/**
|
|
3668
|
+
* @public
|
|
3669
|
+
*/
|
|
3369
3670
|
export interface ListResourceTagsResponse {
|
|
3370
3671
|
/**
|
|
3371
3672
|
* <p>A list of tags. Each tag consists of a tag key and a tag value.</p>
|
|
@@ -3388,6 +3689,9 @@ export interface ListResourceTagsResponse {
|
|
|
3388
3689
|
*/
|
|
3389
3690
|
Truncated?: boolean;
|
|
3390
3691
|
}
|
|
3692
|
+
/**
|
|
3693
|
+
* @public
|
|
3694
|
+
*/
|
|
3391
3695
|
export interface ListRetirableGrantsRequest {
|
|
3392
3696
|
/**
|
|
3393
3697
|
* <p>Use this parameter to specify the maximum number of items to return. When this
|
|
@@ -3415,10 +3719,16 @@ export interface ListRetirableGrantsRequest {
|
|
|
3415
3719
|
*/
|
|
3416
3720
|
RetiringPrincipal: string | undefined;
|
|
3417
3721
|
}
|
|
3722
|
+
/**
|
|
3723
|
+
* @public
|
|
3724
|
+
*/
|
|
3418
3725
|
export declare enum MessageType {
|
|
3419
3726
|
DIGEST = "DIGEST",
|
|
3420
3727
|
RAW = "RAW"
|
|
3421
3728
|
}
|
|
3729
|
+
/**
|
|
3730
|
+
* @public
|
|
3731
|
+
*/
|
|
3422
3732
|
export interface PutKeyPolicyRequest {
|
|
3423
3733
|
/**
|
|
3424
3734
|
* <p>Sets the key policy on the specified KMS key.</p>
|
|
@@ -3490,6 +3800,9 @@ export interface PutKeyPolicyRequest {
|
|
|
3490
3800
|
*/
|
|
3491
3801
|
BypassPolicyLockoutSafetyCheck?: boolean;
|
|
3492
3802
|
}
|
|
3803
|
+
/**
|
|
3804
|
+
* @public
|
|
3805
|
+
*/
|
|
3493
3806
|
export interface ReEncryptRequest {
|
|
3494
3807
|
/**
|
|
3495
3808
|
* <p>Ciphertext of the data to reencrypt.</p>
|
|
@@ -3603,6 +3916,9 @@ export interface ReEncryptRequest {
|
|
|
3603
3916
|
*/
|
|
3604
3917
|
GrantTokens?: string[];
|
|
3605
3918
|
}
|
|
3919
|
+
/**
|
|
3920
|
+
* @public
|
|
3921
|
+
*/
|
|
3606
3922
|
export interface ReEncryptResponse {
|
|
3607
3923
|
/**
|
|
3608
3924
|
* <p>The reencrypted data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
|
|
@@ -3626,6 +3942,9 @@ export interface ReEncryptResponse {
|
|
|
3626
3942
|
*/
|
|
3627
3943
|
DestinationEncryptionAlgorithm?: EncryptionAlgorithmSpec | string;
|
|
3628
3944
|
}
|
|
3945
|
+
/**
|
|
3946
|
+
* @public
|
|
3947
|
+
*/
|
|
3629
3948
|
export interface ReplicateKeyRequest {
|
|
3630
3949
|
/**
|
|
3631
3950
|
* <p>Identifies the multi-Region primary key that is being replicated. To determine whether a
|
|
@@ -3748,6 +4067,9 @@ export interface ReplicateKeyRequest {
|
|
|
3748
4067
|
*/
|
|
3749
4068
|
Tags?: Tag[];
|
|
3750
4069
|
}
|
|
4070
|
+
/**
|
|
4071
|
+
* @public
|
|
4072
|
+
*/
|
|
3751
4073
|
export interface ReplicateKeyResponse {
|
|
3752
4074
|
/**
|
|
3753
4075
|
* <p>Displays details about the new replica key, including its Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) and
|
|
@@ -3766,6 +4088,9 @@ export interface ReplicateKeyResponse {
|
|
|
3766
4088
|
*/
|
|
3767
4089
|
ReplicaTags?: Tag[];
|
|
3768
4090
|
}
|
|
4091
|
+
/**
|
|
4092
|
+
* @public
|
|
4093
|
+
*/
|
|
3769
4094
|
export interface RetireGrantRequest {
|
|
3770
4095
|
/**
|
|
3771
4096
|
* <p>Identifies the grant to be retired. You can use a grant token to identify a new grant even
|
|
@@ -3793,6 +4118,9 @@ export interface RetireGrantRequest {
|
|
|
3793
4118
|
*/
|
|
3794
4119
|
GrantId?: string;
|
|
3795
4120
|
}
|
|
4121
|
+
/**
|
|
4122
|
+
* @public
|
|
4123
|
+
*/
|
|
3796
4124
|
export interface RevokeGrantRequest {
|
|
3797
4125
|
/**
|
|
3798
4126
|
* <p>A unique identifier for the KMS key associated with the grant. To get the key ID and key
|
|
@@ -3819,6 +4147,9 @@ export interface RevokeGrantRequest {
|
|
|
3819
4147
|
*/
|
|
3820
4148
|
GrantId: string | undefined;
|
|
3821
4149
|
}
|
|
4150
|
+
/**
|
|
4151
|
+
* @public
|
|
4152
|
+
*/
|
|
3822
4153
|
export interface ScheduleKeyDeletionRequest {
|
|
3823
4154
|
/**
|
|
3824
4155
|
* <p>The unique identifier of the KMS key to delete.</p>
|
|
@@ -3848,6 +4179,9 @@ export interface ScheduleKeyDeletionRequest {
|
|
|
3848
4179
|
*/
|
|
3849
4180
|
PendingWindowInDays?: number;
|
|
3850
4181
|
}
|
|
4182
|
+
/**
|
|
4183
|
+
* @public
|
|
4184
|
+
*/
|
|
3851
4185
|
export interface ScheduleKeyDeletionResponse {
|
|
3852
4186
|
/**
|
|
3853
4187
|
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the KMS key whose deletion is scheduled.</p>
|
|
@@ -3874,6 +4208,9 @@ export interface ScheduleKeyDeletionResponse {
|
|
|
3874
4208
|
*/
|
|
3875
4209
|
PendingWindowInDays?: number;
|
|
3876
4210
|
}
|
|
4211
|
+
/**
|
|
4212
|
+
* @public
|
|
4213
|
+
*/
|
|
3877
4214
|
export interface SignRequest {
|
|
3878
4215
|
/**
|
|
3879
4216
|
* <p>Identifies an asymmetric KMS key. KMS uses the private key in the asymmetric KMS key to
|
|
@@ -3957,6 +4294,9 @@ export interface SignRequest {
|
|
|
3957
4294
|
*/
|
|
3958
4295
|
SigningAlgorithm: SigningAlgorithmSpec | string | undefined;
|
|
3959
4296
|
}
|
|
4297
|
+
/**
|
|
4298
|
+
* @public
|
|
4299
|
+
*/
|
|
3960
4300
|
export interface SignResponse {
|
|
3961
4301
|
/**
|
|
3962
4302
|
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the asymmetric KMS key that was used to sign the message.</p>
|
|
@@ -3986,6 +4326,9 @@ export interface SignResponse {
|
|
|
3986
4326
|
*/
|
|
3987
4327
|
SigningAlgorithm?: SigningAlgorithmSpec | string;
|
|
3988
4328
|
}
|
|
4329
|
+
/**
|
|
4330
|
+
* @public
|
|
4331
|
+
*/
|
|
3989
4332
|
export interface TagResourceRequest {
|
|
3990
4333
|
/**
|
|
3991
4334
|
* <p>Identifies a customer managed key in the account and Region.</p>
|
|
@@ -4014,6 +4357,9 @@ export interface TagResourceRequest {
|
|
|
4014
4357
|
*/
|
|
4015
4358
|
Tags: Tag[] | undefined;
|
|
4016
4359
|
}
|
|
4360
|
+
/**
|
|
4361
|
+
* @public
|
|
4362
|
+
*/
|
|
4017
4363
|
export interface UntagResourceRequest {
|
|
4018
4364
|
/**
|
|
4019
4365
|
* <p>Identifies the KMS key from which you are removing tags.</p>
|
|
@@ -4037,6 +4383,9 @@ export interface UntagResourceRequest {
|
|
|
4037
4383
|
*/
|
|
4038
4384
|
TagKeys: string[] | undefined;
|
|
4039
4385
|
}
|
|
4386
|
+
/**
|
|
4387
|
+
* @public
|
|
4388
|
+
*/
|
|
4040
4389
|
export interface UpdateAliasRequest {
|
|
4041
4390
|
/**
|
|
4042
4391
|
* <p>Identifies the alias that is changing its KMS key. This value must begin with
|
|
@@ -4067,6 +4416,9 @@ export interface UpdateAliasRequest {
|
|
|
4067
4416
|
*/
|
|
4068
4417
|
TargetKeyId: string | undefined;
|
|
4069
4418
|
}
|
|
4419
|
+
/**
|
|
4420
|
+
* @public
|
|
4421
|
+
*/
|
|
4070
4422
|
export interface UpdateCustomKeyStoreRequest {
|
|
4071
4423
|
/**
|
|
4072
4424
|
* <p>Identifies the custom key store that you want to update. Enter the ID of the custom key
|
|
@@ -4166,8 +4518,14 @@ export interface UpdateCustomKeyStoreRequest {
|
|
|
4166
4518
|
*/
|
|
4167
4519
|
XksProxyConnectivity?: XksProxyConnectivityType | string;
|
|
4168
4520
|
}
|
|
4521
|
+
/**
|
|
4522
|
+
* @public
|
|
4523
|
+
*/
|
|
4169
4524
|
export interface UpdateCustomKeyStoreResponse {
|
|
4170
4525
|
}
|
|
4526
|
+
/**
|
|
4527
|
+
* @public
|
|
4528
|
+
*/
|
|
4171
4529
|
export interface UpdateKeyDescriptionRequest {
|
|
4172
4530
|
/**
|
|
4173
4531
|
* <p>Updates the description of the specified KMS key.</p>
|
|
@@ -4191,6 +4549,9 @@ export interface UpdateKeyDescriptionRequest {
|
|
|
4191
4549
|
*/
|
|
4192
4550
|
Description: string | undefined;
|
|
4193
4551
|
}
|
|
4552
|
+
/**
|
|
4553
|
+
* @public
|
|
4554
|
+
*/
|
|
4194
4555
|
export interface UpdatePrimaryRegionRequest {
|
|
4195
4556
|
/**
|
|
4196
4557
|
* <p>Identifies the current primary key. When the operation completes, this KMS key will be a
|
|
@@ -4219,6 +4580,9 @@ export interface UpdatePrimaryRegionRequest {
|
|
|
4219
4580
|
*/
|
|
4220
4581
|
PrimaryRegion: string | undefined;
|
|
4221
4582
|
}
|
|
4583
|
+
/**
|
|
4584
|
+
* @public
|
|
4585
|
+
*/
|
|
4222
4586
|
export interface VerifyRequest {
|
|
4223
4587
|
/**
|
|
4224
4588
|
* <p>Identifies the asymmetric KMS key that will be used to verify the signature. This must be
|
|
@@ -4306,6 +4670,9 @@ export interface VerifyRequest {
|
|
|
4306
4670
|
*/
|
|
4307
4671
|
GrantTokens?: string[];
|
|
4308
4672
|
}
|
|
4673
|
+
/**
|
|
4674
|
+
* @public
|
|
4675
|
+
*/
|
|
4309
4676
|
export interface VerifyResponse {
|
|
4310
4677
|
/**
|
|
4311
4678
|
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the asymmetric KMS key that was used to verify the signature.</p>
|
|
@@ -4324,6 +4691,9 @@ export interface VerifyResponse {
|
|
|
4324
4691
|
*/
|
|
4325
4692
|
SigningAlgorithm?: SigningAlgorithmSpec | string;
|
|
4326
4693
|
}
|
|
4694
|
+
/**
|
|
4695
|
+
* @public
|
|
4696
|
+
*/
|
|
4327
4697
|
export interface VerifyMacRequest {
|
|
4328
4698
|
/**
|
|
4329
4699
|
* <p>The message that will be used in the verification. Enter the same message that was used to
|
|
@@ -4359,6 +4729,9 @@ export interface VerifyMacRequest {
|
|
|
4359
4729
|
*/
|
|
4360
4730
|
GrantTokens?: string[];
|
|
4361
4731
|
}
|
|
4732
|
+
/**
|
|
4733
|
+
* @public
|
|
4734
|
+
*/
|
|
4362
4735
|
export interface VerifyMacResponse {
|
|
4363
4736
|
/**
|
|
4364
4737
|
* <p>The HMAC KMS key used in the verification.</p>
|