@aws-sdk/client-kms 3.379.1 → 3.382.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/models/models_0.d.ts +344 -0
- package/package.json +5 -5
|
@@ -21,23 +21,28 @@ export type AlgorithmSpec = (typeof AlgorithmSpec)[keyof typeof AlgorithmSpec];
|
|
|
21
21
|
*/
|
|
22
22
|
export interface AliasListEntry {
|
|
23
23
|
/**
|
|
24
|
+
* @public
|
|
24
25
|
* <p>String that contains the alias. This value begins with <code>alias/</code>.</p>
|
|
25
26
|
*/
|
|
26
27
|
AliasName?: string;
|
|
27
28
|
/**
|
|
29
|
+
* @public
|
|
28
30
|
* <p>String that contains the key ARN.</p>
|
|
29
31
|
*/
|
|
30
32
|
AliasArn?: string;
|
|
31
33
|
/**
|
|
34
|
+
* @public
|
|
32
35
|
* <p>String that contains the key identifier of the KMS key associated with the alias.</p>
|
|
33
36
|
*/
|
|
34
37
|
TargetKeyId?: string;
|
|
35
38
|
/**
|
|
39
|
+
* @public
|
|
36
40
|
* <p>Date and time that the alias was most recently created in the account and Region.
|
|
37
41
|
* Formatted as Unix time.</p>
|
|
38
42
|
*/
|
|
39
43
|
CreationDate?: Date;
|
|
40
44
|
/**
|
|
45
|
+
* @public
|
|
41
46
|
* <p>Date and time that the alias was most recently associated with a KMS key in the account
|
|
42
47
|
* and Region. Formatted as Unix time.</p>
|
|
43
48
|
*/
|
|
@@ -61,6 +66,7 @@ export declare class AlreadyExistsException extends __BaseException {
|
|
|
61
66
|
*/
|
|
62
67
|
export interface CancelKeyDeletionRequest {
|
|
63
68
|
/**
|
|
69
|
+
* @public
|
|
64
70
|
* <p>Identifies the KMS key whose deletion is being canceled.</p>
|
|
65
71
|
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
66
72
|
* <p>For example:</p>
|
|
@@ -83,6 +89,7 @@ export interface CancelKeyDeletionRequest {
|
|
|
83
89
|
*/
|
|
84
90
|
export interface CancelKeyDeletionResponse {
|
|
85
91
|
/**
|
|
92
|
+
* @public
|
|
86
93
|
* <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>
|
|
87
94
|
*/
|
|
88
95
|
KeyId?: string;
|
|
@@ -280,6 +287,7 @@ export declare class CloudHsmClusterNotRelatedException extends __BaseException
|
|
|
280
287
|
*/
|
|
281
288
|
export interface ConnectCustomKeyStoreRequest {
|
|
282
289
|
/**
|
|
290
|
+
* @public
|
|
283
291
|
* <p>Enter the key store ID of the custom key store that you want to connect.
|
|
284
292
|
* To find the ID of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p>
|
|
285
293
|
*/
|
|
@@ -396,6 +404,7 @@ export type ConnectionStateType = (typeof ConnectionStateType)[keyof typeof Conn
|
|
|
396
404
|
*/
|
|
397
405
|
export interface CreateAliasRequest {
|
|
398
406
|
/**
|
|
407
|
+
* @public
|
|
399
408
|
* <p>Specifies the alias name. This value must begin with <code>alias/</code> followed by a
|
|
400
409
|
* name, such as <code>alias/ExampleAlias</code>. </p>
|
|
401
410
|
* <important>
|
|
@@ -409,6 +418,7 @@ export interface CreateAliasRequest {
|
|
|
409
418
|
*/
|
|
410
419
|
AliasName: string | undefined;
|
|
411
420
|
/**
|
|
421
|
+
* @public
|
|
412
422
|
* <p>Associates the alias with the specified <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>. The KMS key must
|
|
413
423
|
* be in the same Amazon Web Services Region. </p>
|
|
414
424
|
* <p>A valid key ID is required. If you supply a null or empty string value, this operation
|
|
@@ -479,10 +489,12 @@ export type CustomKeyStoreType = (typeof CustomKeyStoreType)[keyof typeof Custom
|
|
|
479
489
|
*/
|
|
480
490
|
export interface XksProxyAuthenticationCredentialType {
|
|
481
491
|
/**
|
|
492
|
+
* @public
|
|
482
493
|
* <p>A unique identifier for the raw secret access key.</p>
|
|
483
494
|
*/
|
|
484
495
|
AccessKeyId: string | undefined;
|
|
485
496
|
/**
|
|
497
|
+
* @public
|
|
486
498
|
* <p>A secret string of 43-64 characters. Valid characters are a-z, A-Z, 0-9, /, +, and
|
|
487
499
|
* =.</p>
|
|
488
500
|
*/
|
|
@@ -505,6 +517,7 @@ export type XksProxyConnectivityType = (typeof XksProxyConnectivityType)[keyof t
|
|
|
505
517
|
*/
|
|
506
518
|
export interface CreateCustomKeyStoreRequest {
|
|
507
519
|
/**
|
|
520
|
+
* @public
|
|
508
521
|
* <p>Specifies a friendly name for the custom key store. The name must be unique in your
|
|
509
522
|
* Amazon Web Services account and Region. This parameter is required for all custom key stores.</p>
|
|
510
523
|
* <important>
|
|
@@ -513,6 +526,7 @@ export interface CreateCustomKeyStoreRequest {
|
|
|
513
526
|
*/
|
|
514
527
|
CustomKeyStoreName: string | undefined;
|
|
515
528
|
/**
|
|
529
|
+
* @public
|
|
516
530
|
* <p>Identifies the CloudHSM cluster for an CloudHSM key store. This parameter is required for custom
|
|
517
531
|
* key stores with <code>CustomKeyStoreType</code> of <code>AWS_CLOUDHSM</code>.</p>
|
|
518
532
|
* <p>Enter the cluster ID of any active CloudHSM cluster that is not already associated with a
|
|
@@ -520,6 +534,7 @@ export interface CreateCustomKeyStoreRequest {
|
|
|
520
534
|
*/
|
|
521
535
|
CloudHsmClusterId?: string;
|
|
522
536
|
/**
|
|
537
|
+
* @public
|
|
523
538
|
* <p>Specifies the certificate for an CloudHSM key store. This parameter is required for custom
|
|
524
539
|
* key stores with a <code>CustomKeyStoreType</code> of <code>AWS_CLOUDHSM</code>.</p>
|
|
525
540
|
* <p>Enter the content of the trust anchor certificate for the CloudHSM cluster. This is the
|
|
@@ -528,6 +543,7 @@ export interface CreateCustomKeyStoreRequest {
|
|
|
528
543
|
*/
|
|
529
544
|
TrustAnchorCertificate?: string;
|
|
530
545
|
/**
|
|
546
|
+
* @public
|
|
531
547
|
* <p>Specifies the <code>kmsuser</code> password for an CloudHSM key store. This parameter is
|
|
532
548
|
* required for custom key stores with a <code>CustomKeyStoreType</code> of
|
|
533
549
|
* <code>AWS_CLOUDHSM</code>.</p>
|
|
@@ -541,6 +557,7 @@ export interface CreateCustomKeyStoreRequest {
|
|
|
541
557
|
*/
|
|
542
558
|
KeyStorePassword?: string;
|
|
543
559
|
/**
|
|
560
|
+
* @public
|
|
544
561
|
* <p>Specifies the type of custom key store. The default value is
|
|
545
562
|
* <code>AWS_CLOUDHSM</code>.</p>
|
|
546
563
|
* <p>For a custom key store backed by an CloudHSM cluster, omit the parameter or enter
|
|
@@ -550,6 +567,7 @@ export interface CreateCustomKeyStoreRequest {
|
|
|
550
567
|
*/
|
|
551
568
|
CustomKeyStoreType?: CustomKeyStoreType | string;
|
|
552
569
|
/**
|
|
570
|
+
* @public
|
|
553
571
|
* <p>Specifies the endpoint that KMS uses to send requests to the external key store proxy
|
|
554
572
|
* (XKS proxy). This parameter is required for custom key stores with a
|
|
555
573
|
* <code>CustomKeyStoreType</code> of <code>EXTERNAL_KEY_STORE</code>.</p>
|
|
@@ -589,6 +607,7 @@ export interface CreateCustomKeyStoreRequest {
|
|
|
589
607
|
*/
|
|
590
608
|
XksProxyUriEndpoint?: string;
|
|
591
609
|
/**
|
|
610
|
+
* @public
|
|
592
611
|
* <p>Specifies the base path to the proxy APIs for this external key store. To find this value,
|
|
593
612
|
* see the documentation for your external key store proxy. This parameter is required for all
|
|
594
613
|
* custom key stores with a <code>CustomKeyStoreType</code> of
|
|
@@ -609,6 +628,7 @@ export interface CreateCustomKeyStoreRequest {
|
|
|
609
628
|
*/
|
|
610
629
|
XksProxyUriPath?: string;
|
|
611
630
|
/**
|
|
631
|
+
* @public
|
|
612
632
|
* <p>Specifies the name of the Amazon VPC endpoint service for interface endpoints that is used to
|
|
613
633
|
* communicate with your external key store proxy (XKS proxy). This parameter is required when
|
|
614
634
|
* the value of <code>CustomKeyStoreType</code> is <code>EXTERNAL_KEY_STORE</code> and the value
|
|
@@ -628,6 +648,7 @@ export interface CreateCustomKeyStoreRequest {
|
|
|
628
648
|
*/
|
|
629
649
|
XksProxyVpcEndpointServiceName?: string;
|
|
630
650
|
/**
|
|
651
|
+
* @public
|
|
631
652
|
* <p>Specifies an authentication credential for the external key store proxy (XKS proxy). This
|
|
632
653
|
* parameter is required for all custom key stores with a <code>CustomKeyStoreType</code> of
|
|
633
654
|
* <code>EXTERNAL_KEY_STORE</code>.</p>
|
|
@@ -643,6 +664,7 @@ export interface CreateCustomKeyStoreRequest {
|
|
|
643
664
|
*/
|
|
644
665
|
XksProxyAuthenticationCredential?: XksProxyAuthenticationCredentialType;
|
|
645
666
|
/**
|
|
667
|
+
* @public
|
|
646
668
|
* <p>Indicates how KMS communicates with the external key store proxy. This parameter is
|
|
647
669
|
* required for custom key stores with a <code>CustomKeyStoreType</code> of
|
|
648
670
|
* <code>EXTERNAL_KEY_STORE</code>.</p>
|
|
@@ -667,6 +689,7 @@ export interface CreateCustomKeyStoreRequest {
|
|
|
667
689
|
*/
|
|
668
690
|
export interface CreateCustomKeyStoreResponse {
|
|
669
691
|
/**
|
|
692
|
+
* @public
|
|
670
693
|
* <p>A unique identifier for the new custom key store.</p>
|
|
671
694
|
*/
|
|
672
695
|
CustomKeyStoreId?: string;
|
|
@@ -860,6 +883,7 @@ export declare class XksProxyVpcEndpointServiceNotFoundException extends __BaseE
|
|
|
860
883
|
*/
|
|
861
884
|
export interface GrantConstraints {
|
|
862
885
|
/**
|
|
886
|
+
* @public
|
|
863
887
|
* <p>A list of key-value pairs that must be included in the encryption context of the
|
|
864
888
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operation</a> request. The grant allows the cryptographic operation only when the encryption
|
|
865
889
|
* context in the request includes the key-value pairs specified in this constraint, although it
|
|
@@ -867,6 +891,7 @@ export interface GrantConstraints {
|
|
|
867
891
|
*/
|
|
868
892
|
EncryptionContextSubset?: Record<string, string>;
|
|
869
893
|
/**
|
|
894
|
+
* @public
|
|
870
895
|
* <p>A list of key-value pairs that must match the encryption context in the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operation</a>
|
|
871
896
|
* request. The grant allows the operation only when the encryption context in the request is the
|
|
872
897
|
* same as the encryption context specified in this constraint.</p>
|
|
@@ -904,6 +929,7 @@ export type GrantOperation = (typeof GrantOperation)[keyof typeof GrantOperation
|
|
|
904
929
|
*/
|
|
905
930
|
export interface CreateGrantRequest {
|
|
906
931
|
/**
|
|
932
|
+
* @public
|
|
907
933
|
* <p>Identifies the KMS key for the grant. The grant gives principals permission to use this
|
|
908
934
|
* KMS key.</p>
|
|
909
935
|
* <p>Specify the key ID or key ARN of the KMS key. To specify a KMS key in a
|
|
@@ -923,6 +949,7 @@ export interface CreateGrantRequest {
|
|
|
923
949
|
*/
|
|
924
950
|
KeyId: string | undefined;
|
|
925
951
|
/**
|
|
952
|
+
* @public
|
|
926
953
|
* <p>The identity that gets the permissions specified in the grant.</p>
|
|
927
954
|
* <p>To specify the grantee principal, use the Amazon Resource Name (ARN) of an Amazon Web Services
|
|
928
955
|
* principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles,
|
|
@@ -933,6 +960,7 @@ export interface CreateGrantRequest {
|
|
|
933
960
|
*/
|
|
934
961
|
GranteePrincipal: string | undefined;
|
|
935
962
|
/**
|
|
963
|
+
* @public
|
|
936
964
|
* <p>The principal that has permission to use the <a>RetireGrant</a> operation to
|
|
937
965
|
* retire the grant. </p>
|
|
938
966
|
* <p>To specify the principal, use the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of an
|
|
@@ -948,6 +976,7 @@ export interface CreateGrantRequest {
|
|
|
948
976
|
*/
|
|
949
977
|
RetiringPrincipal?: string;
|
|
950
978
|
/**
|
|
979
|
+
* @public
|
|
951
980
|
* <p>A list of operations that the grant permits. </p>
|
|
952
981
|
* <p>This list must include only operations that are permitted in a grant. Also, the operation
|
|
953
982
|
* must be supported on the KMS key. For example, you cannot create a grant for a symmetric
|
|
@@ -958,6 +987,7 @@ export interface CreateGrantRequest {
|
|
|
958
987
|
*/
|
|
959
988
|
Operations: (GrantOperation | string)[] | undefined;
|
|
960
989
|
/**
|
|
990
|
+
* @public
|
|
961
991
|
* <p>Specifies a grant constraint.</p>
|
|
962
992
|
* <important>
|
|
963
993
|
* <p>Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p>
|
|
@@ -987,12 +1017,14 @@ export interface CreateGrantRequest {
|
|
|
987
1017
|
*/
|
|
988
1018
|
Constraints?: GrantConstraints;
|
|
989
1019
|
/**
|
|
1020
|
+
* @public
|
|
990
1021
|
* <p>A list of grant tokens. </p>
|
|
991
1022
|
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
992
1023
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
993
1024
|
*/
|
|
994
1025
|
GrantTokens?: string[];
|
|
995
1026
|
/**
|
|
1027
|
+
* @public
|
|
996
1028
|
* <p>A friendly name for the grant. Use this value to prevent the unintended creation of
|
|
997
1029
|
* duplicate grants when retrying this request.</p>
|
|
998
1030
|
* <important>
|
|
@@ -1009,6 +1041,7 @@ export interface CreateGrantRequest {
|
|
|
1009
1041
|
*/
|
|
1010
1042
|
Name?: string;
|
|
1011
1043
|
/**
|
|
1044
|
+
* @public
|
|
1012
1045
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
1013
1046
|
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1014
1047
|
*/
|
|
@@ -1019,12 +1052,14 @@ export interface CreateGrantRequest {
|
|
|
1019
1052
|
*/
|
|
1020
1053
|
export interface CreateGrantResponse {
|
|
1021
1054
|
/**
|
|
1055
|
+
* @public
|
|
1022
1056
|
* <p>The grant token.</p>
|
|
1023
1057
|
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
1024
1058
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
1025
1059
|
*/
|
|
1026
1060
|
GrantToken?: string;
|
|
1027
1061
|
/**
|
|
1062
|
+
* @public
|
|
1028
1063
|
* <p>The unique identifier for the grant.</p>
|
|
1029
1064
|
* <p>You can use the <code>GrantId</code> in a <a>ListGrants</a>, <a>RetireGrant</a>, or <a>RevokeGrant</a> operation.</p>
|
|
1030
1065
|
*/
|
|
@@ -1153,10 +1188,12 @@ export type OriginType = (typeof OriginType)[keyof typeof OriginType];
|
|
|
1153
1188
|
*/
|
|
1154
1189
|
export interface Tag {
|
|
1155
1190
|
/**
|
|
1191
|
+
* @public
|
|
1156
1192
|
* <p>The key of the tag.</p>
|
|
1157
1193
|
*/
|
|
1158
1194
|
TagKey: string | undefined;
|
|
1159
1195
|
/**
|
|
1196
|
+
* @public
|
|
1160
1197
|
* <p>The value of the tag.</p>
|
|
1161
1198
|
*/
|
|
1162
1199
|
TagValue: string | undefined;
|
|
@@ -1166,6 +1203,7 @@ export interface Tag {
|
|
|
1166
1203
|
*/
|
|
1167
1204
|
export interface CreateKeyRequest {
|
|
1168
1205
|
/**
|
|
1206
|
+
* @public
|
|
1169
1207
|
* <p>The key policy to attach to the KMS key.</p>
|
|
1170
1208
|
* <p>If you provide a key policy, it must meet the following criteria:</p>
|
|
1171
1209
|
* <ul>
|
|
@@ -1194,6 +1232,7 @@ export interface CreateKeyRequest {
|
|
|
1194
1232
|
*/
|
|
1195
1233
|
Policy?: string;
|
|
1196
1234
|
/**
|
|
1235
|
+
* @public
|
|
1197
1236
|
* <p>A description of the KMS key. Use a description that helps you decide whether the KMS key
|
|
1198
1237
|
* is appropriate for a task. The default value is an empty string (no description).</p>
|
|
1199
1238
|
* <important>
|
|
@@ -1203,6 +1242,7 @@ export interface CreateKeyRequest {
|
|
|
1203
1242
|
*/
|
|
1204
1243
|
Description?: string;
|
|
1205
1244
|
/**
|
|
1245
|
+
* @public
|
|
1206
1246
|
* <p>Determines the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> for which you can use the KMS key. The default value is
|
|
1207
1247
|
* <code>ENCRYPT_DECRYPT</code>. This parameter is optional when you are creating a symmetric
|
|
1208
1248
|
* encryption KMS key; otherwise, it is required. You can't change the <code>KeyUsage</code>
|
|
@@ -1232,6 +1272,7 @@ export interface CreateKeyRequest {
|
|
|
1232
1272
|
*/
|
|
1233
1273
|
KeyUsage?: KeyUsageType | string;
|
|
1234
1274
|
/**
|
|
1275
|
+
* @public
|
|
1235
1276
|
* @deprecated
|
|
1236
1277
|
*
|
|
1237
1278
|
* <p>Instead, use the <code>KeySpec</code> parameter.</p>
|
|
@@ -1241,6 +1282,7 @@ export interface CreateKeyRequest {
|
|
|
1241
1282
|
*/
|
|
1242
1283
|
CustomerMasterKeySpec?: CustomerMasterKeySpec | string;
|
|
1243
1284
|
/**
|
|
1285
|
+
* @public
|
|
1244
1286
|
* <p>Specifies the type of KMS key to create. The default value,
|
|
1245
1287
|
* <code>SYMMETRIC_DEFAULT</code>, creates a KMS key with a 256-bit AES-GCM key that is used for
|
|
1246
1288
|
* encryption and decryption, except in China Regions, where it creates a 128-bit symmetric key
|
|
@@ -1358,6 +1400,7 @@ export interface CreateKeyRequest {
|
|
|
1358
1400
|
*/
|
|
1359
1401
|
KeySpec?: KeySpec | string;
|
|
1360
1402
|
/**
|
|
1403
|
+
* @public
|
|
1361
1404
|
* <p>The source of the key material for the KMS key. You cannot change the origin after you
|
|
1362
1405
|
* create the KMS key. The default is <code>AWS_KMS</code>, which means that KMS creates the
|
|
1363
1406
|
* key material.</p>
|
|
@@ -1380,6 +1423,7 @@ export interface CreateKeyRequest {
|
|
|
1380
1423
|
*/
|
|
1381
1424
|
Origin?: OriginType | string;
|
|
1382
1425
|
/**
|
|
1426
|
+
* @public
|
|
1383
1427
|
* <p>Creates the KMS key in the specified <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. The <code>ConnectionState</code> of
|
|
1384
1428
|
* the custom key store must be <code>CONNECTED</code>. To find the CustomKeyStoreID and
|
|
1385
1429
|
* ConnectionState use the <a>DescribeCustomKeyStores</a> operation.</p>
|
|
@@ -1392,6 +1436,7 @@ export interface CreateKeyRequest {
|
|
|
1392
1436
|
*/
|
|
1393
1437
|
CustomKeyStoreId?: string;
|
|
1394
1438
|
/**
|
|
1439
|
+
* @public
|
|
1395
1440
|
* <p>Skips ("bypasses") the key policy lockout safety check. The default value is false.</p>
|
|
1396
1441
|
* <important>
|
|
1397
1442
|
* <p>Setting this value to true increases the risk that the KMS key becomes unmanageable. Do
|
|
@@ -1403,6 +1448,7 @@ export interface CreateKeyRequest {
|
|
|
1403
1448
|
*/
|
|
1404
1449
|
BypassPolicyLockoutSafetyCheck?: boolean;
|
|
1405
1450
|
/**
|
|
1451
|
+
* @public
|
|
1406
1452
|
* <p>Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is
|
|
1407
1453
|
* created. To tag an existing KMS key, use the <a>TagResource</a> operation.</p>
|
|
1408
1454
|
* <important>
|
|
@@ -1422,6 +1468,7 @@ export interface CreateKeyRequest {
|
|
|
1422
1468
|
*/
|
|
1423
1469
|
Tags?: Tag[];
|
|
1424
1470
|
/**
|
|
1471
|
+
* @public
|
|
1425
1472
|
* <p>Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You
|
|
1426
1473
|
* cannot change this value after you create the KMS key. </p>
|
|
1427
1474
|
* <p>For a multi-Region key, set this parameter to <code>True</code>. For a single-Region KMS
|
|
@@ -1439,6 +1486,7 @@ export interface CreateKeyRequest {
|
|
|
1439
1486
|
*/
|
|
1440
1487
|
MultiRegion?: boolean;
|
|
1441
1488
|
/**
|
|
1489
|
+
* @public
|
|
1442
1490
|
* <p>Identifies the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key">external key</a> that
|
|
1443
1491
|
* serves as key material for the KMS key in an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html">external key store</a>. Specify the ID that
|
|
1444
1492
|
* the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-xks-proxy">external key store proxy</a> uses to refer to the external key. For help, see the
|
|
@@ -1550,10 +1598,12 @@ export type MultiRegionKeyType = (typeof MultiRegionKeyType)[keyof typeof MultiR
|
|
|
1550
1598
|
*/
|
|
1551
1599
|
export interface MultiRegionKey {
|
|
1552
1600
|
/**
|
|
1601
|
+
* @public
|
|
1553
1602
|
* <p>Displays the key ARN of a primary or replica key of a multi-Region key.</p>
|
|
1554
1603
|
*/
|
|
1555
1604
|
Arn?: string;
|
|
1556
1605
|
/**
|
|
1606
|
+
* @public
|
|
1557
1607
|
* <p>Displays the Amazon Web Services Region of a primary or replica key in a multi-Region key.</p>
|
|
1558
1608
|
*/
|
|
1559
1609
|
Region?: string;
|
|
@@ -1567,16 +1617,19 @@ export interface MultiRegionKey {
|
|
|
1567
1617
|
*/
|
|
1568
1618
|
export interface MultiRegionConfiguration {
|
|
1569
1619
|
/**
|
|
1620
|
+
* @public
|
|
1570
1621
|
* <p>Indicates whether the KMS key is a <code>PRIMARY</code> or <code>REPLICA</code>
|
|
1571
1622
|
* key.</p>
|
|
1572
1623
|
*/
|
|
1573
1624
|
MultiRegionKeyType?: MultiRegionKeyType | string;
|
|
1574
1625
|
/**
|
|
1626
|
+
* @public
|
|
1575
1627
|
* <p>Displays the key ARN and Region of the primary key. This field includes the current KMS
|
|
1576
1628
|
* key if it is the primary key.</p>
|
|
1577
1629
|
*/
|
|
1578
1630
|
PrimaryKey?: MultiRegionKey;
|
|
1579
1631
|
/**
|
|
1632
|
+
* @public
|
|
1580
1633
|
* <p>displays the key ARNs and Regions of all replica keys. This field includes the current KMS
|
|
1581
1634
|
* key if it is a replica key.</p>
|
|
1582
1635
|
*/
|
|
@@ -1616,6 +1669,7 @@ export type SigningAlgorithmSpec = (typeof SigningAlgorithmSpec)[keyof typeof Si
|
|
|
1616
1669
|
*/
|
|
1617
1670
|
export interface XksKeyConfigurationType {
|
|
1618
1671
|
/**
|
|
1672
|
+
* @public
|
|
1619
1673
|
* <p>The ID of the external key in its external key manager. This is the ID that the external
|
|
1620
1674
|
* key store proxy uses to identify the external key.</p>
|
|
1621
1675
|
*/
|
|
@@ -1628,42 +1682,51 @@ export interface XksKeyConfigurationType {
|
|
|
1628
1682
|
*/
|
|
1629
1683
|
export interface KeyMetadata {
|
|
1630
1684
|
/**
|
|
1685
|
+
* @public
|
|
1631
1686
|
* <p>The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.</p>
|
|
1632
1687
|
*/
|
|
1633
1688
|
AWSAccountId?: string;
|
|
1634
1689
|
/**
|
|
1690
|
+
* @public
|
|
1635
1691
|
* <p>The globally unique identifier for the KMS key.</p>
|
|
1636
1692
|
*/
|
|
1637
1693
|
KeyId: string | undefined;
|
|
1638
1694
|
/**
|
|
1695
|
+
* @public
|
|
1639
1696
|
* <p>The Amazon Resource Name (ARN) of the KMS key. For examples, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms">Key Management Service (KMS)</a> in the Example ARNs section of the <i>Amazon Web Services General
|
|
1640
1697
|
* Reference</i>.</p>
|
|
1641
1698
|
*/
|
|
1642
1699
|
Arn?: string;
|
|
1643
1700
|
/**
|
|
1701
|
+
* @public
|
|
1644
1702
|
* <p>The date and time when the KMS key was created.</p>
|
|
1645
1703
|
*/
|
|
1646
1704
|
CreationDate?: Date;
|
|
1647
1705
|
/**
|
|
1706
|
+
* @public
|
|
1648
1707
|
* <p>Specifies whether the KMS key is enabled. When <code>KeyState</code> is
|
|
1649
1708
|
* <code>Enabled</code> this value is true, otherwise it is false.</p>
|
|
1650
1709
|
*/
|
|
1651
1710
|
Enabled?: boolean;
|
|
1652
1711
|
/**
|
|
1712
|
+
* @public
|
|
1653
1713
|
* <p>The description of the KMS key.</p>
|
|
1654
1714
|
*/
|
|
1655
1715
|
Description?: string;
|
|
1656
1716
|
/**
|
|
1717
|
+
* @public
|
|
1657
1718
|
* <p>The <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> for which you can use the KMS key.</p>
|
|
1658
1719
|
*/
|
|
1659
1720
|
KeyUsage?: KeyUsageType | string;
|
|
1660
1721
|
/**
|
|
1722
|
+
* @public
|
|
1661
1723
|
* <p>The current status of the KMS key.</p>
|
|
1662
1724
|
* <p>For more information about how key state affects the use of a KMS key, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in
|
|
1663
1725
|
* the <i>Key Management Service Developer Guide</i>.</p>
|
|
1664
1726
|
*/
|
|
1665
1727
|
KeyState?: KeyState | string;
|
|
1666
1728
|
/**
|
|
1729
|
+
* @public
|
|
1667
1730
|
* <p>The date and time after which KMS deletes this KMS key. This value is present only when
|
|
1668
1731
|
* the KMS key is scheduled for deletion, that is, when its <code>KeyState</code> is
|
|
1669
1732
|
* <code>PendingDeletion</code>.</p>
|
|
@@ -1673,6 +1736,7 @@ export interface KeyMetadata {
|
|
|
1673
1736
|
*/
|
|
1674
1737
|
DeletionDate?: Date;
|
|
1675
1738
|
/**
|
|
1739
|
+
* @public
|
|
1676
1740
|
* <p>The time at which the imported key material expires. When the key material expires, KMS
|
|
1677
1741
|
* deletes the key material and the KMS key becomes unusable. This value is present only for KMS
|
|
1678
1742
|
* keys whose <code>Origin</code> is <code>EXTERNAL</code> and whose <code>ExpirationModel</code>
|
|
@@ -1680,6 +1744,7 @@ export interface KeyMetadata {
|
|
|
1680
1744
|
*/
|
|
1681
1745
|
ValidTo?: Date;
|
|
1682
1746
|
/**
|
|
1747
|
+
* @public
|
|
1683
1748
|
* <p>The source of the key material for the KMS key. When this value is <code>AWS_KMS</code>,
|
|
1684
1749
|
* KMS created the key material. When this value is <code>EXTERNAL</code>, the key material was
|
|
1685
1750
|
* imported or the KMS key doesn't have any key material. When this value is
|
|
@@ -1688,11 +1753,13 @@ export interface KeyMetadata {
|
|
|
1688
1753
|
*/
|
|
1689
1754
|
Origin?: OriginType | string;
|
|
1690
1755
|
/**
|
|
1756
|
+
* @public
|
|
1691
1757
|
* <p>A unique identifier for the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> that contains the KMS key. This field is
|
|
1692
1758
|
* present only when the KMS key is created in a custom key store.</p>
|
|
1693
1759
|
*/
|
|
1694
1760
|
CustomKeyStoreId?: string;
|
|
1695
1761
|
/**
|
|
1762
|
+
* @public
|
|
1696
1763
|
* <p>The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When
|
|
1697
1764
|
* you create a KMS key in an CloudHSM <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>, KMS creates the key material for the KMS
|
|
1698
1765
|
* key in the associated CloudHSM cluster. This field is present only when the KMS key is created in
|
|
@@ -1700,16 +1767,19 @@ export interface KeyMetadata {
|
|
|
1700
1767
|
*/
|
|
1701
1768
|
CloudHsmClusterId?: string;
|
|
1702
1769
|
/**
|
|
1770
|
+
* @public
|
|
1703
1771
|
* <p>Specifies whether the KMS key's key material expires. This value is present only when
|
|
1704
1772
|
* <code>Origin</code> is <code>EXTERNAL</code>, otherwise this value is omitted.</p>
|
|
1705
1773
|
*/
|
|
1706
1774
|
ExpirationModel?: ExpirationModelType | string;
|
|
1707
1775
|
/**
|
|
1776
|
+
* @public
|
|
1708
1777
|
* <p>The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or
|
|
1709
1778
|
* Amazon Web Services managed. For more information about the difference, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys">KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1710
1779
|
*/
|
|
1711
1780
|
KeyManager?: KeyManagerType | string;
|
|
1712
1781
|
/**
|
|
1782
|
+
* @public
|
|
1713
1783
|
* @deprecated
|
|
1714
1784
|
*
|
|
1715
1785
|
* <p>Instead, use the <code>KeySpec</code> field.</p>
|
|
@@ -1719,10 +1789,12 @@ export interface KeyMetadata {
|
|
|
1719
1789
|
*/
|
|
1720
1790
|
CustomerMasterKeySpec?: CustomerMasterKeySpec | string;
|
|
1721
1791
|
/**
|
|
1792
|
+
* @public
|
|
1722
1793
|
* <p>Describes the type of key material in the KMS key.</p>
|
|
1723
1794
|
*/
|
|
1724
1795
|
KeySpec?: KeySpec | string;
|
|
1725
1796
|
/**
|
|
1797
|
+
* @public
|
|
1726
1798
|
* <p>The encryption algorithms that the KMS key supports. You cannot use the KMS key with other
|
|
1727
1799
|
* encryption algorithms within KMS.</p>
|
|
1728
1800
|
* <p>This value is present only when the <code>KeyUsage</code> of the KMS key is
|
|
@@ -1730,6 +1802,7 @@ export interface KeyMetadata {
|
|
|
1730
1802
|
*/
|
|
1731
1803
|
EncryptionAlgorithms?: (EncryptionAlgorithmSpec | string)[];
|
|
1732
1804
|
/**
|
|
1805
|
+
* @public
|
|
1733
1806
|
* <p>The signing algorithms that the KMS key supports. You cannot use the KMS key with other
|
|
1734
1807
|
* signing algorithms within KMS.</p>
|
|
1735
1808
|
* <p>This field appears only when the <code>KeyUsage</code> of the KMS key is
|
|
@@ -1737,6 +1810,7 @@ export interface KeyMetadata {
|
|
|
1737
1810
|
*/
|
|
1738
1811
|
SigningAlgorithms?: (SigningAlgorithmSpec | string)[];
|
|
1739
1812
|
/**
|
|
1813
|
+
* @public
|
|
1740
1814
|
* <p>Indicates whether the KMS key is a multi-Region (<code>True</code>) or regional
|
|
1741
1815
|
* (<code>False</code>) key. This value is <code>True</code> for multi-Region primary and
|
|
1742
1816
|
* replica keys and <code>False</code> for regional KMS keys.</p>
|
|
@@ -1744,6 +1818,7 @@ export interface KeyMetadata {
|
|
|
1744
1818
|
*/
|
|
1745
1819
|
MultiRegion?: boolean;
|
|
1746
1820
|
/**
|
|
1821
|
+
* @public
|
|
1747
1822
|
* <p>Lists the primary and replica keys in same multi-Region key. This field is present only
|
|
1748
1823
|
* when the value of the <code>MultiRegion</code> field is <code>True</code>.</p>
|
|
1749
1824
|
* <p>For more information about any listed KMS key, use the <a>DescribeKey</a>
|
|
@@ -1768,6 +1843,7 @@ export interface KeyMetadata {
|
|
|
1768
1843
|
*/
|
|
1769
1844
|
MultiRegionConfiguration?: MultiRegionConfiguration;
|
|
1770
1845
|
/**
|
|
1846
|
+
* @public
|
|
1771
1847
|
* <p>The waiting period before the primary key in a multi-Region key is deleted. This waiting
|
|
1772
1848
|
* period begins when the last of its replica keys is deleted. This value is present only when
|
|
1773
1849
|
* the <code>KeyState</code> of the KMS key is <code>PendingReplicaDeletion</code>. That
|
|
@@ -1783,12 +1859,14 @@ export interface KeyMetadata {
|
|
|
1783
1859
|
*/
|
|
1784
1860
|
PendingDeletionWindowInDays?: number;
|
|
1785
1861
|
/**
|
|
1862
|
+
* @public
|
|
1786
1863
|
* <p>The message authentication code (MAC) algorithm that the HMAC KMS key supports.</p>
|
|
1787
1864
|
* <p>This value is present only when the <code>KeyUsage</code> of the KMS key is
|
|
1788
1865
|
* <code>GENERATE_VERIFY_MAC</code>.</p>
|
|
1789
1866
|
*/
|
|
1790
1867
|
MacAlgorithms?: (MacAlgorithmSpec | string)[];
|
|
1791
1868
|
/**
|
|
1869
|
+
* @public
|
|
1792
1870
|
* <p>Information about the external key that is associated with a KMS key in an external key
|
|
1793
1871
|
* store.</p>
|
|
1794
1872
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key">External key</a> in the
|
|
@@ -1801,6 +1879,7 @@ export interface KeyMetadata {
|
|
|
1801
1879
|
*/
|
|
1802
1880
|
export interface CreateKeyResponse {
|
|
1803
1881
|
/**
|
|
1882
|
+
* @public
|
|
1804
1883
|
* <p>Metadata associated with the KMS key.</p>
|
|
1805
1884
|
*/
|
|
1806
1885
|
KeyMetadata?: KeyMetadata;
|
|
@@ -1914,16 +1993,19 @@ export declare class CustomKeyStoreHasCMKsException extends __BaseException {
|
|
|
1914
1993
|
*/
|
|
1915
1994
|
export interface XksProxyConfigurationType {
|
|
1916
1995
|
/**
|
|
1996
|
+
* @public
|
|
1917
1997
|
* <p>Indicates whether the external key store proxy uses a public endpoint or an Amazon VPC endpoint
|
|
1918
1998
|
* service to communicate with KMS.</p>
|
|
1919
1999
|
*/
|
|
1920
2000
|
Connectivity?: XksProxyConnectivityType | string;
|
|
1921
2001
|
/**
|
|
2002
|
+
* @public
|
|
1922
2003
|
* <p>The part of the external key store <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateCustomKeyStore.html#KMS-CreateCustomKeyStore-request-XksProxyAuthenticationCredential">proxy authentication credential</a> that uniquely identifies the secret access
|
|
1923
2004
|
* key.</p>
|
|
1924
2005
|
*/
|
|
1925
2006
|
AccessKeyId?: string;
|
|
1926
2007
|
/**
|
|
2008
|
+
* @public
|
|
1927
2009
|
* <p>The URI endpoint for the external key store proxy.</p>
|
|
1928
2010
|
* <p>If the external key store proxy has a public endpoint, it is displayed here.</p>
|
|
1929
2011
|
* <p>If the external key store proxy uses an Amazon VPC endpoint service name, this field displays
|
|
@@ -1931,10 +2013,12 @@ export interface XksProxyConfigurationType {
|
|
|
1931
2013
|
*/
|
|
1932
2014
|
UriEndpoint?: string;
|
|
1933
2015
|
/**
|
|
2016
|
+
* @public
|
|
1934
2017
|
* <p>The path to the external key store proxy APIs.</p>
|
|
1935
2018
|
*/
|
|
1936
2019
|
UriPath?: string;
|
|
1937
2020
|
/**
|
|
2021
|
+
* @public
|
|
1938
2022
|
* <p>The Amazon VPC endpoint service used to communicate with the external key store proxy. This
|
|
1939
2023
|
* field appears only when the external key store proxy uses an Amazon VPC endpoint service to
|
|
1940
2024
|
* communicate with KMS.</p>
|
|
@@ -1947,20 +2031,24 @@ export interface XksProxyConfigurationType {
|
|
|
1947
2031
|
*/
|
|
1948
2032
|
export interface CustomKeyStoresListEntry {
|
|
1949
2033
|
/**
|
|
2034
|
+
* @public
|
|
1950
2035
|
* <p>A unique identifier for the custom key store.</p>
|
|
1951
2036
|
*/
|
|
1952
2037
|
CustomKeyStoreId?: string;
|
|
1953
2038
|
/**
|
|
2039
|
+
* @public
|
|
1954
2040
|
* <p>The user-specified friendly name for the custom key store.</p>
|
|
1955
2041
|
*/
|
|
1956
2042
|
CustomKeyStoreName?: string;
|
|
1957
2043
|
/**
|
|
2044
|
+
* @public
|
|
1958
2045
|
* <p>A unique identifier for the CloudHSM cluster that is associated with an CloudHSM key store. This
|
|
1959
2046
|
* field appears only when the <code>CustomKeyStoreType</code> is
|
|
1960
2047
|
* <code>AWS_CLOUDHSM</code>.</p>
|
|
1961
2048
|
*/
|
|
1962
2049
|
CloudHsmClusterId?: string;
|
|
1963
2050
|
/**
|
|
2051
|
+
* @public
|
|
1964
2052
|
* <p>The trust anchor certificate of the CloudHSM cluster associated with an CloudHSM key store. When
|
|
1965
2053
|
* you <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr">initialize
|
|
1966
2054
|
* the cluster</a>, you create this certificate and save it in the
|
|
@@ -1970,6 +2058,7 @@ export interface CustomKeyStoresListEntry {
|
|
|
1970
2058
|
*/
|
|
1971
2059
|
TrustAnchorCertificate?: string;
|
|
1972
2060
|
/**
|
|
2061
|
+
* @public
|
|
1973
2062
|
* <p>Indicates whether the custom key store is connected to its backing key store. For an CloudHSM
|
|
1974
2063
|
* key store, the <code>ConnectionState</code> indicates whether it is connected to its CloudHSM
|
|
1975
2064
|
* cluster. For an external key store, the <code>ConnectionState</code> indicates whether it is
|
|
@@ -1991,6 +2080,7 @@ export interface CustomKeyStoresListEntry {
|
|
|
1991
2080
|
*/
|
|
1992
2081
|
ConnectionState?: ConnectionStateType | string;
|
|
1993
2082
|
/**
|
|
2083
|
+
* @public
|
|
1994
2084
|
* <p>Describes the connection error. This field appears in the response only when the
|
|
1995
2085
|
* <code>ConnectionState</code> is <code>FAILED</code>.</p>
|
|
1996
2086
|
* <p>Many failures can be resolved by updating the properties of the custom key store. To
|
|
@@ -2177,16 +2267,19 @@ export interface CustomKeyStoresListEntry {
|
|
|
2177
2267
|
*/
|
|
2178
2268
|
ConnectionErrorCode?: ConnectionErrorCodeType | string;
|
|
2179
2269
|
/**
|
|
2270
|
+
* @public
|
|
2180
2271
|
* <p>The date and time when the custom key store was created.</p>
|
|
2181
2272
|
*/
|
|
2182
2273
|
CreationDate?: Date;
|
|
2183
2274
|
/**
|
|
2275
|
+
* @public
|
|
2184
2276
|
* <p>Indicates the type of the custom key store. <code>AWS_CLOUDHSM</code> indicates a custom
|
|
2185
2277
|
* key store backed by an CloudHSM cluster. <code>EXTERNAL_KEY_STORE</code> indicates a custom key
|
|
2186
2278
|
* store backed by an external key store proxy and external key manager outside of Amazon Web Services.</p>
|
|
2187
2279
|
*/
|
|
2188
2280
|
CustomKeyStoreType?: CustomKeyStoreType | string;
|
|
2189
2281
|
/**
|
|
2282
|
+
* @public
|
|
2190
2283
|
* <p>Configuration settings for the external key store proxy (XKS proxy). The external key
|
|
2191
2284
|
* store proxy translates KMS requests into a format that your external key manager can
|
|
2192
2285
|
* understand. The proxy configuration includes connection information that KMS
|
|
@@ -2246,12 +2339,14 @@ export type KeyEncryptionMechanism = (typeof KeyEncryptionMechanism)[keyof typeo
|
|
|
2246
2339
|
*/
|
|
2247
2340
|
export interface RecipientInfo {
|
|
2248
2341
|
/**
|
|
2342
|
+
* @public
|
|
2249
2343
|
* <p>The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro
|
|
2250
2344
|
* Enclave to encrypt plaintext values for the response. The only valid value is
|
|
2251
2345
|
* <code>RSAES_OAEP_SHA_256</code>.</p>
|
|
2252
2346
|
*/
|
|
2253
2347
|
KeyEncryptionAlgorithm?: KeyEncryptionMechanism | string;
|
|
2254
2348
|
/**
|
|
2349
|
+
* @public
|
|
2255
2350
|
* <p>The attestation document for an Amazon Web Services Nitro Enclave. This document includes the enclave's
|
|
2256
2351
|
* public key.</p>
|
|
2257
2352
|
*/
|
|
@@ -2262,10 +2357,12 @@ export interface RecipientInfo {
|
|
|
2262
2357
|
*/
|
|
2263
2358
|
export interface DecryptRequest {
|
|
2264
2359
|
/**
|
|
2360
|
+
* @public
|
|
2265
2361
|
* <p>Ciphertext to be decrypted. The blob includes metadata.</p>
|
|
2266
2362
|
*/
|
|
2267
2363
|
CiphertextBlob: Uint8Array | undefined;
|
|
2268
2364
|
/**
|
|
2365
|
+
* @public
|
|
2269
2366
|
* <p>Specifies the encryption context to use when decrypting the data.
|
|
2270
2367
|
* An encryption context is valid only for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.</p>
|
|
2271
2368
|
* <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represent additional authenticated data.
|
|
@@ -2276,12 +2373,14 @@ export interface DecryptRequest {
|
|
|
2276
2373
|
*/
|
|
2277
2374
|
EncryptionContext?: Record<string, string>;
|
|
2278
2375
|
/**
|
|
2376
|
+
* @public
|
|
2279
2377
|
* <p>A list of grant tokens. </p>
|
|
2280
2378
|
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
2281
2379
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2282
2380
|
*/
|
|
2283
2381
|
GrantTokens?: string[];
|
|
2284
2382
|
/**
|
|
2383
|
+
* @public
|
|
2285
2384
|
* <p>Specifies the KMS key that KMS uses to decrypt the ciphertext.</p>
|
|
2286
2385
|
* <p>Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a
|
|
2287
2386
|
* different KMS key, the <code>Decrypt</code> operation throws an
|
|
@@ -2314,6 +2413,7 @@ export interface DecryptRequest {
|
|
|
2314
2413
|
*/
|
|
2315
2414
|
KeyId?: string;
|
|
2316
2415
|
/**
|
|
2416
|
+
* @public
|
|
2317
2417
|
* <p>Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify
|
|
2318
2418
|
* the same algorithm that was used to encrypt the data. If you specify a different algorithm,
|
|
2319
2419
|
* the <code>Decrypt</code> operation fails.</p>
|
|
@@ -2323,6 +2423,7 @@ export interface DecryptRequest {
|
|
|
2323
2423
|
*/
|
|
2324
2424
|
EncryptionAlgorithm?: EncryptionAlgorithmSpec | string;
|
|
2325
2425
|
/**
|
|
2426
|
+
* @public
|
|
2326
2427
|
* <p>A signed <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc">attestation document</a> from
|
|
2327
2428
|
* an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The
|
|
2328
2429
|
* only valid encryption algorithm is <code>RSAES_OAEP_SHA_256</code>. </p>
|
|
@@ -2337,6 +2438,7 @@ export interface DecryptRequest {
|
|
|
2337
2438
|
*/
|
|
2338
2439
|
Recipient?: RecipientInfo;
|
|
2339
2440
|
/**
|
|
2441
|
+
* @public
|
|
2340
2442
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
2341
2443
|
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2342
2444
|
*/
|
|
@@ -2347,20 +2449,24 @@ export interface DecryptRequest {
|
|
|
2347
2449
|
*/
|
|
2348
2450
|
export interface DecryptResponse {
|
|
2349
2451
|
/**
|
|
2452
|
+
* @public
|
|
2350
2453
|
* <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>
|
|
2351
2454
|
*/
|
|
2352
2455
|
KeyId?: string;
|
|
2353
2456
|
/**
|
|
2457
|
+
* @public
|
|
2354
2458
|
* <p>Decrypted plaintext 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>
|
|
2355
2459
|
* <p>If the response includes the <code>CiphertextForRecipient</code> field, the
|
|
2356
2460
|
* <code>Plaintext</code> field is null or empty.</p>
|
|
2357
2461
|
*/
|
|
2358
2462
|
Plaintext?: Uint8Array;
|
|
2359
2463
|
/**
|
|
2464
|
+
* @public
|
|
2360
2465
|
* <p>The encryption algorithm that was used to decrypt the ciphertext.</p>
|
|
2361
2466
|
*/
|
|
2362
2467
|
EncryptionAlgorithm?: EncryptionAlgorithmSpec | string;
|
|
2363
2468
|
/**
|
|
2469
|
+
* @public
|
|
2364
2470
|
* <p>The plaintext data encrypted with the public key in the attestation document. </p>
|
|
2365
2471
|
* <p>This field is included in the response only when the <code>Recipient</code> parameter in
|
|
2366
2472
|
* the request includes a valid attestation document from an Amazon Web Services Nitro enclave.
|
|
@@ -2448,6 +2554,7 @@ export declare class KeyUnavailableException extends __BaseException {
|
|
|
2448
2554
|
*/
|
|
2449
2555
|
export interface DeleteAliasRequest {
|
|
2450
2556
|
/**
|
|
2557
|
+
* @public
|
|
2451
2558
|
* <p>The alias to be deleted. The alias name must begin with <code>alias/</code> followed by
|
|
2452
2559
|
* the alias name, such as <code>alias/ExampleAlias</code>.</p>
|
|
2453
2560
|
*/
|
|
@@ -2458,6 +2565,7 @@ export interface DeleteAliasRequest {
|
|
|
2458
2565
|
*/
|
|
2459
2566
|
export interface DeleteCustomKeyStoreRequest {
|
|
2460
2567
|
/**
|
|
2568
|
+
* @public
|
|
2461
2569
|
* <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>
|
|
2462
2570
|
*/
|
|
2463
2571
|
CustomKeyStoreId: string | undefined;
|
|
@@ -2472,6 +2580,7 @@ export interface DeleteCustomKeyStoreResponse {
|
|
|
2472
2580
|
*/
|
|
2473
2581
|
export interface DeleteImportedKeyMaterialRequest {
|
|
2474
2582
|
/**
|
|
2583
|
+
* @public
|
|
2475
2584
|
* <p>Identifies the KMS key from which you are deleting imported key material. The
|
|
2476
2585
|
* <code>Origin</code> of the KMS key must be <code>EXTERNAL</code>.</p>
|
|
2477
2586
|
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
@@ -2495,6 +2604,7 @@ export interface DeleteImportedKeyMaterialRequest {
|
|
|
2495
2604
|
*/
|
|
2496
2605
|
export interface DescribeCustomKeyStoresRequest {
|
|
2497
2606
|
/**
|
|
2607
|
+
* @public
|
|
2498
2608
|
* <p>Gets only information about the specified custom key store. Enter the key store ID.</p>
|
|
2499
2609
|
* <p>By default, this operation gets information about all custom key stores in the account and
|
|
2500
2610
|
* Region. To limit the output to a particular custom key store, provide either the
|
|
@@ -2503,6 +2613,7 @@ export interface DescribeCustomKeyStoresRequest {
|
|
|
2503
2613
|
*/
|
|
2504
2614
|
CustomKeyStoreId?: string;
|
|
2505
2615
|
/**
|
|
2616
|
+
* @public
|
|
2506
2617
|
* <p>Gets only information about the specified custom key store. Enter the friendly name of the
|
|
2507
2618
|
* custom key store.</p>
|
|
2508
2619
|
* <p>By default, this operation gets information about all custom key stores in the account and
|
|
@@ -2512,12 +2623,14 @@ export interface DescribeCustomKeyStoresRequest {
|
|
|
2512
2623
|
*/
|
|
2513
2624
|
CustomKeyStoreName?: string;
|
|
2514
2625
|
/**
|
|
2626
|
+
* @public
|
|
2515
2627
|
* <p>Use this parameter to specify the maximum number of items to return. When this
|
|
2516
2628
|
* value is present, KMS does not return more than the specified number of items, but it might
|
|
2517
2629
|
* return fewer.</p>
|
|
2518
2630
|
*/
|
|
2519
2631
|
Limit?: number;
|
|
2520
2632
|
/**
|
|
2633
|
+
* @public
|
|
2521
2634
|
* <p>Use this parameter in a subsequent request after you receive a response with
|
|
2522
2635
|
* truncated results. Set it to the value of <code>NextMarker</code> from the truncated response
|
|
2523
2636
|
* you just received.</p>
|
|
@@ -2529,15 +2642,18 @@ export interface DescribeCustomKeyStoresRequest {
|
|
|
2529
2642
|
*/
|
|
2530
2643
|
export interface DescribeCustomKeyStoresResponse {
|
|
2531
2644
|
/**
|
|
2645
|
+
* @public
|
|
2532
2646
|
* <p>Contains metadata about each custom key store.</p>
|
|
2533
2647
|
*/
|
|
2534
2648
|
CustomKeyStores?: CustomKeyStoresListEntry[];
|
|
2535
2649
|
/**
|
|
2650
|
+
* @public
|
|
2536
2651
|
* <p>When <code>Truncated</code> is true, this element is present and contains the
|
|
2537
2652
|
* value to use for the <code>Marker</code> parameter in a subsequent request.</p>
|
|
2538
2653
|
*/
|
|
2539
2654
|
NextMarker?: string;
|
|
2540
2655
|
/**
|
|
2656
|
+
* @public
|
|
2541
2657
|
* <p>A flag that indicates whether there are more items in the list. When this
|
|
2542
2658
|
* value is true, the list in this response is truncated. To get more items, pass the value of
|
|
2543
2659
|
* the <code>NextMarker</code> element in thisresponse to the <code>Marker</code> parameter in a
|
|
@@ -2563,6 +2679,7 @@ export declare class InvalidMarkerException extends __BaseException {
|
|
|
2563
2679
|
*/
|
|
2564
2680
|
export interface DescribeKeyRequest {
|
|
2565
2681
|
/**
|
|
2682
|
+
* @public
|
|
2566
2683
|
* <p>Describes the specified KMS key. </p>
|
|
2567
2684
|
* <p>If you specify a predefined Amazon Web Services alias (an Amazon Web Services alias with no key ID), KMS associates
|
|
2568
2685
|
* the alias with an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html##aws-managed-cmk">Amazon Web Services managed key</a> and returns its
|
|
@@ -2591,6 +2708,7 @@ export interface DescribeKeyRequest {
|
|
|
2591
2708
|
*/
|
|
2592
2709
|
KeyId: string | undefined;
|
|
2593
2710
|
/**
|
|
2711
|
+
* @public
|
|
2594
2712
|
* <p>A list of grant tokens.</p>
|
|
2595
2713
|
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
2596
2714
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
@@ -2602,6 +2720,7 @@ export interface DescribeKeyRequest {
|
|
|
2602
2720
|
*/
|
|
2603
2721
|
export interface DescribeKeyResponse {
|
|
2604
2722
|
/**
|
|
2723
|
+
* @public
|
|
2605
2724
|
* <p>Metadata associated with the key.</p>
|
|
2606
2725
|
*/
|
|
2607
2726
|
KeyMetadata?: KeyMetadata;
|
|
@@ -2611,6 +2730,7 @@ export interface DescribeKeyResponse {
|
|
|
2611
2730
|
*/
|
|
2612
2731
|
export interface DisableKeyRequest {
|
|
2613
2732
|
/**
|
|
2733
|
+
* @public
|
|
2614
2734
|
* <p>Identifies the KMS key to disable.</p>
|
|
2615
2735
|
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
2616
2736
|
* <p>For example:</p>
|
|
@@ -2633,6 +2753,7 @@ export interface DisableKeyRequest {
|
|
|
2633
2753
|
*/
|
|
2634
2754
|
export interface DisableKeyRotationRequest {
|
|
2635
2755
|
/**
|
|
2756
|
+
* @public
|
|
2636
2757
|
* <p>Identifies a symmetric encryption KMS key. You cannot enable or disable automatic rotation
|
|
2637
2758
|
* of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html#asymmetric-cmks">asymmetric KMS keys</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html">HMAC
|
|
2638
2759
|
* 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
|
|
@@ -2658,6 +2779,7 @@ export interface DisableKeyRotationRequest {
|
|
|
2658
2779
|
*/
|
|
2659
2780
|
export interface DisconnectCustomKeyStoreRequest {
|
|
2660
2781
|
/**
|
|
2782
|
+
* @public
|
|
2661
2783
|
* <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>
|
|
2662
2784
|
*/
|
|
2663
2785
|
CustomKeyStoreId: string | undefined;
|
|
@@ -2672,6 +2794,7 @@ export interface DisconnectCustomKeyStoreResponse {
|
|
|
2672
2794
|
*/
|
|
2673
2795
|
export interface EnableKeyRequest {
|
|
2674
2796
|
/**
|
|
2797
|
+
* @public
|
|
2675
2798
|
* <p>Identifies the KMS key to enable.</p>
|
|
2676
2799
|
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
2677
2800
|
* <p>For example:</p>
|
|
@@ -2694,6 +2817,7 @@ export interface EnableKeyRequest {
|
|
|
2694
2817
|
*/
|
|
2695
2818
|
export interface EnableKeyRotationRequest {
|
|
2696
2819
|
/**
|
|
2820
|
+
* @public
|
|
2697
2821
|
* <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>
|
|
2698
2822
|
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
2699
2823
|
* <p>For example:</p>
|
|
@@ -2716,6 +2840,7 @@ export interface EnableKeyRotationRequest {
|
|
|
2716
2840
|
*/
|
|
2717
2841
|
export interface EncryptRequest {
|
|
2718
2842
|
/**
|
|
2843
|
+
* @public
|
|
2719
2844
|
* <p>Identifies the KMS key to use in the encryption operation. The KMS key must have a
|
|
2720
2845
|
* <code>KeyUsage</code> of <code>ENCRYPT_DECRYPT</code>. To find the <code>KeyUsage</code> of
|
|
2721
2846
|
* a KMS key, use the <a>DescribeKey</a> operation.</p>
|
|
@@ -2743,10 +2868,12 @@ export interface EncryptRequest {
|
|
|
2743
2868
|
*/
|
|
2744
2869
|
KeyId: string | undefined;
|
|
2745
2870
|
/**
|
|
2871
|
+
* @public
|
|
2746
2872
|
* <p>Data to be encrypted.</p>
|
|
2747
2873
|
*/
|
|
2748
2874
|
Plaintext: Uint8Array | undefined;
|
|
2749
2875
|
/**
|
|
2876
|
+
* @public
|
|
2750
2877
|
* <p>Specifies the encryption context that will be used to encrypt the data.
|
|
2751
2878
|
* An encryption context is valid only for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context. </p>
|
|
2752
2879
|
* <important>
|
|
@@ -2760,12 +2887,14 @@ export interface EncryptRequest {
|
|
|
2760
2887
|
*/
|
|
2761
2888
|
EncryptionContext?: Record<string, string>;
|
|
2762
2889
|
/**
|
|
2890
|
+
* @public
|
|
2763
2891
|
* <p>A list of grant tokens.</p>
|
|
2764
2892
|
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
2765
2893
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2766
2894
|
*/
|
|
2767
2895
|
GrantTokens?: string[];
|
|
2768
2896
|
/**
|
|
2897
|
+
* @public
|
|
2769
2898
|
* <p>Specifies the encryption algorithm that KMS will use to encrypt the plaintext message.
|
|
2770
2899
|
* The algorithm must be compatible with the KMS key that you specify.</p>
|
|
2771
2900
|
* <p>This parameter is required only for asymmetric KMS keys. The default value,
|
|
@@ -2775,6 +2904,7 @@ export interface EncryptRequest {
|
|
|
2775
2904
|
*/
|
|
2776
2905
|
EncryptionAlgorithm?: EncryptionAlgorithmSpec | string;
|
|
2777
2906
|
/**
|
|
2907
|
+
* @public
|
|
2778
2908
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
2779
2909
|
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2780
2910
|
*/
|
|
@@ -2785,14 +2915,17 @@ export interface EncryptRequest {
|
|
|
2785
2915
|
*/
|
|
2786
2916
|
export interface EncryptResponse {
|
|
2787
2917
|
/**
|
|
2918
|
+
* @public
|
|
2788
2919
|
* <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>
|
|
2789
2920
|
*/
|
|
2790
2921
|
CiphertextBlob?: Uint8Array;
|
|
2791
2922
|
/**
|
|
2923
|
+
* @public
|
|
2792
2924
|
* <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 encrypt the plaintext.</p>
|
|
2793
2925
|
*/
|
|
2794
2926
|
KeyId?: string;
|
|
2795
2927
|
/**
|
|
2928
|
+
* @public
|
|
2796
2929
|
* <p>The encryption algorithm that was used to encrypt the plaintext.</p>
|
|
2797
2930
|
*/
|
|
2798
2931
|
EncryptionAlgorithm?: EncryptionAlgorithmSpec | string;
|
|
@@ -2815,6 +2948,7 @@ export declare class ExpiredImportTokenException extends __BaseException {
|
|
|
2815
2948
|
*/
|
|
2816
2949
|
export interface GenerateDataKeyRequest {
|
|
2817
2950
|
/**
|
|
2951
|
+
* @public
|
|
2818
2952
|
* <p>Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify
|
|
2819
2953
|
* an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your
|
|
2820
2954
|
* KMS key, use the <a>DescribeKey</a> operation.</p>
|
|
@@ -2842,6 +2976,7 @@ export interface GenerateDataKeyRequest {
|
|
|
2842
2976
|
*/
|
|
2843
2977
|
KeyId: string | undefined;
|
|
2844
2978
|
/**
|
|
2979
|
+
* @public
|
|
2845
2980
|
* <p>Specifies the encryption context that will be used when encrypting the data key.</p>
|
|
2846
2981
|
* <important>
|
|
2847
2982
|
* <p>Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p>
|
|
@@ -2854,6 +2989,7 @@ export interface GenerateDataKeyRequest {
|
|
|
2854
2989
|
*/
|
|
2855
2990
|
EncryptionContext?: Record<string, string>;
|
|
2856
2991
|
/**
|
|
2992
|
+
* @public
|
|
2857
2993
|
* <p>Specifies the length of the data key in bytes. For example, use the value 64 to generate a
|
|
2858
2994
|
* 512-bit data key (64 bytes is 512 bits). For 128-bit (16-byte) and 256-bit (32-byte) data
|
|
2859
2995
|
* keys, use the <code>KeySpec</code> parameter.</p>
|
|
@@ -2862,6 +2998,7 @@ export interface GenerateDataKeyRequest {
|
|
|
2862
2998
|
*/
|
|
2863
2999
|
NumberOfBytes?: number;
|
|
2864
3000
|
/**
|
|
3001
|
+
* @public
|
|
2865
3002
|
* <p>Specifies the length of the data key. Use <code>AES_128</code> to generate a 128-bit
|
|
2866
3003
|
* symmetric key, or <code>AES_256</code> to generate a 256-bit symmetric key.</p>
|
|
2867
3004
|
* <p>You must specify either the <code>KeySpec</code> or the <code>NumberOfBytes</code>
|
|
@@ -2869,12 +3006,14 @@ export interface GenerateDataKeyRequest {
|
|
|
2869
3006
|
*/
|
|
2870
3007
|
KeySpec?: DataKeySpec | string;
|
|
2871
3008
|
/**
|
|
3009
|
+
* @public
|
|
2872
3010
|
* <p>A list of grant tokens.</p>
|
|
2873
3011
|
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
2874
3012
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2875
3013
|
*/
|
|
2876
3014
|
GrantTokens?: string[];
|
|
2877
3015
|
/**
|
|
3016
|
+
* @public
|
|
2878
3017
|
* <p>A signed <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc">attestation document</a> from
|
|
2879
3018
|
* an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The
|
|
2880
3019
|
* only valid encryption algorithm is <code>RSAES_OAEP_SHA_256</code>. </p>
|
|
@@ -2891,6 +3030,7 @@ export interface GenerateDataKeyRequest {
|
|
|
2891
3030
|
*/
|
|
2892
3031
|
Recipient?: RecipientInfo;
|
|
2893
3032
|
/**
|
|
3033
|
+
* @public
|
|
2894
3034
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
2895
3035
|
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2896
3036
|
*/
|
|
@@ -2901,10 +3041,12 @@ export interface GenerateDataKeyRequest {
|
|
|
2901
3041
|
*/
|
|
2902
3042
|
export interface GenerateDataKeyResponse {
|
|
2903
3043
|
/**
|
|
3044
|
+
* @public
|
|
2904
3045
|
* <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>
|
|
2905
3046
|
*/
|
|
2906
3047
|
CiphertextBlob?: Uint8Array;
|
|
2907
3048
|
/**
|
|
3049
|
+
* @public
|
|
2908
3050
|
* <p>The plaintext 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. Use this data key to encrypt your data outside of
|
|
2909
3051
|
* KMS. Then, remove it from memory as soon as possible.</p>
|
|
2910
3052
|
* <p>If the response includes the <code>CiphertextForRecipient</code> field, the
|
|
@@ -2912,10 +3054,12 @@ export interface GenerateDataKeyResponse {
|
|
|
2912
3054
|
*/
|
|
2913
3055
|
Plaintext?: Uint8Array;
|
|
2914
3056
|
/**
|
|
3057
|
+
* @public
|
|
2915
3058
|
* <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 encrypted the data key.</p>
|
|
2916
3059
|
*/
|
|
2917
3060
|
KeyId?: string;
|
|
2918
3061
|
/**
|
|
3062
|
+
* @public
|
|
2919
3063
|
* <p>The plaintext data key encrypted with the public key from the Nitro enclave. This
|
|
2920
3064
|
* ciphertext can be decrypted only by using a private key in the Nitro enclave. </p>
|
|
2921
3065
|
* <p>This field is included in the response only when the <code>Recipient</code> parameter in
|
|
@@ -2929,6 +3073,7 @@ export interface GenerateDataKeyResponse {
|
|
|
2929
3073
|
*/
|
|
2930
3074
|
export interface GenerateDataKeyPairRequest {
|
|
2931
3075
|
/**
|
|
3076
|
+
* @public
|
|
2932
3077
|
* <p>Specifies the encryption context that will be used when encrypting the private key in the
|
|
2933
3078
|
* data key pair.</p>
|
|
2934
3079
|
* <important>
|
|
@@ -2942,6 +3087,7 @@ export interface GenerateDataKeyPairRequest {
|
|
|
2942
3087
|
*/
|
|
2943
3088
|
EncryptionContext?: Record<string, string>;
|
|
2944
3089
|
/**
|
|
3090
|
+
* @public
|
|
2945
3091
|
* <p>Specifies the symmetric encryption KMS key that encrypts the private key in the data key
|
|
2946
3092
|
* pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the
|
|
2947
3093
|
* type and origin of your KMS key, use the <a>DescribeKey</a> operation.</p>
|
|
@@ -2969,17 +3115,20 @@ export interface GenerateDataKeyPairRequest {
|
|
|
2969
3115
|
*/
|
|
2970
3116
|
KeyId: string | undefined;
|
|
2971
3117
|
/**
|
|
3118
|
+
* @public
|
|
2972
3119
|
* <p>Determines the type of data key pair that is generated. </p>
|
|
2973
3120
|
* <p>The KMS rule that restricts the use of asymmetric RSA and SM2 KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS. The SM2 key spec is only available in China Regions.</p>
|
|
2974
3121
|
*/
|
|
2975
3122
|
KeyPairSpec: DataKeyPairSpec | string | undefined;
|
|
2976
3123
|
/**
|
|
3124
|
+
* @public
|
|
2977
3125
|
* <p>A list of grant tokens.</p>
|
|
2978
3126
|
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
2979
3127
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2980
3128
|
*/
|
|
2981
3129
|
GrantTokens?: string[];
|
|
2982
3130
|
/**
|
|
3131
|
+
* @public
|
|
2983
3132
|
* <p>A signed <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc">attestation document</a> from
|
|
2984
3133
|
* an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The
|
|
2985
3134
|
* only valid encryption algorithm is <code>RSAES_OAEP_SHA_256</code>. </p>
|
|
@@ -2996,6 +3145,7 @@ export interface GenerateDataKeyPairRequest {
|
|
|
2996
3145
|
*/
|
|
2997
3146
|
Recipient?: RecipientInfo;
|
|
2998
3147
|
/**
|
|
3148
|
+
* @public
|
|
2999
3149
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
3000
3150
|
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3001
3151
|
*/
|
|
@@ -3006,28 +3156,34 @@ export interface GenerateDataKeyPairRequest {
|
|
|
3006
3156
|
*/
|
|
3007
3157
|
export interface GenerateDataKeyPairResponse {
|
|
3008
3158
|
/**
|
|
3159
|
+
* @public
|
|
3009
3160
|
* <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>
|
|
3010
3161
|
*/
|
|
3011
3162
|
PrivateKeyCiphertextBlob?: Uint8Array;
|
|
3012
3163
|
/**
|
|
3164
|
+
* @public
|
|
3013
3165
|
* <p>The plaintext 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>
|
|
3014
3166
|
* <p>If the response includes the <code>CiphertextForRecipient</code> field, the
|
|
3015
3167
|
* <code>PrivateKeyPlaintext</code> field is null or empty.</p>
|
|
3016
3168
|
*/
|
|
3017
3169
|
PrivateKeyPlaintext?: Uint8Array;
|
|
3018
3170
|
/**
|
|
3171
|
+
* @public
|
|
3019
3172
|
* <p>The public key (in 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>
|
|
3020
3173
|
*/
|
|
3021
3174
|
PublicKey?: Uint8Array;
|
|
3022
3175
|
/**
|
|
3176
|
+
* @public
|
|
3023
3177
|
* <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 encrypted the private key.</p>
|
|
3024
3178
|
*/
|
|
3025
3179
|
KeyId?: string;
|
|
3026
3180
|
/**
|
|
3181
|
+
* @public
|
|
3027
3182
|
* <p>The type of data key pair that was generated.</p>
|
|
3028
3183
|
*/
|
|
3029
3184
|
KeyPairSpec?: DataKeyPairSpec | string;
|
|
3030
3185
|
/**
|
|
3186
|
+
* @public
|
|
3031
3187
|
* <p>The plaintext private data key encrypted with the public key from the Nitro enclave. This
|
|
3032
3188
|
* ciphertext can be decrypted only by using a private key in the Nitro enclave. </p>
|
|
3033
3189
|
* <p>This field is included in the response only when the <code>Recipient</code> parameter in
|
|
@@ -3041,6 +3197,7 @@ export interface GenerateDataKeyPairResponse {
|
|
|
3041
3197
|
*/
|
|
3042
3198
|
export interface GenerateDataKeyPairWithoutPlaintextRequest {
|
|
3043
3199
|
/**
|
|
3200
|
+
* @public
|
|
3044
3201
|
* <p>Specifies the encryption context that will be used when encrypting the private key in the
|
|
3045
3202
|
* data key pair.</p>
|
|
3046
3203
|
* <important>
|
|
@@ -3054,6 +3211,7 @@ export interface GenerateDataKeyPairWithoutPlaintextRequest {
|
|
|
3054
3211
|
*/
|
|
3055
3212
|
EncryptionContext?: Record<string, string>;
|
|
3056
3213
|
/**
|
|
3214
|
+
* @public
|
|
3057
3215
|
* <p>Specifies the symmetric encryption KMS key that encrypts the private key in the data key
|
|
3058
3216
|
* pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the
|
|
3059
3217
|
* type and origin of your KMS key, use the <a>DescribeKey</a> operation. </p>
|
|
@@ -3081,17 +3239,20 @@ export interface GenerateDataKeyPairWithoutPlaintextRequest {
|
|
|
3081
3239
|
*/
|
|
3082
3240
|
KeyId: string | undefined;
|
|
3083
3241
|
/**
|
|
3242
|
+
* @public
|
|
3084
3243
|
* <p>Determines the type of data key pair that is generated.</p>
|
|
3085
3244
|
* <p>The KMS rule that restricts the use of asymmetric RSA and SM2 KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS. The SM2 key spec is only available in China Regions.</p>
|
|
3086
3245
|
*/
|
|
3087
3246
|
KeyPairSpec: DataKeyPairSpec | string | undefined;
|
|
3088
3247
|
/**
|
|
3248
|
+
* @public
|
|
3089
3249
|
* <p>A list of grant tokens.</p>
|
|
3090
3250
|
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
3091
3251
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
3092
3252
|
*/
|
|
3093
3253
|
GrantTokens?: string[];
|
|
3094
3254
|
/**
|
|
3255
|
+
* @public
|
|
3095
3256
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
3096
3257
|
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3097
3258
|
*/
|
|
@@ -3102,18 +3263,22 @@ export interface GenerateDataKeyPairWithoutPlaintextRequest {
|
|
|
3102
3263
|
*/
|
|
3103
3264
|
export interface GenerateDataKeyPairWithoutPlaintextResponse {
|
|
3104
3265
|
/**
|
|
3266
|
+
* @public
|
|
3105
3267
|
* <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>
|
|
3106
3268
|
*/
|
|
3107
3269
|
PrivateKeyCiphertextBlob?: Uint8Array;
|
|
3108
3270
|
/**
|
|
3271
|
+
* @public
|
|
3109
3272
|
* <p>The public key (in 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>
|
|
3110
3273
|
*/
|
|
3111
3274
|
PublicKey?: Uint8Array;
|
|
3112
3275
|
/**
|
|
3276
|
+
* @public
|
|
3113
3277
|
* <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 encrypted the private key.</p>
|
|
3114
3278
|
*/
|
|
3115
3279
|
KeyId?: string;
|
|
3116
3280
|
/**
|
|
3281
|
+
* @public
|
|
3117
3282
|
* <p>The type of data key pair that was generated.</p>
|
|
3118
3283
|
*/
|
|
3119
3284
|
KeyPairSpec?: DataKeyPairSpec | string;
|
|
@@ -3123,6 +3288,7 @@ export interface GenerateDataKeyPairWithoutPlaintextResponse {
|
|
|
3123
3288
|
*/
|
|
3124
3289
|
export interface GenerateDataKeyWithoutPlaintextRequest {
|
|
3125
3290
|
/**
|
|
3291
|
+
* @public
|
|
3126
3292
|
* <p>Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify
|
|
3127
3293
|
* an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your
|
|
3128
3294
|
* KMS key, use the <a>DescribeKey</a> operation.</p>
|
|
@@ -3150,6 +3316,7 @@ export interface GenerateDataKeyWithoutPlaintextRequest {
|
|
|
3150
3316
|
*/
|
|
3151
3317
|
KeyId: string | undefined;
|
|
3152
3318
|
/**
|
|
3319
|
+
* @public
|
|
3153
3320
|
* <p>Specifies the encryption context that will be used when encrypting the data key.</p>
|
|
3154
3321
|
* <important>
|
|
3155
3322
|
* <p>Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p>
|
|
@@ -3162,23 +3329,27 @@ export interface GenerateDataKeyWithoutPlaintextRequest {
|
|
|
3162
3329
|
*/
|
|
3163
3330
|
EncryptionContext?: Record<string, string>;
|
|
3164
3331
|
/**
|
|
3332
|
+
* @public
|
|
3165
3333
|
* <p>The length of the data key. Use <code>AES_128</code> to generate a 128-bit symmetric key,
|
|
3166
3334
|
* or <code>AES_256</code> to generate a 256-bit symmetric key.</p>
|
|
3167
3335
|
*/
|
|
3168
3336
|
KeySpec?: DataKeySpec | string;
|
|
3169
3337
|
/**
|
|
3338
|
+
* @public
|
|
3170
3339
|
* <p>The length of the data key in bytes. For example, use the value 64 to generate a 512-bit
|
|
3171
3340
|
* data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys),
|
|
3172
3341
|
* we recommend that you use the <code>KeySpec</code> field instead of this one.</p>
|
|
3173
3342
|
*/
|
|
3174
3343
|
NumberOfBytes?: number;
|
|
3175
3344
|
/**
|
|
3345
|
+
* @public
|
|
3176
3346
|
* <p>A list of grant tokens.</p>
|
|
3177
3347
|
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
3178
3348
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
3179
3349
|
*/
|
|
3180
3350
|
GrantTokens?: string[];
|
|
3181
3351
|
/**
|
|
3352
|
+
* @public
|
|
3182
3353
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
3183
3354
|
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3184
3355
|
*/
|
|
@@ -3189,10 +3360,12 @@ export interface GenerateDataKeyWithoutPlaintextRequest {
|
|
|
3189
3360
|
*/
|
|
3190
3361
|
export interface GenerateDataKeyWithoutPlaintextResponse {
|
|
3191
3362
|
/**
|
|
3363
|
+
* @public
|
|
3192
3364
|
* <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>
|
|
3193
3365
|
*/
|
|
3194
3366
|
CiphertextBlob?: Uint8Array;
|
|
3195
3367
|
/**
|
|
3368
|
+
* @public
|
|
3196
3369
|
* <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 encrypted the data key.</p>
|
|
3197
3370
|
*/
|
|
3198
3371
|
KeyId?: string;
|
|
@@ -3202,6 +3375,7 @@ export interface GenerateDataKeyWithoutPlaintextResponse {
|
|
|
3202
3375
|
*/
|
|
3203
3376
|
export interface GenerateMacRequest {
|
|
3204
3377
|
/**
|
|
3378
|
+
* @public
|
|
3205
3379
|
* <p>The message to be hashed. Specify a message of up to 4,096 bytes. </p>
|
|
3206
3380
|
* <p>
|
|
3207
3381
|
* <code>GenerateMac</code> and <a>VerifyMac</a> do not provide special handling
|
|
@@ -3210,6 +3384,7 @@ export interface GenerateMacRequest {
|
|
|
3210
3384
|
*/
|
|
3211
3385
|
Message: Uint8Array | undefined;
|
|
3212
3386
|
/**
|
|
3387
|
+
* @public
|
|
3213
3388
|
* <p>The HMAC KMS key to use in the operation. The MAC algorithm computes the HMAC for the
|
|
3214
3389
|
* message and the key as described in <a href="https://datatracker.ietf.org/doc/html/rfc2104">RFC 2104</a>.</p>
|
|
3215
3390
|
* <p>To identify an HMAC KMS key, use the <a>DescribeKey</a> operation and see the
|
|
@@ -3217,6 +3392,7 @@ export interface GenerateMacRequest {
|
|
|
3217
3392
|
*/
|
|
3218
3393
|
KeyId: string | undefined;
|
|
3219
3394
|
/**
|
|
3395
|
+
* @public
|
|
3220
3396
|
* <p>The MAC algorithm used in the operation.</p>
|
|
3221
3397
|
* <p> The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC
|
|
3222
3398
|
* algorithms that your HMAC KMS key supports, use the <a>DescribeKey</a> operation
|
|
@@ -3224,12 +3400,14 @@ export interface GenerateMacRequest {
|
|
|
3224
3400
|
*/
|
|
3225
3401
|
MacAlgorithm: MacAlgorithmSpec | string | undefined;
|
|
3226
3402
|
/**
|
|
3403
|
+
* @public
|
|
3227
3404
|
* <p>A list of grant tokens.</p>
|
|
3228
3405
|
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
3229
3406
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
3230
3407
|
*/
|
|
3231
3408
|
GrantTokens?: string[];
|
|
3232
3409
|
/**
|
|
3410
|
+
* @public
|
|
3233
3411
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
3234
3412
|
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3235
3413
|
*/
|
|
@@ -3240,16 +3418,19 @@ export interface GenerateMacRequest {
|
|
|
3240
3418
|
*/
|
|
3241
3419
|
export interface GenerateMacResponse {
|
|
3242
3420
|
/**
|
|
3421
|
+
* @public
|
|
3243
3422
|
* <p>The hash-based message authentication code (HMAC) that was generated for the specified
|
|
3244
3423
|
* message, HMAC KMS key, and MAC algorithm.</p>
|
|
3245
3424
|
* <p>This is the standard, raw HMAC defined in <a href="https://datatracker.ietf.org/doc/html/rfc2104">RFC 2104</a>.</p>
|
|
3246
3425
|
*/
|
|
3247
3426
|
Mac?: Uint8Array;
|
|
3248
3427
|
/**
|
|
3428
|
+
* @public
|
|
3249
3429
|
* <p>The MAC algorithm that was used to generate the HMAC.</p>
|
|
3250
3430
|
*/
|
|
3251
3431
|
MacAlgorithm?: MacAlgorithmSpec | string;
|
|
3252
3432
|
/**
|
|
3433
|
+
* @public
|
|
3253
3434
|
* <p>The HMAC KMS key used in the operation.</p>
|
|
3254
3435
|
*/
|
|
3255
3436
|
KeyId?: string;
|
|
@@ -3259,10 +3440,12 @@ export interface GenerateMacResponse {
|
|
|
3259
3440
|
*/
|
|
3260
3441
|
export interface GenerateRandomRequest {
|
|
3261
3442
|
/**
|
|
3443
|
+
* @public
|
|
3262
3444
|
* <p>The length of the random byte string. This parameter is required.</p>
|
|
3263
3445
|
*/
|
|
3264
3446
|
NumberOfBytes?: number;
|
|
3265
3447
|
/**
|
|
3448
|
+
* @public
|
|
3266
3449
|
* <p>Generates the random byte string in the CloudHSM cluster that is associated with the
|
|
3267
3450
|
* specified CloudHSM key store. To find the ID of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p>
|
|
3268
3451
|
* <p>External key store IDs are not valid for this parameter. If you specify the ID of an
|
|
@@ -3271,6 +3454,7 @@ export interface GenerateRandomRequest {
|
|
|
3271
3454
|
*/
|
|
3272
3455
|
CustomKeyStoreId?: string;
|
|
3273
3456
|
/**
|
|
3457
|
+
* @public
|
|
3274
3458
|
* <p>A signed <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc">attestation document</a> from
|
|
3275
3459
|
* an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The
|
|
3276
3460
|
* only valid encryption algorithm is <code>RSAES_OAEP_SHA_256</code>. </p>
|
|
@@ -3290,12 +3474,14 @@ export interface GenerateRandomRequest {
|
|
|
3290
3474
|
*/
|
|
3291
3475
|
export interface GenerateRandomResponse {
|
|
3292
3476
|
/**
|
|
3477
|
+
* @public
|
|
3293
3478
|
* <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>
|
|
3294
3479
|
* <p>If the response includes the <code>CiphertextForRecipient</code> field, the
|
|
3295
3480
|
* <code>Plaintext</code> field is null or empty.</p>
|
|
3296
3481
|
*/
|
|
3297
3482
|
Plaintext?: Uint8Array;
|
|
3298
3483
|
/**
|
|
3484
|
+
* @public
|
|
3299
3485
|
* <p>The plaintext random bytes encrypted with the public key from the Nitro enclave. This
|
|
3300
3486
|
* ciphertext can be decrypted only by using a private key in the Nitro enclave. </p>
|
|
3301
3487
|
* <p>This field is included in the response only when the <code>Recipient</code> parameter in
|
|
@@ -3309,6 +3495,7 @@ export interface GenerateRandomResponse {
|
|
|
3309
3495
|
*/
|
|
3310
3496
|
export interface GetKeyPolicyRequest {
|
|
3311
3497
|
/**
|
|
3498
|
+
* @public
|
|
3312
3499
|
* <p>Gets the key policy for the specified KMS key.</p>
|
|
3313
3500
|
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
3314
3501
|
* <p>For example:</p>
|
|
@@ -3326,6 +3513,7 @@ export interface GetKeyPolicyRequest {
|
|
|
3326
3513
|
*/
|
|
3327
3514
|
KeyId: string | undefined;
|
|
3328
3515
|
/**
|
|
3516
|
+
* @public
|
|
3329
3517
|
* <p>Specifies the name of the key policy. The only valid name is <code>default</code>. To get
|
|
3330
3518
|
* the names of key policies, use <a>ListKeyPolicies</a>.</p>
|
|
3331
3519
|
*/
|
|
@@ -3336,6 +3524,7 @@ export interface GetKeyPolicyRequest {
|
|
|
3336
3524
|
*/
|
|
3337
3525
|
export interface GetKeyPolicyResponse {
|
|
3338
3526
|
/**
|
|
3527
|
+
* @public
|
|
3339
3528
|
* <p>A key policy document in JSON format.</p>
|
|
3340
3529
|
*/
|
|
3341
3530
|
Policy?: string;
|
|
@@ -3345,6 +3534,7 @@ export interface GetKeyPolicyResponse {
|
|
|
3345
3534
|
*/
|
|
3346
3535
|
export interface GetKeyRotationStatusRequest {
|
|
3347
3536
|
/**
|
|
3537
|
+
* @public
|
|
3348
3538
|
* <p>Gets the rotation status for the specified KMS key.</p>
|
|
3349
3539
|
* <p>Specify the key ID or key ARN of the KMS key. To specify a KMS key in a
|
|
3350
3540
|
* different Amazon Web Services account, you must use the key ARN.</p>
|
|
@@ -3368,6 +3558,7 @@ export interface GetKeyRotationStatusRequest {
|
|
|
3368
3558
|
*/
|
|
3369
3559
|
export interface GetKeyRotationStatusResponse {
|
|
3370
3560
|
/**
|
|
3561
|
+
* @public
|
|
3371
3562
|
* <p>A Boolean value that specifies whether key rotation is enabled.</p>
|
|
3372
3563
|
*/
|
|
3373
3564
|
KeyRotationEnabled?: boolean;
|
|
@@ -3390,6 +3581,7 @@ export type WrappingKeySpec = (typeof WrappingKeySpec)[keyof typeof WrappingKeyS
|
|
|
3390
3581
|
*/
|
|
3391
3582
|
export interface GetParametersForImportRequest {
|
|
3392
3583
|
/**
|
|
3584
|
+
* @public
|
|
3393
3585
|
* <p>The identifier of the KMS key that will be associated with the imported key material. The
|
|
3394
3586
|
* <code>Origin</code> of the KMS key must be <code>EXTERNAL</code>.</p>
|
|
3395
3587
|
* <p>All KMS key types are supported, including multi-Region keys. However, you cannot import
|
|
@@ -3410,6 +3602,7 @@ export interface GetParametersForImportRequest {
|
|
|
3410
3602
|
*/
|
|
3411
3603
|
KeyId: string | undefined;
|
|
3412
3604
|
/**
|
|
3605
|
+
* @public
|
|
3413
3606
|
* <p>The algorithm you will use with the RSA public key (<code>PublicKey</code>) in the
|
|
3414
3607
|
* response to protect your key material during import. For more information, see <a href="kms/latest/developerguide/importing-keys-get-public-key-and-token.html#select-wrapping-algorithm">Select a wrapping algorithm</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3415
3608
|
* <p>For RSA_AES wrapping algorithms, you encrypt your key material with an AES key that you
|
|
@@ -3451,6 +3644,7 @@ export interface GetParametersForImportRequest {
|
|
|
3451
3644
|
*/
|
|
3452
3645
|
WrappingAlgorithm: AlgorithmSpec | string | undefined;
|
|
3453
3646
|
/**
|
|
3647
|
+
* @public
|
|
3454
3648
|
* <p>The type of RSA public key to return in the response. You will use this wrapping key with
|
|
3455
3649
|
* the specified wrapping algorithm to protect your key material during import. </p>
|
|
3456
3650
|
* <p>Use the longest RSA wrapping key that is practical. </p>
|
|
@@ -3464,20 +3658,24 @@ export interface GetParametersForImportRequest {
|
|
|
3464
3658
|
*/
|
|
3465
3659
|
export interface GetParametersForImportResponse {
|
|
3466
3660
|
/**
|
|
3661
|
+
* @public
|
|
3467
3662
|
* <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>
|
|
3468
3663
|
* request.</p>
|
|
3469
3664
|
*/
|
|
3470
3665
|
KeyId?: string;
|
|
3471
3666
|
/**
|
|
3667
|
+
* @public
|
|
3472
3668
|
* <p>The import token to send in a subsequent <a>ImportKeyMaterial</a>
|
|
3473
3669
|
* request.</p>
|
|
3474
3670
|
*/
|
|
3475
3671
|
ImportToken?: Uint8Array;
|
|
3476
3672
|
/**
|
|
3673
|
+
* @public
|
|
3477
3674
|
* <p>The public key to use to encrypt the key material before importing it with <a>ImportKeyMaterial</a>.</p>
|
|
3478
3675
|
*/
|
|
3479
3676
|
PublicKey?: Uint8Array;
|
|
3480
3677
|
/**
|
|
3678
|
+
* @public
|
|
3481
3679
|
* <p>The time at which the import token and public key are no longer valid. After this time,
|
|
3482
3680
|
* you cannot use them to make an <a>ImportKeyMaterial</a> request and you must send
|
|
3483
3681
|
* another <code>GetParametersForImport</code> request to get new ones.</p>
|
|
@@ -3489,6 +3687,7 @@ export interface GetParametersForImportResponse {
|
|
|
3489
3687
|
*/
|
|
3490
3688
|
export interface GetPublicKeyRequest {
|
|
3491
3689
|
/**
|
|
3690
|
+
* @public
|
|
3492
3691
|
* <p>Identifies the asymmetric KMS key that includes the public key.</p>
|
|
3493
3692
|
* <p>To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.</p>
|
|
3494
3693
|
* <p>For example:</p>
|
|
@@ -3514,6 +3713,7 @@ export interface GetPublicKeyRequest {
|
|
|
3514
3713
|
*/
|
|
3515
3714
|
KeyId: string | undefined;
|
|
3516
3715
|
/**
|
|
3716
|
+
* @public
|
|
3517
3717
|
* <p>A list of grant tokens.</p>
|
|
3518
3718
|
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
3519
3719
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
@@ -3525,11 +3725,13 @@ export interface GetPublicKeyRequest {
|
|
|
3525
3725
|
*/
|
|
3526
3726
|
export interface GetPublicKeyResponse {
|
|
3527
3727
|
/**
|
|
3728
|
+
* @public
|
|
3528
3729
|
* <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
|
|
3529
3730
|
* downloaded.</p>
|
|
3530
3731
|
*/
|
|
3531
3732
|
KeyId?: string;
|
|
3532
3733
|
/**
|
|
3734
|
+
* @public
|
|
3533
3735
|
* <p>The exported public key. </p>
|
|
3534
3736
|
* <p>The value is a DER-encoded X.509 public key, also known as
|
|
3535
3737
|
* <code>SubjectPublicKeyInfo</code> (SPKI), as defined in <a href="https://tools.ietf.org/html/rfc5280">RFC 5280</a>. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
|
|
@@ -3537,6 +3739,7 @@ export interface GetPublicKeyResponse {
|
|
|
3537
3739
|
*/
|
|
3538
3740
|
PublicKey?: Uint8Array;
|
|
3539
3741
|
/**
|
|
3742
|
+
* @public
|
|
3540
3743
|
* @deprecated
|
|
3541
3744
|
*
|
|
3542
3745
|
* <p>Instead, use the <code>KeySpec</code> field in the <code>GetPublicKey</code>
|
|
@@ -3547,10 +3750,12 @@ export interface GetPublicKeyResponse {
|
|
|
3547
3750
|
*/
|
|
3548
3751
|
CustomerMasterKeySpec?: CustomerMasterKeySpec | string;
|
|
3549
3752
|
/**
|
|
3753
|
+
* @public
|
|
3550
3754
|
* <p>The type of the of the public key that was downloaded.</p>
|
|
3551
3755
|
*/
|
|
3552
3756
|
KeySpec?: KeySpec | string;
|
|
3553
3757
|
/**
|
|
3758
|
+
* @public
|
|
3554
3759
|
* <p>The permitted use of the public key. Valid values are <code>ENCRYPT_DECRYPT</code> or
|
|
3555
3760
|
* <code>SIGN_VERIFY</code>. </p>
|
|
3556
3761
|
* <p>This information is critical. If a public key with <code>SIGN_VERIFY</code> key usage
|
|
@@ -3558,6 +3763,7 @@ export interface GetPublicKeyResponse {
|
|
|
3558
3763
|
*/
|
|
3559
3764
|
KeyUsage?: KeyUsageType | string;
|
|
3560
3765
|
/**
|
|
3766
|
+
* @public
|
|
3561
3767
|
* <p>The encryption algorithms that KMS supports for this key. </p>
|
|
3562
3768
|
* <p>This information is critical. If a public key encrypts data outside of KMS by using an
|
|
3563
3769
|
* unsupported encryption algorithm, the ciphertext cannot be decrypted. </p>
|
|
@@ -3566,6 +3772,7 @@ export interface GetPublicKeyResponse {
|
|
|
3566
3772
|
*/
|
|
3567
3773
|
EncryptionAlgorithms?: (EncryptionAlgorithmSpec | string)[];
|
|
3568
3774
|
/**
|
|
3775
|
+
* @public
|
|
3569
3776
|
* <p>The signing algorithms that KMS supports for this key.</p>
|
|
3570
3777
|
* <p>This field appears in the response only when the <code>KeyUsage</code> of the public key
|
|
3571
3778
|
* is <code>SIGN_VERIFY</code>.</p>
|
|
@@ -3578,22 +3785,27 @@ export interface GetPublicKeyResponse {
|
|
|
3578
3785
|
*/
|
|
3579
3786
|
export interface GrantListEntry {
|
|
3580
3787
|
/**
|
|
3788
|
+
* @public
|
|
3581
3789
|
* <p>The unique identifier for the KMS key to which the grant applies.</p>
|
|
3582
3790
|
*/
|
|
3583
3791
|
KeyId?: string;
|
|
3584
3792
|
/**
|
|
3793
|
+
* @public
|
|
3585
3794
|
* <p>The unique identifier for the grant.</p>
|
|
3586
3795
|
*/
|
|
3587
3796
|
GrantId?: string;
|
|
3588
3797
|
/**
|
|
3798
|
+
* @public
|
|
3589
3799
|
* <p>The friendly name that identifies the grant. If a name was provided in the <a>CreateGrant</a> request, that name is returned. Otherwise this value is null.</p>
|
|
3590
3800
|
*/
|
|
3591
3801
|
Name?: string;
|
|
3592
3802
|
/**
|
|
3803
|
+
* @public
|
|
3593
3804
|
* <p>The date and time when the grant was created.</p>
|
|
3594
3805
|
*/
|
|
3595
3806
|
CreationDate?: Date;
|
|
3596
3807
|
/**
|
|
3808
|
+
* @public
|
|
3597
3809
|
* <p>The identity that gets the permissions in the grant.</p>
|
|
3598
3810
|
* <p>The <code>GranteePrincipal</code> field in the <code>ListGrants</code> response usually contains the
|
|
3599
3811
|
* user or role designated as the grantee principal in the grant. However, when the grantee
|
|
@@ -3603,18 +3815,22 @@ export interface GrantListEntry {
|
|
|
3603
3815
|
*/
|
|
3604
3816
|
GranteePrincipal?: string;
|
|
3605
3817
|
/**
|
|
3818
|
+
* @public
|
|
3606
3819
|
* <p>The principal that can retire the grant.</p>
|
|
3607
3820
|
*/
|
|
3608
3821
|
RetiringPrincipal?: string;
|
|
3609
3822
|
/**
|
|
3823
|
+
* @public
|
|
3610
3824
|
* <p>The Amazon Web Services account under which the grant was issued.</p>
|
|
3611
3825
|
*/
|
|
3612
3826
|
IssuingAccount?: string;
|
|
3613
3827
|
/**
|
|
3828
|
+
* @public
|
|
3614
3829
|
* <p>The list of operations permitted by the grant.</p>
|
|
3615
3830
|
*/
|
|
3616
3831
|
Operations?: (GrantOperation | string)[];
|
|
3617
3832
|
/**
|
|
3833
|
+
* @public
|
|
3618
3834
|
* <p>A list of key-value pairs that must be present in the encryption context of certain
|
|
3619
3835
|
* subsequent operations that the grant allows.</p>
|
|
3620
3836
|
*/
|
|
@@ -3625,6 +3841,7 @@ export interface GrantListEntry {
|
|
|
3625
3841
|
*/
|
|
3626
3842
|
export interface ImportKeyMaterialRequest {
|
|
3627
3843
|
/**
|
|
3844
|
+
* @public
|
|
3628
3845
|
* <p>The identifier of the KMS key that will be associated with the imported key material. This
|
|
3629
3846
|
* must be the same KMS key specified in the <code>KeyID</code> parameter of the corresponding
|
|
3630
3847
|
* <a>GetParametersForImport</a> request. The <code>Origin</code> of the KMS key
|
|
@@ -3650,17 +3867,20 @@ export interface ImportKeyMaterialRequest {
|
|
|
3650
3867
|
*/
|
|
3651
3868
|
KeyId: string | undefined;
|
|
3652
3869
|
/**
|
|
3870
|
+
* @public
|
|
3653
3871
|
* <p>The import token that you received in the response to a previous <a>GetParametersForImport</a> request. It must be from the same response that contained
|
|
3654
3872
|
* the public key that you used to encrypt the key material.</p>
|
|
3655
3873
|
*/
|
|
3656
3874
|
ImportToken: Uint8Array | undefined;
|
|
3657
3875
|
/**
|
|
3876
|
+
* @public
|
|
3658
3877
|
* <p>The encrypted key material to import. The key material must be encrypted under the public
|
|
3659
3878
|
* wrapping key that <a>GetParametersForImport</a> returned, using the wrapping
|
|
3660
3879
|
* algorithm that you specified in the same <code>GetParametersForImport</code> request.</p>
|
|
3661
3880
|
*/
|
|
3662
3881
|
EncryptedKeyMaterial: Uint8Array | undefined;
|
|
3663
3882
|
/**
|
|
3883
|
+
* @public
|
|
3664
3884
|
* <p>The date and time when the imported key material expires. This parameter is required when
|
|
3665
3885
|
* the value of the <code>ExpirationModel</code> parameter is <code>KEY_MATERIAL_EXPIRES</code>.
|
|
3666
3886
|
* Otherwise it is not valid.</p>
|
|
@@ -3674,6 +3894,7 @@ export interface ImportKeyMaterialRequest {
|
|
|
3674
3894
|
*/
|
|
3675
3895
|
ValidTo?: Date;
|
|
3676
3896
|
/**
|
|
3897
|
+
* @public
|
|
3677
3898
|
* <p>Specifies whether the key material expires. The default is
|
|
3678
3899
|
* <code>KEY_MATERIAL_EXPIRES</code>. For help with this choice, see <a href="https://docs.aws.amazon.com/en_us/kms/latest/developerguide/importing-keys.html#importing-keys-expiration">Setting an expiration time</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3679
3900
|
* <p>When the value of <code>ExpirationModel</code> is <code>KEY_MATERIAL_EXPIRES</code>, you
|
|
@@ -3735,10 +3956,12 @@ export declare class InvalidGrantIdException extends __BaseException {
|
|
|
3735
3956
|
*/
|
|
3736
3957
|
export interface KeyListEntry {
|
|
3737
3958
|
/**
|
|
3959
|
+
* @public
|
|
3738
3960
|
* <p>Unique identifier of the key.</p>
|
|
3739
3961
|
*/
|
|
3740
3962
|
KeyId?: string;
|
|
3741
3963
|
/**
|
|
3964
|
+
* @public
|
|
3742
3965
|
* <p>ARN of the key.</p>
|
|
3743
3966
|
*/
|
|
3744
3967
|
KeyArn?: string;
|
|
@@ -3776,6 +3999,7 @@ export declare class KMSInvalidSignatureException extends __BaseException {
|
|
|
3776
3999
|
*/
|
|
3777
4000
|
export interface ListAliasesRequest {
|
|
3778
4001
|
/**
|
|
4002
|
+
* @public
|
|
3779
4003
|
* <p>Lists only aliases that are associated with the specified KMS key. Enter a KMS key in your
|
|
3780
4004
|
* Amazon Web Services account. </p>
|
|
3781
4005
|
* <p>This parameter is optional. If you omit it, <code>ListAliases</code> returns all aliases
|
|
@@ -3796,6 +4020,7 @@ export interface ListAliasesRequest {
|
|
|
3796
4020
|
*/
|
|
3797
4021
|
KeyId?: string;
|
|
3798
4022
|
/**
|
|
4023
|
+
* @public
|
|
3799
4024
|
* <p>Use this parameter to specify the maximum number of items to return. When this
|
|
3800
4025
|
* value is present, KMS does not return more than the specified number of items, but it might
|
|
3801
4026
|
* return fewer.</p>
|
|
@@ -3804,6 +4029,7 @@ export interface ListAliasesRequest {
|
|
|
3804
4029
|
*/
|
|
3805
4030
|
Limit?: number;
|
|
3806
4031
|
/**
|
|
4032
|
+
* @public
|
|
3807
4033
|
* <p>Use this parameter in a subsequent request after you receive a response with
|
|
3808
4034
|
* truncated results. Set it to the value of <code>NextMarker</code> from the truncated response
|
|
3809
4035
|
* you just received.</p>
|
|
@@ -3815,15 +4041,18 @@ export interface ListAliasesRequest {
|
|
|
3815
4041
|
*/
|
|
3816
4042
|
export interface ListAliasesResponse {
|
|
3817
4043
|
/**
|
|
4044
|
+
* @public
|
|
3818
4045
|
* <p>A list of aliases.</p>
|
|
3819
4046
|
*/
|
|
3820
4047
|
Aliases?: AliasListEntry[];
|
|
3821
4048
|
/**
|
|
4049
|
+
* @public
|
|
3822
4050
|
* <p>When <code>Truncated</code> is true, this element is present and contains the
|
|
3823
4051
|
* value to use for the <code>Marker</code> parameter in a subsequent request.</p>
|
|
3824
4052
|
*/
|
|
3825
4053
|
NextMarker?: string;
|
|
3826
4054
|
/**
|
|
4055
|
+
* @public
|
|
3827
4056
|
* <p>A flag that indicates whether there are more items in the list. When this
|
|
3828
4057
|
* value is true, the list in this response is truncated. To get more items, pass the value of
|
|
3829
4058
|
* the <code>NextMarker</code> element in thisresponse to the <code>Marker</code> parameter in a
|
|
@@ -3836,6 +4065,7 @@ export interface ListAliasesResponse {
|
|
|
3836
4065
|
*/
|
|
3837
4066
|
export interface ListGrantsRequest {
|
|
3838
4067
|
/**
|
|
4068
|
+
* @public
|
|
3839
4069
|
* <p>Use this parameter to specify the maximum number of items to return. When this
|
|
3840
4070
|
* value is present, KMS does not return more than the specified number of items, but it might
|
|
3841
4071
|
* return fewer.</p>
|
|
@@ -3844,12 +4074,14 @@ export interface ListGrantsRequest {
|
|
|
3844
4074
|
*/
|
|
3845
4075
|
Limit?: number;
|
|
3846
4076
|
/**
|
|
4077
|
+
* @public
|
|
3847
4078
|
* <p>Use this parameter in a subsequent request after you receive a response with
|
|
3848
4079
|
* truncated results. Set it to the value of <code>NextMarker</code> from the truncated response
|
|
3849
4080
|
* you just received.</p>
|
|
3850
4081
|
*/
|
|
3851
4082
|
Marker?: string;
|
|
3852
4083
|
/**
|
|
4084
|
+
* @public
|
|
3853
4085
|
* <p>Returns only grants for the specified KMS key. This parameter is required.</p>
|
|
3854
4086
|
* <p>Specify the key ID or key ARN of the KMS key. To specify a KMS key in a
|
|
3855
4087
|
* different Amazon Web Services account, you must use the key ARN.</p>
|
|
@@ -3868,11 +4100,13 @@ export interface ListGrantsRequest {
|
|
|
3868
4100
|
*/
|
|
3869
4101
|
KeyId: string | undefined;
|
|
3870
4102
|
/**
|
|
4103
|
+
* @public
|
|
3871
4104
|
* <p>Returns only the grant with the specified grant ID. The grant ID uniquely identifies the
|
|
3872
4105
|
* grant. </p>
|
|
3873
4106
|
*/
|
|
3874
4107
|
GrantId?: string;
|
|
3875
4108
|
/**
|
|
4109
|
+
* @public
|
|
3876
4110
|
* <p>Returns only grants where the specified principal is the grantee principal for the
|
|
3877
4111
|
* grant.</p>
|
|
3878
4112
|
*/
|
|
@@ -3883,15 +4117,18 @@ export interface ListGrantsRequest {
|
|
|
3883
4117
|
*/
|
|
3884
4118
|
export interface ListGrantsResponse {
|
|
3885
4119
|
/**
|
|
4120
|
+
* @public
|
|
3886
4121
|
* <p>A list of grants.</p>
|
|
3887
4122
|
*/
|
|
3888
4123
|
Grants?: GrantListEntry[];
|
|
3889
4124
|
/**
|
|
4125
|
+
* @public
|
|
3890
4126
|
* <p>When <code>Truncated</code> is true, this element is present and contains the
|
|
3891
4127
|
* value to use for the <code>Marker</code> parameter in a subsequent request.</p>
|
|
3892
4128
|
*/
|
|
3893
4129
|
NextMarker?: string;
|
|
3894
4130
|
/**
|
|
4131
|
+
* @public
|
|
3895
4132
|
* <p>A flag that indicates whether there are more items in the list. When this
|
|
3896
4133
|
* value is true, the list in this response is truncated. To get more items, pass the value of
|
|
3897
4134
|
* the <code>NextMarker</code> element in thisresponse to the <code>Marker</code> parameter in a
|
|
@@ -3904,6 +4141,7 @@ export interface ListGrantsResponse {
|
|
|
3904
4141
|
*/
|
|
3905
4142
|
export interface ListKeyPoliciesRequest {
|
|
3906
4143
|
/**
|
|
4144
|
+
* @public
|
|
3907
4145
|
* <p>Gets the names of key policies for the specified KMS key.</p>
|
|
3908
4146
|
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
3909
4147
|
* <p>For example:</p>
|
|
@@ -3921,6 +4159,7 @@ export interface ListKeyPoliciesRequest {
|
|
|
3921
4159
|
*/
|
|
3922
4160
|
KeyId: string | undefined;
|
|
3923
4161
|
/**
|
|
4162
|
+
* @public
|
|
3924
4163
|
* <p>Use this parameter to specify the maximum number of items to return. When this
|
|
3925
4164
|
* value is present, KMS does not return more than the specified number of items, but it might
|
|
3926
4165
|
* return fewer.</p>
|
|
@@ -3930,6 +4169,7 @@ export interface ListKeyPoliciesRequest {
|
|
|
3930
4169
|
*/
|
|
3931
4170
|
Limit?: number;
|
|
3932
4171
|
/**
|
|
4172
|
+
* @public
|
|
3933
4173
|
* <p>Use this parameter in a subsequent request after you receive a response with
|
|
3934
4174
|
* truncated results. Set it to the value of <code>NextMarker</code> from the truncated response
|
|
3935
4175
|
* you just received.</p>
|
|
@@ -3941,15 +4181,18 @@ export interface ListKeyPoliciesRequest {
|
|
|
3941
4181
|
*/
|
|
3942
4182
|
export interface ListKeyPoliciesResponse {
|
|
3943
4183
|
/**
|
|
4184
|
+
* @public
|
|
3944
4185
|
* <p>A list of key policy names. The only valid value is <code>default</code>.</p>
|
|
3945
4186
|
*/
|
|
3946
4187
|
PolicyNames?: string[];
|
|
3947
4188
|
/**
|
|
4189
|
+
* @public
|
|
3948
4190
|
* <p>When <code>Truncated</code> is true, this element is present and contains the
|
|
3949
4191
|
* value to use for the <code>Marker</code> parameter in a subsequent request.</p>
|
|
3950
4192
|
*/
|
|
3951
4193
|
NextMarker?: string;
|
|
3952
4194
|
/**
|
|
4195
|
+
* @public
|
|
3953
4196
|
* <p>A flag that indicates whether there are more items in the list. When this
|
|
3954
4197
|
* value is true, the list in this response is truncated. To get more items, pass the value of
|
|
3955
4198
|
* the <code>NextMarker</code> element in thisresponse to the <code>Marker</code> parameter in a
|
|
@@ -3962,6 +4205,7 @@ export interface ListKeyPoliciesResponse {
|
|
|
3962
4205
|
*/
|
|
3963
4206
|
export interface ListKeysRequest {
|
|
3964
4207
|
/**
|
|
4208
|
+
* @public
|
|
3965
4209
|
* <p>Use this parameter to specify the maximum number of items to return. When this
|
|
3966
4210
|
* value is present, KMS does not return more than the specified number of items, but it might
|
|
3967
4211
|
* return fewer.</p>
|
|
@@ -3970,6 +4214,7 @@ export interface ListKeysRequest {
|
|
|
3970
4214
|
*/
|
|
3971
4215
|
Limit?: number;
|
|
3972
4216
|
/**
|
|
4217
|
+
* @public
|
|
3973
4218
|
* <p>Use this parameter in a subsequent request after you receive a response with
|
|
3974
4219
|
* truncated results. Set it to the value of <code>NextMarker</code> from the truncated response
|
|
3975
4220
|
* you just received.</p>
|
|
@@ -3981,15 +4226,18 @@ export interface ListKeysRequest {
|
|
|
3981
4226
|
*/
|
|
3982
4227
|
export interface ListKeysResponse {
|
|
3983
4228
|
/**
|
|
4229
|
+
* @public
|
|
3984
4230
|
* <p>A list of KMS keys.</p>
|
|
3985
4231
|
*/
|
|
3986
4232
|
Keys?: KeyListEntry[];
|
|
3987
4233
|
/**
|
|
4234
|
+
* @public
|
|
3988
4235
|
* <p>When <code>Truncated</code> is true, this element is present and contains the
|
|
3989
4236
|
* value to use for the <code>Marker</code> parameter in a subsequent request.</p>
|
|
3990
4237
|
*/
|
|
3991
4238
|
NextMarker?: string;
|
|
3992
4239
|
/**
|
|
4240
|
+
* @public
|
|
3993
4241
|
* <p>A flag that indicates whether there are more items in the list. When this
|
|
3994
4242
|
* value is true, the list in this response is truncated. To get more items, pass the value of
|
|
3995
4243
|
* the <code>NextMarker</code> element in thisresponse to the <code>Marker</code> parameter in a
|
|
@@ -4002,6 +4250,7 @@ export interface ListKeysResponse {
|
|
|
4002
4250
|
*/
|
|
4003
4251
|
export interface ListResourceTagsRequest {
|
|
4004
4252
|
/**
|
|
4253
|
+
* @public
|
|
4005
4254
|
* <p>Gets tags on the specified KMS key.</p>
|
|
4006
4255
|
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
4007
4256
|
* <p>For example:</p>
|
|
@@ -4019,6 +4268,7 @@ export interface ListResourceTagsRequest {
|
|
|
4019
4268
|
*/
|
|
4020
4269
|
KeyId: string | undefined;
|
|
4021
4270
|
/**
|
|
4271
|
+
* @public
|
|
4022
4272
|
* <p>Use this parameter to specify the maximum number of items to return. When this
|
|
4023
4273
|
* value is present, KMS does not return more than the specified number of items, but it might
|
|
4024
4274
|
* return fewer.</p>
|
|
@@ -4027,6 +4277,7 @@ export interface ListResourceTagsRequest {
|
|
|
4027
4277
|
*/
|
|
4028
4278
|
Limit?: number;
|
|
4029
4279
|
/**
|
|
4280
|
+
* @public
|
|
4030
4281
|
* <p>Use this parameter in a subsequent request after you receive a response with
|
|
4031
4282
|
* truncated results. Set it to the value of <code>NextMarker</code> from the truncated response
|
|
4032
4283
|
* you just received.</p>
|
|
@@ -4040,6 +4291,7 @@ export interface ListResourceTagsRequest {
|
|
|
4040
4291
|
*/
|
|
4041
4292
|
export interface ListResourceTagsResponse {
|
|
4042
4293
|
/**
|
|
4294
|
+
* @public
|
|
4043
4295
|
* <p>A list of tags. Each tag consists of a tag key and a tag value.</p>
|
|
4044
4296
|
* <note>
|
|
4045
4297
|
* <p>Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">ABAC for KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
@@ -4047,12 +4299,14 @@ export interface ListResourceTagsResponse {
|
|
|
4047
4299
|
*/
|
|
4048
4300
|
Tags?: Tag[];
|
|
4049
4301
|
/**
|
|
4302
|
+
* @public
|
|
4050
4303
|
* <p>When <code>Truncated</code> is true, this element is present and contains the
|
|
4051
4304
|
* value to use for the <code>Marker</code> parameter in a subsequent request.</p>
|
|
4052
4305
|
* <p>Do not assume or infer any information from this value.</p>
|
|
4053
4306
|
*/
|
|
4054
4307
|
NextMarker?: string;
|
|
4055
4308
|
/**
|
|
4309
|
+
* @public
|
|
4056
4310
|
* <p>A flag that indicates whether there are more items in the list. When this
|
|
4057
4311
|
* value is true, the list in this response is truncated. To get more items, pass the value of
|
|
4058
4312
|
* the <code>NextMarker</code> element in thisresponse to the <code>Marker</code> parameter in a
|
|
@@ -4065,6 +4319,7 @@ export interface ListResourceTagsResponse {
|
|
|
4065
4319
|
*/
|
|
4066
4320
|
export interface ListRetirableGrantsRequest {
|
|
4067
4321
|
/**
|
|
4322
|
+
* @public
|
|
4068
4323
|
* <p>Use this parameter to specify the maximum number of items to return. When this
|
|
4069
4324
|
* value is present, KMS does not return more than the specified number of items, but it might
|
|
4070
4325
|
* return fewer.</p>
|
|
@@ -4073,12 +4328,14 @@ export interface ListRetirableGrantsRequest {
|
|
|
4073
4328
|
*/
|
|
4074
4329
|
Limit?: number;
|
|
4075
4330
|
/**
|
|
4331
|
+
* @public
|
|
4076
4332
|
* <p>Use this parameter in a subsequent request after you receive a response with
|
|
4077
4333
|
* truncated results. Set it to the value of <code>NextMarker</code> from the truncated response
|
|
4078
4334
|
* you just received.</p>
|
|
4079
4335
|
*/
|
|
4080
4336
|
Marker?: string;
|
|
4081
4337
|
/**
|
|
4338
|
+
* @public
|
|
4082
4339
|
* <p>The retiring principal for which to list grants. Enter a principal in your
|
|
4083
4340
|
* Amazon Web Services account.</p>
|
|
4084
4341
|
* <p>To specify the retiring principal, use the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of an
|
|
@@ -4107,6 +4364,7 @@ export type MessageType = (typeof MessageType)[keyof typeof MessageType];
|
|
|
4107
4364
|
*/
|
|
4108
4365
|
export interface PutKeyPolicyRequest {
|
|
4109
4366
|
/**
|
|
4367
|
+
* @public
|
|
4110
4368
|
* <p>Sets the key policy on the specified KMS key.</p>
|
|
4111
4369
|
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
4112
4370
|
* <p>For example:</p>
|
|
@@ -4124,10 +4382,12 @@ export interface PutKeyPolicyRequest {
|
|
|
4124
4382
|
*/
|
|
4125
4383
|
KeyId: string | undefined;
|
|
4126
4384
|
/**
|
|
4385
|
+
* @public
|
|
4127
4386
|
* <p>The name of the key policy. The only valid value is <code>default</code>.</p>
|
|
4128
4387
|
*/
|
|
4129
4388
|
PolicyName: string | undefined;
|
|
4130
4389
|
/**
|
|
4390
|
+
* @public
|
|
4131
4391
|
* <p>The key policy to attach to the KMS key.</p>
|
|
4132
4392
|
* <p>The key policy must meet the following criteria:</p>
|
|
4133
4393
|
* <ul>
|
|
@@ -4165,6 +4425,7 @@ export interface PutKeyPolicyRequest {
|
|
|
4165
4425
|
*/
|
|
4166
4426
|
Policy: string | undefined;
|
|
4167
4427
|
/**
|
|
4428
|
+
* @public
|
|
4168
4429
|
* <p>Skips ("bypasses") the key policy lockout safety check. The default value is false.</p>
|
|
4169
4430
|
* <important>
|
|
4170
4431
|
* <p>Setting this value to true increases the risk that the KMS key becomes unmanageable. Do
|
|
@@ -4181,10 +4442,12 @@ export interface PutKeyPolicyRequest {
|
|
|
4181
4442
|
*/
|
|
4182
4443
|
export interface ReEncryptRequest {
|
|
4183
4444
|
/**
|
|
4445
|
+
* @public
|
|
4184
4446
|
* <p>Ciphertext of the data to reencrypt.</p>
|
|
4185
4447
|
*/
|
|
4186
4448
|
CiphertextBlob: Uint8Array | undefined;
|
|
4187
4449
|
/**
|
|
4450
|
+
* @public
|
|
4188
4451
|
* <p>Specifies the encryption context to use to decrypt the ciphertext. Enter the same
|
|
4189
4452
|
* encryption context that was used to encrypt the ciphertext.</p>
|
|
4190
4453
|
* <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represent additional authenticated data.
|
|
@@ -4195,6 +4458,7 @@ export interface ReEncryptRequest {
|
|
|
4195
4458
|
*/
|
|
4196
4459
|
SourceEncryptionContext?: Record<string, string>;
|
|
4197
4460
|
/**
|
|
4461
|
+
* @public
|
|
4198
4462
|
* <p>Specifies the KMS key that KMS will use to decrypt the ciphertext before it is
|
|
4199
4463
|
* re-encrypted.</p>
|
|
4200
4464
|
* <p>Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a
|
|
@@ -4228,6 +4492,7 @@ export interface ReEncryptRequest {
|
|
|
4228
4492
|
*/
|
|
4229
4493
|
SourceKeyId?: string;
|
|
4230
4494
|
/**
|
|
4495
|
+
* @public
|
|
4231
4496
|
* <p>A unique identifier for the KMS key that is used to reencrypt the data. Specify a
|
|
4232
4497
|
* symmetric encryption KMS key or an asymmetric KMS key with a <code>KeyUsage</code> value of
|
|
4233
4498
|
* <code>ENCRYPT_DECRYPT</code>. To find the <code>KeyUsage</code> value of a KMS key, use the
|
|
@@ -4256,6 +4521,7 @@ export interface ReEncryptRequest {
|
|
|
4256
4521
|
*/
|
|
4257
4522
|
DestinationKeyId: string | undefined;
|
|
4258
4523
|
/**
|
|
4524
|
+
* @public
|
|
4259
4525
|
* <p>Specifies that encryption context to use when the reencrypting the data.</p>
|
|
4260
4526
|
* <important>
|
|
4261
4527
|
* <p>Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p>
|
|
@@ -4271,6 +4537,7 @@ export interface ReEncryptRequest {
|
|
|
4271
4537
|
*/
|
|
4272
4538
|
DestinationEncryptionContext?: Record<string, string>;
|
|
4273
4539
|
/**
|
|
4540
|
+
* @public
|
|
4274
4541
|
* <p>Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it
|
|
4275
4542
|
* is reencrypted. The default value, <code>SYMMETRIC_DEFAULT</code>, represents the algorithm
|
|
4276
4543
|
* used for symmetric encryption KMS keys.</p>
|
|
@@ -4281,6 +4548,7 @@ export interface ReEncryptRequest {
|
|
|
4281
4548
|
*/
|
|
4282
4549
|
SourceEncryptionAlgorithm?: EncryptionAlgorithmSpec | string;
|
|
4283
4550
|
/**
|
|
4551
|
+
* @public
|
|
4284
4552
|
* <p>Specifies the encryption algorithm that KMS will use to reecrypt the data after it has
|
|
4285
4553
|
* decrypted it. The default value, <code>SYMMETRIC_DEFAULT</code>, represents the encryption
|
|
4286
4554
|
* algorithm used for symmetric encryption KMS keys.</p>
|
|
@@ -4289,12 +4557,14 @@ export interface ReEncryptRequest {
|
|
|
4289
4557
|
*/
|
|
4290
4558
|
DestinationEncryptionAlgorithm?: EncryptionAlgorithmSpec | string;
|
|
4291
4559
|
/**
|
|
4560
|
+
* @public
|
|
4292
4561
|
* <p>A list of grant tokens.</p>
|
|
4293
4562
|
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
4294
4563
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
4295
4564
|
*/
|
|
4296
4565
|
GrantTokens?: string[];
|
|
4297
4566
|
/**
|
|
4567
|
+
* @public
|
|
4298
4568
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
4299
4569
|
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
4300
4570
|
*/
|
|
@@ -4305,23 +4575,28 @@ export interface ReEncryptRequest {
|
|
|
4305
4575
|
*/
|
|
4306
4576
|
export interface ReEncryptResponse {
|
|
4307
4577
|
/**
|
|
4578
|
+
* @public
|
|
4308
4579
|
* <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>
|
|
4309
4580
|
*/
|
|
4310
4581
|
CiphertextBlob?: Uint8Array;
|
|
4311
4582
|
/**
|
|
4583
|
+
* @public
|
|
4312
4584
|
* <p>Unique identifier of the KMS key used to originally encrypt the data.</p>
|
|
4313
4585
|
*/
|
|
4314
4586
|
SourceKeyId?: string;
|
|
4315
4587
|
/**
|
|
4588
|
+
* @public
|
|
4316
4589
|
* <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 reencrypt the data.</p>
|
|
4317
4590
|
*/
|
|
4318
4591
|
KeyId?: string;
|
|
4319
4592
|
/**
|
|
4593
|
+
* @public
|
|
4320
4594
|
* <p>The encryption algorithm that was used to decrypt the ciphertext before it was
|
|
4321
4595
|
* reencrypted.</p>
|
|
4322
4596
|
*/
|
|
4323
4597
|
SourceEncryptionAlgorithm?: EncryptionAlgorithmSpec | string;
|
|
4324
4598
|
/**
|
|
4599
|
+
* @public
|
|
4325
4600
|
* <p>The encryption algorithm that was used to reencrypt the data.</p>
|
|
4326
4601
|
*/
|
|
4327
4602
|
DestinationEncryptionAlgorithm?: EncryptionAlgorithmSpec | string;
|
|
@@ -4331,6 +4606,7 @@ export interface ReEncryptResponse {
|
|
|
4331
4606
|
*/
|
|
4332
4607
|
export interface ReplicateKeyRequest {
|
|
4333
4608
|
/**
|
|
4609
|
+
* @public
|
|
4334
4610
|
* <p>Identifies the multi-Region primary key that is being replicated. To determine whether a
|
|
4335
4611
|
* KMS key is a multi-Region primary key, use the <a>DescribeKey</a> operation to
|
|
4336
4612
|
* check the value of the <code>MultiRegionKeyType</code> property.</p>
|
|
@@ -4350,6 +4626,7 @@ export interface ReplicateKeyRequest {
|
|
|
4350
4626
|
*/
|
|
4351
4627
|
KeyId: string | undefined;
|
|
4352
4628
|
/**
|
|
4629
|
+
* @public
|
|
4353
4630
|
* <p>The Region ID of the Amazon Web Services Region for this replica key. </p>
|
|
4354
4631
|
* <p>Enter the Region ID, such as <code>us-east-1</code> or <code>ap-southeast-2</code>. For a
|
|
4355
4632
|
* list of Amazon Web Services Regions in which KMS is supported, see <a href="https://docs.aws.amazon.com/general/latest/gr/kms.html#kms_region">KMS service endpoints</a> in the
|
|
@@ -4370,6 +4647,7 @@ export interface ReplicateKeyRequest {
|
|
|
4370
4647
|
*/
|
|
4371
4648
|
ReplicaRegion: string | undefined;
|
|
4372
4649
|
/**
|
|
4650
|
+
* @public
|
|
4373
4651
|
* <p>The key policy to attach to the KMS key. This parameter is optional. If you do not provide
|
|
4374
4652
|
* a key policy, KMS attaches the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default">default key policy</a> to the
|
|
4375
4653
|
* KMS key.</p>
|
|
@@ -4412,6 +4690,7 @@ export interface ReplicateKeyRequest {
|
|
|
4412
4690
|
*/
|
|
4413
4691
|
Policy?: string;
|
|
4414
4692
|
/**
|
|
4693
|
+
* @public
|
|
4415
4694
|
* <p>Skips ("bypasses") the key policy lockout safety check. The default value is false.</p>
|
|
4416
4695
|
* <important>
|
|
4417
4696
|
* <p>Setting this value to true increases the risk that the KMS key becomes unmanageable. Do
|
|
@@ -4423,6 +4702,7 @@ export interface ReplicateKeyRequest {
|
|
|
4423
4702
|
*/
|
|
4424
4703
|
BypassPolicyLockoutSafetyCheck?: boolean;
|
|
4425
4704
|
/**
|
|
4705
|
+
* @public
|
|
4426
4706
|
* <p>A description of the KMS key. The default value is an empty string (no
|
|
4427
4707
|
* description).</p>
|
|
4428
4708
|
* <important>
|
|
@@ -4434,6 +4714,7 @@ export interface ReplicateKeyRequest {
|
|
|
4434
4714
|
*/
|
|
4435
4715
|
Description?: string;
|
|
4436
4716
|
/**
|
|
4717
|
+
* @public
|
|
4437
4718
|
* <p>Assigns one or more tags to the replica key. Use this parameter to tag the KMS key when it
|
|
4438
4719
|
* is created. To tag an existing KMS key, use the <a>TagResource</a>
|
|
4439
4720
|
* operation.</p>
|
|
@@ -4462,17 +4743,20 @@ export interface ReplicateKeyRequest {
|
|
|
4462
4743
|
*/
|
|
4463
4744
|
export interface ReplicateKeyResponse {
|
|
4464
4745
|
/**
|
|
4746
|
+
* @public
|
|
4465
4747
|
* <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
|
|
4466
4748
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a>. It also includes the ARN and Amazon Web Services Region of its primary key and other
|
|
4467
4749
|
* replica keys.</p>
|
|
4468
4750
|
*/
|
|
4469
4751
|
ReplicaKeyMetadata?: KeyMetadata;
|
|
4470
4752
|
/**
|
|
4753
|
+
* @public
|
|
4471
4754
|
* <p>The key policy of the new replica key. The value is a key policy document in JSON
|
|
4472
4755
|
* format.</p>
|
|
4473
4756
|
*/
|
|
4474
4757
|
ReplicaPolicy?: string;
|
|
4475
4758
|
/**
|
|
4759
|
+
* @public
|
|
4476
4760
|
* <p>The tags on the new replica key. The value is a list of tag key and tag value
|
|
4477
4761
|
* pairs.</p>
|
|
4478
4762
|
*/
|
|
@@ -4483,6 +4767,7 @@ export interface ReplicateKeyResponse {
|
|
|
4483
4767
|
*/
|
|
4484
4768
|
export interface RetireGrantRequest {
|
|
4485
4769
|
/**
|
|
4770
|
+
* @public
|
|
4486
4771
|
* <p>Identifies the grant to be retired. You can use a grant token to identify a new grant even
|
|
4487
4772
|
* before it has achieved eventual consistency.</p>
|
|
4488
4773
|
* <p>Only the <a>CreateGrant</a> operation returns a grant token. For details, see
|
|
@@ -4491,12 +4776,14 @@ export interface RetireGrantRequest {
|
|
|
4491
4776
|
*/
|
|
4492
4777
|
GrantToken?: string;
|
|
4493
4778
|
/**
|
|
4779
|
+
* @public
|
|
4494
4780
|
* <p>The key ARN KMS key associated with the grant. To find the key ARN, use the <a>ListKeys</a> operation.</p>
|
|
4495
4781
|
* <p>For example: <code>arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
|
|
4496
4782
|
* </p>
|
|
4497
4783
|
*/
|
|
4498
4784
|
KeyId?: string;
|
|
4499
4785
|
/**
|
|
4786
|
+
* @public
|
|
4500
4787
|
* <p>Identifies the grant to retire. To get the grant ID, use <a>CreateGrant</a>,
|
|
4501
4788
|
* <a>ListGrants</a>, or <a>ListRetirableGrants</a>.</p>
|
|
4502
4789
|
* <ul>
|
|
@@ -4508,6 +4795,7 @@ export interface RetireGrantRequest {
|
|
|
4508
4795
|
*/
|
|
4509
4796
|
GrantId?: string;
|
|
4510
4797
|
/**
|
|
4798
|
+
* @public
|
|
4511
4799
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
4512
4800
|
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
4513
4801
|
*/
|
|
@@ -4518,6 +4806,7 @@ export interface RetireGrantRequest {
|
|
|
4518
4806
|
*/
|
|
4519
4807
|
export interface RevokeGrantRequest {
|
|
4520
4808
|
/**
|
|
4809
|
+
* @public
|
|
4521
4810
|
* <p>A unique identifier for the KMS key associated with the grant. To get the key ID and key
|
|
4522
4811
|
* ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
4523
4812
|
* <p>Specify the key ID or key ARN of the KMS key. To specify a KMS key in a
|
|
@@ -4537,11 +4826,13 @@ export interface RevokeGrantRequest {
|
|
|
4537
4826
|
*/
|
|
4538
4827
|
KeyId: string | undefined;
|
|
4539
4828
|
/**
|
|
4829
|
+
* @public
|
|
4540
4830
|
* <p>Identifies the grant to revoke. To get the grant ID, use <a>CreateGrant</a>,
|
|
4541
4831
|
* <a>ListGrants</a>, or <a>ListRetirableGrants</a>.</p>
|
|
4542
4832
|
*/
|
|
4543
4833
|
GrantId: string | undefined;
|
|
4544
4834
|
/**
|
|
4835
|
+
* @public
|
|
4545
4836
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
4546
4837
|
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
4547
4838
|
*/
|
|
@@ -4552,6 +4843,7 @@ export interface RevokeGrantRequest {
|
|
|
4552
4843
|
*/
|
|
4553
4844
|
export interface ScheduleKeyDeletionRequest {
|
|
4554
4845
|
/**
|
|
4846
|
+
* @public
|
|
4555
4847
|
* <p>The unique identifier of the KMS key to delete.</p>
|
|
4556
4848
|
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
4557
4849
|
* <p>For example:</p>
|
|
@@ -4569,6 +4861,7 @@ export interface ScheduleKeyDeletionRequest {
|
|
|
4569
4861
|
*/
|
|
4570
4862
|
KeyId: string | undefined;
|
|
4571
4863
|
/**
|
|
4864
|
+
* @public
|
|
4572
4865
|
* <p>The waiting period, specified in number of days. After the waiting period ends, KMS
|
|
4573
4866
|
* deletes the KMS key.</p>
|
|
4574
4867
|
* <p>If the KMS key is a multi-Region primary key with replica keys, the waiting period begins
|
|
@@ -4588,10 +4881,12 @@ export interface ScheduleKeyDeletionRequest {
|
|
|
4588
4881
|
*/
|
|
4589
4882
|
export interface ScheduleKeyDeletionResponse {
|
|
4590
4883
|
/**
|
|
4884
|
+
* @public
|
|
4591
4885
|
* <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>
|
|
4592
4886
|
*/
|
|
4593
4887
|
KeyId?: string;
|
|
4594
4888
|
/**
|
|
4889
|
+
* @public
|
|
4595
4890
|
* <p>The date and time after which KMS deletes the KMS key.</p>
|
|
4596
4891
|
* <p>If the KMS key is a multi-Region primary key with replica keys, this field does not
|
|
4597
4892
|
* appear. The deletion date for the primary key isn't known until its last replica key is
|
|
@@ -4599,12 +4894,14 @@ export interface ScheduleKeyDeletionResponse {
|
|
|
4599
4894
|
*/
|
|
4600
4895
|
DeletionDate?: Date;
|
|
4601
4896
|
/**
|
|
4897
|
+
* @public
|
|
4602
4898
|
* <p>The current status of the KMS key.</p>
|
|
4603
4899
|
* <p>For more information about how key state affects the use of a KMS key, see
|
|
4604
4900
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
4605
4901
|
*/
|
|
4606
4902
|
KeyState?: KeyState | string;
|
|
4607
4903
|
/**
|
|
4904
|
+
* @public
|
|
4608
4905
|
* <p>The waiting period before the KMS key is deleted. </p>
|
|
4609
4906
|
* <p>If the KMS key is a multi-Region primary key with replicas, the waiting period begins when
|
|
4610
4907
|
* the last of its replica keys is deleted. Otherwise, the waiting period begins
|
|
@@ -4617,6 +4914,7 @@ export interface ScheduleKeyDeletionResponse {
|
|
|
4617
4914
|
*/
|
|
4618
4915
|
export interface SignRequest {
|
|
4619
4916
|
/**
|
|
4917
|
+
* @public
|
|
4620
4918
|
* <p>Identifies an asymmetric KMS key. KMS uses the private key in the asymmetric KMS key to
|
|
4621
4919
|
* sign the message. The <code>KeyUsage</code> type of the KMS key must be
|
|
4622
4920
|
* <code>SIGN_VERIFY</code>. To find the <code>KeyUsage</code> of a KMS key, use the <a>DescribeKey</a> operation.</p>
|
|
@@ -4644,6 +4942,7 @@ export interface SignRequest {
|
|
|
4644
4942
|
*/
|
|
4645
4943
|
KeyId: string | undefined;
|
|
4646
4944
|
/**
|
|
4945
|
+
* @public
|
|
4647
4946
|
* <p>Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a
|
|
4648
4947
|
* larger message, provide a message digest.</p>
|
|
4649
4948
|
* <p>If you provide a message digest, use the <code>DIGEST</code> value of
|
|
@@ -4651,6 +4950,7 @@ export interface SignRequest {
|
|
|
4651
4950
|
*/
|
|
4652
4951
|
Message: Uint8Array | undefined;
|
|
4653
4952
|
/**
|
|
4953
|
+
* @public
|
|
4654
4954
|
* <p>Tells KMS whether the value of the <code>Message</code> parameter should be hashed as
|
|
4655
4955
|
* part of the signing algorithm. Use <code>RAW</code> for unhashed messages; use
|
|
4656
4956
|
* <code>DIGEST</code> for message digests, which are already hashed.</p>
|
|
@@ -4688,12 +4988,14 @@ export interface SignRequest {
|
|
|
4688
4988
|
*/
|
|
4689
4989
|
MessageType?: MessageType | string;
|
|
4690
4990
|
/**
|
|
4991
|
+
* @public
|
|
4691
4992
|
* <p>A list of grant tokens.</p>
|
|
4692
4993
|
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
4693
4994
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
4694
4995
|
*/
|
|
4695
4996
|
GrantTokens?: string[];
|
|
4696
4997
|
/**
|
|
4998
|
+
* @public
|
|
4697
4999
|
* <p>Specifies the signing algorithm to use when signing the message. </p>
|
|
4698
5000
|
* <p>Choose an algorithm that is compatible with the type and size of the specified asymmetric
|
|
4699
5001
|
* KMS key. When signing with RSA key pairs, RSASSA-PSS algorithms are preferred. We include
|
|
@@ -4701,6 +5003,7 @@ export interface SignRequest {
|
|
|
4701
5003
|
*/
|
|
4702
5004
|
SigningAlgorithm: SigningAlgorithmSpec | string | undefined;
|
|
4703
5005
|
/**
|
|
5006
|
+
* @public
|
|
4704
5007
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
4705
5008
|
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
4706
5009
|
*/
|
|
@@ -4711,10 +5014,12 @@ export interface SignRequest {
|
|
|
4711
5014
|
*/
|
|
4712
5015
|
export interface SignResponse {
|
|
4713
5016
|
/**
|
|
5017
|
+
* @public
|
|
4714
5018
|
* <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>
|
|
4715
5019
|
*/
|
|
4716
5020
|
KeyId?: string;
|
|
4717
5021
|
/**
|
|
5022
|
+
* @public
|
|
4718
5023
|
* <p>The cryptographic signature that was generated for the message. </p>
|
|
4719
5024
|
* <ul>
|
|
4720
5025
|
* <li>
|
|
@@ -4734,6 +5039,7 @@ export interface SignResponse {
|
|
|
4734
5039
|
*/
|
|
4735
5040
|
Signature?: Uint8Array;
|
|
4736
5041
|
/**
|
|
5042
|
+
* @public
|
|
4737
5043
|
* <p>The signing algorithm that was used to sign the message.</p>
|
|
4738
5044
|
*/
|
|
4739
5045
|
SigningAlgorithm?: SigningAlgorithmSpec | string;
|
|
@@ -4743,6 +5049,7 @@ export interface SignResponse {
|
|
|
4743
5049
|
*/
|
|
4744
5050
|
export interface TagResourceRequest {
|
|
4745
5051
|
/**
|
|
5052
|
+
* @public
|
|
4746
5053
|
* <p>Identifies a customer managed key in the account and Region.</p>
|
|
4747
5054
|
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
4748
5055
|
* <p>For example:</p>
|
|
@@ -4760,6 +5067,7 @@ export interface TagResourceRequest {
|
|
|
4760
5067
|
*/
|
|
4761
5068
|
KeyId: string | undefined;
|
|
4762
5069
|
/**
|
|
5070
|
+
* @public
|
|
4763
5071
|
* <p>One or more tags. Each tag consists of a tag key and a tag value. The tag value can be an
|
|
4764
5072
|
* empty (null) string. </p>
|
|
4765
5073
|
* <important>
|
|
@@ -4776,6 +5084,7 @@ export interface TagResourceRequest {
|
|
|
4776
5084
|
*/
|
|
4777
5085
|
export interface UntagResourceRequest {
|
|
4778
5086
|
/**
|
|
5087
|
+
* @public
|
|
4779
5088
|
* <p>Identifies the KMS key from which you are removing tags.</p>
|
|
4780
5089
|
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
4781
5090
|
* <p>For example:</p>
|
|
@@ -4793,6 +5102,7 @@ export interface UntagResourceRequest {
|
|
|
4793
5102
|
*/
|
|
4794
5103
|
KeyId: string | undefined;
|
|
4795
5104
|
/**
|
|
5105
|
+
* @public
|
|
4796
5106
|
* <p>One or more tag keys. Specify only the tag keys, not the tag values.</p>
|
|
4797
5107
|
*/
|
|
4798
5108
|
TagKeys: string[] | undefined;
|
|
@@ -4802,6 +5112,7 @@ export interface UntagResourceRequest {
|
|
|
4802
5112
|
*/
|
|
4803
5113
|
export interface UpdateAliasRequest {
|
|
4804
5114
|
/**
|
|
5115
|
+
* @public
|
|
4805
5116
|
* <p>Identifies the alias that is changing its KMS key. This value must begin with
|
|
4806
5117
|
* <code>alias/</code> followed by the alias name, such as <code>alias/ExampleAlias</code>. You
|
|
4807
5118
|
* cannot use <code>UpdateAlias</code> to change the alias name.</p>
|
|
@@ -4811,6 +5122,7 @@ export interface UpdateAliasRequest {
|
|
|
4811
5122
|
*/
|
|
4812
5123
|
AliasName: string | undefined;
|
|
4813
5124
|
/**
|
|
5125
|
+
* @public
|
|
4814
5126
|
* <p>Identifies the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a> to associate with the alias. You don't have permission to
|
|
4815
5127
|
* associate an alias with an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed key</a>.</p>
|
|
4816
5128
|
* <p>The KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the new
|
|
@@ -4838,11 +5150,13 @@ export interface UpdateAliasRequest {
|
|
|
4838
5150
|
*/
|
|
4839
5151
|
export interface UpdateCustomKeyStoreRequest {
|
|
4840
5152
|
/**
|
|
5153
|
+
* @public
|
|
4841
5154
|
* <p>Identifies the custom key store that you want to update. Enter the ID of the custom key
|
|
4842
5155
|
* store. To find the ID of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p>
|
|
4843
5156
|
*/
|
|
4844
5157
|
CustomKeyStoreId: string | undefined;
|
|
4845
5158
|
/**
|
|
5159
|
+
* @public
|
|
4846
5160
|
* <p>Changes the friendly name of the custom key store to the value that you specify. The
|
|
4847
5161
|
* custom key store name must be unique in the Amazon Web Services account.</p>
|
|
4848
5162
|
* <important>
|
|
@@ -4853,6 +5167,7 @@ export interface UpdateCustomKeyStoreRequest {
|
|
|
4853
5167
|
*/
|
|
4854
5168
|
NewCustomKeyStoreName?: string;
|
|
4855
5169
|
/**
|
|
5170
|
+
* @public
|
|
4856
5171
|
* <p>Enter the current password of the <code>kmsuser</code> crypto user (CU) in the CloudHSM
|
|
4857
5172
|
* cluster that is associated with the custom key store. This parameter is valid only for custom
|
|
4858
5173
|
* key stores with a <code>CustomKeyStoreType</code> of <code>AWS_CLOUDHSM</code>.</p>
|
|
@@ -4862,6 +5177,7 @@ export interface UpdateCustomKeyStoreRequest {
|
|
|
4862
5177
|
*/
|
|
4863
5178
|
KeyStorePassword?: string;
|
|
4864
5179
|
/**
|
|
5180
|
+
* @public
|
|
4865
5181
|
* <p>Associates the custom key store with a related CloudHSM cluster. This parameter is valid only
|
|
4866
5182
|
* for custom key stores with a <code>CustomKeyStoreType</code> of
|
|
4867
5183
|
* <code>AWS_CLOUDHSM</code>.</p>
|
|
@@ -4875,6 +5191,7 @@ export interface UpdateCustomKeyStoreRequest {
|
|
|
4875
5191
|
*/
|
|
4876
5192
|
CloudHsmClusterId?: string;
|
|
4877
5193
|
/**
|
|
5194
|
+
* @public
|
|
4878
5195
|
* <p>Changes the URI endpoint that KMS uses to connect to your external key store proxy (XKS
|
|
4879
5196
|
* proxy). This parameter is valid only for custom key stores with a
|
|
4880
5197
|
* <code>CustomKeyStoreType</code> of <code>EXTERNAL_KEY_STORE</code>.</p>
|
|
@@ -4890,6 +5207,7 @@ export interface UpdateCustomKeyStoreRequest {
|
|
|
4890
5207
|
*/
|
|
4891
5208
|
XksProxyUriEndpoint?: string;
|
|
4892
5209
|
/**
|
|
5210
|
+
* @public
|
|
4893
5211
|
* <p>Changes the base path to the proxy APIs for this external key store. To find this value,
|
|
4894
5212
|
* see the documentation for your external key manager and external key store proxy (XKS proxy).
|
|
4895
5213
|
* This parameter is valid only for custom key stores with a <code>CustomKeyStoreType</code> of
|
|
@@ -4904,6 +5222,7 @@ export interface UpdateCustomKeyStoreRequest {
|
|
|
4904
5222
|
*/
|
|
4905
5223
|
XksProxyUriPath?: string;
|
|
4906
5224
|
/**
|
|
5225
|
+
* @public
|
|
4907
5226
|
* <p>Changes the name that KMS uses to identify the Amazon VPC endpoint service for your external
|
|
4908
5227
|
* key store proxy (XKS proxy). This parameter is valid when the <code>CustomKeyStoreType</code>
|
|
4909
5228
|
* is <code>EXTERNAL_KEY_STORE</code> and the <code>XksProxyConnectivity</code> is
|
|
@@ -4912,6 +5231,7 @@ export interface UpdateCustomKeyStoreRequest {
|
|
|
4912
5231
|
*/
|
|
4913
5232
|
XksProxyVpcEndpointServiceName?: string;
|
|
4914
5233
|
/**
|
|
5234
|
+
* @public
|
|
4915
5235
|
* <p>Changes the credentials that KMS uses to sign requests to the external key store proxy
|
|
4916
5236
|
* (XKS proxy). This parameter is valid only for custom key stores with a
|
|
4917
5237
|
* <code>CustomKeyStoreType</code> of <code>EXTERNAL_KEY_STORE</code>.</p>
|
|
@@ -4925,6 +5245,7 @@ export interface UpdateCustomKeyStoreRequest {
|
|
|
4925
5245
|
*/
|
|
4926
5246
|
XksProxyAuthenticationCredential?: XksProxyAuthenticationCredentialType;
|
|
4927
5247
|
/**
|
|
5248
|
+
* @public
|
|
4928
5249
|
* <p>Changes the connectivity setting for the external key store. To indicate that the external
|
|
4929
5250
|
* key store proxy uses a Amazon VPC endpoint service to communicate with KMS, specify
|
|
4930
5251
|
* <code>VPC_ENDPOINT_SERVICE</code>. Otherwise, specify <code>PUBLIC_ENDPOINT</code>.</p>
|
|
@@ -4948,6 +5269,7 @@ export interface UpdateCustomKeyStoreResponse {
|
|
|
4948
5269
|
*/
|
|
4949
5270
|
export interface UpdateKeyDescriptionRequest {
|
|
4950
5271
|
/**
|
|
5272
|
+
* @public
|
|
4951
5273
|
* <p>Updates the description of the specified KMS key.</p>
|
|
4952
5274
|
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
4953
5275
|
* <p>For example:</p>
|
|
@@ -4965,6 +5287,7 @@ export interface UpdateKeyDescriptionRequest {
|
|
|
4965
5287
|
*/
|
|
4966
5288
|
KeyId: string | undefined;
|
|
4967
5289
|
/**
|
|
5290
|
+
* @public
|
|
4968
5291
|
* <p>New description for the KMS key.</p>
|
|
4969
5292
|
* <important>
|
|
4970
5293
|
* <p>Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p>
|
|
@@ -4977,6 +5300,7 @@ export interface UpdateKeyDescriptionRequest {
|
|
|
4977
5300
|
*/
|
|
4978
5301
|
export interface UpdatePrimaryRegionRequest {
|
|
4979
5302
|
/**
|
|
5303
|
+
* @public
|
|
4980
5304
|
* <p>Identifies the current primary key. When the operation completes, this KMS key will be a
|
|
4981
5305
|
* replica key.</p>
|
|
4982
5306
|
* <p>Specify the key ID or key ARN of a multi-Region primary key.</p>
|
|
@@ -4995,6 +5319,7 @@ export interface UpdatePrimaryRegionRequest {
|
|
|
4995
5319
|
*/
|
|
4996
5320
|
KeyId: string | undefined;
|
|
4997
5321
|
/**
|
|
5322
|
+
* @public
|
|
4998
5323
|
* <p>The Amazon Web Services Region of the new primary key. Enter the Region ID, such as
|
|
4999
5324
|
* <code>us-east-1</code> or <code>ap-southeast-2</code>. There must be an existing replica key
|
|
5000
5325
|
* in this Region. </p>
|
|
@@ -5008,6 +5333,7 @@ export interface UpdatePrimaryRegionRequest {
|
|
|
5008
5333
|
*/
|
|
5009
5334
|
export interface VerifyRequest {
|
|
5010
5335
|
/**
|
|
5336
|
+
* @public
|
|
5011
5337
|
* <p>Identifies the asymmetric KMS key that will be used to verify the signature. This must be
|
|
5012
5338
|
* the same KMS key that was used to generate the signature. If you specify a different KMS key,
|
|
5013
5339
|
* the signature verification fails.</p>
|
|
@@ -5035,6 +5361,7 @@ export interface VerifyRequest {
|
|
|
5035
5361
|
*/
|
|
5036
5362
|
KeyId: string | undefined;
|
|
5037
5363
|
/**
|
|
5364
|
+
* @public
|
|
5038
5365
|
* <p>Specifies the message that was signed. You can submit a raw message of up to 4096 bytes,
|
|
5039
5366
|
* or a hash digest of the message. If you submit a digest, use the <code>MessageType</code>
|
|
5040
5367
|
* parameter with a value of <code>DIGEST</code>.</p>
|
|
@@ -5044,6 +5371,7 @@ export interface VerifyRequest {
|
|
|
5044
5371
|
*/
|
|
5045
5372
|
Message: Uint8Array | undefined;
|
|
5046
5373
|
/**
|
|
5374
|
+
* @public
|
|
5047
5375
|
* <p>Tells KMS whether the value of the <code>Message</code> parameter should be hashed as
|
|
5048
5376
|
* part of the signing algorithm. Use <code>RAW</code> for unhashed messages; use
|
|
5049
5377
|
* <code>DIGEST</code> for message digests, which are already hashed.</p>
|
|
@@ -5082,21 +5410,25 @@ export interface VerifyRequest {
|
|
|
5082
5410
|
*/
|
|
5083
5411
|
MessageType?: MessageType | string;
|
|
5084
5412
|
/**
|
|
5413
|
+
* @public
|
|
5085
5414
|
* <p>The signature that the <code>Sign</code> operation generated.</p>
|
|
5086
5415
|
*/
|
|
5087
5416
|
Signature: Uint8Array | undefined;
|
|
5088
5417
|
/**
|
|
5418
|
+
* @public
|
|
5089
5419
|
* <p>The signing algorithm that was used to sign the message. If you submit a different
|
|
5090
5420
|
* algorithm, the signature verification fails.</p>
|
|
5091
5421
|
*/
|
|
5092
5422
|
SigningAlgorithm: SigningAlgorithmSpec | string | undefined;
|
|
5093
5423
|
/**
|
|
5424
|
+
* @public
|
|
5094
5425
|
* <p>A list of grant tokens.</p>
|
|
5095
5426
|
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
5096
5427
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
5097
5428
|
*/
|
|
5098
5429
|
GrantTokens?: string[];
|
|
5099
5430
|
/**
|
|
5431
|
+
* @public
|
|
5100
5432
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
5101
5433
|
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
5102
5434
|
*/
|
|
@@ -5107,10 +5439,12 @@ export interface VerifyRequest {
|
|
|
5107
5439
|
*/
|
|
5108
5440
|
export interface VerifyResponse {
|
|
5109
5441
|
/**
|
|
5442
|
+
* @public
|
|
5110
5443
|
* <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>
|
|
5111
5444
|
*/
|
|
5112
5445
|
KeyId?: string;
|
|
5113
5446
|
/**
|
|
5447
|
+
* @public
|
|
5114
5448
|
* <p>A Boolean value that indicates whether the signature was verified. A value of
|
|
5115
5449
|
* <code>True</code> indicates that the <code>Signature</code> was produced by signing the
|
|
5116
5450
|
* <code>Message</code> with the specified <code>KeyID</code> and
|
|
@@ -5119,6 +5453,7 @@ export interface VerifyResponse {
|
|
|
5119
5453
|
*/
|
|
5120
5454
|
SignatureValid?: boolean;
|
|
5121
5455
|
/**
|
|
5456
|
+
* @public
|
|
5122
5457
|
* <p>The signing algorithm that was used to verify the signature.</p>
|
|
5123
5458
|
*/
|
|
5124
5459
|
SigningAlgorithm?: SigningAlgorithmSpec | string;
|
|
@@ -5128,6 +5463,7 @@ export interface VerifyResponse {
|
|
|
5128
5463
|
*/
|
|
5129
5464
|
export interface VerifyMacRequest {
|
|
5130
5465
|
/**
|
|
5466
|
+
* @public
|
|
5131
5467
|
* <p>The message that will be used in the verification. Enter the same message that was used to
|
|
5132
5468
|
* generate the HMAC.</p>
|
|
5133
5469
|
* <p>
|
|
@@ -5137,30 +5473,35 @@ export interface VerifyMacRequest {
|
|
|
5137
5473
|
*/
|
|
5138
5474
|
Message: Uint8Array | undefined;
|
|
5139
5475
|
/**
|
|
5476
|
+
* @public
|
|
5140
5477
|
* <p>The KMS key that will be used in the verification.</p>
|
|
5141
5478
|
* <p>Enter a key ID of the KMS key that was used to generate the HMAC. If you identify a
|
|
5142
5479
|
* different KMS key, the <code>VerifyMac</code> operation fails.</p>
|
|
5143
5480
|
*/
|
|
5144
5481
|
KeyId: string | undefined;
|
|
5145
5482
|
/**
|
|
5483
|
+
* @public
|
|
5146
5484
|
* <p>The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that
|
|
5147
5485
|
* was used to compute the HMAC. This algorithm must be supported by the HMAC KMS key identified
|
|
5148
5486
|
* by the <code>KeyId</code> parameter.</p>
|
|
5149
5487
|
*/
|
|
5150
5488
|
MacAlgorithm: MacAlgorithmSpec | string | undefined;
|
|
5151
5489
|
/**
|
|
5490
|
+
* @public
|
|
5152
5491
|
* <p>The HMAC to verify. Enter the HMAC that was generated by the <a>GenerateMac</a>
|
|
5153
5492
|
* operation when you specified the same message, HMAC KMS key, and MAC algorithm as the values
|
|
5154
5493
|
* specified in this request.</p>
|
|
5155
5494
|
*/
|
|
5156
5495
|
Mac: Uint8Array | undefined;
|
|
5157
5496
|
/**
|
|
5497
|
+
* @public
|
|
5158
5498
|
* <p>A list of grant tokens.</p>
|
|
5159
5499
|
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
5160
5500
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
5161
5501
|
*/
|
|
5162
5502
|
GrantTokens?: string[];
|
|
5163
5503
|
/**
|
|
5504
|
+
* @public
|
|
5164
5505
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
5165
5506
|
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
5166
5507
|
*/
|
|
@@ -5171,10 +5512,12 @@ export interface VerifyMacRequest {
|
|
|
5171
5512
|
*/
|
|
5172
5513
|
export interface VerifyMacResponse {
|
|
5173
5514
|
/**
|
|
5515
|
+
* @public
|
|
5174
5516
|
* <p>The HMAC KMS key used in the verification.</p>
|
|
5175
5517
|
*/
|
|
5176
5518
|
KeyId?: string;
|
|
5177
5519
|
/**
|
|
5520
|
+
* @public
|
|
5178
5521
|
* <p>A Boolean value that indicates whether the HMAC was verified. A value of <code>True</code>
|
|
5179
5522
|
* indicates that the HMAC (<code>Mac</code>) was generated with the specified
|
|
5180
5523
|
* <code>Message</code>, HMAC KMS key (<code>KeyID</code>) and
|
|
@@ -5185,6 +5528,7 @@ export interface VerifyMacResponse {
|
|
|
5185
5528
|
*/
|
|
5186
5529
|
MacValid?: boolean;
|
|
5187
5530
|
/**
|
|
5531
|
+
* @public
|
|
5188
5532
|
* <p>The MAC algorithm used in the verification.</p>
|
|
5189
5533
|
*/
|
|
5190
5534
|
MacAlgorithm?: MacAlgorithmSpec | string;
|