@aws-sdk/client-kms 3.687.0 → 3.691.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 +291 -291
- package/dist-types/ts3.4/models/models_0.d.ts +295 -291
- package/package.json +7 -7
|
@@ -25,29 +25,29 @@ export interface AliasListEntry {
|
|
|
25
25
|
* <p>String that contains the alias. This value begins with <code>alias/</code>.</p>
|
|
26
26
|
* @public
|
|
27
27
|
*/
|
|
28
|
-
AliasName?: string;
|
|
28
|
+
AliasName?: string | undefined;
|
|
29
29
|
/**
|
|
30
30
|
* <p>String that contains the key ARN.</p>
|
|
31
31
|
* @public
|
|
32
32
|
*/
|
|
33
|
-
AliasArn?: string;
|
|
33
|
+
AliasArn?: string | undefined;
|
|
34
34
|
/**
|
|
35
35
|
* <p>String that contains the key identifier of the KMS key associated with the alias.</p>
|
|
36
36
|
* @public
|
|
37
37
|
*/
|
|
38
|
-
TargetKeyId?: string;
|
|
38
|
+
TargetKeyId?: string | undefined;
|
|
39
39
|
/**
|
|
40
40
|
* <p>Date and time that the alias was most recently created in the account and Region.
|
|
41
41
|
* Formatted as Unix time.</p>
|
|
42
42
|
* @public
|
|
43
43
|
*/
|
|
44
|
-
CreationDate?: Date;
|
|
44
|
+
CreationDate?: Date | undefined;
|
|
45
45
|
/**
|
|
46
46
|
* <p>Date and time that the alias was most recently associated with a KMS key in the account
|
|
47
47
|
* and Region. Formatted as Unix time.</p>
|
|
48
48
|
* @public
|
|
49
49
|
*/
|
|
50
|
-
LastUpdatedDate?: Date;
|
|
50
|
+
LastUpdatedDate?: Date | undefined;
|
|
51
51
|
}
|
|
52
52
|
/**
|
|
53
53
|
* <p>The request was rejected because it attempted to create a resource that already
|
|
@@ -93,7 +93,7 @@ export interface CancelKeyDeletionResponse {
|
|
|
93
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>
|
|
94
94
|
* @public
|
|
95
95
|
*/
|
|
96
|
-
KeyId?: string;
|
|
96
|
+
KeyId?: string | undefined;
|
|
97
97
|
}
|
|
98
98
|
/**
|
|
99
99
|
* <p>The system timed out while trying to fulfill the request. You can retry the
|
|
@@ -546,7 +546,7 @@ export interface CreateCustomKeyStoreRequest {
|
|
|
546
546
|
* custom key store. To find the cluster ID, use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html">DescribeClusters</a> operation.</p>
|
|
547
547
|
* @public
|
|
548
548
|
*/
|
|
549
|
-
CloudHsmClusterId?: string;
|
|
549
|
+
CloudHsmClusterId?: string | undefined;
|
|
550
550
|
/**
|
|
551
551
|
* <p>Specifies the certificate for an CloudHSM key store. This parameter is required for custom
|
|
552
552
|
* key stores with a <code>CustomKeyStoreType</code> of <code>AWS_CLOUDHSM</code>.</p>
|
|
@@ -555,7 +555,7 @@ export interface CreateCustomKeyStoreRequest {
|
|
|
555
555
|
* cluster</a>.</p>
|
|
556
556
|
* @public
|
|
557
557
|
*/
|
|
558
|
-
TrustAnchorCertificate?: string;
|
|
558
|
+
TrustAnchorCertificate?: string | undefined;
|
|
559
559
|
/**
|
|
560
560
|
* <p>Specifies the <code>kmsuser</code> password for an CloudHSM key store. This parameter is
|
|
561
561
|
* required for custom key stores with a <code>CustomKeyStoreType</code> of
|
|
@@ -569,7 +569,7 @@ export interface CreateCustomKeyStoreRequest {
|
|
|
569
569
|
* the password in the CloudHSM cluster.</p>
|
|
570
570
|
* @public
|
|
571
571
|
*/
|
|
572
|
-
KeyStorePassword?: string;
|
|
572
|
+
KeyStorePassword?: string | undefined;
|
|
573
573
|
/**
|
|
574
574
|
* <p>Specifies the type of custom key store. The default value is
|
|
575
575
|
* <code>AWS_CLOUDHSM</code>.</p>
|
|
@@ -579,7 +579,7 @@ export interface CreateCustomKeyStoreRequest {
|
|
|
579
579
|
* store is created.</p>
|
|
580
580
|
* @public
|
|
581
581
|
*/
|
|
582
|
-
CustomKeyStoreType?: CustomKeyStoreType;
|
|
582
|
+
CustomKeyStoreType?: CustomKeyStoreType | undefined;
|
|
583
583
|
/**
|
|
584
584
|
* <p>Specifies the endpoint that KMS uses to send requests to the external key store proxy
|
|
585
585
|
* (XKS proxy). This parameter is required for custom key stores with a
|
|
@@ -619,7 +619,7 @@ export interface CreateCustomKeyStoreRequest {
|
|
|
619
619
|
* </ul>
|
|
620
620
|
* @public
|
|
621
621
|
*/
|
|
622
|
-
XksProxyUriEndpoint?: string;
|
|
622
|
+
XksProxyUriEndpoint?: string | undefined;
|
|
623
623
|
/**
|
|
624
624
|
* <p>Specifies the base path to the proxy APIs for this external key store. To find this value,
|
|
625
625
|
* see the documentation for your external key store proxy. This parameter is required for all
|
|
@@ -640,7 +640,7 @@ export interface CreateCustomKeyStoreRequest {
|
|
|
640
640
|
* </ul>
|
|
641
641
|
* @public
|
|
642
642
|
*/
|
|
643
|
-
XksProxyUriPath?: string;
|
|
643
|
+
XksProxyUriPath?: string | undefined;
|
|
644
644
|
/**
|
|
645
645
|
* <p>Specifies the name of the Amazon VPC endpoint service for interface endpoints that is used to
|
|
646
646
|
* communicate with your external key store proxy (XKS proxy). This parameter is required when
|
|
@@ -660,7 +660,7 @@ export interface CreateCustomKeyStoreRequest {
|
|
|
660
660
|
* </ul>
|
|
661
661
|
* @public
|
|
662
662
|
*/
|
|
663
|
-
XksProxyVpcEndpointServiceName?: string;
|
|
663
|
+
XksProxyVpcEndpointServiceName?: string | undefined;
|
|
664
664
|
/**
|
|
665
665
|
* <p>Specifies an authentication credential for the external key store proxy (XKS proxy). This
|
|
666
666
|
* parameter is required for all custom key stores with a <code>CustomKeyStoreType</code> of
|
|
@@ -676,7 +676,7 @@ export interface CreateCustomKeyStoreRequest {
|
|
|
676
676
|
* operation to provide the new credential to KMS.</p>
|
|
677
677
|
* @public
|
|
678
678
|
*/
|
|
679
|
-
XksProxyAuthenticationCredential?: XksProxyAuthenticationCredentialType;
|
|
679
|
+
XksProxyAuthenticationCredential?: XksProxyAuthenticationCredentialType | undefined;
|
|
680
680
|
/**
|
|
681
681
|
* <p>Indicates how KMS communicates with the external key store proxy. This parameter is
|
|
682
682
|
* required for custom key stores with a <code>CustomKeyStoreType</code> of
|
|
@@ -696,7 +696,7 @@ export interface CreateCustomKeyStoreRequest {
|
|
|
696
696
|
* your corporate data center.</p>
|
|
697
697
|
* @public
|
|
698
698
|
*/
|
|
699
|
-
XksProxyConnectivity?: XksProxyConnectivityType;
|
|
699
|
+
XksProxyConnectivity?: XksProxyConnectivityType | undefined;
|
|
700
700
|
}
|
|
701
701
|
/**
|
|
702
702
|
* @public
|
|
@@ -706,7 +706,7 @@ export interface CreateCustomKeyStoreResponse {
|
|
|
706
706
|
* <p>A unique identifier for the new custom key store.</p>
|
|
707
707
|
* @public
|
|
708
708
|
*/
|
|
709
|
-
CustomKeyStoreId?: string;
|
|
709
|
+
CustomKeyStoreId?: string | undefined;
|
|
710
710
|
}
|
|
711
711
|
/**
|
|
712
712
|
* <p>The request was rejected because the specified custom key store name is already assigned
|
|
@@ -901,14 +901,14 @@ export interface GrantConstraints {
|
|
|
901
901
|
* can include additional key-value pairs.</p>
|
|
902
902
|
* @public
|
|
903
903
|
*/
|
|
904
|
-
EncryptionContextSubset?: Record<string, string
|
|
904
|
+
EncryptionContextSubset?: Record<string, string> | undefined;
|
|
905
905
|
/**
|
|
906
906
|
* <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>
|
|
907
907
|
* request. The grant allows the operation only when the encryption context in the request is the
|
|
908
908
|
* same as the encryption context specified in this constraint.</p>
|
|
909
909
|
* @public
|
|
910
910
|
*/
|
|
911
|
-
EncryptionContextEquals?: Record<string, string
|
|
911
|
+
EncryptionContextEquals?: Record<string, string> | undefined;
|
|
912
912
|
}
|
|
913
913
|
/**
|
|
914
914
|
* @public
|
|
@@ -987,7 +987,7 @@ export interface CreateGrantRequest {
|
|
|
987
987
|
* revoking grants</a> in the <i>Key Management Service Developer Guide</i>. </p>
|
|
988
988
|
* @public
|
|
989
989
|
*/
|
|
990
|
-
RetiringPrincipal?: string;
|
|
990
|
+
RetiringPrincipal?: string | undefined;
|
|
991
991
|
/**
|
|
992
992
|
* <p>A list of operations that the grant permits. </p>
|
|
993
993
|
* <p>This list must include only operations that are permitted in a grant. Also, the operation
|
|
@@ -1028,14 +1028,14 @@ export interface CreateGrantRequest {
|
|
|
1028
1028
|
* </i>. </p>
|
|
1029
1029
|
* @public
|
|
1030
1030
|
*/
|
|
1031
|
-
Constraints?: GrantConstraints;
|
|
1031
|
+
Constraints?: GrantConstraints | undefined;
|
|
1032
1032
|
/**
|
|
1033
1033
|
* <p>A list of grant tokens. </p>
|
|
1034
1034
|
* <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
|
|
1035
1035
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
1036
1036
|
* @public
|
|
1037
1037
|
*/
|
|
1038
|
-
GrantTokens?: string[];
|
|
1038
|
+
GrantTokens?: string[] | undefined;
|
|
1039
1039
|
/**
|
|
1040
1040
|
* <p>A friendly name for the grant. Use this value to prevent the unintended creation of
|
|
1041
1041
|
* duplicate grants when retrying this request.</p>
|
|
@@ -1052,13 +1052,13 @@ export interface CreateGrantRequest {
|
|
|
1052
1052
|
* All grant tokens for the same grant ID can be used interchangeably.</p>
|
|
1053
1053
|
* @public
|
|
1054
1054
|
*/
|
|
1055
|
-
Name?: string;
|
|
1055
|
+
Name?: string | undefined;
|
|
1056
1056
|
/**
|
|
1057
1057
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
1058
1058
|
* <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>
|
|
1059
1059
|
* @public
|
|
1060
1060
|
*/
|
|
1061
|
-
DryRun?: boolean;
|
|
1061
|
+
DryRun?: boolean | undefined;
|
|
1062
1062
|
}
|
|
1063
1063
|
/**
|
|
1064
1064
|
* @public
|
|
@@ -1070,13 +1070,13 @@ export interface CreateGrantResponse {
|
|
|
1070
1070
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
1071
1071
|
* @public
|
|
1072
1072
|
*/
|
|
1073
|
-
GrantToken?: string;
|
|
1073
|
+
GrantToken?: string | undefined;
|
|
1074
1074
|
/**
|
|
1075
1075
|
* <p>The unique identifier for the grant.</p>
|
|
1076
1076
|
* <p>You can use the <code>GrantId</code> in a <a>ListGrants</a>, <a>RetireGrant</a>, or <a>RevokeGrant</a> operation.</p>
|
|
1077
1077
|
* @public
|
|
1078
1078
|
*/
|
|
1079
|
-
GrantId?: string;
|
|
1079
|
+
GrantId?: string | undefined;
|
|
1080
1080
|
}
|
|
1081
1081
|
/**
|
|
1082
1082
|
* <p>The request was rejected because the specified KMS key is not enabled.</p>
|
|
@@ -1242,7 +1242,7 @@ export interface CreateKeyRequest {
|
|
|
1242
1242
|
* </i>.</p>
|
|
1243
1243
|
* @public
|
|
1244
1244
|
*/
|
|
1245
|
-
Policy?: string;
|
|
1245
|
+
Policy?: string | undefined;
|
|
1246
1246
|
/**
|
|
1247
1247
|
* <p>A description of the KMS key. Use a description that helps you decide whether the KMS key
|
|
1248
1248
|
* is appropriate for a task. The default value is an empty string (no description).</p>
|
|
@@ -1252,7 +1252,7 @@ export interface CreateKeyRequest {
|
|
|
1252
1252
|
* <p>To set or change the description after the key is created, use <a>UpdateKeyDescription</a>.</p>
|
|
1253
1253
|
* @public
|
|
1254
1254
|
*/
|
|
1255
|
-
Description?: string;
|
|
1255
|
+
Description?: string | undefined;
|
|
1256
1256
|
/**
|
|
1257
1257
|
* <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
|
|
1258
1258
|
* <code>ENCRYPT_DECRYPT</code>. This parameter is optional when you are creating a symmetric
|
|
@@ -1286,7 +1286,7 @@ export interface CreateKeyRequest {
|
|
|
1286
1286
|
* </ul>
|
|
1287
1287
|
* @public
|
|
1288
1288
|
*/
|
|
1289
|
-
KeyUsage?: KeyUsageType;
|
|
1289
|
+
KeyUsage?: KeyUsageType | undefined;
|
|
1290
1290
|
/**
|
|
1291
1291
|
* @deprecated
|
|
1292
1292
|
*
|
|
@@ -1296,7 +1296,7 @@ export interface CreateKeyRequest {
|
|
|
1296
1296
|
* code. However, to avoid breaking changes, KMS supports both parameters.</p>
|
|
1297
1297
|
* @public
|
|
1298
1298
|
*/
|
|
1299
|
-
CustomerMasterKeySpec?: CustomerMasterKeySpec;
|
|
1299
|
+
CustomerMasterKeySpec?: CustomerMasterKeySpec | undefined;
|
|
1300
1300
|
/**
|
|
1301
1301
|
* <p>Specifies the type of KMS key to create. The default value,
|
|
1302
1302
|
* <code>SYMMETRIC_DEFAULT</code>, creates a KMS key with a 256-bit AES-GCM key that is used for
|
|
@@ -1413,7 +1413,7 @@ export interface CreateKeyRequest {
|
|
|
1413
1413
|
* </ul>
|
|
1414
1414
|
* @public
|
|
1415
1415
|
*/
|
|
1416
|
-
KeySpec?: KeySpec;
|
|
1416
|
+
KeySpec?: KeySpec | undefined;
|
|
1417
1417
|
/**
|
|
1418
1418
|
* <p>The source of the key material for the KMS key. You cannot change the origin after you
|
|
1419
1419
|
* create the KMS key. The default is <code>AWS_KMS</code>, which means that KMS creates the
|
|
@@ -1436,7 +1436,7 @@ export interface CreateKeyRequest {
|
|
|
1436
1436
|
* <code>KeySpec</code> value must be <code>SYMMETRIC_DEFAULT</code>.</p>
|
|
1437
1437
|
* @public
|
|
1438
1438
|
*/
|
|
1439
|
-
Origin?: OriginType;
|
|
1439
|
+
Origin?: OriginType | undefined;
|
|
1440
1440
|
/**
|
|
1441
1441
|
* <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
|
|
1442
1442
|
* the custom key store must be <code>CONNECTED</code>. To find the CustomKeyStoreID and
|
|
@@ -1449,7 +1449,7 @@ export interface CreateKeyRequest {
|
|
|
1449
1449
|
* specify an external key that serves as key material for the KMS key.</p>
|
|
1450
1450
|
* @public
|
|
1451
1451
|
*/
|
|
1452
|
-
CustomKeyStoreId?: string;
|
|
1452
|
+
CustomKeyStoreId?: string | undefined;
|
|
1453
1453
|
/**
|
|
1454
1454
|
* <p>Skips ("bypasses") the key policy lockout safety check. The default value is false.</p>
|
|
1455
1455
|
* <important>
|
|
@@ -1462,7 +1462,7 @@ export interface CreateKeyRequest {
|
|
|
1462
1462
|
* request on the KMS key.</p>
|
|
1463
1463
|
* @public
|
|
1464
1464
|
*/
|
|
1465
|
-
BypassPolicyLockoutSafetyCheck?: boolean;
|
|
1465
|
+
BypassPolicyLockoutSafetyCheck?: boolean | undefined;
|
|
1466
1466
|
/**
|
|
1467
1467
|
* <p>Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is
|
|
1468
1468
|
* created. To tag an existing KMS key, use the <a>TagResource</a> operation.</p>
|
|
@@ -1482,7 +1482,7 @@ export interface CreateKeyRequest {
|
|
|
1482
1482
|
* see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">Tagging Keys</a>.</p>
|
|
1483
1483
|
* @public
|
|
1484
1484
|
*/
|
|
1485
|
-
Tags?: Tag[];
|
|
1485
|
+
Tags?: Tag[] | undefined;
|
|
1486
1486
|
/**
|
|
1487
1487
|
* <p>Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You
|
|
1488
1488
|
* cannot change this value after you create the KMS key. </p>
|
|
@@ -1500,7 +1500,7 @@ export interface CreateKeyRequest {
|
|
|
1500
1500
|
* a custom key store.</p>
|
|
1501
1501
|
* @public
|
|
1502
1502
|
*/
|
|
1503
|
-
MultiRegion?: boolean;
|
|
1503
|
+
MultiRegion?: boolean | undefined;
|
|
1504
1504
|
/**
|
|
1505
1505
|
* <p>Identifies the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key">external key</a> that
|
|
1506
1506
|
* 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
|
|
@@ -1524,7 +1524,7 @@ export interface CreateKeyRequest {
|
|
|
1524
1524
|
* encryption</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1525
1525
|
* @public
|
|
1526
1526
|
*/
|
|
1527
|
-
XksKeyId?: string;
|
|
1527
|
+
XksKeyId?: string | undefined;
|
|
1528
1528
|
}
|
|
1529
1529
|
/**
|
|
1530
1530
|
* @public
|
|
@@ -1628,12 +1628,12 @@ export interface MultiRegionKey {
|
|
|
1628
1628
|
* <p>Displays the key ARN of a primary or replica key of a multi-Region key.</p>
|
|
1629
1629
|
* @public
|
|
1630
1630
|
*/
|
|
1631
|
-
Arn?: string;
|
|
1631
|
+
Arn?: string | undefined;
|
|
1632
1632
|
/**
|
|
1633
1633
|
* <p>Displays the Amazon Web Services Region of a primary or replica key in a multi-Region key.</p>
|
|
1634
1634
|
* @public
|
|
1635
1635
|
*/
|
|
1636
|
-
Region?: string;
|
|
1636
|
+
Region?: string | undefined;
|
|
1637
1637
|
}
|
|
1638
1638
|
/**
|
|
1639
1639
|
* <p>Describes the configuration of this multi-Region key. This field appears only when the KMS
|
|
@@ -1648,19 +1648,19 @@ export interface MultiRegionConfiguration {
|
|
|
1648
1648
|
* key.</p>
|
|
1649
1649
|
* @public
|
|
1650
1650
|
*/
|
|
1651
|
-
MultiRegionKeyType?: MultiRegionKeyType;
|
|
1651
|
+
MultiRegionKeyType?: MultiRegionKeyType | undefined;
|
|
1652
1652
|
/**
|
|
1653
1653
|
* <p>Displays the key ARN and Region of the primary key. This field includes the current KMS
|
|
1654
1654
|
* key if it is the primary key.</p>
|
|
1655
1655
|
* @public
|
|
1656
1656
|
*/
|
|
1657
|
-
PrimaryKey?: MultiRegionKey;
|
|
1657
|
+
PrimaryKey?: MultiRegionKey | undefined;
|
|
1658
1658
|
/**
|
|
1659
1659
|
* <p>displays the key ARNs and Regions of all replica keys. This field includes the current KMS
|
|
1660
1660
|
* key if it is a replica key.</p>
|
|
1661
1661
|
* @public
|
|
1662
1662
|
*/
|
|
1663
|
-
ReplicaKeys?: MultiRegionKey[];
|
|
1663
|
+
ReplicaKeys?: MultiRegionKey[] | undefined;
|
|
1664
1664
|
}
|
|
1665
1665
|
/**
|
|
1666
1666
|
* @public
|
|
@@ -1700,7 +1700,7 @@ export interface XksKeyConfigurationType {
|
|
|
1700
1700
|
* key store proxy uses to identify the external key.</p>
|
|
1701
1701
|
* @public
|
|
1702
1702
|
*/
|
|
1703
|
-
Id?: string;
|
|
1703
|
+
Id?: string | undefined;
|
|
1704
1704
|
}
|
|
1705
1705
|
/**
|
|
1706
1706
|
* <p>Contains metadata about a KMS key.</p>
|
|
@@ -1712,7 +1712,7 @@ export interface KeyMetadata {
|
|
|
1712
1712
|
* <p>The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.</p>
|
|
1713
1713
|
* @public
|
|
1714
1714
|
*/
|
|
1715
|
-
AWSAccountId?: string;
|
|
1715
|
+
AWSAccountId?: string | undefined;
|
|
1716
1716
|
/**
|
|
1717
1717
|
* <p>The globally unique identifier for the KMS key.</p>
|
|
1718
1718
|
* @public
|
|
@@ -1723,35 +1723,35 @@ export interface KeyMetadata {
|
|
|
1723
1723
|
* Reference</i>.</p>
|
|
1724
1724
|
* @public
|
|
1725
1725
|
*/
|
|
1726
|
-
Arn?: string;
|
|
1726
|
+
Arn?: string | undefined;
|
|
1727
1727
|
/**
|
|
1728
1728
|
* <p>The date and time when the KMS key was created.</p>
|
|
1729
1729
|
* @public
|
|
1730
1730
|
*/
|
|
1731
|
-
CreationDate?: Date;
|
|
1731
|
+
CreationDate?: Date | undefined;
|
|
1732
1732
|
/**
|
|
1733
1733
|
* <p>Specifies whether the KMS key is enabled. When <code>KeyState</code> is
|
|
1734
1734
|
* <code>Enabled</code> this value is true, otherwise it is false.</p>
|
|
1735
1735
|
* @public
|
|
1736
1736
|
*/
|
|
1737
|
-
Enabled?: boolean;
|
|
1737
|
+
Enabled?: boolean | undefined;
|
|
1738
1738
|
/**
|
|
1739
1739
|
* <p>The description of the KMS key.</p>
|
|
1740
1740
|
* @public
|
|
1741
1741
|
*/
|
|
1742
|
-
Description?: string;
|
|
1742
|
+
Description?: string | undefined;
|
|
1743
1743
|
/**
|
|
1744
1744
|
* <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>
|
|
1745
1745
|
* @public
|
|
1746
1746
|
*/
|
|
1747
|
-
KeyUsage?: KeyUsageType;
|
|
1747
|
+
KeyUsage?: KeyUsageType | undefined;
|
|
1748
1748
|
/**
|
|
1749
1749
|
* <p>The current status of the KMS key.</p>
|
|
1750
1750
|
* <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
|
|
1751
1751
|
* the <i>Key Management Service Developer Guide</i>.</p>
|
|
1752
1752
|
* @public
|
|
1753
1753
|
*/
|
|
1754
|
-
KeyState?: KeyState;
|
|
1754
|
+
KeyState?: KeyState | undefined;
|
|
1755
1755
|
/**
|
|
1756
1756
|
* <p>The date and time after which KMS deletes this KMS key. This value is present only when
|
|
1757
1757
|
* the KMS key is scheduled for deletion, that is, when its <code>KeyState</code> is
|
|
@@ -1761,7 +1761,7 @@ export interface KeyMetadata {
|
|
|
1761
1761
|
* period is displayed in the <code>PendingDeletionWindowInDays</code> field.</p>
|
|
1762
1762
|
* @public
|
|
1763
1763
|
*/
|
|
1764
|
-
DeletionDate?: Date;
|
|
1764
|
+
DeletionDate?: Date | undefined;
|
|
1765
1765
|
/**
|
|
1766
1766
|
* <p>The time at which the imported key material expires. When the key material expires, KMS
|
|
1767
1767
|
* deletes the key material and the KMS key becomes unusable. This value is present only for KMS
|
|
@@ -1769,7 +1769,7 @@ export interface KeyMetadata {
|
|
|
1769
1769
|
* is <code>KEY_MATERIAL_EXPIRES</code>, otherwise this value is omitted.</p>
|
|
1770
1770
|
* @public
|
|
1771
1771
|
*/
|
|
1772
|
-
ValidTo?: Date;
|
|
1772
|
+
ValidTo?: Date | undefined;
|
|
1773
1773
|
/**
|
|
1774
1774
|
* <p>The source of the key material for the KMS key. When this value is <code>AWS_KMS</code>,
|
|
1775
1775
|
* KMS created the key material. When this value is <code>EXTERNAL</code>, the key material was
|
|
@@ -1778,13 +1778,13 @@ export interface KeyMetadata {
|
|
|
1778
1778
|
* a custom key store.</p>
|
|
1779
1779
|
* @public
|
|
1780
1780
|
*/
|
|
1781
|
-
Origin?: OriginType;
|
|
1781
|
+
Origin?: OriginType | undefined;
|
|
1782
1782
|
/**
|
|
1783
1783
|
* <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
|
|
1784
1784
|
* present only when the KMS key is created in a custom key store.</p>
|
|
1785
1785
|
* @public
|
|
1786
1786
|
*/
|
|
1787
|
-
CustomKeyStoreId?: string;
|
|
1787
|
+
CustomKeyStoreId?: string | undefined;
|
|
1788
1788
|
/**
|
|
1789
1789
|
* <p>The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When
|
|
1790
1790
|
* 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
|
|
@@ -1792,19 +1792,19 @@ export interface KeyMetadata {
|
|
|
1792
1792
|
* an CloudHSM key store.</p>
|
|
1793
1793
|
* @public
|
|
1794
1794
|
*/
|
|
1795
|
-
CloudHsmClusterId?: string;
|
|
1795
|
+
CloudHsmClusterId?: string | undefined;
|
|
1796
1796
|
/**
|
|
1797
1797
|
* <p>Specifies whether the KMS key's key material expires. This value is present only when
|
|
1798
1798
|
* <code>Origin</code> is <code>EXTERNAL</code>, otherwise this value is omitted.</p>
|
|
1799
1799
|
* @public
|
|
1800
1800
|
*/
|
|
1801
|
-
ExpirationModel?: ExpirationModelType;
|
|
1801
|
+
ExpirationModel?: ExpirationModelType | undefined;
|
|
1802
1802
|
/**
|
|
1803
1803
|
* <p>The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or
|
|
1804
1804
|
* 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>
|
|
1805
1805
|
* @public
|
|
1806
1806
|
*/
|
|
1807
|
-
KeyManager?: KeyManagerType;
|
|
1807
|
+
KeyManager?: KeyManagerType | undefined;
|
|
1808
1808
|
/**
|
|
1809
1809
|
* @deprecated
|
|
1810
1810
|
*
|
|
@@ -1814,12 +1814,12 @@ export interface KeyMetadata {
|
|
|
1814
1814
|
* avoid breaking changes, KMS supports both fields.</p>
|
|
1815
1815
|
* @public
|
|
1816
1816
|
*/
|
|
1817
|
-
CustomerMasterKeySpec?: CustomerMasterKeySpec;
|
|
1817
|
+
CustomerMasterKeySpec?: CustomerMasterKeySpec | undefined;
|
|
1818
1818
|
/**
|
|
1819
1819
|
* <p>Describes the type of key material in the KMS key.</p>
|
|
1820
1820
|
* @public
|
|
1821
1821
|
*/
|
|
1822
|
-
KeySpec?: KeySpec;
|
|
1822
|
+
KeySpec?: KeySpec | undefined;
|
|
1823
1823
|
/**
|
|
1824
1824
|
* <p>The encryption algorithms that the KMS key supports. You cannot use the KMS key with other
|
|
1825
1825
|
* encryption algorithms within KMS.</p>
|
|
@@ -1827,7 +1827,7 @@ export interface KeyMetadata {
|
|
|
1827
1827
|
* <code>ENCRYPT_DECRYPT</code>.</p>
|
|
1828
1828
|
* @public
|
|
1829
1829
|
*/
|
|
1830
|
-
EncryptionAlgorithms?: EncryptionAlgorithmSpec[];
|
|
1830
|
+
EncryptionAlgorithms?: EncryptionAlgorithmSpec[] | undefined;
|
|
1831
1831
|
/**
|
|
1832
1832
|
* <p>The signing algorithms that the KMS key supports. You cannot use the KMS key with other
|
|
1833
1833
|
* signing algorithms within KMS.</p>
|
|
@@ -1835,12 +1835,12 @@ export interface KeyMetadata {
|
|
|
1835
1835
|
* <code>SIGN_VERIFY</code>.</p>
|
|
1836
1836
|
* @public
|
|
1837
1837
|
*/
|
|
1838
|
-
SigningAlgorithms?: SigningAlgorithmSpec[];
|
|
1838
|
+
SigningAlgorithms?: SigningAlgorithmSpec[] | undefined;
|
|
1839
1839
|
/**
|
|
1840
1840
|
* <p>The key agreement algorithm used to derive a shared secret.</p>
|
|
1841
1841
|
* @public
|
|
1842
1842
|
*/
|
|
1843
|
-
KeyAgreementAlgorithms?: KeyAgreementAlgorithmSpec[];
|
|
1843
|
+
KeyAgreementAlgorithms?: KeyAgreementAlgorithmSpec[] | undefined;
|
|
1844
1844
|
/**
|
|
1845
1845
|
* <p>Indicates whether the KMS key is a multi-Region (<code>True</code>) or regional
|
|
1846
1846
|
* (<code>False</code>) key. This value is <code>True</code> for multi-Region primary and
|
|
@@ -1848,7 +1848,7 @@ export interface KeyMetadata {
|
|
|
1848
1848
|
* <p>For more information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Multi-Region keys in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1849
1849
|
* @public
|
|
1850
1850
|
*/
|
|
1851
|
-
MultiRegion?: boolean;
|
|
1851
|
+
MultiRegion?: boolean | undefined;
|
|
1852
1852
|
/**
|
|
1853
1853
|
* <p>Lists the primary and replica keys in same multi-Region key. This field is present only
|
|
1854
1854
|
* when the value of the <code>MultiRegion</code> field is <code>True</code>.</p>
|
|
@@ -1873,7 +1873,7 @@ export interface KeyMetadata {
|
|
|
1873
1873
|
* </ul>
|
|
1874
1874
|
* @public
|
|
1875
1875
|
*/
|
|
1876
|
-
MultiRegionConfiguration?: MultiRegionConfiguration;
|
|
1876
|
+
MultiRegionConfiguration?: MultiRegionConfiguration | undefined;
|
|
1877
1877
|
/**
|
|
1878
1878
|
* <p>The waiting period before the primary key in a multi-Region key is deleted. This waiting
|
|
1879
1879
|
* period begins when the last of its replica keys is deleted. This value is present only when
|
|
@@ -1889,14 +1889,14 @@ export interface KeyMetadata {
|
|
|
1889
1889
|
* and the deletion date appears in the <code>DeletionDate</code> field.</p>
|
|
1890
1890
|
* @public
|
|
1891
1891
|
*/
|
|
1892
|
-
PendingDeletionWindowInDays?: number;
|
|
1892
|
+
PendingDeletionWindowInDays?: number | undefined;
|
|
1893
1893
|
/**
|
|
1894
1894
|
* <p>The message authentication code (MAC) algorithm that the HMAC KMS key supports.</p>
|
|
1895
1895
|
* <p>This value is present only when the <code>KeyUsage</code> of the KMS key is
|
|
1896
1896
|
* <code>GENERATE_VERIFY_MAC</code>.</p>
|
|
1897
1897
|
* @public
|
|
1898
1898
|
*/
|
|
1899
|
-
MacAlgorithms?: MacAlgorithmSpec[];
|
|
1899
|
+
MacAlgorithms?: MacAlgorithmSpec[] | undefined;
|
|
1900
1900
|
/**
|
|
1901
1901
|
* <p>Information about the external key that is associated with a KMS key in an external key
|
|
1902
1902
|
* store.</p>
|
|
@@ -1904,7 +1904,7 @@ export interface KeyMetadata {
|
|
|
1904
1904
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
1905
1905
|
* @public
|
|
1906
1906
|
*/
|
|
1907
|
-
XksKeyConfiguration?: XksKeyConfigurationType;
|
|
1907
|
+
XksKeyConfiguration?: XksKeyConfigurationType | undefined;
|
|
1908
1908
|
}
|
|
1909
1909
|
/**
|
|
1910
1910
|
* @public
|
|
@@ -1914,7 +1914,7 @@ export interface CreateKeyResponse {
|
|
|
1914
1914
|
* <p>Metadata associated with the KMS key.</p>
|
|
1915
1915
|
* @public
|
|
1916
1916
|
*/
|
|
1917
|
-
KeyMetadata?: KeyMetadata;
|
|
1917
|
+
KeyMetadata?: KeyMetadata | undefined;
|
|
1918
1918
|
}
|
|
1919
1919
|
/**
|
|
1920
1920
|
* <p>The request was rejected because the specified policy is not syntactically or semantically
|
|
@@ -2029,13 +2029,13 @@ export interface XksProxyConfigurationType {
|
|
|
2029
2029
|
* service to communicate with KMS.</p>
|
|
2030
2030
|
* @public
|
|
2031
2031
|
*/
|
|
2032
|
-
Connectivity?: XksProxyConnectivityType;
|
|
2032
|
+
Connectivity?: XksProxyConnectivityType | undefined;
|
|
2033
2033
|
/**
|
|
2034
2034
|
* <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
|
|
2035
2035
|
* key.</p>
|
|
2036
2036
|
* @public
|
|
2037
2037
|
*/
|
|
2038
|
-
AccessKeyId?: string;
|
|
2038
|
+
AccessKeyId?: string | undefined;
|
|
2039
2039
|
/**
|
|
2040
2040
|
* <p>The URI endpoint for the external key store proxy.</p>
|
|
2041
2041
|
* <p>If the external key store proxy has a public endpoint, it is displayed here.</p>
|
|
@@ -2043,19 +2043,19 @@ export interface XksProxyConfigurationType {
|
|
|
2043
2043
|
* the private DNS name associated with the VPC endpoint service.</p>
|
|
2044
2044
|
* @public
|
|
2045
2045
|
*/
|
|
2046
|
-
UriEndpoint?: string;
|
|
2046
|
+
UriEndpoint?: string | undefined;
|
|
2047
2047
|
/**
|
|
2048
2048
|
* <p>The path to the external key store proxy APIs.</p>
|
|
2049
2049
|
* @public
|
|
2050
2050
|
*/
|
|
2051
|
-
UriPath?: string;
|
|
2051
|
+
UriPath?: string | undefined;
|
|
2052
2052
|
/**
|
|
2053
2053
|
* <p>The Amazon VPC endpoint service used to communicate with the external key store proxy. This
|
|
2054
2054
|
* field appears only when the external key store proxy uses an Amazon VPC endpoint service to
|
|
2055
2055
|
* communicate with KMS.</p>
|
|
2056
2056
|
* @public
|
|
2057
2057
|
*/
|
|
2058
|
-
VpcEndpointServiceName?: string;
|
|
2058
|
+
VpcEndpointServiceName?: string | undefined;
|
|
2059
2059
|
}
|
|
2060
2060
|
/**
|
|
2061
2061
|
* <p>Contains information about each custom key store in the custom key store list.</p>
|
|
@@ -2066,19 +2066,19 @@ export interface CustomKeyStoresListEntry {
|
|
|
2066
2066
|
* <p>A unique identifier for the custom key store.</p>
|
|
2067
2067
|
* @public
|
|
2068
2068
|
*/
|
|
2069
|
-
CustomKeyStoreId?: string;
|
|
2069
|
+
CustomKeyStoreId?: string | undefined;
|
|
2070
2070
|
/**
|
|
2071
2071
|
* <p>The user-specified friendly name for the custom key store.</p>
|
|
2072
2072
|
* @public
|
|
2073
2073
|
*/
|
|
2074
|
-
CustomKeyStoreName?: string;
|
|
2074
|
+
CustomKeyStoreName?: string | undefined;
|
|
2075
2075
|
/**
|
|
2076
2076
|
* <p>A unique identifier for the CloudHSM cluster that is associated with an CloudHSM key store. This
|
|
2077
2077
|
* field appears only when the <code>CustomKeyStoreType</code> is
|
|
2078
2078
|
* <code>AWS_CLOUDHSM</code>.</p>
|
|
2079
2079
|
* @public
|
|
2080
2080
|
*/
|
|
2081
|
-
CloudHsmClusterId?: string;
|
|
2081
|
+
CloudHsmClusterId?: string | undefined;
|
|
2082
2082
|
/**
|
|
2083
2083
|
* <p>The trust anchor certificate of the CloudHSM cluster associated with an CloudHSM key store. When
|
|
2084
2084
|
* you <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr">initialize
|
|
@@ -2088,7 +2088,7 @@ export interface CustomKeyStoresListEntry {
|
|
|
2088
2088
|
* <code>AWS_CLOUDHSM</code>.</p>
|
|
2089
2089
|
* @public
|
|
2090
2090
|
*/
|
|
2091
|
-
TrustAnchorCertificate?: string;
|
|
2091
|
+
TrustAnchorCertificate?: string | undefined;
|
|
2092
2092
|
/**
|
|
2093
2093
|
* <p>Indicates whether the custom key store is connected to its backing key store. For an CloudHSM
|
|
2094
2094
|
* key store, the <code>ConnectionState</code> indicates whether it is connected to its CloudHSM
|
|
@@ -2110,7 +2110,7 @@ export interface CustomKeyStoresListEntry {
|
|
|
2110
2110
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2111
2111
|
* @public
|
|
2112
2112
|
*/
|
|
2113
|
-
ConnectionState?: ConnectionStateType;
|
|
2113
|
+
ConnectionState?: ConnectionStateType | undefined;
|
|
2114
2114
|
/**
|
|
2115
2115
|
* <p>Describes the connection error. This field appears in the response only when the
|
|
2116
2116
|
* <code>ConnectionState</code> is <code>FAILED</code>.</p>
|
|
@@ -2297,19 +2297,19 @@ export interface CustomKeyStoresListEntry {
|
|
|
2297
2297
|
* </ul>
|
|
2298
2298
|
* @public
|
|
2299
2299
|
*/
|
|
2300
|
-
ConnectionErrorCode?: ConnectionErrorCodeType;
|
|
2300
|
+
ConnectionErrorCode?: ConnectionErrorCodeType | undefined;
|
|
2301
2301
|
/**
|
|
2302
2302
|
* <p>The date and time when the custom key store was created.</p>
|
|
2303
2303
|
* @public
|
|
2304
2304
|
*/
|
|
2305
|
-
CreationDate?: Date;
|
|
2305
|
+
CreationDate?: Date | undefined;
|
|
2306
2306
|
/**
|
|
2307
2307
|
* <p>Indicates the type of the custom key store. <code>AWS_CLOUDHSM</code> indicates a custom
|
|
2308
2308
|
* key store backed by an CloudHSM cluster. <code>EXTERNAL_KEY_STORE</code> indicates a custom key
|
|
2309
2309
|
* store backed by an external key store proxy and external key manager outside of Amazon Web Services.</p>
|
|
2310
2310
|
* @public
|
|
2311
2311
|
*/
|
|
2312
|
-
CustomKeyStoreType?: CustomKeyStoreType;
|
|
2312
|
+
CustomKeyStoreType?: CustomKeyStoreType | undefined;
|
|
2313
2313
|
/**
|
|
2314
2314
|
* <p>Configuration settings for the external key store proxy (XKS proxy). The external key
|
|
2315
2315
|
* store proxy translates KMS requests into a format that your external key manager can
|
|
@@ -2319,7 +2319,7 @@ export interface CustomKeyStoresListEntry {
|
|
|
2319
2319
|
* <code>EXTERNAL_KEY_STORE</code>.</p>
|
|
2320
2320
|
* @public
|
|
2321
2321
|
*/
|
|
2322
|
-
XksProxyConfiguration?: XksProxyConfigurationType;
|
|
2322
|
+
XksProxyConfiguration?: XksProxyConfigurationType | undefined;
|
|
2323
2323
|
}
|
|
2324
2324
|
/**
|
|
2325
2325
|
* @public
|
|
@@ -2376,13 +2376,13 @@ export interface RecipientInfo {
|
|
|
2376
2376
|
* <code>RSAES_OAEP_SHA_256</code>.</p>
|
|
2377
2377
|
* @public
|
|
2378
2378
|
*/
|
|
2379
|
-
KeyEncryptionAlgorithm?: KeyEncryptionMechanism;
|
|
2379
|
+
KeyEncryptionAlgorithm?: KeyEncryptionMechanism | undefined;
|
|
2380
2380
|
/**
|
|
2381
2381
|
* <p>The attestation document for an Amazon Web Services Nitro Enclave. This document includes the enclave's
|
|
2382
2382
|
* public key.</p>
|
|
2383
2383
|
* @public
|
|
2384
2384
|
*/
|
|
2385
|
-
AttestationDocument?: Uint8Array;
|
|
2385
|
+
AttestationDocument?: Uint8Array | undefined;
|
|
2386
2386
|
}
|
|
2387
2387
|
/**
|
|
2388
2388
|
* @public
|
|
@@ -2403,14 +2403,14 @@ export interface DecryptRequest {
|
|
|
2403
2403
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2404
2404
|
* @public
|
|
2405
2405
|
*/
|
|
2406
|
-
EncryptionContext?: Record<string, string
|
|
2406
|
+
EncryptionContext?: Record<string, string> | undefined;
|
|
2407
2407
|
/**
|
|
2408
2408
|
* <p>A list of grant tokens. </p>
|
|
2409
2409
|
* <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
|
|
2410
2410
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2411
2411
|
* @public
|
|
2412
2412
|
*/
|
|
2413
|
-
GrantTokens?: string[];
|
|
2413
|
+
GrantTokens?: string[] | undefined;
|
|
2414
2414
|
/**
|
|
2415
2415
|
* <p>Specifies the KMS key that KMS uses to decrypt the ciphertext.</p>
|
|
2416
2416
|
* <p>Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a
|
|
@@ -2443,7 +2443,7 @@ export interface DecryptRequest {
|
|
|
2443
2443
|
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>
|
|
2444
2444
|
* @public
|
|
2445
2445
|
*/
|
|
2446
|
-
KeyId?: string;
|
|
2446
|
+
KeyId?: string | undefined;
|
|
2447
2447
|
/**
|
|
2448
2448
|
* <p>Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify
|
|
2449
2449
|
* the same algorithm that was used to encrypt the data. If you specify a different algorithm,
|
|
@@ -2453,7 +2453,7 @@ export interface DecryptRequest {
|
|
|
2453
2453
|
* algorithm that is valid for symmetric encryption KMS keys.</p>
|
|
2454
2454
|
* @public
|
|
2455
2455
|
*/
|
|
2456
|
-
EncryptionAlgorithm?: EncryptionAlgorithmSpec;
|
|
2456
|
+
EncryptionAlgorithm?: EncryptionAlgorithmSpec | undefined;
|
|
2457
2457
|
/**
|
|
2458
2458
|
* <p>A signed <a href="https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-concepts.html#term-attestdoc">attestation
|
|
2459
2459
|
* document</a> from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the
|
|
@@ -2468,13 +2468,13 @@ export interface DecryptRequest {
|
|
|
2468
2468
|
* <p>For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves uses KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2469
2469
|
* @public
|
|
2470
2470
|
*/
|
|
2471
|
-
Recipient?: RecipientInfo;
|
|
2471
|
+
Recipient?: RecipientInfo | undefined;
|
|
2472
2472
|
/**
|
|
2473
2473
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
2474
2474
|
* <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>
|
|
2475
2475
|
* @public
|
|
2476
2476
|
*/
|
|
2477
|
-
DryRun?: boolean;
|
|
2477
|
+
DryRun?: boolean | undefined;
|
|
2478
2478
|
}
|
|
2479
2479
|
/**
|
|
2480
2480
|
* @public
|
|
@@ -2484,19 +2484,19 @@ export interface DecryptResponse {
|
|
|
2484
2484
|
* <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>
|
|
2485
2485
|
* @public
|
|
2486
2486
|
*/
|
|
2487
|
-
KeyId?: string;
|
|
2487
|
+
KeyId?: string | undefined;
|
|
2488
2488
|
/**
|
|
2489
2489
|
* <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>
|
|
2490
2490
|
* <p>If the response includes the <code>CiphertextForRecipient</code> field, the
|
|
2491
2491
|
* <code>Plaintext</code> field is null or empty.</p>
|
|
2492
2492
|
* @public
|
|
2493
2493
|
*/
|
|
2494
|
-
Plaintext?: Uint8Array;
|
|
2494
|
+
Plaintext?: Uint8Array | undefined;
|
|
2495
2495
|
/**
|
|
2496
2496
|
* <p>The encryption algorithm that was used to decrypt the ciphertext.</p>
|
|
2497
2497
|
* @public
|
|
2498
2498
|
*/
|
|
2499
|
-
EncryptionAlgorithm?: EncryptionAlgorithmSpec;
|
|
2499
|
+
EncryptionAlgorithm?: EncryptionAlgorithmSpec | undefined;
|
|
2500
2500
|
/**
|
|
2501
2501
|
* <p>The plaintext data encrypted with the public key in the attestation document. </p>
|
|
2502
2502
|
* <p>This field is included in the response only when the <code>Recipient</code> parameter in
|
|
@@ -2504,7 +2504,7 @@ export interface DecryptResponse {
|
|
|
2504
2504
|
* For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves uses KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2505
2505
|
* @public
|
|
2506
2506
|
*/
|
|
2507
|
-
CiphertextForRecipient?: Uint8Array;
|
|
2507
|
+
CiphertextForRecipient?: Uint8Array | undefined;
|
|
2508
2508
|
}
|
|
2509
2509
|
/**
|
|
2510
2510
|
* <p>The request was rejected because the specified KMS key cannot decrypt the data. The
|
|
@@ -2691,13 +2691,13 @@ export interface DeriveSharedSecretRequest {
|
|
|
2691
2691
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2692
2692
|
* @public
|
|
2693
2693
|
*/
|
|
2694
|
-
GrantTokens?: string[];
|
|
2694
|
+
GrantTokens?: string[] | undefined;
|
|
2695
2695
|
/**
|
|
2696
2696
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
2697
2697
|
* <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>
|
|
2698
2698
|
* @public
|
|
2699
2699
|
*/
|
|
2700
|
-
DryRun?: boolean;
|
|
2700
|
+
DryRun?: boolean | undefined;
|
|
2701
2701
|
/**
|
|
2702
2702
|
* <p>A signed <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc">attestation document</a> from
|
|
2703
2703
|
* an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The
|
|
@@ -2717,7 +2717,7 @@ export interface DeriveSharedSecretRequest {
|
|
|
2717
2717
|
* <p>For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves uses KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2718
2718
|
* @public
|
|
2719
2719
|
*/
|
|
2720
|
-
Recipient?: RecipientInfo;
|
|
2720
|
+
Recipient?: RecipientInfo | undefined;
|
|
2721
2721
|
}
|
|
2722
2722
|
/**
|
|
2723
2723
|
* @public
|
|
@@ -2727,7 +2727,7 @@ export interface DeriveSharedSecretResponse {
|
|
|
2727
2727
|
* <p>Identifies the KMS key used to derive the shared secret.</p>
|
|
2728
2728
|
* @public
|
|
2729
2729
|
*/
|
|
2730
|
-
KeyId?: string;
|
|
2730
|
+
KeyId?: string | undefined;
|
|
2731
2731
|
/**
|
|
2732
2732
|
* <p>The raw secret derived from the specified key agreement algorithm, private key in the
|
|
2733
2733
|
* asymmetric KMS key, and your peer's public key.</p>
|
|
@@ -2735,7 +2735,7 @@ export interface DeriveSharedSecretResponse {
|
|
|
2735
2735
|
* empty.</p>
|
|
2736
2736
|
* @public
|
|
2737
2737
|
*/
|
|
2738
|
-
SharedSecret?: Uint8Array;
|
|
2738
|
+
SharedSecret?: Uint8Array | undefined;
|
|
2739
2739
|
/**
|
|
2740
2740
|
* <p>The plaintext shared secret encrypted with the public key in the attestation document.</p>
|
|
2741
2741
|
* <p>This field is included in the response only when the <code>Recipient</code> parameter in
|
|
@@ -2743,12 +2743,12 @@ export interface DeriveSharedSecretResponse {
|
|
|
2743
2743
|
* For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves uses KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2744
2744
|
* @public
|
|
2745
2745
|
*/
|
|
2746
|
-
CiphertextForRecipient?: Uint8Array;
|
|
2746
|
+
CiphertextForRecipient?: Uint8Array | undefined;
|
|
2747
2747
|
/**
|
|
2748
2748
|
* <p>Identifies the key agreement algorithm used to derive the shared secret.</p>
|
|
2749
2749
|
* @public
|
|
2750
2750
|
*/
|
|
2751
|
-
KeyAgreementAlgorithm?: KeyAgreementAlgorithmSpec;
|
|
2751
|
+
KeyAgreementAlgorithm?: KeyAgreementAlgorithmSpec | undefined;
|
|
2752
2752
|
/**
|
|
2753
2753
|
* <p>The source of the key material for the specified KMS key.</p>
|
|
2754
2754
|
* <p>When this value is <code>AWS_KMS</code>, KMS created the key material. When this value is <code>EXTERNAL</code>,
|
|
@@ -2758,7 +2758,7 @@ export interface DeriveSharedSecretResponse {
|
|
|
2758
2758
|
* <code>EXTERNAL_KEY_STORE</code>.</p>
|
|
2759
2759
|
* @public
|
|
2760
2760
|
*/
|
|
2761
|
-
KeyOrigin?: OriginType;
|
|
2761
|
+
KeyOrigin?: OriginType | undefined;
|
|
2762
2762
|
}
|
|
2763
2763
|
/**
|
|
2764
2764
|
* @public
|
|
@@ -2772,7 +2772,7 @@ export interface DescribeCustomKeyStoresRequest {
|
|
|
2772
2772
|
* both.</p>
|
|
2773
2773
|
* @public
|
|
2774
2774
|
*/
|
|
2775
|
-
CustomKeyStoreId?: string;
|
|
2775
|
+
CustomKeyStoreId?: string | undefined;
|
|
2776
2776
|
/**
|
|
2777
2777
|
* <p>Gets only information about the specified custom key store. Enter the friendly name of the
|
|
2778
2778
|
* custom key store.</p>
|
|
@@ -2782,21 +2782,21 @@ export interface DescribeCustomKeyStoresRequest {
|
|
|
2782
2782
|
* both.</p>
|
|
2783
2783
|
* @public
|
|
2784
2784
|
*/
|
|
2785
|
-
CustomKeyStoreName?: string;
|
|
2785
|
+
CustomKeyStoreName?: string | undefined;
|
|
2786
2786
|
/**
|
|
2787
2787
|
* <p>Use this parameter to specify the maximum number of items to return. When this
|
|
2788
2788
|
* value is present, KMS does not return more than the specified number of items, but it might
|
|
2789
2789
|
* return fewer.</p>
|
|
2790
2790
|
* @public
|
|
2791
2791
|
*/
|
|
2792
|
-
Limit?: number;
|
|
2792
|
+
Limit?: number | undefined;
|
|
2793
2793
|
/**
|
|
2794
2794
|
* <p>Use this parameter in a subsequent request after you receive a response with
|
|
2795
2795
|
* truncated results. Set it to the value of <code>NextMarker</code> from the truncated response
|
|
2796
2796
|
* you just received.</p>
|
|
2797
2797
|
* @public
|
|
2798
2798
|
*/
|
|
2799
|
-
Marker?: string;
|
|
2799
|
+
Marker?: string | undefined;
|
|
2800
2800
|
}
|
|
2801
2801
|
/**
|
|
2802
2802
|
* @public
|
|
@@ -2806,13 +2806,13 @@ export interface DescribeCustomKeyStoresResponse {
|
|
|
2806
2806
|
* <p>Contains metadata about each custom key store.</p>
|
|
2807
2807
|
* @public
|
|
2808
2808
|
*/
|
|
2809
|
-
CustomKeyStores?: CustomKeyStoresListEntry[];
|
|
2809
|
+
CustomKeyStores?: CustomKeyStoresListEntry[] | undefined;
|
|
2810
2810
|
/**
|
|
2811
2811
|
* <p>When <code>Truncated</code> is true, this element is present and contains the
|
|
2812
2812
|
* value to use for the <code>Marker</code> parameter in a subsequent request.</p>
|
|
2813
2813
|
* @public
|
|
2814
2814
|
*/
|
|
2815
|
-
NextMarker?: string;
|
|
2815
|
+
NextMarker?: string | undefined;
|
|
2816
2816
|
/**
|
|
2817
2817
|
* <p>A flag that indicates whether there are more items in the list. When this
|
|
2818
2818
|
* value is true, the list in this response is truncated. To get more items, pass the value of
|
|
@@ -2820,7 +2820,7 @@ export interface DescribeCustomKeyStoresResponse {
|
|
|
2820
2820
|
* subsequent request.</p>
|
|
2821
2821
|
* @public
|
|
2822
2822
|
*/
|
|
2823
|
-
Truncated?: boolean;
|
|
2823
|
+
Truncated?: boolean | undefined;
|
|
2824
2824
|
}
|
|
2825
2825
|
/**
|
|
2826
2826
|
* <p>The request was rejected because the marker that specifies where pagination should next
|
|
@@ -2874,7 +2874,7 @@ export interface DescribeKeyRequest {
|
|
|
2874
2874
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2875
2875
|
* @public
|
|
2876
2876
|
*/
|
|
2877
|
-
GrantTokens?: string[];
|
|
2877
|
+
GrantTokens?: string[] | undefined;
|
|
2878
2878
|
}
|
|
2879
2879
|
/**
|
|
2880
2880
|
* @public
|
|
@@ -2884,7 +2884,7 @@ export interface DescribeKeyResponse {
|
|
|
2884
2884
|
* <p>Metadata associated with the key.</p>
|
|
2885
2885
|
* @public
|
|
2886
2886
|
*/
|
|
2887
|
-
KeyMetadata?: KeyMetadata;
|
|
2887
|
+
KeyMetadata?: KeyMetadata | undefined;
|
|
2888
2888
|
}
|
|
2889
2889
|
/**
|
|
2890
2890
|
* @public
|
|
@@ -3008,7 +3008,7 @@ export interface EnableKeyRotationRequest {
|
|
|
3008
3008
|
* <p> </p>
|
|
3009
3009
|
* @public
|
|
3010
3010
|
*/
|
|
3011
|
-
RotationPeriodInDays?: number;
|
|
3011
|
+
RotationPeriodInDays?: number | undefined;
|
|
3012
3012
|
}
|
|
3013
3013
|
/**
|
|
3014
3014
|
* @public
|
|
@@ -3060,14 +3060,14 @@ export interface EncryptRequest {
|
|
|
3060
3060
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3061
3061
|
* @public
|
|
3062
3062
|
*/
|
|
3063
|
-
EncryptionContext?: Record<string, string
|
|
3063
|
+
EncryptionContext?: Record<string, string> | undefined;
|
|
3064
3064
|
/**
|
|
3065
3065
|
* <p>A list of grant tokens.</p>
|
|
3066
3066
|
* <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
|
|
3067
3067
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
3068
3068
|
* @public
|
|
3069
3069
|
*/
|
|
3070
|
-
GrantTokens?: string[];
|
|
3070
|
+
GrantTokens?: string[] | undefined;
|
|
3071
3071
|
/**
|
|
3072
3072
|
* <p>Specifies the encryption algorithm that KMS will use to encrypt the plaintext message.
|
|
3073
3073
|
* The algorithm must be compatible with the KMS key that you specify.</p>
|
|
@@ -3077,13 +3077,13 @@ export interface EncryptRequest {
|
|
|
3077
3077
|
* <p>The SM2PKE algorithm is only available in China Regions.</p>
|
|
3078
3078
|
* @public
|
|
3079
3079
|
*/
|
|
3080
|
-
EncryptionAlgorithm?: EncryptionAlgorithmSpec;
|
|
3080
|
+
EncryptionAlgorithm?: EncryptionAlgorithmSpec | undefined;
|
|
3081
3081
|
/**
|
|
3082
3082
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
3083
3083
|
* <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>
|
|
3084
3084
|
* @public
|
|
3085
3085
|
*/
|
|
3086
|
-
DryRun?: boolean;
|
|
3086
|
+
DryRun?: boolean | undefined;
|
|
3087
3087
|
}
|
|
3088
3088
|
/**
|
|
3089
3089
|
* @public
|
|
@@ -3093,17 +3093,17 @@ export interface EncryptResponse {
|
|
|
3093
3093
|
* <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>
|
|
3094
3094
|
* @public
|
|
3095
3095
|
*/
|
|
3096
|
-
CiphertextBlob?: Uint8Array;
|
|
3096
|
+
CiphertextBlob?: Uint8Array | undefined;
|
|
3097
3097
|
/**
|
|
3098
3098
|
* <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>
|
|
3099
3099
|
* @public
|
|
3100
3100
|
*/
|
|
3101
|
-
KeyId?: string;
|
|
3101
|
+
KeyId?: string | undefined;
|
|
3102
3102
|
/**
|
|
3103
3103
|
* <p>The encryption algorithm that was used to encrypt the plaintext.</p>
|
|
3104
3104
|
* @public
|
|
3105
3105
|
*/
|
|
3106
|
-
EncryptionAlgorithm?: EncryptionAlgorithmSpec;
|
|
3106
|
+
EncryptionAlgorithm?: EncryptionAlgorithmSpec | undefined;
|
|
3107
3107
|
}
|
|
3108
3108
|
/**
|
|
3109
3109
|
* <p>The request was rejected because the specified import token is expired. Use <a>GetParametersForImport</a> to get a new import token and public key, use the new
|
|
@@ -3162,7 +3162,7 @@ export interface GenerateDataKeyRequest {
|
|
|
3162
3162
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3163
3163
|
* @public
|
|
3164
3164
|
*/
|
|
3165
|
-
EncryptionContext?: Record<string, string
|
|
3165
|
+
EncryptionContext?: Record<string, string> | undefined;
|
|
3166
3166
|
/**
|
|
3167
3167
|
* <p>Specifies the length of the data key in bytes. For example, use the value 64 to generate a
|
|
3168
3168
|
* 512-bit data key (64 bytes is 512 bits). For 128-bit (16-byte) and 256-bit (32-byte) data
|
|
@@ -3171,7 +3171,7 @@ export interface GenerateDataKeyRequest {
|
|
|
3171
3171
|
* parameter (but not both) in every <code>GenerateDataKey</code> request.</p>
|
|
3172
3172
|
* @public
|
|
3173
3173
|
*/
|
|
3174
|
-
NumberOfBytes?: number;
|
|
3174
|
+
NumberOfBytes?: number | undefined;
|
|
3175
3175
|
/**
|
|
3176
3176
|
* <p>Specifies the length of the data key. Use <code>AES_128</code> to generate a 128-bit
|
|
3177
3177
|
* symmetric key, or <code>AES_256</code> to generate a 256-bit symmetric key.</p>
|
|
@@ -3179,14 +3179,14 @@ export interface GenerateDataKeyRequest {
|
|
|
3179
3179
|
* parameter (but not both) in every <code>GenerateDataKey</code> request.</p>
|
|
3180
3180
|
* @public
|
|
3181
3181
|
*/
|
|
3182
|
-
KeySpec?: DataKeySpec;
|
|
3182
|
+
KeySpec?: DataKeySpec | undefined;
|
|
3183
3183
|
/**
|
|
3184
3184
|
* <p>A list of grant tokens.</p>
|
|
3185
3185
|
* <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
|
|
3186
3186
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
3187
3187
|
* @public
|
|
3188
3188
|
*/
|
|
3189
|
-
GrantTokens?: string[];
|
|
3189
|
+
GrantTokens?: string[] | undefined;
|
|
3190
3190
|
/**
|
|
3191
3191
|
* <p>A signed <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc">attestation document</a> from
|
|
3192
3192
|
* an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The
|
|
@@ -3203,13 +3203,13 @@ export interface GenerateDataKeyRequest {
|
|
|
3203
3203
|
* <p>For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves uses KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3204
3204
|
* @public
|
|
3205
3205
|
*/
|
|
3206
|
-
Recipient?: RecipientInfo;
|
|
3206
|
+
Recipient?: RecipientInfo | undefined;
|
|
3207
3207
|
/**
|
|
3208
3208
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
3209
3209
|
* <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>
|
|
3210
3210
|
* @public
|
|
3211
3211
|
*/
|
|
3212
|
-
DryRun?: boolean;
|
|
3212
|
+
DryRun?: boolean | undefined;
|
|
3213
3213
|
}
|
|
3214
3214
|
/**
|
|
3215
3215
|
* @public
|
|
@@ -3219,7 +3219,7 @@ export interface GenerateDataKeyResponse {
|
|
|
3219
3219
|
* <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>
|
|
3220
3220
|
* @public
|
|
3221
3221
|
*/
|
|
3222
|
-
CiphertextBlob?: Uint8Array;
|
|
3222
|
+
CiphertextBlob?: Uint8Array | undefined;
|
|
3223
3223
|
/**
|
|
3224
3224
|
* <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
|
|
3225
3225
|
* KMS. Then, remove it from memory as soon as possible.</p>
|
|
@@ -3227,12 +3227,12 @@ export interface GenerateDataKeyResponse {
|
|
|
3227
3227
|
* <code>Plaintext</code> field is null or empty.</p>
|
|
3228
3228
|
* @public
|
|
3229
3229
|
*/
|
|
3230
|
-
Plaintext?: Uint8Array;
|
|
3230
|
+
Plaintext?: Uint8Array | undefined;
|
|
3231
3231
|
/**
|
|
3232
3232
|
* <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>
|
|
3233
3233
|
* @public
|
|
3234
3234
|
*/
|
|
3235
|
-
KeyId?: string;
|
|
3235
|
+
KeyId?: string | undefined;
|
|
3236
3236
|
/**
|
|
3237
3237
|
* <p>The plaintext data key encrypted with the public key from the Nitro enclave. This
|
|
3238
3238
|
* ciphertext can be decrypted only by using a private key in the Nitro enclave. </p>
|
|
@@ -3241,7 +3241,7 @@ export interface GenerateDataKeyResponse {
|
|
|
3241
3241
|
* For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves uses KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3242
3242
|
* @public
|
|
3243
3243
|
*/
|
|
3244
|
-
CiphertextForRecipient?: Uint8Array;
|
|
3244
|
+
CiphertextForRecipient?: Uint8Array | undefined;
|
|
3245
3245
|
}
|
|
3246
3246
|
/**
|
|
3247
3247
|
* @public
|
|
@@ -3260,7 +3260,7 @@ export interface GenerateDataKeyPairRequest {
|
|
|
3260
3260
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3261
3261
|
* @public
|
|
3262
3262
|
*/
|
|
3263
|
-
EncryptionContext?: Record<string, string
|
|
3263
|
+
EncryptionContext?: Record<string, string> | undefined;
|
|
3264
3264
|
/**
|
|
3265
3265
|
* <p>Specifies the symmetric encryption KMS key that encrypts the private key in the data key
|
|
3266
3266
|
* pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the
|
|
@@ -3301,7 +3301,7 @@ export interface GenerateDataKeyPairRequest {
|
|
|
3301
3301
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
3302
3302
|
* @public
|
|
3303
3303
|
*/
|
|
3304
|
-
GrantTokens?: string[];
|
|
3304
|
+
GrantTokens?: string[] | undefined;
|
|
3305
3305
|
/**
|
|
3306
3306
|
* <p>A signed <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc">attestation document</a> from
|
|
3307
3307
|
* an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The
|
|
@@ -3320,13 +3320,13 @@ export interface GenerateDataKeyPairRequest {
|
|
|
3320
3320
|
* <p>For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves uses KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3321
3321
|
* @public
|
|
3322
3322
|
*/
|
|
3323
|
-
Recipient?: RecipientInfo;
|
|
3323
|
+
Recipient?: RecipientInfo | undefined;
|
|
3324
3324
|
/**
|
|
3325
3325
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
3326
3326
|
* <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>
|
|
3327
3327
|
* @public
|
|
3328
3328
|
*/
|
|
3329
|
-
DryRun?: boolean;
|
|
3329
|
+
DryRun?: boolean | undefined;
|
|
3330
3330
|
}
|
|
3331
3331
|
/**
|
|
3332
3332
|
* @public
|
|
@@ -3336,29 +3336,29 @@ export interface GenerateDataKeyPairResponse {
|
|
|
3336
3336
|
* <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>
|
|
3337
3337
|
* @public
|
|
3338
3338
|
*/
|
|
3339
|
-
PrivateKeyCiphertextBlob?: Uint8Array;
|
|
3339
|
+
PrivateKeyCiphertextBlob?: Uint8Array | undefined;
|
|
3340
3340
|
/**
|
|
3341
3341
|
* <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>
|
|
3342
3342
|
* <p>If the response includes the <code>CiphertextForRecipient</code> field, the
|
|
3343
3343
|
* <code>PrivateKeyPlaintext</code> field is null or empty.</p>
|
|
3344
3344
|
* @public
|
|
3345
3345
|
*/
|
|
3346
|
-
PrivateKeyPlaintext?: Uint8Array;
|
|
3346
|
+
PrivateKeyPlaintext?: Uint8Array | undefined;
|
|
3347
3347
|
/**
|
|
3348
3348
|
* <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>
|
|
3349
3349
|
* @public
|
|
3350
3350
|
*/
|
|
3351
|
-
PublicKey?: Uint8Array;
|
|
3351
|
+
PublicKey?: Uint8Array | undefined;
|
|
3352
3352
|
/**
|
|
3353
3353
|
* <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>
|
|
3354
3354
|
* @public
|
|
3355
3355
|
*/
|
|
3356
|
-
KeyId?: string;
|
|
3356
|
+
KeyId?: string | undefined;
|
|
3357
3357
|
/**
|
|
3358
3358
|
* <p>The type of data key pair that was generated.</p>
|
|
3359
3359
|
* @public
|
|
3360
3360
|
*/
|
|
3361
|
-
KeyPairSpec?: DataKeyPairSpec;
|
|
3361
|
+
KeyPairSpec?: DataKeyPairSpec | undefined;
|
|
3362
3362
|
/**
|
|
3363
3363
|
* <p>The plaintext private data key encrypted with the public key from the Nitro enclave. This
|
|
3364
3364
|
* ciphertext can be decrypted only by using a private key in the Nitro enclave. </p>
|
|
@@ -3367,7 +3367,7 @@ export interface GenerateDataKeyPairResponse {
|
|
|
3367
3367
|
* For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves uses KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3368
3368
|
* @public
|
|
3369
3369
|
*/
|
|
3370
|
-
CiphertextForRecipient?: Uint8Array;
|
|
3370
|
+
CiphertextForRecipient?: Uint8Array | undefined;
|
|
3371
3371
|
}
|
|
3372
3372
|
/**
|
|
3373
3373
|
* @public
|
|
@@ -3386,7 +3386,7 @@ export interface GenerateDataKeyPairWithoutPlaintextRequest {
|
|
|
3386
3386
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3387
3387
|
* @public
|
|
3388
3388
|
*/
|
|
3389
|
-
EncryptionContext?: Record<string, string
|
|
3389
|
+
EncryptionContext?: Record<string, string> | undefined;
|
|
3390
3390
|
/**
|
|
3391
3391
|
* <p>Specifies the symmetric encryption KMS key that encrypts the private key in the data key
|
|
3392
3392
|
* pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the
|
|
@@ -3427,13 +3427,13 @@ export interface GenerateDataKeyPairWithoutPlaintextRequest {
|
|
|
3427
3427
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
3428
3428
|
* @public
|
|
3429
3429
|
*/
|
|
3430
|
-
GrantTokens?: string[];
|
|
3430
|
+
GrantTokens?: string[] | undefined;
|
|
3431
3431
|
/**
|
|
3432
3432
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
3433
3433
|
* <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>
|
|
3434
3434
|
* @public
|
|
3435
3435
|
*/
|
|
3436
|
-
DryRun?: boolean;
|
|
3436
|
+
DryRun?: boolean | undefined;
|
|
3437
3437
|
}
|
|
3438
3438
|
/**
|
|
3439
3439
|
* @public
|
|
@@ -3443,22 +3443,22 @@ export interface GenerateDataKeyPairWithoutPlaintextResponse {
|
|
|
3443
3443
|
* <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>
|
|
3444
3444
|
* @public
|
|
3445
3445
|
*/
|
|
3446
|
-
PrivateKeyCiphertextBlob?: Uint8Array;
|
|
3446
|
+
PrivateKeyCiphertextBlob?: Uint8Array | undefined;
|
|
3447
3447
|
/**
|
|
3448
3448
|
* <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>
|
|
3449
3449
|
* @public
|
|
3450
3450
|
*/
|
|
3451
|
-
PublicKey?: Uint8Array;
|
|
3451
|
+
PublicKey?: Uint8Array | undefined;
|
|
3452
3452
|
/**
|
|
3453
3453
|
* <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>
|
|
3454
3454
|
* @public
|
|
3455
3455
|
*/
|
|
3456
|
-
KeyId?: string;
|
|
3456
|
+
KeyId?: string | undefined;
|
|
3457
3457
|
/**
|
|
3458
3458
|
* <p>The type of data key pair that was generated.</p>
|
|
3459
3459
|
* @public
|
|
3460
3460
|
*/
|
|
3461
|
-
KeyPairSpec?: DataKeyPairSpec;
|
|
3461
|
+
KeyPairSpec?: DataKeyPairSpec | undefined;
|
|
3462
3462
|
}
|
|
3463
3463
|
/**
|
|
3464
3464
|
* @public
|
|
@@ -3504,33 +3504,33 @@ export interface GenerateDataKeyWithoutPlaintextRequest {
|
|
|
3504
3504
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3505
3505
|
* @public
|
|
3506
3506
|
*/
|
|
3507
|
-
EncryptionContext?: Record<string, string
|
|
3507
|
+
EncryptionContext?: Record<string, string> | undefined;
|
|
3508
3508
|
/**
|
|
3509
3509
|
* <p>The length of the data key. Use <code>AES_128</code> to generate a 128-bit symmetric key,
|
|
3510
3510
|
* or <code>AES_256</code> to generate a 256-bit symmetric key.</p>
|
|
3511
3511
|
* @public
|
|
3512
3512
|
*/
|
|
3513
|
-
KeySpec?: DataKeySpec;
|
|
3513
|
+
KeySpec?: DataKeySpec | undefined;
|
|
3514
3514
|
/**
|
|
3515
3515
|
* <p>The length of the data key in bytes. For example, use the value 64 to generate a 512-bit
|
|
3516
3516
|
* data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys),
|
|
3517
3517
|
* we recommend that you use the <code>KeySpec</code> field instead of this one.</p>
|
|
3518
3518
|
* @public
|
|
3519
3519
|
*/
|
|
3520
|
-
NumberOfBytes?: number;
|
|
3520
|
+
NumberOfBytes?: number | undefined;
|
|
3521
3521
|
/**
|
|
3522
3522
|
* <p>A list of grant tokens.</p>
|
|
3523
3523
|
* <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
|
|
3524
3524
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
3525
3525
|
* @public
|
|
3526
3526
|
*/
|
|
3527
|
-
GrantTokens?: string[];
|
|
3527
|
+
GrantTokens?: string[] | undefined;
|
|
3528
3528
|
/**
|
|
3529
3529
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
3530
3530
|
* <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>
|
|
3531
3531
|
* @public
|
|
3532
3532
|
*/
|
|
3533
|
-
DryRun?: boolean;
|
|
3533
|
+
DryRun?: boolean | undefined;
|
|
3534
3534
|
}
|
|
3535
3535
|
/**
|
|
3536
3536
|
* @public
|
|
@@ -3540,12 +3540,12 @@ export interface GenerateDataKeyWithoutPlaintextResponse {
|
|
|
3540
3540
|
* <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>
|
|
3541
3541
|
* @public
|
|
3542
3542
|
*/
|
|
3543
|
-
CiphertextBlob?: Uint8Array;
|
|
3543
|
+
CiphertextBlob?: Uint8Array | undefined;
|
|
3544
3544
|
/**
|
|
3545
3545
|
* <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>
|
|
3546
3546
|
* @public
|
|
3547
3547
|
*/
|
|
3548
|
-
KeyId?: string;
|
|
3548
|
+
KeyId?: string | undefined;
|
|
3549
3549
|
}
|
|
3550
3550
|
/**
|
|
3551
3551
|
* @public
|
|
@@ -3582,13 +3582,13 @@ export interface GenerateMacRequest {
|
|
|
3582
3582
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
3583
3583
|
* @public
|
|
3584
3584
|
*/
|
|
3585
|
-
GrantTokens?: string[];
|
|
3585
|
+
GrantTokens?: string[] | undefined;
|
|
3586
3586
|
/**
|
|
3587
3587
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
3588
3588
|
* <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>
|
|
3589
3589
|
* @public
|
|
3590
3590
|
*/
|
|
3591
|
-
DryRun?: boolean;
|
|
3591
|
+
DryRun?: boolean | undefined;
|
|
3592
3592
|
}
|
|
3593
3593
|
/**
|
|
3594
3594
|
* @public
|
|
@@ -3600,17 +3600,17 @@ export interface GenerateMacResponse {
|
|
|
3600
3600
|
* <p>This is the standard, raw HMAC defined in <a href="https://datatracker.ietf.org/doc/html/rfc2104">RFC 2104</a>.</p>
|
|
3601
3601
|
* @public
|
|
3602
3602
|
*/
|
|
3603
|
-
Mac?: Uint8Array;
|
|
3603
|
+
Mac?: Uint8Array | undefined;
|
|
3604
3604
|
/**
|
|
3605
3605
|
* <p>The MAC algorithm that was used to generate the HMAC.</p>
|
|
3606
3606
|
* @public
|
|
3607
3607
|
*/
|
|
3608
|
-
MacAlgorithm?: MacAlgorithmSpec;
|
|
3608
|
+
MacAlgorithm?: MacAlgorithmSpec | undefined;
|
|
3609
3609
|
/**
|
|
3610
3610
|
* <p>The HMAC KMS key used in the operation.</p>
|
|
3611
3611
|
* @public
|
|
3612
3612
|
*/
|
|
3613
|
-
KeyId?: string;
|
|
3613
|
+
KeyId?: string | undefined;
|
|
3614
3614
|
}
|
|
3615
3615
|
/**
|
|
3616
3616
|
* @public
|
|
@@ -3620,7 +3620,7 @@ export interface GenerateRandomRequest {
|
|
|
3620
3620
|
* <p>The length of the random byte string. This parameter is required.</p>
|
|
3621
3621
|
* @public
|
|
3622
3622
|
*/
|
|
3623
|
-
NumberOfBytes?: number;
|
|
3623
|
+
NumberOfBytes?: number | undefined;
|
|
3624
3624
|
/**
|
|
3625
3625
|
* <p>Generates the random byte string in the CloudHSM cluster that is associated with the
|
|
3626
3626
|
* specified CloudHSM key store. To find the ID of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p>
|
|
@@ -3629,7 +3629,7 @@ export interface GenerateRandomRequest {
|
|
|
3629
3629
|
* <code>UnsupportedOperationException</code>.</p>
|
|
3630
3630
|
* @public
|
|
3631
3631
|
*/
|
|
3632
|
-
CustomKeyStoreId?: string;
|
|
3632
|
+
CustomKeyStoreId?: string | undefined;
|
|
3633
3633
|
/**
|
|
3634
3634
|
* <p>A signed <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc">attestation document</a> from
|
|
3635
3635
|
* an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The
|
|
@@ -3644,7 +3644,7 @@ export interface GenerateRandomRequest {
|
|
|
3644
3644
|
* <p>For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves uses KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3645
3645
|
* @public
|
|
3646
3646
|
*/
|
|
3647
|
-
Recipient?: RecipientInfo;
|
|
3647
|
+
Recipient?: RecipientInfo | undefined;
|
|
3648
3648
|
}
|
|
3649
3649
|
/**
|
|
3650
3650
|
* @public
|
|
@@ -3656,7 +3656,7 @@ export interface GenerateRandomResponse {
|
|
|
3656
3656
|
* <code>Plaintext</code> field is null or empty.</p>
|
|
3657
3657
|
* @public
|
|
3658
3658
|
*/
|
|
3659
|
-
Plaintext?: Uint8Array;
|
|
3659
|
+
Plaintext?: Uint8Array | undefined;
|
|
3660
3660
|
/**
|
|
3661
3661
|
* <p>The plaintext random bytes encrypted with the public key from the Nitro enclave. This
|
|
3662
3662
|
* ciphertext can be decrypted only by using a private key in the Nitro enclave. </p>
|
|
@@ -3665,7 +3665,7 @@ export interface GenerateRandomResponse {
|
|
|
3665
3665
|
* For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves uses KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3666
3666
|
* @public
|
|
3667
3667
|
*/
|
|
3668
|
-
CiphertextForRecipient?: Uint8Array;
|
|
3668
|
+
CiphertextForRecipient?: Uint8Array | undefined;
|
|
3669
3669
|
}
|
|
3670
3670
|
/**
|
|
3671
3671
|
* @public
|
|
@@ -3694,7 +3694,7 @@ export interface GetKeyPolicyRequest {
|
|
|
3694
3694
|
* the names of key policies, use <a>ListKeyPolicies</a>.</p>
|
|
3695
3695
|
* @public
|
|
3696
3696
|
*/
|
|
3697
|
-
PolicyName?: string;
|
|
3697
|
+
PolicyName?: string | undefined;
|
|
3698
3698
|
}
|
|
3699
3699
|
/**
|
|
3700
3700
|
* @public
|
|
@@ -3704,12 +3704,12 @@ export interface GetKeyPolicyResponse {
|
|
|
3704
3704
|
* <p>A key policy document in JSON format.</p>
|
|
3705
3705
|
* @public
|
|
3706
3706
|
*/
|
|
3707
|
-
Policy?: string;
|
|
3707
|
+
Policy?: string | undefined;
|
|
3708
3708
|
/**
|
|
3709
3709
|
* <p>The name of the key policy. The only valid value is <code>default</code>.</p>
|
|
3710
3710
|
* @public
|
|
3711
3711
|
*/
|
|
3712
|
-
PolicyName?: string;
|
|
3712
|
+
PolicyName?: string | undefined;
|
|
3713
3713
|
}
|
|
3714
3714
|
/**
|
|
3715
3715
|
* @public
|
|
@@ -3743,22 +3743,22 @@ export interface GetKeyRotationStatusResponse {
|
|
|
3743
3743
|
* <p>A Boolean value that specifies whether key rotation is enabled.</p>
|
|
3744
3744
|
* @public
|
|
3745
3745
|
*/
|
|
3746
|
-
KeyRotationEnabled?: boolean;
|
|
3746
|
+
KeyRotationEnabled?: boolean | undefined;
|
|
3747
3747
|
/**
|
|
3748
3748
|
* <p>Identifies the specified symmetric encryption KMS key.</p>
|
|
3749
3749
|
* @public
|
|
3750
3750
|
*/
|
|
3751
|
-
KeyId?: string;
|
|
3751
|
+
KeyId?: string | undefined;
|
|
3752
3752
|
/**
|
|
3753
3753
|
* <p>The number of days between each automatic rotation. The default value is 365 days.</p>
|
|
3754
3754
|
* @public
|
|
3755
3755
|
*/
|
|
3756
|
-
RotationPeriodInDays?: number;
|
|
3756
|
+
RotationPeriodInDays?: number | undefined;
|
|
3757
3757
|
/**
|
|
3758
3758
|
* <p>The next date that KMS will automatically rotate the key material.</p>
|
|
3759
3759
|
* @public
|
|
3760
3760
|
*/
|
|
3761
|
-
NextRotationDate?: Date;
|
|
3761
|
+
NextRotationDate?: Date | undefined;
|
|
3762
3762
|
/**
|
|
3763
3763
|
* <p>Identifies the date and time that an in progress on-demand rotation was initiated.</p>
|
|
3764
3764
|
* <p>The KMS API follows an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">eventual consistency</a> model
|
|
@@ -3768,7 +3768,7 @@ export interface GetKeyRotationStatusResponse {
|
|
|
3768
3768
|
* on-demand rotation.</p>
|
|
3769
3769
|
* @public
|
|
3770
3770
|
*/
|
|
3771
|
-
OnDemandRotationStartDate?: Date;
|
|
3771
|
+
OnDemandRotationStartDate?: Date | undefined;
|
|
3772
3772
|
}
|
|
3773
3773
|
/**
|
|
3774
3774
|
* @public
|
|
@@ -3870,25 +3870,25 @@ export interface GetParametersForImportResponse {
|
|
|
3870
3870
|
* request.</p>
|
|
3871
3871
|
* @public
|
|
3872
3872
|
*/
|
|
3873
|
-
KeyId?: string;
|
|
3873
|
+
KeyId?: string | undefined;
|
|
3874
3874
|
/**
|
|
3875
3875
|
* <p>The import token to send in a subsequent <a>ImportKeyMaterial</a>
|
|
3876
3876
|
* request.</p>
|
|
3877
3877
|
* @public
|
|
3878
3878
|
*/
|
|
3879
|
-
ImportToken?: Uint8Array;
|
|
3879
|
+
ImportToken?: Uint8Array | undefined;
|
|
3880
3880
|
/**
|
|
3881
3881
|
* <p>The public key to use to encrypt the key material before importing it with <a>ImportKeyMaterial</a>.</p>
|
|
3882
3882
|
* @public
|
|
3883
3883
|
*/
|
|
3884
|
-
PublicKey?: Uint8Array;
|
|
3884
|
+
PublicKey?: Uint8Array | undefined;
|
|
3885
3885
|
/**
|
|
3886
3886
|
* <p>The time at which the import token and public key are no longer valid. After this time,
|
|
3887
3887
|
* you cannot use them to make an <a>ImportKeyMaterial</a> request and you must send
|
|
3888
3888
|
* another <code>GetParametersForImport</code> request to get new ones.</p>
|
|
3889
3889
|
* @public
|
|
3890
3890
|
*/
|
|
3891
|
-
ParametersValidTo?: Date;
|
|
3891
|
+
ParametersValidTo?: Date | undefined;
|
|
3892
3892
|
}
|
|
3893
3893
|
/**
|
|
3894
3894
|
* @public
|
|
@@ -3926,7 +3926,7 @@ export interface GetPublicKeyRequest {
|
|
|
3926
3926
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
3927
3927
|
* @public
|
|
3928
3928
|
*/
|
|
3929
|
-
GrantTokens?: string[];
|
|
3929
|
+
GrantTokens?: string[] | undefined;
|
|
3930
3930
|
}
|
|
3931
3931
|
/**
|
|
3932
3932
|
* @public
|
|
@@ -3937,7 +3937,7 @@ export interface GetPublicKeyResponse {
|
|
|
3937
3937
|
* downloaded.</p>
|
|
3938
3938
|
* @public
|
|
3939
3939
|
*/
|
|
3940
|
-
KeyId?: string;
|
|
3940
|
+
KeyId?: string | undefined;
|
|
3941
3941
|
/**
|
|
3942
3942
|
* <p>The exported public key. </p>
|
|
3943
3943
|
* <p>The value is a DER-encoded X.509 public key, also known as
|
|
@@ -3945,7 +3945,7 @@ export interface GetPublicKeyResponse {
|
|
|
3945
3945
|
* <p></p>
|
|
3946
3946
|
* @public
|
|
3947
3947
|
*/
|
|
3948
|
-
PublicKey?: Uint8Array;
|
|
3948
|
+
PublicKey?: Uint8Array | undefined;
|
|
3949
3949
|
/**
|
|
3950
3950
|
* @deprecated
|
|
3951
3951
|
*
|
|
@@ -3956,12 +3956,12 @@ export interface GetPublicKeyResponse {
|
|
|
3956
3956
|
* avoid breaking changes, KMS supports both fields.</p>
|
|
3957
3957
|
* @public
|
|
3958
3958
|
*/
|
|
3959
|
-
CustomerMasterKeySpec?: CustomerMasterKeySpec;
|
|
3959
|
+
CustomerMasterKeySpec?: CustomerMasterKeySpec | undefined;
|
|
3960
3960
|
/**
|
|
3961
3961
|
* <p>The type of the of the public key that was downloaded.</p>
|
|
3962
3962
|
* @public
|
|
3963
3963
|
*/
|
|
3964
|
-
KeySpec?: KeySpec;
|
|
3964
|
+
KeySpec?: KeySpec | undefined;
|
|
3965
3965
|
/**
|
|
3966
3966
|
* <p>The permitted use of the public key. Valid values for asymmetric key pairs are <code>ENCRYPT_DECRYPT</code>,
|
|
3967
3967
|
* <code>SIGN_VERIFY</code>, and <code>KEY_AGREEMENT</code>. </p>
|
|
@@ -3969,7 +3969,7 @@ export interface GetPublicKeyResponse {
|
|
|
3969
3969
|
* encrypts data outside of KMS, the ciphertext cannot be decrypted. </p>
|
|
3970
3970
|
* @public
|
|
3971
3971
|
*/
|
|
3972
|
-
KeyUsage?: KeyUsageType;
|
|
3972
|
+
KeyUsage?: KeyUsageType | undefined;
|
|
3973
3973
|
/**
|
|
3974
3974
|
* <p>The encryption algorithms that KMS supports for this key. </p>
|
|
3975
3975
|
* <p>This information is critical. If a public key encrypts data outside of KMS by using an
|
|
@@ -3978,19 +3978,19 @@ export interface GetPublicKeyResponse {
|
|
|
3978
3978
|
* is <code>ENCRYPT_DECRYPT</code>.</p>
|
|
3979
3979
|
* @public
|
|
3980
3980
|
*/
|
|
3981
|
-
EncryptionAlgorithms?: EncryptionAlgorithmSpec[];
|
|
3981
|
+
EncryptionAlgorithms?: EncryptionAlgorithmSpec[] | undefined;
|
|
3982
3982
|
/**
|
|
3983
3983
|
* <p>The signing algorithms that KMS supports for this key.</p>
|
|
3984
3984
|
* <p>This field appears in the response only when the <code>KeyUsage</code> of the public key
|
|
3985
3985
|
* is <code>SIGN_VERIFY</code>.</p>
|
|
3986
3986
|
* @public
|
|
3987
3987
|
*/
|
|
3988
|
-
SigningAlgorithms?: SigningAlgorithmSpec[];
|
|
3988
|
+
SigningAlgorithms?: SigningAlgorithmSpec[] | undefined;
|
|
3989
3989
|
/**
|
|
3990
3990
|
* <p>The key agreement algorithm used to derive a shared secret. This field is present only when the KMS key has a <code>KeyUsage</code> value of <code>KEY_AGREEMENT</code>.</p>
|
|
3991
3991
|
* @public
|
|
3992
3992
|
*/
|
|
3993
|
-
KeyAgreementAlgorithms?: KeyAgreementAlgorithmSpec[];
|
|
3993
|
+
KeyAgreementAlgorithms?: KeyAgreementAlgorithmSpec[] | undefined;
|
|
3994
3994
|
}
|
|
3995
3995
|
/**
|
|
3996
3996
|
* <p>Contains information about a grant.</p>
|
|
@@ -4001,22 +4001,22 @@ export interface GrantListEntry {
|
|
|
4001
4001
|
* <p>The unique identifier for the KMS key to which the grant applies.</p>
|
|
4002
4002
|
* @public
|
|
4003
4003
|
*/
|
|
4004
|
-
KeyId?: string;
|
|
4004
|
+
KeyId?: string | undefined;
|
|
4005
4005
|
/**
|
|
4006
4006
|
* <p>The unique identifier for the grant.</p>
|
|
4007
4007
|
* @public
|
|
4008
4008
|
*/
|
|
4009
|
-
GrantId?: string;
|
|
4009
|
+
GrantId?: string | undefined;
|
|
4010
4010
|
/**
|
|
4011
4011
|
* <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>
|
|
4012
4012
|
* @public
|
|
4013
4013
|
*/
|
|
4014
|
-
Name?: string;
|
|
4014
|
+
Name?: string | undefined;
|
|
4015
4015
|
/**
|
|
4016
4016
|
* <p>The date and time when the grant was created.</p>
|
|
4017
4017
|
* @public
|
|
4018
4018
|
*/
|
|
4019
|
-
CreationDate?: Date;
|
|
4019
|
+
CreationDate?: Date | undefined;
|
|
4020
4020
|
/**
|
|
4021
4021
|
* <p>The identity that gets the permissions in the grant.</p>
|
|
4022
4022
|
* <p>The <code>GranteePrincipal</code> field in the <code>ListGrants</code> response usually contains the
|
|
@@ -4026,28 +4026,28 @@ export interface GrantListEntry {
|
|
|
4026
4026
|
* principal</a>, which might represent several different grantee principals.</p>
|
|
4027
4027
|
* @public
|
|
4028
4028
|
*/
|
|
4029
|
-
GranteePrincipal?: string;
|
|
4029
|
+
GranteePrincipal?: string | undefined;
|
|
4030
4030
|
/**
|
|
4031
4031
|
* <p>The principal that can retire the grant.</p>
|
|
4032
4032
|
* @public
|
|
4033
4033
|
*/
|
|
4034
|
-
RetiringPrincipal?: string;
|
|
4034
|
+
RetiringPrincipal?: string | undefined;
|
|
4035
4035
|
/**
|
|
4036
4036
|
* <p>The Amazon Web Services account under which the grant was issued.</p>
|
|
4037
4037
|
* @public
|
|
4038
4038
|
*/
|
|
4039
|
-
IssuingAccount?: string;
|
|
4039
|
+
IssuingAccount?: string | undefined;
|
|
4040
4040
|
/**
|
|
4041
4041
|
* <p>The list of operations permitted by the grant.</p>
|
|
4042
4042
|
* @public
|
|
4043
4043
|
*/
|
|
4044
|
-
Operations?: GrantOperation[];
|
|
4044
|
+
Operations?: GrantOperation[] | undefined;
|
|
4045
4045
|
/**
|
|
4046
4046
|
* <p>A list of key-value pairs that must be present in the encryption context of certain
|
|
4047
4047
|
* subsequent operations that the grant allows.</p>
|
|
4048
4048
|
* @public
|
|
4049
4049
|
*/
|
|
4050
|
-
Constraints?: GrantConstraints;
|
|
4050
|
+
Constraints?: GrantConstraints | undefined;
|
|
4051
4051
|
}
|
|
4052
4052
|
/**
|
|
4053
4053
|
* @public
|
|
@@ -4105,7 +4105,7 @@ export interface ImportKeyMaterialRequest {
|
|
|
4105
4105
|
* current import after the request completes. To change either value, you must delete (<a>DeleteImportedKeyMaterial</a>) and reimport the key material.</p>
|
|
4106
4106
|
* @public
|
|
4107
4107
|
*/
|
|
4108
|
-
ValidTo?: Date;
|
|
4108
|
+
ValidTo?: Date | undefined;
|
|
4109
4109
|
/**
|
|
4110
4110
|
* <p>Specifies whether the key material expires. The default is
|
|
4111
4111
|
* <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>
|
|
@@ -4118,7 +4118,7 @@ export interface ImportKeyMaterialRequest {
|
|
|
4118
4118
|
* material.</p>
|
|
4119
4119
|
* @public
|
|
4120
4120
|
*/
|
|
4121
|
-
ExpirationModel?: ExpirationModelType;
|
|
4121
|
+
ExpirationModel?: ExpirationModelType | undefined;
|
|
4122
4122
|
}
|
|
4123
4123
|
/**
|
|
4124
4124
|
* @public
|
|
@@ -4172,12 +4172,12 @@ export interface KeyListEntry {
|
|
|
4172
4172
|
* <p>Unique identifier of the key.</p>
|
|
4173
4173
|
* @public
|
|
4174
4174
|
*/
|
|
4175
|
-
KeyId?: string;
|
|
4175
|
+
KeyId?: string | undefined;
|
|
4176
4176
|
/**
|
|
4177
4177
|
* <p>ARN of the key.</p>
|
|
4178
4178
|
* @public
|
|
4179
4179
|
*/
|
|
4180
|
-
KeyArn?: string;
|
|
4180
|
+
KeyArn?: string | undefined;
|
|
4181
4181
|
}
|
|
4182
4182
|
/**
|
|
4183
4183
|
* <p>The request was rejected because the HMAC verification failed. HMAC verification fails
|
|
@@ -4231,7 +4231,7 @@ export interface ListAliasesRequest {
|
|
|
4231
4231
|
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
4232
4232
|
* @public
|
|
4233
4233
|
*/
|
|
4234
|
-
KeyId?: string;
|
|
4234
|
+
KeyId?: string | undefined;
|
|
4235
4235
|
/**
|
|
4236
4236
|
* <p>Use this parameter to specify the maximum number of items to return. When this
|
|
4237
4237
|
* value is present, KMS does not return more than the specified number of items, but it might
|
|
@@ -4240,14 +4240,14 @@ export interface ListAliasesRequest {
|
|
|
4240
4240
|
* and 100, inclusive. If you do not include a value, it defaults to 50.</p>
|
|
4241
4241
|
* @public
|
|
4242
4242
|
*/
|
|
4243
|
-
Limit?: number;
|
|
4243
|
+
Limit?: number | undefined;
|
|
4244
4244
|
/**
|
|
4245
4245
|
* <p>Use this parameter in a subsequent request after you receive a response with
|
|
4246
4246
|
* truncated results. Set it to the value of <code>NextMarker</code> from the truncated response
|
|
4247
4247
|
* you just received.</p>
|
|
4248
4248
|
* @public
|
|
4249
4249
|
*/
|
|
4250
|
-
Marker?: string;
|
|
4250
|
+
Marker?: string | undefined;
|
|
4251
4251
|
}
|
|
4252
4252
|
/**
|
|
4253
4253
|
* @public
|
|
@@ -4257,13 +4257,13 @@ export interface ListAliasesResponse {
|
|
|
4257
4257
|
* <p>A list of aliases.</p>
|
|
4258
4258
|
* @public
|
|
4259
4259
|
*/
|
|
4260
|
-
Aliases?: AliasListEntry[];
|
|
4260
|
+
Aliases?: AliasListEntry[] | undefined;
|
|
4261
4261
|
/**
|
|
4262
4262
|
* <p>When <code>Truncated</code> is true, this element is present and contains the
|
|
4263
4263
|
* value to use for the <code>Marker</code> parameter in a subsequent request.</p>
|
|
4264
4264
|
* @public
|
|
4265
4265
|
*/
|
|
4266
|
-
NextMarker?: string;
|
|
4266
|
+
NextMarker?: string | undefined;
|
|
4267
4267
|
/**
|
|
4268
4268
|
* <p>A flag that indicates whether there are more items in the list. When this
|
|
4269
4269
|
* value is true, the list in this response is truncated. To get more items, pass the value of
|
|
@@ -4271,7 +4271,7 @@ export interface ListAliasesResponse {
|
|
|
4271
4271
|
* subsequent request.</p>
|
|
4272
4272
|
* @public
|
|
4273
4273
|
*/
|
|
4274
|
-
Truncated?: boolean;
|
|
4274
|
+
Truncated?: boolean | undefined;
|
|
4275
4275
|
}
|
|
4276
4276
|
/**
|
|
4277
4277
|
* @public
|
|
@@ -4285,14 +4285,14 @@ export interface ListGrantsRequest {
|
|
|
4285
4285
|
* and 100, inclusive. If you do not include a value, it defaults to 50.</p>
|
|
4286
4286
|
* @public
|
|
4287
4287
|
*/
|
|
4288
|
-
Limit?: number;
|
|
4288
|
+
Limit?: number | undefined;
|
|
4289
4289
|
/**
|
|
4290
4290
|
* <p>Use this parameter in a subsequent request after you receive a response with
|
|
4291
4291
|
* truncated results. Set it to the value of <code>NextMarker</code> from the truncated response
|
|
4292
4292
|
* you just received.</p>
|
|
4293
4293
|
* @public
|
|
4294
4294
|
*/
|
|
4295
|
-
Marker?: string;
|
|
4295
|
+
Marker?: string | undefined;
|
|
4296
4296
|
/**
|
|
4297
4297
|
* <p>Returns only grants for the specified KMS key. This parameter is required.</p>
|
|
4298
4298
|
* <p>Specify the key ID or key ARN of the KMS key. To specify a KMS key in a
|
|
@@ -4317,13 +4317,13 @@ export interface ListGrantsRequest {
|
|
|
4317
4317
|
* grant. </p>
|
|
4318
4318
|
* @public
|
|
4319
4319
|
*/
|
|
4320
|
-
GrantId?: string;
|
|
4320
|
+
GrantId?: string | undefined;
|
|
4321
4321
|
/**
|
|
4322
4322
|
* <p>Returns only grants where the specified principal is the grantee principal for the
|
|
4323
4323
|
* grant.</p>
|
|
4324
4324
|
* @public
|
|
4325
4325
|
*/
|
|
4326
|
-
GranteePrincipal?: string;
|
|
4326
|
+
GranteePrincipal?: string | undefined;
|
|
4327
4327
|
}
|
|
4328
4328
|
/**
|
|
4329
4329
|
* @public
|
|
@@ -4333,13 +4333,13 @@ export interface ListGrantsResponse {
|
|
|
4333
4333
|
* <p>A list of grants.</p>
|
|
4334
4334
|
* @public
|
|
4335
4335
|
*/
|
|
4336
|
-
Grants?: GrantListEntry[];
|
|
4336
|
+
Grants?: GrantListEntry[] | undefined;
|
|
4337
4337
|
/**
|
|
4338
4338
|
* <p>When <code>Truncated</code> is true, this element is present and contains the
|
|
4339
4339
|
* value to use for the <code>Marker</code> parameter in a subsequent request.</p>
|
|
4340
4340
|
* @public
|
|
4341
4341
|
*/
|
|
4342
|
-
NextMarker?: string;
|
|
4342
|
+
NextMarker?: string | undefined;
|
|
4343
4343
|
/**
|
|
4344
4344
|
* <p>A flag that indicates whether there are more items in the list. When this
|
|
4345
4345
|
* value is true, the list in this response is truncated. To get more items, pass the value of
|
|
@@ -4347,7 +4347,7 @@ export interface ListGrantsResponse {
|
|
|
4347
4347
|
* subsequent request.</p>
|
|
4348
4348
|
* @public
|
|
4349
4349
|
*/
|
|
4350
|
-
Truncated?: boolean;
|
|
4350
|
+
Truncated?: boolean | undefined;
|
|
4351
4351
|
}
|
|
4352
4352
|
/**
|
|
4353
4353
|
* @public
|
|
@@ -4380,14 +4380,14 @@ export interface ListKeyPoliciesRequest {
|
|
|
4380
4380
|
* <p>Only one policy can be attached to a key.</p>
|
|
4381
4381
|
* @public
|
|
4382
4382
|
*/
|
|
4383
|
-
Limit?: number;
|
|
4383
|
+
Limit?: number | undefined;
|
|
4384
4384
|
/**
|
|
4385
4385
|
* <p>Use this parameter in a subsequent request after you receive a response with
|
|
4386
4386
|
* truncated results. Set it to the value of <code>NextMarker</code> from the truncated response
|
|
4387
4387
|
* you just received.</p>
|
|
4388
4388
|
* @public
|
|
4389
4389
|
*/
|
|
4390
|
-
Marker?: string;
|
|
4390
|
+
Marker?: string | undefined;
|
|
4391
4391
|
}
|
|
4392
4392
|
/**
|
|
4393
4393
|
* @public
|
|
@@ -4397,13 +4397,13 @@ export interface ListKeyPoliciesResponse {
|
|
|
4397
4397
|
* <p>A list of key policy names. The only valid value is <code>default</code>.</p>
|
|
4398
4398
|
* @public
|
|
4399
4399
|
*/
|
|
4400
|
-
PolicyNames?: string[];
|
|
4400
|
+
PolicyNames?: string[] | undefined;
|
|
4401
4401
|
/**
|
|
4402
4402
|
* <p>When <code>Truncated</code> is true, this element is present and contains the
|
|
4403
4403
|
* value to use for the <code>Marker</code> parameter in a subsequent request.</p>
|
|
4404
4404
|
* @public
|
|
4405
4405
|
*/
|
|
4406
|
-
NextMarker?: string;
|
|
4406
|
+
NextMarker?: string | undefined;
|
|
4407
4407
|
/**
|
|
4408
4408
|
* <p>A flag that indicates whether there are more items in the list. When this
|
|
4409
4409
|
* value is true, the list in this response is truncated. To get more items, pass the value of
|
|
@@ -4411,7 +4411,7 @@ export interface ListKeyPoliciesResponse {
|
|
|
4411
4411
|
* subsequent request.</p>
|
|
4412
4412
|
* @public
|
|
4413
4413
|
*/
|
|
4414
|
-
Truncated?: boolean;
|
|
4414
|
+
Truncated?: boolean | undefined;
|
|
4415
4415
|
}
|
|
4416
4416
|
/**
|
|
4417
4417
|
* @public
|
|
@@ -4443,14 +4443,14 @@ export interface ListKeyRotationsRequest {
|
|
|
4443
4443
|
* 1 and 1000, inclusive. If you do not include a value, it defaults to 100.</p>
|
|
4444
4444
|
* @public
|
|
4445
4445
|
*/
|
|
4446
|
-
Limit?: number;
|
|
4446
|
+
Limit?: number | undefined;
|
|
4447
4447
|
/**
|
|
4448
4448
|
* <p>Use this parameter in a subsequent request after you receive a response with
|
|
4449
4449
|
* truncated results. Set it to the value of <code>NextMarker</code> from the truncated response
|
|
4450
4450
|
* you just received.</p>
|
|
4451
4451
|
* @public
|
|
4452
4452
|
*/
|
|
4453
|
-
Marker?: string;
|
|
4453
|
+
Marker?: string | undefined;
|
|
4454
4454
|
}
|
|
4455
4455
|
/**
|
|
4456
4456
|
* @public
|
|
@@ -4473,17 +4473,17 @@ export interface RotationsListEntry {
|
|
|
4473
4473
|
* <p>Unique identifier of the key.</p>
|
|
4474
4474
|
* @public
|
|
4475
4475
|
*/
|
|
4476
|
-
KeyId?: string;
|
|
4476
|
+
KeyId?: string | undefined;
|
|
4477
4477
|
/**
|
|
4478
4478
|
* <p>Date and time that the key material rotation completed. Formatted as Unix time.</p>
|
|
4479
4479
|
* @public
|
|
4480
4480
|
*/
|
|
4481
|
-
RotationDate?: Date;
|
|
4481
|
+
RotationDate?: Date | undefined;
|
|
4482
4482
|
/**
|
|
4483
4483
|
* <p>Identifies whether the key material rotation was a scheduled <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotating-keys-enable-disable">automatic rotation</a> or an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotating-keys-on-demand">on-demand rotation</a>.</p>
|
|
4484
4484
|
* @public
|
|
4485
4485
|
*/
|
|
4486
|
-
RotationType?: RotationType;
|
|
4486
|
+
RotationType?: RotationType | undefined;
|
|
4487
4487
|
}
|
|
4488
4488
|
/**
|
|
4489
4489
|
* @public
|
|
@@ -4493,13 +4493,13 @@ export interface ListKeyRotationsResponse {
|
|
|
4493
4493
|
* <p>A list of completed key material rotations.</p>
|
|
4494
4494
|
* @public
|
|
4495
4495
|
*/
|
|
4496
|
-
Rotations?: RotationsListEntry[];
|
|
4496
|
+
Rotations?: RotationsListEntry[] | undefined;
|
|
4497
4497
|
/**
|
|
4498
4498
|
* <p>When <code>Truncated</code> is true, this element is present and contains the
|
|
4499
4499
|
* value to use for the <code>Marker</code> parameter in a subsequent request.</p>
|
|
4500
4500
|
* @public
|
|
4501
4501
|
*/
|
|
4502
|
-
NextMarker?: string;
|
|
4502
|
+
NextMarker?: string | undefined;
|
|
4503
4503
|
/**
|
|
4504
4504
|
* <p>A flag that indicates whether there are more items in the list. When this
|
|
4505
4505
|
* value is true, the list in this response is truncated. To get more items, pass the value of
|
|
@@ -4507,7 +4507,7 @@ export interface ListKeyRotationsResponse {
|
|
|
4507
4507
|
* subsequent request.</p>
|
|
4508
4508
|
* @public
|
|
4509
4509
|
*/
|
|
4510
|
-
Truncated?: boolean;
|
|
4510
|
+
Truncated?: boolean | undefined;
|
|
4511
4511
|
}
|
|
4512
4512
|
/**
|
|
4513
4513
|
* @public
|
|
@@ -4521,14 +4521,14 @@ export interface ListKeysRequest {
|
|
|
4521
4521
|
* 1 and 1000, inclusive. If you do not include a value, it defaults to 100.</p>
|
|
4522
4522
|
* @public
|
|
4523
4523
|
*/
|
|
4524
|
-
Limit?: number;
|
|
4524
|
+
Limit?: number | undefined;
|
|
4525
4525
|
/**
|
|
4526
4526
|
* <p>Use this parameter in a subsequent request after you receive a response with
|
|
4527
4527
|
* truncated results. Set it to the value of <code>NextMarker</code> from the truncated response
|
|
4528
4528
|
* you just received.</p>
|
|
4529
4529
|
* @public
|
|
4530
4530
|
*/
|
|
4531
|
-
Marker?: string;
|
|
4531
|
+
Marker?: string | undefined;
|
|
4532
4532
|
}
|
|
4533
4533
|
/**
|
|
4534
4534
|
* @public
|
|
@@ -4538,13 +4538,13 @@ export interface ListKeysResponse {
|
|
|
4538
4538
|
* <p>A list of KMS keys.</p>
|
|
4539
4539
|
* @public
|
|
4540
4540
|
*/
|
|
4541
|
-
Keys?: KeyListEntry[];
|
|
4541
|
+
Keys?: KeyListEntry[] | undefined;
|
|
4542
4542
|
/**
|
|
4543
4543
|
* <p>When <code>Truncated</code> is true, this element is present and contains the
|
|
4544
4544
|
* value to use for the <code>Marker</code> parameter in a subsequent request.</p>
|
|
4545
4545
|
* @public
|
|
4546
4546
|
*/
|
|
4547
|
-
NextMarker?: string;
|
|
4547
|
+
NextMarker?: string | undefined;
|
|
4548
4548
|
/**
|
|
4549
4549
|
* <p>A flag that indicates whether there are more items in the list. When this
|
|
4550
4550
|
* value is true, the list in this response is truncated. To get more items, pass the value of
|
|
@@ -4552,7 +4552,7 @@ export interface ListKeysResponse {
|
|
|
4552
4552
|
* subsequent request.</p>
|
|
4553
4553
|
* @public
|
|
4554
4554
|
*/
|
|
4555
|
-
Truncated?: boolean;
|
|
4555
|
+
Truncated?: boolean | undefined;
|
|
4556
4556
|
}
|
|
4557
4557
|
/**
|
|
4558
4558
|
* @public
|
|
@@ -4584,7 +4584,7 @@ export interface ListResourceTagsRequest {
|
|
|
4584
4584
|
* you do not include a value, it defaults to 50.</p>
|
|
4585
4585
|
* @public
|
|
4586
4586
|
*/
|
|
4587
|
-
Limit?: number;
|
|
4587
|
+
Limit?: number | undefined;
|
|
4588
4588
|
/**
|
|
4589
4589
|
* <p>Use this parameter in a subsequent request after you receive a response with
|
|
4590
4590
|
* truncated results. Set it to the value of <code>NextMarker</code> from the truncated response
|
|
@@ -4593,7 +4593,7 @@ export interface ListResourceTagsRequest {
|
|
|
4593
4593
|
* the truncated response you just received.</p>
|
|
4594
4594
|
* @public
|
|
4595
4595
|
*/
|
|
4596
|
-
Marker?: string;
|
|
4596
|
+
Marker?: string | undefined;
|
|
4597
4597
|
}
|
|
4598
4598
|
/**
|
|
4599
4599
|
* @public
|
|
@@ -4606,14 +4606,14 @@ export interface ListResourceTagsResponse {
|
|
|
4606
4606
|
* </note>
|
|
4607
4607
|
* @public
|
|
4608
4608
|
*/
|
|
4609
|
-
Tags?: Tag[];
|
|
4609
|
+
Tags?: Tag[] | undefined;
|
|
4610
4610
|
/**
|
|
4611
4611
|
* <p>When <code>Truncated</code> is true, this element is present and contains the
|
|
4612
4612
|
* value to use for the <code>Marker</code> parameter in a subsequent request.</p>
|
|
4613
4613
|
* <p>Do not assume or infer any information from this value.</p>
|
|
4614
4614
|
* @public
|
|
4615
4615
|
*/
|
|
4616
|
-
NextMarker?: string;
|
|
4616
|
+
NextMarker?: string | undefined;
|
|
4617
4617
|
/**
|
|
4618
4618
|
* <p>A flag that indicates whether there are more items in the list. When this
|
|
4619
4619
|
* value is true, the list in this response is truncated. To get more items, pass the value of
|
|
@@ -4621,7 +4621,7 @@ export interface ListResourceTagsResponse {
|
|
|
4621
4621
|
* subsequent request.</p>
|
|
4622
4622
|
* @public
|
|
4623
4623
|
*/
|
|
4624
|
-
Truncated?: boolean;
|
|
4624
|
+
Truncated?: boolean | undefined;
|
|
4625
4625
|
}
|
|
4626
4626
|
/**
|
|
4627
4627
|
* @public
|
|
@@ -4635,14 +4635,14 @@ export interface ListRetirableGrantsRequest {
|
|
|
4635
4635
|
* and 100, inclusive. If you do not include a value, it defaults to 50.</p>
|
|
4636
4636
|
* @public
|
|
4637
4637
|
*/
|
|
4638
|
-
Limit?: number;
|
|
4638
|
+
Limit?: number | undefined;
|
|
4639
4639
|
/**
|
|
4640
4640
|
* <p>Use this parameter in a subsequent request after you receive a response with
|
|
4641
4641
|
* truncated results. Set it to the value of <code>NextMarker</code> from the truncated response
|
|
4642
4642
|
* you just received.</p>
|
|
4643
4643
|
* @public
|
|
4644
4644
|
*/
|
|
4645
|
-
Marker?: string;
|
|
4645
|
+
Marker?: string | undefined;
|
|
4646
4646
|
/**
|
|
4647
4647
|
* <p>The retiring principal for which to list grants. Enter a principal in your
|
|
4648
4648
|
* Amazon Web Services account.</p>
|
|
@@ -4694,7 +4694,7 @@ export interface PutKeyPolicyRequest {
|
|
|
4694
4694
|
* <p>The name of the key policy. If no policy name is specified, the default value is <code>default</code>. The only valid value is <code>default</code>.</p>
|
|
4695
4695
|
* @public
|
|
4696
4696
|
*/
|
|
4697
|
-
PolicyName?: string;
|
|
4697
|
+
PolicyName?: string | undefined;
|
|
4698
4698
|
/**
|
|
4699
4699
|
* <p>The key policy to attach to the KMS key.</p>
|
|
4700
4700
|
* <p>The key policy must meet the following criteria:</p>
|
|
@@ -4745,7 +4745,7 @@ export interface PutKeyPolicyRequest {
|
|
|
4745
4745
|
* request on the KMS key.</p>
|
|
4746
4746
|
* @public
|
|
4747
4747
|
*/
|
|
4748
|
-
BypassPolicyLockoutSafetyCheck?: boolean;
|
|
4748
|
+
BypassPolicyLockoutSafetyCheck?: boolean | undefined;
|
|
4749
4749
|
}
|
|
4750
4750
|
/**
|
|
4751
4751
|
* @public
|
|
@@ -4766,7 +4766,7 @@ export interface ReEncryptRequest {
|
|
|
4766
4766
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
4767
4767
|
* @public
|
|
4768
4768
|
*/
|
|
4769
|
-
SourceEncryptionContext?: Record<string, string
|
|
4769
|
+
SourceEncryptionContext?: Record<string, string> | undefined;
|
|
4770
4770
|
/**
|
|
4771
4771
|
* <p>Specifies the KMS key that KMS will use to decrypt the ciphertext before it is
|
|
4772
4772
|
* re-encrypted.</p>
|
|
@@ -4800,7 +4800,7 @@ export interface ReEncryptRequest {
|
|
|
4800
4800
|
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>
|
|
4801
4801
|
* @public
|
|
4802
4802
|
*/
|
|
4803
|
-
SourceKeyId?: string;
|
|
4803
|
+
SourceKeyId?: string | undefined;
|
|
4804
4804
|
/**
|
|
4805
4805
|
* <p>A unique identifier for the KMS key that is used to reencrypt the data. Specify a
|
|
4806
4806
|
* symmetric encryption KMS key or an asymmetric KMS key with a <code>KeyUsage</code> value of
|
|
@@ -4845,7 +4845,7 @@ export interface ReEncryptRequest {
|
|
|
4845
4845
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
4846
4846
|
* @public
|
|
4847
4847
|
*/
|
|
4848
|
-
DestinationEncryptionContext?: Record<string, string
|
|
4848
|
+
DestinationEncryptionContext?: Record<string, string> | undefined;
|
|
4849
4849
|
/**
|
|
4850
4850
|
* <p>Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it
|
|
4851
4851
|
* is reencrypted. The default value, <code>SYMMETRIC_DEFAULT</code>, represents the algorithm
|
|
@@ -4856,7 +4856,7 @@ export interface ReEncryptRequest {
|
|
|
4856
4856
|
* key.</p>
|
|
4857
4857
|
* @public
|
|
4858
4858
|
*/
|
|
4859
|
-
SourceEncryptionAlgorithm?: EncryptionAlgorithmSpec;
|
|
4859
|
+
SourceEncryptionAlgorithm?: EncryptionAlgorithmSpec | undefined;
|
|
4860
4860
|
/**
|
|
4861
4861
|
* <p>Specifies the encryption algorithm that KMS will use to reecrypt the data after it has
|
|
4862
4862
|
* decrypted it. The default value, <code>SYMMETRIC_DEFAULT</code>, represents the encryption
|
|
@@ -4865,20 +4865,20 @@ export interface ReEncryptRequest {
|
|
|
4865
4865
|
* key.</p>
|
|
4866
4866
|
* @public
|
|
4867
4867
|
*/
|
|
4868
|
-
DestinationEncryptionAlgorithm?: EncryptionAlgorithmSpec;
|
|
4868
|
+
DestinationEncryptionAlgorithm?: EncryptionAlgorithmSpec | undefined;
|
|
4869
4869
|
/**
|
|
4870
4870
|
* <p>A list of grant tokens.</p>
|
|
4871
4871
|
* <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
|
|
4872
4872
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
4873
4873
|
* @public
|
|
4874
4874
|
*/
|
|
4875
|
-
GrantTokens?: string[];
|
|
4875
|
+
GrantTokens?: string[] | undefined;
|
|
4876
4876
|
/**
|
|
4877
4877
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
4878
4878
|
* <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>
|
|
4879
4879
|
* @public
|
|
4880
4880
|
*/
|
|
4881
|
-
DryRun?: boolean;
|
|
4881
|
+
DryRun?: boolean | undefined;
|
|
4882
4882
|
}
|
|
4883
4883
|
/**
|
|
4884
4884
|
* @public
|
|
@@ -4888,28 +4888,28 @@ export interface ReEncryptResponse {
|
|
|
4888
4888
|
* <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>
|
|
4889
4889
|
* @public
|
|
4890
4890
|
*/
|
|
4891
|
-
CiphertextBlob?: Uint8Array;
|
|
4891
|
+
CiphertextBlob?: Uint8Array | undefined;
|
|
4892
4892
|
/**
|
|
4893
4893
|
* <p>Unique identifier of the KMS key used to originally encrypt the data.</p>
|
|
4894
4894
|
* @public
|
|
4895
4895
|
*/
|
|
4896
|
-
SourceKeyId?: string;
|
|
4896
|
+
SourceKeyId?: string | undefined;
|
|
4897
4897
|
/**
|
|
4898
4898
|
* <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>
|
|
4899
4899
|
* @public
|
|
4900
4900
|
*/
|
|
4901
|
-
KeyId?: string;
|
|
4901
|
+
KeyId?: string | undefined;
|
|
4902
4902
|
/**
|
|
4903
4903
|
* <p>The encryption algorithm that was used to decrypt the ciphertext before it was
|
|
4904
4904
|
* reencrypted.</p>
|
|
4905
4905
|
* @public
|
|
4906
4906
|
*/
|
|
4907
|
-
SourceEncryptionAlgorithm?: EncryptionAlgorithmSpec;
|
|
4907
|
+
SourceEncryptionAlgorithm?: EncryptionAlgorithmSpec | undefined;
|
|
4908
4908
|
/**
|
|
4909
4909
|
* <p>The encryption algorithm that was used to reencrypt the data.</p>
|
|
4910
4910
|
* @public
|
|
4911
4911
|
*/
|
|
4912
|
-
DestinationEncryptionAlgorithm?: EncryptionAlgorithmSpec;
|
|
4912
|
+
DestinationEncryptionAlgorithm?: EncryptionAlgorithmSpec | undefined;
|
|
4913
4913
|
}
|
|
4914
4914
|
/**
|
|
4915
4915
|
* @public
|
|
@@ -4998,7 +4998,7 @@ export interface ReplicateKeyRequest {
|
|
|
4998
4998
|
* </i>.</p>
|
|
4999
4999
|
* @public
|
|
5000
5000
|
*/
|
|
5001
|
-
Policy?: string;
|
|
5001
|
+
Policy?: string | undefined;
|
|
5002
5002
|
/**
|
|
5003
5003
|
* <p>Skips ("bypasses") the key policy lockout safety check. The default value is false.</p>
|
|
5004
5004
|
* <important>
|
|
@@ -5011,7 +5011,7 @@ export interface ReplicateKeyRequest {
|
|
|
5011
5011
|
* request on the KMS key.</p>
|
|
5012
5012
|
* @public
|
|
5013
5013
|
*/
|
|
5014
|
-
BypassPolicyLockoutSafetyCheck?: boolean;
|
|
5014
|
+
BypassPolicyLockoutSafetyCheck?: boolean | undefined;
|
|
5015
5015
|
/**
|
|
5016
5016
|
* <p>A description of the KMS key. The default value is an empty string (no
|
|
5017
5017
|
* description).</p>
|
|
@@ -5023,7 +5023,7 @@ export interface ReplicateKeyRequest {
|
|
|
5023
5023
|
* KMS does not synchronize this property.</p>
|
|
5024
5024
|
* @public
|
|
5025
5025
|
*/
|
|
5026
|
-
Description?: string;
|
|
5026
|
+
Description?: string | undefined;
|
|
5027
5027
|
/**
|
|
5028
5028
|
* <p>Assigns one or more tags to the replica key. Use this parameter to tag the KMS key when it
|
|
5029
5029
|
* is created. To tag an existing KMS key, use the <a>TagResource</a>
|
|
@@ -5047,7 +5047,7 @@ export interface ReplicateKeyRequest {
|
|
|
5047
5047
|
* see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">Tagging Keys</a>.</p>
|
|
5048
5048
|
* @public
|
|
5049
5049
|
*/
|
|
5050
|
-
Tags?: Tag[];
|
|
5050
|
+
Tags?: Tag[] | undefined;
|
|
5051
5051
|
}
|
|
5052
5052
|
/**
|
|
5053
5053
|
* @public
|
|
@@ -5059,19 +5059,19 @@ export interface ReplicateKeyResponse {
|
|
|
5059
5059
|
* replica keys.</p>
|
|
5060
5060
|
* @public
|
|
5061
5061
|
*/
|
|
5062
|
-
ReplicaKeyMetadata?: KeyMetadata;
|
|
5062
|
+
ReplicaKeyMetadata?: KeyMetadata | undefined;
|
|
5063
5063
|
/**
|
|
5064
5064
|
* <p>The key policy of the new replica key. The value is a key policy document in JSON
|
|
5065
5065
|
* format.</p>
|
|
5066
5066
|
* @public
|
|
5067
5067
|
*/
|
|
5068
|
-
ReplicaPolicy?: string;
|
|
5068
|
+
ReplicaPolicy?: string | undefined;
|
|
5069
5069
|
/**
|
|
5070
5070
|
* <p>The tags on the new replica key. The value is a list of tag key and tag value
|
|
5071
5071
|
* pairs.</p>
|
|
5072
5072
|
* @public
|
|
5073
5073
|
*/
|
|
5074
|
-
ReplicaTags?: Tag[];
|
|
5074
|
+
ReplicaTags?: Tag[] | undefined;
|
|
5075
5075
|
}
|
|
5076
5076
|
/**
|
|
5077
5077
|
* @public
|
|
@@ -5085,14 +5085,14 @@ export interface RetireGrantRequest {
|
|
|
5085
5085
|
* and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-eventual-consistency">Eventual consistency</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
5086
5086
|
* @public
|
|
5087
5087
|
*/
|
|
5088
|
-
GrantToken?: string;
|
|
5088
|
+
GrantToken?: string | undefined;
|
|
5089
5089
|
/**
|
|
5090
5090
|
* <p>The key ARN KMS key associated with the grant. To find the key ARN, use the <a>ListKeys</a> operation.</p>
|
|
5091
5091
|
* <p>For example: <code>arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
|
|
5092
5092
|
* </p>
|
|
5093
5093
|
* @public
|
|
5094
5094
|
*/
|
|
5095
|
-
KeyId?: string;
|
|
5095
|
+
KeyId?: string | undefined;
|
|
5096
5096
|
/**
|
|
5097
5097
|
* <p>Identifies the grant to retire. To get the grant ID, use <a>CreateGrant</a>,
|
|
5098
5098
|
* <a>ListGrants</a>, or <a>ListRetirableGrants</a>.</p>
|
|
@@ -5104,13 +5104,13 @@ export interface RetireGrantRequest {
|
|
|
5104
5104
|
* </ul>
|
|
5105
5105
|
* @public
|
|
5106
5106
|
*/
|
|
5107
|
-
GrantId?: string;
|
|
5107
|
+
GrantId?: string | undefined;
|
|
5108
5108
|
/**
|
|
5109
5109
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
5110
5110
|
* <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>
|
|
5111
5111
|
* @public
|
|
5112
5112
|
*/
|
|
5113
|
-
DryRun?: boolean;
|
|
5113
|
+
DryRun?: boolean | undefined;
|
|
5114
5114
|
}
|
|
5115
5115
|
/**
|
|
5116
5116
|
* @public
|
|
@@ -5147,7 +5147,7 @@ export interface RevokeGrantRequest {
|
|
|
5147
5147
|
* <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>
|
|
5148
5148
|
* @public
|
|
5149
5149
|
*/
|
|
5150
|
-
DryRun?: boolean;
|
|
5150
|
+
DryRun?: boolean | undefined;
|
|
5151
5151
|
}
|
|
5152
5152
|
/**
|
|
5153
5153
|
* @public
|
|
@@ -5185,7 +5185,7 @@ export interface RotateKeyOnDemandResponse {
|
|
|
5185
5185
|
* on.</p>
|
|
5186
5186
|
* @public
|
|
5187
5187
|
*/
|
|
5188
|
-
KeyId?: string;
|
|
5188
|
+
KeyId?: string | undefined;
|
|
5189
5189
|
}
|
|
5190
5190
|
/**
|
|
5191
5191
|
* @public
|
|
@@ -5223,7 +5223,7 @@ export interface ScheduleKeyDeletionRequest {
|
|
|
5223
5223
|
* parameter.</p>
|
|
5224
5224
|
* @public
|
|
5225
5225
|
*/
|
|
5226
|
-
PendingWindowInDays?: number;
|
|
5226
|
+
PendingWindowInDays?: number | undefined;
|
|
5227
5227
|
}
|
|
5228
5228
|
/**
|
|
5229
5229
|
* @public
|
|
@@ -5233,7 +5233,7 @@ export interface ScheduleKeyDeletionResponse {
|
|
|
5233
5233
|
* <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>
|
|
5234
5234
|
* @public
|
|
5235
5235
|
*/
|
|
5236
|
-
KeyId?: string;
|
|
5236
|
+
KeyId?: string | undefined;
|
|
5237
5237
|
/**
|
|
5238
5238
|
* <p>The date and time after which KMS deletes the KMS key.</p>
|
|
5239
5239
|
* <p>If the KMS key is a multi-Region primary key with replica keys, this field does not
|
|
@@ -5241,14 +5241,14 @@ export interface ScheduleKeyDeletionResponse {
|
|
|
5241
5241
|
* deleted.</p>
|
|
5242
5242
|
* @public
|
|
5243
5243
|
*/
|
|
5244
|
-
DeletionDate?: Date;
|
|
5244
|
+
DeletionDate?: Date | undefined;
|
|
5245
5245
|
/**
|
|
5246
5246
|
* <p>The current status of the KMS key.</p>
|
|
5247
5247
|
* <p>For more information about how key state affects the use of a KMS key, see
|
|
5248
5248
|
* <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>
|
|
5249
5249
|
* @public
|
|
5250
5250
|
*/
|
|
5251
|
-
KeyState?: KeyState;
|
|
5251
|
+
KeyState?: KeyState | undefined;
|
|
5252
5252
|
/**
|
|
5253
5253
|
* <p>The waiting period before the KMS key is deleted. </p>
|
|
5254
5254
|
* <p>If the KMS key is a multi-Region primary key with replicas, the waiting period begins when
|
|
@@ -5256,7 +5256,7 @@ export interface ScheduleKeyDeletionResponse {
|
|
|
5256
5256
|
* immediately.</p>
|
|
5257
5257
|
* @public
|
|
5258
5258
|
*/
|
|
5259
|
-
PendingWindowInDays?: number;
|
|
5259
|
+
PendingWindowInDays?: number | undefined;
|
|
5260
5260
|
}
|
|
5261
5261
|
/**
|
|
5262
5262
|
* @public
|
|
@@ -5335,14 +5335,14 @@ export interface SignRequest {
|
|
|
5335
5335
|
* </ul>
|
|
5336
5336
|
* @public
|
|
5337
5337
|
*/
|
|
5338
|
-
MessageType?: MessageType;
|
|
5338
|
+
MessageType?: MessageType | undefined;
|
|
5339
5339
|
/**
|
|
5340
5340
|
* <p>A list of grant tokens.</p>
|
|
5341
5341
|
* <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
|
|
5342
5342
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
5343
5343
|
* @public
|
|
5344
5344
|
*/
|
|
5345
|
-
GrantTokens?: string[];
|
|
5345
|
+
GrantTokens?: string[] | undefined;
|
|
5346
5346
|
/**
|
|
5347
5347
|
* <p>Specifies the signing algorithm to use when signing the message. </p>
|
|
5348
5348
|
* <p>Choose an algorithm that is compatible with the type and size of the specified asymmetric
|
|
@@ -5356,7 +5356,7 @@ export interface SignRequest {
|
|
|
5356
5356
|
* <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>
|
|
5357
5357
|
* @public
|
|
5358
5358
|
*/
|
|
5359
|
-
DryRun?: boolean;
|
|
5359
|
+
DryRun?: boolean | undefined;
|
|
5360
5360
|
}
|
|
5361
5361
|
/**
|
|
5362
5362
|
* @public
|
|
@@ -5366,7 +5366,7 @@ export interface SignResponse {
|
|
|
5366
5366
|
* <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>
|
|
5367
5367
|
* @public
|
|
5368
5368
|
*/
|
|
5369
|
-
KeyId?: string;
|
|
5369
|
+
KeyId?: string | undefined;
|
|
5370
5370
|
/**
|
|
5371
5371
|
* <p>The cryptographic signature that was generated for the message. </p>
|
|
5372
5372
|
* <ul>
|
|
@@ -5386,12 +5386,12 @@ export interface SignResponse {
|
|
|
5386
5386
|
* <p>When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
|
|
5387
5387
|
* @public
|
|
5388
5388
|
*/
|
|
5389
|
-
Signature?: Uint8Array;
|
|
5389
|
+
Signature?: Uint8Array | undefined;
|
|
5390
5390
|
/**
|
|
5391
5391
|
* <p>The signing algorithm that was used to sign the message.</p>
|
|
5392
5392
|
* @public
|
|
5393
5393
|
*/
|
|
5394
|
-
SigningAlgorithm?: SigningAlgorithmSpec;
|
|
5394
|
+
SigningAlgorithm?: SigningAlgorithmSpec | undefined;
|
|
5395
5395
|
}
|
|
5396
5396
|
/**
|
|
5397
5397
|
* @public
|
|
@@ -5514,7 +5514,7 @@ export interface UpdateCustomKeyStoreRequest {
|
|
|
5514
5514
|
* be connected or disconnected.</p>
|
|
5515
5515
|
* @public
|
|
5516
5516
|
*/
|
|
5517
|
-
NewCustomKeyStoreName?: string;
|
|
5517
|
+
NewCustomKeyStoreName?: string | undefined;
|
|
5518
5518
|
/**
|
|
5519
5519
|
* <p>Enter the current password of the <code>kmsuser</code> crypto user (CU) in the CloudHSM
|
|
5520
5520
|
* cluster that is associated with the custom key store. This parameter is valid only for custom
|
|
@@ -5524,7 +5524,7 @@ export interface UpdateCustomKeyStoreRequest {
|
|
|
5524
5524
|
* <p>To change this value, the CloudHSM key store must be disconnected.</p>
|
|
5525
5525
|
* @public
|
|
5526
5526
|
*/
|
|
5527
|
-
KeyStorePassword?: string;
|
|
5527
|
+
KeyStorePassword?: string | undefined;
|
|
5528
5528
|
/**
|
|
5529
5529
|
* <p>Associates the custom key store with a related CloudHSM cluster. This parameter is valid only
|
|
5530
5530
|
* for custom key stores with a <code>CustomKeyStoreType</code> of
|
|
@@ -5538,7 +5538,7 @@ export interface UpdateCustomKeyStoreRequest {
|
|
|
5538
5538
|
* <p>To change this value, the CloudHSM key store must be disconnected.</p>
|
|
5539
5539
|
* @public
|
|
5540
5540
|
*/
|
|
5541
|
-
CloudHsmClusterId?: string;
|
|
5541
|
+
CloudHsmClusterId?: string | undefined;
|
|
5542
5542
|
/**
|
|
5543
5543
|
* <p>Changes the URI endpoint that KMS uses to connect to your external key store proxy (XKS
|
|
5544
5544
|
* proxy). This parameter is valid only for custom key stores with a
|
|
@@ -5554,7 +5554,7 @@ export interface UpdateCustomKeyStoreRequest {
|
|
|
5554
5554
|
* <p>To change this value, the external key store must be disconnected.</p>
|
|
5555
5555
|
* @public
|
|
5556
5556
|
*/
|
|
5557
|
-
XksProxyUriEndpoint?: string;
|
|
5557
|
+
XksProxyUriEndpoint?: string | undefined;
|
|
5558
5558
|
/**
|
|
5559
5559
|
* <p>Changes the base path to the proxy APIs for this external key store. To find this value,
|
|
5560
5560
|
* see the documentation for your external key manager and external key store proxy (XKS proxy).
|
|
@@ -5569,7 +5569,7 @@ export interface UpdateCustomKeyStoreRequest {
|
|
|
5569
5569
|
* <p>You can change this value when the external key store is connected or disconnected.</p>
|
|
5570
5570
|
* @public
|
|
5571
5571
|
*/
|
|
5572
|
-
XksProxyUriPath?: string;
|
|
5572
|
+
XksProxyUriPath?: string | undefined;
|
|
5573
5573
|
/**
|
|
5574
5574
|
* <p>Changes the name that KMS uses to identify the Amazon VPC endpoint service for your external
|
|
5575
5575
|
* key store proxy (XKS proxy). This parameter is valid when the <code>CustomKeyStoreType</code>
|
|
@@ -5578,7 +5578,7 @@ export interface UpdateCustomKeyStoreRequest {
|
|
|
5578
5578
|
* <p>To change this value, the external key store must be disconnected.</p>
|
|
5579
5579
|
* @public
|
|
5580
5580
|
*/
|
|
5581
|
-
XksProxyVpcEndpointServiceName?: string;
|
|
5581
|
+
XksProxyVpcEndpointServiceName?: string | undefined;
|
|
5582
5582
|
/**
|
|
5583
5583
|
* <p>Changes the credentials that KMS uses to sign requests to the external key store proxy
|
|
5584
5584
|
* (XKS proxy). This parameter is valid only for custom key stores with a
|
|
@@ -5592,7 +5592,7 @@ export interface UpdateCustomKeyStoreRequest {
|
|
|
5592
5592
|
* <p>You can change this value when the external key store is connected or disconnected.</p>
|
|
5593
5593
|
* @public
|
|
5594
5594
|
*/
|
|
5595
|
-
XksProxyAuthenticationCredential?: XksProxyAuthenticationCredentialType;
|
|
5595
|
+
XksProxyAuthenticationCredential?: XksProxyAuthenticationCredentialType | undefined;
|
|
5596
5596
|
/**
|
|
5597
5597
|
* <p>Changes the connectivity setting for the external key store. To indicate that the external
|
|
5598
5598
|
* key store proxy uses a Amazon VPC endpoint service to communicate with KMS, specify
|
|
@@ -5606,7 +5606,7 @@ export interface UpdateCustomKeyStoreRequest {
|
|
|
5606
5606
|
* <p>To change this value, the external key store must be disconnected.</p>
|
|
5607
5607
|
* @public
|
|
5608
5608
|
*/
|
|
5609
|
-
XksProxyConnectivity?: XksProxyConnectivityType;
|
|
5609
|
+
XksProxyConnectivity?: XksProxyConnectivityType | undefined;
|
|
5610
5610
|
}
|
|
5611
5611
|
/**
|
|
5612
5612
|
* @public
|
|
@@ -5757,7 +5757,7 @@ export interface VerifyRequest {
|
|
|
5757
5757
|
* </ul>
|
|
5758
5758
|
* @public
|
|
5759
5759
|
*/
|
|
5760
|
-
MessageType?: MessageType;
|
|
5760
|
+
MessageType?: MessageType | undefined;
|
|
5761
5761
|
/**
|
|
5762
5762
|
* <p>The signature that the <code>Sign</code> operation generated.</p>
|
|
5763
5763
|
* @public
|
|
@@ -5775,13 +5775,13 @@ export interface VerifyRequest {
|
|
|
5775
5775
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
5776
5776
|
* @public
|
|
5777
5777
|
*/
|
|
5778
|
-
GrantTokens?: string[];
|
|
5778
|
+
GrantTokens?: string[] | undefined;
|
|
5779
5779
|
/**
|
|
5780
5780
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
5781
5781
|
* <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>
|
|
5782
5782
|
* @public
|
|
5783
5783
|
*/
|
|
5784
|
-
DryRun?: boolean;
|
|
5784
|
+
DryRun?: boolean | undefined;
|
|
5785
5785
|
}
|
|
5786
5786
|
/**
|
|
5787
5787
|
* @public
|
|
@@ -5791,7 +5791,7 @@ export interface VerifyResponse {
|
|
|
5791
5791
|
* <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>
|
|
5792
5792
|
* @public
|
|
5793
5793
|
*/
|
|
5794
|
-
KeyId?: string;
|
|
5794
|
+
KeyId?: string | undefined;
|
|
5795
5795
|
/**
|
|
5796
5796
|
* <p>A Boolean value that indicates whether the signature was verified. A value of
|
|
5797
5797
|
* <code>True</code> indicates that the <code>Signature</code> was produced by signing the
|
|
@@ -5800,12 +5800,12 @@ export interface VerifyResponse {
|
|
|
5800
5800
|
* operation fails with a <code>KMSInvalidSignatureException</code> exception. </p>
|
|
5801
5801
|
* @public
|
|
5802
5802
|
*/
|
|
5803
|
-
SignatureValid?: boolean;
|
|
5803
|
+
SignatureValid?: boolean | undefined;
|
|
5804
5804
|
/**
|
|
5805
5805
|
* <p>The signing algorithm that was used to verify the signature.</p>
|
|
5806
5806
|
* @public
|
|
5807
5807
|
*/
|
|
5808
|
-
SigningAlgorithm?: SigningAlgorithmSpec;
|
|
5808
|
+
SigningAlgorithm?: SigningAlgorithmSpec | undefined;
|
|
5809
5809
|
}
|
|
5810
5810
|
/**
|
|
5811
5811
|
* @public
|
|
@@ -5848,13 +5848,13 @@ export interface VerifyMacRequest {
|
|
|
5848
5848
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
5849
5849
|
* @public
|
|
5850
5850
|
*/
|
|
5851
|
-
GrantTokens?: string[];
|
|
5851
|
+
GrantTokens?: string[] | undefined;
|
|
5852
5852
|
/**
|
|
5853
5853
|
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
5854
5854
|
* <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>
|
|
5855
5855
|
* @public
|
|
5856
5856
|
*/
|
|
5857
|
-
DryRun?: boolean;
|
|
5857
|
+
DryRun?: boolean | undefined;
|
|
5858
5858
|
}
|
|
5859
5859
|
/**
|
|
5860
5860
|
* @public
|
|
@@ -5864,7 +5864,7 @@ export interface VerifyMacResponse {
|
|
|
5864
5864
|
* <p>The HMAC KMS key used in the verification.</p>
|
|
5865
5865
|
* @public
|
|
5866
5866
|
*/
|
|
5867
|
-
KeyId?: string;
|
|
5867
|
+
KeyId?: string | undefined;
|
|
5868
5868
|
/**
|
|
5869
5869
|
* <p>A Boolean value that indicates whether the HMAC was verified. A value of <code>True</code>
|
|
5870
5870
|
* indicates that the HMAC (<code>Mac</code>) was generated with the specified
|
|
@@ -5875,12 +5875,12 @@ export interface VerifyMacResponse {
|
|
|
5875
5875
|
* the inputs changed since the HMAC was computed.</p>
|
|
5876
5876
|
* @public
|
|
5877
5877
|
*/
|
|
5878
|
-
MacValid?: boolean;
|
|
5878
|
+
MacValid?: boolean | undefined;
|
|
5879
5879
|
/**
|
|
5880
5880
|
* <p>The MAC algorithm used in the verification.</p>
|
|
5881
5881
|
* @public
|
|
5882
5882
|
*/
|
|
5883
|
-
MacAlgorithm?: MacAlgorithmSpec;
|
|
5883
|
+
MacAlgorithm?: MacAlgorithmSpec | undefined;
|
|
5884
5884
|
}
|
|
5885
5885
|
/**
|
|
5886
5886
|
* @internal
|