@aws-sdk/client-kms 3.363.0 → 3.366.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/models/models_0.js +15 -2
- package/dist-cjs/protocols/Aws_json1_1.js +60 -0
- package/dist-es/models/models_0.js +12 -0
- package/dist-es/protocols/Aws_json1_1.js +61 -1
- package/dist-types/commands/CancelKeyDeletionCommand.d.ts +3 -1
- package/dist-types/commands/CreateAliasCommand.d.ts +3 -1
- package/dist-types/commands/CreateCustomKeyStoreCommand.d.ts +11 -8
- package/dist-types/commands/CreateGrantCommand.d.ts +9 -1
- package/dist-types/commands/CreateKeyCommand.d.ts +16 -13
- package/dist-types/commands/DecryptCommand.d.ts +10 -2
- package/dist-types/commands/DeleteAliasCommand.d.ts +3 -1
- package/dist-types/commands/DeleteImportedKeyMaterialCommand.d.ts +3 -1
- package/dist-types/commands/DescribeCustomKeyStoresCommand.d.ts +2 -2
- package/dist-types/commands/DisableKeyCommand.d.ts +3 -1
- package/dist-types/commands/DisableKeyRotationCommand.d.ts +3 -1
- package/dist-types/commands/EnableKeyCommand.d.ts +3 -1
- package/dist-types/commands/EnableKeyRotationCommand.d.ts +3 -1
- package/dist-types/commands/EncryptCommand.d.ts +10 -3
- package/dist-types/commands/GenerateDataKeyCommand.d.ts +17 -8
- package/dist-types/commands/GenerateDataKeyPairCommand.d.ts +21 -11
- package/dist-types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +13 -4
- package/dist-types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +13 -4
- package/dist-types/commands/GenerateMacCommand.d.ts +12 -3
- package/dist-types/commands/GenerateRandomCommand.d.ts +1 -1
- package/dist-types/commands/GetKeyPolicyCommand.d.ts +3 -1
- package/dist-types/commands/GetKeyRotationStatusCommand.d.ts +3 -1
- package/dist-types/commands/GetParametersForImportCommand.d.ts +7 -4
- package/dist-types/commands/GetPublicKeyCommand.d.ts +8 -7
- package/dist-types/commands/ImportKeyMaterialCommand.d.ts +4 -3
- package/dist-types/commands/ListGrantsCommand.d.ts +3 -1
- package/dist-types/commands/ListKeyPoliciesCommand.d.ts +3 -1
- package/dist-types/commands/PutKeyPolicyCommand.d.ts +3 -1
- package/dist-types/commands/ReEncryptCommand.d.ts +9 -1
- package/dist-types/commands/ReplicateKeyCommand.d.ts +3 -1
- package/dist-types/commands/RetireGrantCommand.d.ts +9 -1
- package/dist-types/commands/RevokeGrantCommand.d.ts +9 -1
- package/dist-types/commands/ScheduleKeyDeletionCommand.d.ts +6 -4
- package/dist-types/commands/SignCommand.d.ts +9 -1
- package/dist-types/commands/TagResourceCommand.d.ts +3 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +3 -1
- package/dist-types/commands/UpdateAliasCommand.d.ts +3 -1
- package/dist-types/commands/UpdateCustomKeyStoreCommand.d.ts +5 -3
- package/dist-types/commands/UpdateKeyDescriptionCommand.d.ts +3 -1
- package/dist-types/commands/UpdatePrimaryRegionCommand.d.ts +3 -1
- package/dist-types/commands/VerifyCommand.d.ts +17 -10
- package/dist-types/commands/VerifyMacCommand.d.ts +9 -1
- package/dist-types/models/models_0.d.ts +228 -126
- package/dist-types/ts3.4/models/models_0.d.ts +21 -0
- package/package.json +1 -1
|
@@ -141,7 +141,9 @@ export declare class KMSInternalException extends __BaseException {
|
|
|
141
141
|
* </i>.</p>
|
|
142
142
|
* </li>
|
|
143
143
|
* <li>
|
|
144
|
-
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
144
|
+
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
145
|
+
* represents a general failure with many possible causes. To identify the cause, see the
|
|
146
|
+
* error message that accompanies the exception.</p>
|
|
145
147
|
* </li>
|
|
146
148
|
* </ul>
|
|
147
149
|
*/
|
|
@@ -611,8 +613,8 @@ export interface CreateCustomKeyStoreRequest {
|
|
|
611
613
|
* communicate with your external key store proxy (XKS proxy). This parameter is required when
|
|
612
614
|
* the value of <code>CustomKeyStoreType</code> is <code>EXTERNAL_KEY_STORE</code> and the value
|
|
613
615
|
* of <code>XksProxyConnectivity</code> is <code>VPC_ENDPOINT_SERVICE</code>.</p>
|
|
614
|
-
* <p>The Amazon VPC endpoint service must <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-xks-keystore.html#xks-requirements">fulfill all
|
|
615
|
-
*
|
|
616
|
+
* <p>The Amazon VPC endpoint service must <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-xks-keystore.html#xks-requirements">fulfill all
|
|
617
|
+
* requirements</a> for use with an external key store. </p>
|
|
616
618
|
* <p>
|
|
617
619
|
* <b>Uniqueness requirements:</b>
|
|
618
620
|
* </p>
|
|
@@ -647,7 +649,8 @@ export interface CreateCustomKeyStoreRequest {
|
|
|
647
649
|
* <p>If the external key store proxy uses a public endpoint, specify
|
|
648
650
|
* <code>PUBLIC_ENDPOINT</code>. If the external key store proxy uses a Amazon VPC
|
|
649
651
|
* endpoint service for communication with KMS, specify <code>VPC_ENDPOINT_SERVICE</code>. For
|
|
650
|
-
* help making this choice, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/plan-xks-keystore.html#choose-xks-connectivity">Choosing a connectivity
|
|
652
|
+
* help making this choice, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/plan-xks-keystore.html#choose-xks-connectivity">Choosing a connectivity
|
|
653
|
+
* option</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
651
654
|
* <p>An Amazon VPC endpoint service keeps your communication with KMS in a private address space
|
|
652
655
|
* entirely within Amazon Web Services, but it requires more configuration, including establishing a Amazon VPC with multiple subnets, a VPC endpoint service, a network load balancer, and a
|
|
653
656
|
* verified private DNS name. A public endpoint is simpler to set up, but it might be slower and
|
|
@@ -775,8 +778,9 @@ export declare class XksProxyUriInUseException extends __BaseException {
|
|
|
775
778
|
* @public
|
|
776
779
|
* <p>KMS was unable to reach the specified <code>XksProxyUriPath</code>. The path must be
|
|
777
780
|
* reachable before you create the external key store or update its settings.</p>
|
|
778
|
-
* <p>This exception is also thrown when the external key store proxy response to a
|
|
779
|
-
*
|
|
781
|
+
* <p>This exception is also thrown when the external key store proxy response to a
|
|
782
|
+
* <code>GetHealthStatus</code> request indicates that all external key manager instances are
|
|
783
|
+
* unavailable.</p>
|
|
780
784
|
*/
|
|
781
785
|
export declare class XksProxyUriUnreachableException extends __BaseException {
|
|
782
786
|
readonly name: "XksProxyUriUnreachableException";
|
|
@@ -804,7 +808,8 @@ export declare class XksProxyVpcEndpointServiceInUseException extends __BaseExce
|
|
|
804
808
|
* @public
|
|
805
809
|
* <p>The request was rejected because the Amazon VPC endpoint service configuration does not fulfill
|
|
806
810
|
* the requirements for an external key store proxy. For details, see the exception message and
|
|
807
|
-
* <a href="kms/latest/developerguide/vpc-connectivity.html#xks-vpc-requirements">review the
|
|
811
|
+
* <a href="kms/latest/developerguide/vpc-connectivity.html#xks-vpc-requirements">review the
|
|
812
|
+
* requirements</a> for Amazon VPC endpoint service connectivity for an external key
|
|
808
813
|
* store.</p>
|
|
809
814
|
*/
|
|
810
815
|
export declare class XksProxyVpcEndpointServiceInvalidConfigurationException extends __BaseException {
|
|
@@ -919,8 +924,8 @@ export interface CreateGrantRequest {
|
|
|
919
924
|
KeyId: string | undefined;
|
|
920
925
|
/**
|
|
921
926
|
* <p>The identity that gets the permissions specified in the grant.</p>
|
|
922
|
-
* <p>To specify the grantee principal, use the Amazon Resource Name (ARN) of an
|
|
923
|
-
*
|
|
927
|
+
* <p>To specify the grantee principal, use the Amazon Resource Name (ARN) of an Amazon Web Services
|
|
928
|
+
* principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles,
|
|
924
929
|
* federated users, and assumed role users. For help with the ARN syntax for a principal, see
|
|
925
930
|
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM ARNs</a> in the <i>
|
|
926
931
|
* <i>Identity and Access Management User Guide</i>
|
|
@@ -1003,6 +1008,11 @@ export interface CreateGrantRequest {
|
|
|
1003
1008
|
* All grant tokens for the same grant ID can be used interchangeably.</p>
|
|
1004
1009
|
*/
|
|
1005
1010
|
Name?: string;
|
|
1011
|
+
/**
|
|
1012
|
+
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
1013
|
+
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1014
|
+
*/
|
|
1015
|
+
DryRun?: boolean;
|
|
1006
1016
|
}
|
|
1007
1017
|
/**
|
|
1008
1018
|
* @public
|
|
@@ -1032,6 +1042,20 @@ export declare class DisabledException extends __BaseException {
|
|
|
1032
1042
|
*/
|
|
1033
1043
|
constructor(opts: __ExceptionOptionType<DisabledException, __BaseException>);
|
|
1034
1044
|
}
|
|
1045
|
+
/**
|
|
1046
|
+
* @public
|
|
1047
|
+
* <p>
|
|
1048
|
+
* The request was rejected because the DryRun parameter was specified.
|
|
1049
|
+
* </p>
|
|
1050
|
+
*/
|
|
1051
|
+
export declare class DryRunOperationException extends __BaseException {
|
|
1052
|
+
readonly name: "DryRunOperationException";
|
|
1053
|
+
readonly $fault: "client";
|
|
1054
|
+
/**
|
|
1055
|
+
* @internal
|
|
1056
|
+
*/
|
|
1057
|
+
constructor(opts: __ExceptionOptionType<DryRunOperationException, __BaseException>);
|
|
1058
|
+
}
|
|
1035
1059
|
/**
|
|
1036
1060
|
* @public
|
|
1037
1061
|
* <p>The request was rejected because the specified grant token is not valid.</p>
|
|
@@ -1170,8 +1194,8 @@ export interface CreateKeyRequest {
|
|
|
1170
1194
|
*/
|
|
1171
1195
|
Policy?: string;
|
|
1172
1196
|
/**
|
|
1173
|
-
* <p>A description of the KMS key. Use a description that helps you decide whether the KMS key
|
|
1174
|
-
* default value is an empty string (no description).</p>
|
|
1197
|
+
* <p>A description of the KMS key. Use a description that helps you decide whether the KMS key
|
|
1198
|
+
* is appropriate for a task. The default value is an empty string (no description).</p>
|
|
1175
1199
|
* <important>
|
|
1176
1200
|
* <p>Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p>
|
|
1177
1201
|
* </important>
|
|
@@ -1201,8 +1225,8 @@ export interface CreateKeyRequest {
|
|
|
1201
1225
|
* <code>SIGN_VERIFY</code>.</p>
|
|
1202
1226
|
* </li>
|
|
1203
1227
|
* <li>
|
|
1204
|
-
* <p>For asymmetric KMS keys with SM2 key material (China Regions only), specify
|
|
1205
|
-
*
|
|
1228
|
+
* <p>For asymmetric KMS keys with SM2 key material (China Regions only), specify
|
|
1229
|
+
* <code>ENCRYPT_DECRYPT</code> or <code>SIGN_VERIFY</code>.</p>
|
|
1206
1230
|
* </li>
|
|
1207
1231
|
* </ul>
|
|
1208
1232
|
*/
|
|
@@ -1218,8 +1242,9 @@ export interface CreateKeyRequest {
|
|
|
1218
1242
|
CustomerMasterKeySpec?: CustomerMasterKeySpec | string;
|
|
1219
1243
|
/**
|
|
1220
1244
|
* <p>Specifies the type of KMS key to create. The default value,
|
|
1221
|
-
* <code>SYMMETRIC_DEFAULT</code>, creates a KMS key with a 256-bit AES-GCM key that is used for
|
|
1222
|
-
*
|
|
1245
|
+
* <code>SYMMETRIC_DEFAULT</code>, creates a KMS key with a 256-bit AES-GCM key that is used for
|
|
1246
|
+
* encryption and decryption, except in China Regions, where it creates a 128-bit symmetric key
|
|
1247
|
+
* that uses SM4 encryption. For help choosing a key spec for your KMS key, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-types.html#symm-asymm-choose">Choosing a KMS key type</a> in the <i>
|
|
1223
1248
|
* <i>Key Management Service Developer Guide</i>
|
|
1224
1249
|
* </i>.</p>
|
|
1225
1250
|
* <p>The <code>KeySpec</code> determines whether the KMS key contains a symmetric key or an
|
|
@@ -1342,9 +1367,10 @@ export interface CreateKeyRequest {
|
|
|
1342
1367
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key
|
|
1343
1368
|
* Material</a> in the <i>Key Management Service Developer Guide</i>. The <code>EXTERNAL</code> origin value is valid
|
|
1344
1369
|
* only for symmetric KMS keys.</p>
|
|
1345
|
-
* <p>To <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-cmk-keystore.html">create a KMS
|
|
1346
|
-
*
|
|
1347
|
-
*
|
|
1370
|
+
* <p>To <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-cmk-keystore.html">create a KMS
|
|
1371
|
+
* key in an CloudHSM key store</a> and create its key material in the associated CloudHSM
|
|
1372
|
+
* cluster, set this value to <code>AWS_CLOUDHSM</code>. You must also use the
|
|
1373
|
+
* <code>CustomKeyStoreId</code> parameter to identify the CloudHSM key store. The
|
|
1348
1374
|
* <code>KeySpec</code> value must be <code>SYMMETRIC_DEFAULT</code>.</p>
|
|
1349
1375
|
* <p>To <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-xks-keys.html">create a KMS key in
|
|
1350
1376
|
* an external key store</a>, set this value to <code>EXTERNAL_KEY_STORE</code>. You must
|
|
@@ -1361,8 +1387,8 @@ export interface CreateKeyRequest {
|
|
|
1361
1387
|
* cannot create any other type of KMS key in a custom key store.</p>
|
|
1362
1388
|
* <p>When you create a KMS key in an CloudHSM key store, KMS generates a non-exportable 256-bit
|
|
1363
1389
|
* symmetric key in its associated CloudHSM cluster and associates it with the KMS key. When you
|
|
1364
|
-
* create a KMS key in an external key store, you must use the <code>XksKeyId</code> parameter to
|
|
1365
|
-
* external key that serves as key material for the KMS key.</p>
|
|
1390
|
+
* create a KMS key in an external key store, you must use the <code>XksKeyId</code> parameter to
|
|
1391
|
+
* specify an external key that serves as key material for the KMS key.</p>
|
|
1366
1392
|
*/
|
|
1367
1393
|
CustomKeyStoreId?: string;
|
|
1368
1394
|
/**
|
|
@@ -1578,18 +1604,20 @@ export declare const SigningAlgorithmSpec: {
|
|
|
1578
1604
|
export type SigningAlgorithmSpec = (typeof SigningAlgorithmSpec)[keyof typeof SigningAlgorithmSpec];
|
|
1579
1605
|
/**
|
|
1580
1606
|
* @public
|
|
1581
|
-
* <p>Information about the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key">external key </a>that is
|
|
1582
|
-
* external key store. </p>
|
|
1607
|
+
* <p>Information about the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key">external key </a>that is
|
|
1608
|
+
* associated with a KMS key in an external key store. </p>
|
|
1583
1609
|
* <p>This element appears in a <a>CreateKey</a> or <a>DescribeKey</a>
|
|
1584
1610
|
* response only for a KMS key in an external key store.</p>
|
|
1585
|
-
* <p>The <i>external key</i> is a symmetric encryption key that is hosted by
|
|
1586
|
-
*
|
|
1587
|
-
*
|
|
1588
|
-
*
|
|
1611
|
+
* <p>The <i>external key</i> is a symmetric encryption key that is hosted by an
|
|
1612
|
+
* external key manager outside of Amazon Web Services. When you use the KMS key in an external key store in a
|
|
1613
|
+
* cryptographic operation, the cryptographic operation is performed in the external key manager
|
|
1614
|
+
* using the specified external key. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key">External key</a> in the
|
|
1615
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
1589
1616
|
*/
|
|
1590
1617
|
export interface XksKeyConfigurationType {
|
|
1591
1618
|
/**
|
|
1592
|
-
* <p>The ID of the external key in its external key manager. This is the ID that the external
|
|
1619
|
+
* <p>The ID of the external key in its external key manager. This is the ID that the external
|
|
1620
|
+
* key store proxy uses to identify the external key.</p>
|
|
1593
1621
|
*/
|
|
1594
1622
|
Id?: string;
|
|
1595
1623
|
}
|
|
@@ -1761,10 +1789,10 @@ export interface KeyMetadata {
|
|
|
1761
1789
|
*/
|
|
1762
1790
|
MacAlgorithms?: (MacAlgorithmSpec | string)[];
|
|
1763
1791
|
/**
|
|
1764
|
-
* <p>Information about the external key that is associated with a KMS key in an
|
|
1765
|
-
*
|
|
1766
|
-
* <p>For more information, see
|
|
1767
|
-
* <
|
|
1792
|
+
* <p>Information about the external key that is associated with a KMS key in an external key
|
|
1793
|
+
* store.</p>
|
|
1794
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key">External key</a> in the
|
|
1795
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
1768
1796
|
*/
|
|
1769
1797
|
XksKeyConfiguration?: XksKeyConfigurationType;
|
|
1770
1798
|
}
|
|
@@ -1846,9 +1874,9 @@ export declare class XksKeyInvalidConfigurationException extends __BaseException
|
|
|
1846
1874
|
}
|
|
1847
1875
|
/**
|
|
1848
1876
|
* @public
|
|
1849
|
-
* <p>The request was rejected because the external key store proxy could not find the external
|
|
1850
|
-
* exception is thrown when the value of the <code>XksKeyId</code> parameter doesn't
|
|
1851
|
-
* key in the external key manager associated with the external key proxy.</p>
|
|
1877
|
+
* <p>The request was rejected because the external key store proxy could not find the external
|
|
1878
|
+
* key. This exception is thrown when the value of the <code>XksKeyId</code> parameter doesn't
|
|
1879
|
+
* identify a key in the external key manager associated with the external key proxy.</p>
|
|
1852
1880
|
* <p>Verify that the <code>XksKeyId</code> represents an existing key in the external key
|
|
1853
1881
|
* manager. Use the key identifier that the external key store proxy uses to identify the key.
|
|
1854
1882
|
* For details, see the documentation provided with your external key store proxy or key
|
|
@@ -1891,8 +1919,8 @@ export interface XksProxyConfigurationType {
|
|
|
1891
1919
|
*/
|
|
1892
1920
|
Connectivity?: XksProxyConnectivityType | string;
|
|
1893
1921
|
/**
|
|
1894
|
-
* <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>
|
|
1895
|
-
*
|
|
1922
|
+
* <p>The part of the external key store <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateCustomKeyStore.html#KMS-CreateCustomKeyStore-request-XksProxyAuthenticationCredential">proxy authentication credential</a> that uniquely identifies the secret access
|
|
1923
|
+
* key.</p>
|
|
1896
1924
|
*/
|
|
1897
1925
|
AccessKeyId?: string;
|
|
1898
1926
|
/**
|
|
@@ -2002,10 +2030,10 @@ export interface CustomKeyStoresListEntry {
|
|
|
2002
2030
|
* </li>
|
|
2003
2031
|
* <li>
|
|
2004
2032
|
* <p>
|
|
2005
|
-
* <code>INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET</code> — At least one private
|
|
2006
|
-
* associated with the CloudHSM cluster doesn't have any available IP addresses. A CloudHSM
|
|
2007
|
-
* store connection requires one free IP address in each of the associated private
|
|
2008
|
-
* although two are preferable. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed">How to Fix a Connection
|
|
2033
|
+
* <code>INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET</code> — At least one private
|
|
2034
|
+
* subnet associated with the CloudHSM cluster doesn't have any available IP addresses. A CloudHSM
|
|
2035
|
+
* key store connection requires one free IP address in each of the associated private
|
|
2036
|
+
* subnets, although two are preferable. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed">How to Fix a Connection
|
|
2009
2037
|
* Failure</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2010
2038
|
* </li>
|
|
2011
2039
|
* <li>
|
|
@@ -2087,8 +2115,7 @@ export interface CustomKeyStoresListEntry {
|
|
|
2087
2115
|
* external key store proxy because the TLS configuration is invalid. Verify that the XKS
|
|
2088
2116
|
* proxy supports TLS 1.2 or 1.3. Also, verify that the TLS certificate is not expired, and
|
|
2089
2117
|
* that it matches the hostname in the <code>XksProxyUriEndpoint</code> value, and that it is
|
|
2090
|
-
* signed by a certificate authority included in the <a href="https://github.com/aws/aws-kms-xksproxy-api-spec/blob/main/TrustedCertificateAuthorities">Trusted Certificate Authorities</a>
|
|
2091
|
-
* list.</p>
|
|
2118
|
+
* signed by a certificate authority included in the <a href="https://github.com/aws/aws-kms-xksproxy-api-spec/blob/main/TrustedCertificateAuthorities">Trusted Certificate Authorities</a> list.</p>
|
|
2092
2119
|
* </li>
|
|
2093
2120
|
* <li>
|
|
2094
2121
|
* <p>
|
|
@@ -2219,13 +2246,14 @@ export type KeyEncryptionMechanism = (typeof KeyEncryptionMechanism)[keyof typeo
|
|
|
2219
2246
|
*/
|
|
2220
2247
|
export interface RecipientInfo {
|
|
2221
2248
|
/**
|
|
2222
|
-
* <p>The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro
|
|
2223
|
-
* values for the response. The only valid value is
|
|
2249
|
+
* <p>The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro
|
|
2250
|
+
* Enclave to encrypt plaintext values for the response. The only valid value is
|
|
2251
|
+
* <code>RSAES_OAEP_SHA_256</code>.</p>
|
|
2224
2252
|
*/
|
|
2225
2253
|
KeyEncryptionAlgorithm?: KeyEncryptionMechanism | string;
|
|
2226
2254
|
/**
|
|
2227
|
-
* <p>The attestation document for an Amazon Web Services Nitro Enclave. This document includes the enclave's
|
|
2228
|
-
* key.</p>
|
|
2255
|
+
* <p>The attestation document for an Amazon Web Services Nitro Enclave. This document includes the enclave's
|
|
2256
|
+
* public key.</p>
|
|
2229
2257
|
*/
|
|
2230
2258
|
AttestationDocument?: Uint8Array;
|
|
2231
2259
|
}
|
|
@@ -2296,8 +2324,8 @@ export interface DecryptRequest {
|
|
|
2296
2324
|
EncryptionAlgorithm?: EncryptionAlgorithmSpec | string;
|
|
2297
2325
|
/**
|
|
2298
2326
|
* <p>A signed <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc">attestation document</a> from
|
|
2299
|
-
* an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key.
|
|
2300
|
-
*
|
|
2327
|
+
* an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The
|
|
2328
|
+
* only valid encryption algorithm is <code>RSAES_OAEP_SHA_256</code>. </p>
|
|
2301
2329
|
* <p>This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this
|
|
2302
2330
|
* parameter, use the <a href="https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk">Amazon Web Services Nitro Enclaves SDK</a> or any Amazon Web Services SDK.</p>
|
|
2303
2331
|
* <p>When you use this parameter, instead of returning the plaintext data, KMS encrypts the
|
|
@@ -2308,6 +2336,11 @@ export interface DecryptRequest {
|
|
|
2308
2336
|
* <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>
|
|
2309
2337
|
*/
|
|
2310
2338
|
Recipient?: RecipientInfo;
|
|
2339
|
+
/**
|
|
2340
|
+
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
2341
|
+
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2342
|
+
*/
|
|
2343
|
+
DryRun?: boolean;
|
|
2311
2344
|
}
|
|
2312
2345
|
/**
|
|
2313
2346
|
* @public
|
|
@@ -2320,7 +2353,7 @@ export interface DecryptResponse {
|
|
|
2320
2353
|
/**
|
|
2321
2354
|
* <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>
|
|
2322
2355
|
* <p>If the response includes the <code>CiphertextForRecipient</code> field, the
|
|
2323
|
-
*
|
|
2356
|
+
* <code>Plaintext</code> field is null or empty.</p>
|
|
2324
2357
|
*/
|
|
2325
2358
|
Plaintext?: Uint8Array;
|
|
2326
2359
|
/**
|
|
@@ -2736,11 +2769,16 @@ export interface EncryptRequest {
|
|
|
2736
2769
|
* <p>Specifies the encryption algorithm that KMS will use to encrypt the plaintext message.
|
|
2737
2770
|
* The algorithm must be compatible with the KMS key that you specify.</p>
|
|
2738
2771
|
* <p>This parameter is required only for asymmetric KMS keys. The default value,
|
|
2739
|
-
* <code>SYMMETRIC_DEFAULT</code>, is the algorithm used for symmetric encryption KMS keys. If
|
|
2740
|
-
* using an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256.</p>
|
|
2772
|
+
* <code>SYMMETRIC_DEFAULT</code>, is the algorithm used for symmetric encryption KMS keys. If
|
|
2773
|
+
* you are using an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256.</p>
|
|
2741
2774
|
* <p>The SM2PKE algorithm is only available in China Regions.</p>
|
|
2742
2775
|
*/
|
|
2743
2776
|
EncryptionAlgorithm?: EncryptionAlgorithmSpec | string;
|
|
2777
|
+
/**
|
|
2778
|
+
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
2779
|
+
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2780
|
+
*/
|
|
2781
|
+
DryRun?: boolean;
|
|
2744
2782
|
}
|
|
2745
2783
|
/**
|
|
2746
2784
|
* @public
|
|
@@ -2838,20 +2876,25 @@ export interface GenerateDataKeyRequest {
|
|
|
2838
2876
|
GrantTokens?: string[];
|
|
2839
2877
|
/**
|
|
2840
2878
|
* <p>A signed <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc">attestation document</a> from
|
|
2841
|
-
* an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key.
|
|
2842
|
-
*
|
|
2879
|
+
* an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The
|
|
2880
|
+
* only valid encryption algorithm is <code>RSAES_OAEP_SHA_256</code>. </p>
|
|
2843
2881
|
* <p>This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this
|
|
2844
2882
|
* parameter, use the <a href="https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk">Amazon Web Services Nitro Enclaves SDK</a> or any Amazon Web Services SDK.</p>
|
|
2845
2883
|
* <p>When you use this parameter, instead of returning the plaintext data key, KMS encrypts
|
|
2846
2884
|
* the plaintext data key under the public key in the attestation document, and returns the
|
|
2847
2885
|
* resulting ciphertext in the <code>CiphertextForRecipient</code> field in the response. This
|
|
2848
2886
|
* ciphertext can be decrypted only with the private key in the enclave. The
|
|
2849
|
-
*
|
|
2887
|
+
* <code>CiphertextBlob</code> field in the response contains a copy of the data key encrypted
|
|
2850
2888
|
* under the KMS key specified by the <code>KeyId</code> parameter. The <code>Plaintext</code>
|
|
2851
2889
|
* field in the response is null or empty.</p>
|
|
2852
2890
|
* <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>
|
|
2853
2891
|
*/
|
|
2854
2892
|
Recipient?: RecipientInfo;
|
|
2893
|
+
/**
|
|
2894
|
+
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
2895
|
+
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2896
|
+
*/
|
|
2897
|
+
DryRun?: boolean;
|
|
2855
2898
|
}
|
|
2856
2899
|
/**
|
|
2857
2900
|
* @public
|
|
@@ -2865,7 +2908,7 @@ export interface GenerateDataKeyResponse {
|
|
|
2865
2908
|
* <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
|
|
2866
2909
|
* KMS. Then, remove it from memory as soon as possible.</p>
|
|
2867
2910
|
* <p>If the response includes the <code>CiphertextForRecipient</code> field, the
|
|
2868
|
-
*
|
|
2911
|
+
* <code>Plaintext</code> field is null or empty.</p>
|
|
2869
2912
|
*/
|
|
2870
2913
|
Plaintext?: Uint8Array;
|
|
2871
2914
|
/**
|
|
@@ -2873,8 +2916,8 @@ export interface GenerateDataKeyResponse {
|
|
|
2873
2916
|
*/
|
|
2874
2917
|
KeyId?: string;
|
|
2875
2918
|
/**
|
|
2876
|
-
* <p>The plaintext data key encrypted with the public key from the Nitro enclave. This
|
|
2877
|
-
* be decrypted only by using a private key in the Nitro enclave. </p>
|
|
2919
|
+
* <p>The plaintext data key encrypted with the public key from the Nitro enclave. This
|
|
2920
|
+
* ciphertext can be decrypted only by using a private key in the Nitro enclave. </p>
|
|
2878
2921
|
* <p>This field is included in the response only when the <code>Recipient</code> parameter in
|
|
2879
2922
|
* the request includes a valid attestation document from an Amazon Web Services Nitro enclave.
|
|
2880
2923
|
* 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>
|
|
@@ -2938,20 +2981,25 @@ export interface GenerateDataKeyPairRequest {
|
|
|
2938
2981
|
GrantTokens?: string[];
|
|
2939
2982
|
/**
|
|
2940
2983
|
* <p>A signed <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc">attestation document</a> from
|
|
2941
|
-
* an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key.
|
|
2942
|
-
*
|
|
2984
|
+
* an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The
|
|
2985
|
+
* only valid encryption algorithm is <code>RSAES_OAEP_SHA_256</code>. </p>
|
|
2943
2986
|
* <p>This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this
|
|
2944
2987
|
* parameter, use the <a href="https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk">Amazon Web Services Nitro Enclaves SDK</a> or any Amazon Web Services SDK.</p>
|
|
2945
|
-
* <p>When you use this parameter, instead of returning a plaintext copy of the private data
|
|
2946
|
-
* the plaintext private data key under the public key in the attestation
|
|
2947
|
-
* resulting ciphertext in the <code>CiphertextForRecipient</code>
|
|
2948
|
-
* ciphertext can be decrypted only with the private key in the
|
|
2949
|
-
* <code>CiphertextBlob</code> field in the response contains a copy of the private
|
|
2950
|
-
* under the KMS key specified by the <code>KeyId</code> parameter. The
|
|
2951
|
-
*
|
|
2988
|
+
* <p>When you use this parameter, instead of returning a plaintext copy of the private data
|
|
2989
|
+
* key, KMS encrypts the plaintext private data key under the public key in the attestation
|
|
2990
|
+
* document, and returns the resulting ciphertext in the <code>CiphertextForRecipient</code>
|
|
2991
|
+
* field in the response. This ciphertext can be decrypted only with the private key in the
|
|
2992
|
+
* enclave. The <code>CiphertextBlob</code> field in the response contains a copy of the private
|
|
2993
|
+
* data key encrypted under the KMS key specified by the <code>KeyId</code> parameter. The
|
|
2994
|
+
* <code>PrivateKeyPlaintext</code> field in the response is null or empty.</p>
|
|
2952
2995
|
* <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>
|
|
2953
2996
|
*/
|
|
2954
2997
|
Recipient?: RecipientInfo;
|
|
2998
|
+
/**
|
|
2999
|
+
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
3000
|
+
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3001
|
+
*/
|
|
3002
|
+
DryRun?: boolean;
|
|
2955
3003
|
}
|
|
2956
3004
|
/**
|
|
2957
3005
|
* @public
|
|
@@ -2964,7 +3012,7 @@ export interface GenerateDataKeyPairResponse {
|
|
|
2964
3012
|
/**
|
|
2965
3013
|
* <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>
|
|
2966
3014
|
* <p>If the response includes the <code>CiphertextForRecipient</code> field, the
|
|
2967
|
-
*
|
|
3015
|
+
* <code>PrivateKeyPlaintext</code> field is null or empty.</p>
|
|
2968
3016
|
*/
|
|
2969
3017
|
PrivateKeyPlaintext?: Uint8Array;
|
|
2970
3018
|
/**
|
|
@@ -2980,8 +3028,8 @@ export interface GenerateDataKeyPairResponse {
|
|
|
2980
3028
|
*/
|
|
2981
3029
|
KeyPairSpec?: DataKeyPairSpec | string;
|
|
2982
3030
|
/**
|
|
2983
|
-
* <p>The plaintext private data key encrypted with the public key from the Nitro enclave. This
|
|
2984
|
-
* be decrypted only by using a private key in the Nitro enclave. </p>
|
|
3031
|
+
* <p>The plaintext private data key encrypted with the public key from the Nitro enclave. This
|
|
3032
|
+
* ciphertext can be decrypted only by using a private key in the Nitro enclave. </p>
|
|
2985
3033
|
* <p>This field is included in the response only when the <code>Recipient</code> parameter in
|
|
2986
3034
|
* the request includes a valid attestation document from an Amazon Web Services Nitro enclave.
|
|
2987
3035
|
* 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>
|
|
@@ -3043,6 +3091,11 @@ export interface GenerateDataKeyPairWithoutPlaintextRequest {
|
|
|
3043
3091
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
3044
3092
|
*/
|
|
3045
3093
|
GrantTokens?: string[];
|
|
3094
|
+
/**
|
|
3095
|
+
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
3096
|
+
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3097
|
+
*/
|
|
3098
|
+
DryRun?: boolean;
|
|
3046
3099
|
}
|
|
3047
3100
|
/**
|
|
3048
3101
|
* @public
|
|
@@ -3125,6 +3178,11 @@ export interface GenerateDataKeyWithoutPlaintextRequest {
|
|
|
3125
3178
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
3126
3179
|
*/
|
|
3127
3180
|
GrantTokens?: string[];
|
|
3181
|
+
/**
|
|
3182
|
+
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
3183
|
+
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3184
|
+
*/
|
|
3185
|
+
DryRun?: boolean;
|
|
3128
3186
|
}
|
|
3129
3187
|
/**
|
|
3130
3188
|
* @public
|
|
@@ -3171,14 +3229,19 @@ export interface GenerateMacRequest {
|
|
|
3171
3229
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
3172
3230
|
*/
|
|
3173
3231
|
GrantTokens?: string[];
|
|
3232
|
+
/**
|
|
3233
|
+
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
3234
|
+
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3235
|
+
*/
|
|
3236
|
+
DryRun?: boolean;
|
|
3174
3237
|
}
|
|
3175
3238
|
/**
|
|
3176
3239
|
* @public
|
|
3177
3240
|
*/
|
|
3178
3241
|
export interface GenerateMacResponse {
|
|
3179
3242
|
/**
|
|
3180
|
-
* <p>The hash-based message authentication code (HMAC) that was generated for the
|
|
3181
|
-
*
|
|
3243
|
+
* <p>The hash-based message authentication code (HMAC) that was generated for the specified
|
|
3244
|
+
* message, HMAC KMS key, and MAC algorithm.</p>
|
|
3182
3245
|
* <p>This is the standard, raw HMAC defined in <a href="https://datatracker.ietf.org/doc/html/rfc2104">RFC 2104</a>.</p>
|
|
3183
3246
|
*/
|
|
3184
3247
|
Mac?: Uint8Array;
|
|
@@ -3204,13 +3267,13 @@ export interface GenerateRandomRequest {
|
|
|
3204
3267
|
* specified CloudHSM key store. To find the ID of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p>
|
|
3205
3268
|
* <p>External key store IDs are not valid for this parameter. If you specify the ID of an
|
|
3206
3269
|
* external key store, <code>GenerateRandom</code> throws an
|
|
3207
|
-
*
|
|
3270
|
+
* <code>UnsupportedOperationException</code>.</p>
|
|
3208
3271
|
*/
|
|
3209
3272
|
CustomKeyStoreId?: string;
|
|
3210
3273
|
/**
|
|
3211
3274
|
* <p>A signed <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc">attestation document</a> from
|
|
3212
|
-
* an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key.
|
|
3213
|
-
*
|
|
3275
|
+
* an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The
|
|
3276
|
+
* only valid encryption algorithm is <code>RSAES_OAEP_SHA_256</code>. </p>
|
|
3214
3277
|
* <p>This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this
|
|
3215
3278
|
* parameter, use the <a href="https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk">Amazon Web Services Nitro Enclaves SDK</a> or any Amazon Web Services SDK.</p>
|
|
3216
3279
|
* <p>When you use this parameter, instead of returning plaintext bytes, KMS encrypts the
|
|
@@ -3229,12 +3292,12 @@ export interface GenerateRandomResponse {
|
|
|
3229
3292
|
/**
|
|
3230
3293
|
* <p>The random byte string. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
|
|
3231
3294
|
* <p>If the response includes the <code>CiphertextForRecipient</code> field, the
|
|
3232
|
-
*
|
|
3295
|
+
* <code>Plaintext</code> field is null or empty.</p>
|
|
3233
3296
|
*/
|
|
3234
3297
|
Plaintext?: Uint8Array;
|
|
3235
3298
|
/**
|
|
3236
|
-
* <p>The plaintext random bytes encrypted with the public key from the Nitro enclave. This
|
|
3237
|
-
* be decrypted only by using a private key in the Nitro enclave. </p>
|
|
3299
|
+
* <p>The plaintext random bytes encrypted with the public key from the Nitro enclave. This
|
|
3300
|
+
* ciphertext can be decrypted only by using a private key in the Nitro enclave. </p>
|
|
3238
3301
|
* <p>This field is included in the response only when the <code>Recipient</code> parameter in
|
|
3239
3302
|
* the request includes a valid attestation document from an Amazon Web Services Nitro enclave.
|
|
3240
3303
|
* 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>
|
|
@@ -3357,30 +3420,32 @@ export interface GetParametersForImportRequest {
|
|
|
3357
3420
|
* <ul>
|
|
3358
3421
|
* <li>
|
|
3359
3422
|
* <p>
|
|
3360
|
-
* <b>RSA_AES_KEY_WRAP_SHA_256</b> — Supported for
|
|
3361
|
-
* material.</p>
|
|
3423
|
+
* <b>RSA_AES_KEY_WRAP_SHA_256</b> — Supported for
|
|
3424
|
+
* wrapping RSA and ECC key material.</p>
|
|
3362
3425
|
* </li>
|
|
3363
3426
|
* <li>
|
|
3364
3427
|
* <p>
|
|
3365
|
-
* <b>RSA_AES_KEY_WRAP_SHA_1</b> — Supported for
|
|
3428
|
+
* <b>RSA_AES_KEY_WRAP_SHA_1</b> — Supported for
|
|
3429
|
+
* wrapping RSA and ECC key material.</p>
|
|
3366
3430
|
* </li>
|
|
3367
3431
|
* <li>
|
|
3368
3432
|
* <p>
|
|
3369
|
-
* <b>RSAES_OAEP_SHA_256</b> — Supported for all types
|
|
3370
|
-
*
|
|
3371
|
-
*
|
|
3433
|
+
* <b>RSAES_OAEP_SHA_256</b> — Supported for all types
|
|
3434
|
+
* of key material, except RSA key material (private key).</p>
|
|
3435
|
+
* <p>You cannot use the RSAES_OAEP_SHA_256 wrapping algorithm with the RSA_2048 wrapping
|
|
3436
|
+
* key spec to wrap ECC_NIST_P521 key material.</p>
|
|
3372
3437
|
* </li>
|
|
3373
3438
|
* <li>
|
|
3374
3439
|
* <p>
|
|
3375
|
-
* <b>RSAES_OAEP_SHA_1</b> — Supported for all types of
|
|
3376
|
-
* key).</p>
|
|
3377
|
-
* <p>You cannot use the RSAES_OAEP_SHA_1 wrapping algorithm with the RSA_2048 wrapping key
|
|
3378
|
-
* ECC_NIST_P521 key material.</p>
|
|
3440
|
+
* <b>RSAES_OAEP_SHA_1</b> — Supported for all types of
|
|
3441
|
+
* key material, except RSA key material (private key).</p>
|
|
3442
|
+
* <p>You cannot use the RSAES_OAEP_SHA_1 wrapping algorithm with the RSA_2048 wrapping key
|
|
3443
|
+
* spec to wrap ECC_NIST_P521 key material.</p>
|
|
3379
3444
|
* </li>
|
|
3380
3445
|
* <li>
|
|
3381
3446
|
* <p>
|
|
3382
|
-
* <b>RSAES_PKCS1_V1_5</b> (Deprecated) — Supported only
|
|
3383
|
-
* material (and only in legacy mode).</p>
|
|
3447
|
+
* <b>RSAES_PKCS1_V1_5</b> (Deprecated) — Supported only
|
|
3448
|
+
* for symmetric encryption key material (and only in legacy mode).</p>
|
|
3384
3449
|
* </li>
|
|
3385
3450
|
* </ul>
|
|
3386
3451
|
*/
|
|
@@ -4229,6 +4294,11 @@ export interface ReEncryptRequest {
|
|
|
4229
4294
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
4230
4295
|
*/
|
|
4231
4296
|
GrantTokens?: string[];
|
|
4297
|
+
/**
|
|
4298
|
+
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
4299
|
+
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
4300
|
+
*/
|
|
4301
|
+
DryRun?: boolean;
|
|
4232
4302
|
}
|
|
4233
4303
|
/**
|
|
4234
4304
|
* @public
|
|
@@ -4437,6 +4507,11 @@ export interface RetireGrantRequest {
|
|
|
4437
4507
|
* </ul>
|
|
4438
4508
|
*/
|
|
4439
4509
|
GrantId?: string;
|
|
4510
|
+
/**
|
|
4511
|
+
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
4512
|
+
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
4513
|
+
*/
|
|
4514
|
+
DryRun?: boolean;
|
|
4440
4515
|
}
|
|
4441
4516
|
/**
|
|
4442
4517
|
* @public
|
|
@@ -4466,6 +4541,11 @@ export interface RevokeGrantRequest {
|
|
|
4466
4541
|
* <a>ListGrants</a>, or <a>ListRetirableGrants</a>.</p>
|
|
4467
4542
|
*/
|
|
4468
4543
|
GrantId: string | undefined;
|
|
4544
|
+
/**
|
|
4545
|
+
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
4546
|
+
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
4547
|
+
*/
|
|
4548
|
+
DryRun?: boolean;
|
|
4469
4549
|
}
|
|
4470
4550
|
/**
|
|
4471
4551
|
* @public
|
|
@@ -4495,11 +4575,11 @@ export interface ScheduleKeyDeletionRequest {
|
|
|
4495
4575
|
* when the last of its replica keys is deleted. Otherwise, the waiting period begins
|
|
4496
4576
|
* immediately.</p>
|
|
4497
4577
|
* <p>This value is optional. If you include a value, it must be between 7 and 30, inclusive. If
|
|
4498
|
-
* you do not include a value, it defaults to 30. You can use the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-
|
|
4578
|
+
* you do not include a value, it defaults to 30. You can use the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-kms-schedule-key-deletion-pending-window-in-days">
|
|
4499
4579
|
* <code>kms:ScheduleKeyDeletionPendingWindowInDays</code>
|
|
4500
|
-
* </a>
|
|
4501
|
-
*
|
|
4502
|
-
*
|
|
4580
|
+
* </a> condition key to further
|
|
4581
|
+
* constrain the values that principals can specify in the <code>PendingWindowInDays</code>
|
|
4582
|
+
* parameter.</p>
|
|
4503
4583
|
*/
|
|
4504
4584
|
PendingWindowInDays?: number;
|
|
4505
4585
|
}
|
|
@@ -4566,28 +4646,30 @@ export interface SignRequest {
|
|
|
4566
4646
|
/**
|
|
4567
4647
|
* <p>Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a
|
|
4568
4648
|
* larger message, provide a message digest.</p>
|
|
4569
|
-
* <p>If you provide a message digest, use the <code>DIGEST</code> value of
|
|
4570
|
-
*
|
|
4649
|
+
* <p>If you provide a message digest, use the <code>DIGEST</code> value of
|
|
4650
|
+
* <code>MessageType</code> to prevent the digest from being hashed again while signing.</p>
|
|
4571
4651
|
*/
|
|
4572
4652
|
Message: Uint8Array | undefined;
|
|
4573
4653
|
/**
|
|
4574
|
-
* <p>Tells KMS whether the value of the <code>Message</code> parameter should be hashed
|
|
4575
|
-
*
|
|
4576
|
-
*
|
|
4654
|
+
* <p>Tells KMS whether the value of the <code>Message</code> parameter should be hashed as
|
|
4655
|
+
* part of the signing algorithm. Use <code>RAW</code> for unhashed messages; use
|
|
4656
|
+
* <code>DIGEST</code> for message digests, which are already hashed.</p>
|
|
4577
4657
|
* <p>When the value of <code>MessageType</code> is <code>RAW</code>, KMS uses the standard
|
|
4578
|
-
* signing algorithm, which begins with a hash function. When the value is <code>DIGEST</code>,
|
|
4579
|
-
* the hashing step in the signing algorithm.</p>
|
|
4658
|
+
* signing algorithm, which begins with a hash function. When the value is <code>DIGEST</code>,
|
|
4659
|
+
* KMS skips the hashing step in the signing algorithm.</p>
|
|
4580
4660
|
* <important>
|
|
4581
4661
|
* <p>Use the <code>DIGEST</code> value only when the value of the <code>Message</code>
|
|
4582
|
-
* parameter is a message digest. If you use the <code>DIGEST</code> value with an unhashed
|
|
4583
|
-
* the security of the signing operation can be compromised.</p>
|
|
4662
|
+
* parameter is a message digest. If you use the <code>DIGEST</code> value with an unhashed
|
|
4663
|
+
* message, the security of the signing operation can be compromised.</p>
|
|
4584
4664
|
* </important>
|
|
4585
|
-
* <p>When the value of <code>MessageType</code>is <code>DIGEST</code>, the length
|
|
4586
|
-
*
|
|
4665
|
+
* <p>When the value of <code>MessageType</code>is <code>DIGEST</code>, the length of the
|
|
4666
|
+
* <code>Message</code> value must match the length of hashed messages for the specified
|
|
4667
|
+
* signing algorithm.</p>
|
|
4587
4668
|
* <p>You can submit a message digest and omit the <code>MessageType</code> or specify
|
|
4588
|
-
*
|
|
4589
|
-
* verifying with a system that assumes a single hash.</p>
|
|
4590
|
-
* <p>The hashing algorithm in that <code>Sign</code> uses is based on the
|
|
4669
|
+
* <code>RAW</code> so the digest is hashed again while signing. However, this can cause
|
|
4670
|
+
* verification failures when verifying with a system that assumes a single hash.</p>
|
|
4671
|
+
* <p>The hashing algorithm in that <code>Sign</code> uses is based on the
|
|
4672
|
+
* <code>SigningAlgorithm</code> value.</p>
|
|
4591
4673
|
* <ul>
|
|
4592
4674
|
* <li>
|
|
4593
4675
|
* <p>Signing algorithms that end in SHA_256 use the SHA_256 hashing algorithm.</p>
|
|
@@ -4599,7 +4681,8 @@ export interface SignRequest {
|
|
|
4599
4681
|
* <p>Signing algorithms that end in SHA_512 use the SHA_512 hashing algorithm.</p>
|
|
4600
4682
|
* </li>
|
|
4601
4683
|
* <li>
|
|
4602
|
-
* <p>SM2DSA uses the SM3 hashing algorithm. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification">Offline
|
|
4684
|
+
* <p>SM2DSA uses the SM3 hashing algorithm. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification">Offline
|
|
4685
|
+
* verification with SM2 key pairs</a>.</p>
|
|
4603
4686
|
* </li>
|
|
4604
4687
|
* </ul>
|
|
4605
4688
|
*/
|
|
@@ -4613,10 +4696,15 @@ export interface SignRequest {
|
|
|
4613
4696
|
/**
|
|
4614
4697
|
* <p>Specifies the signing algorithm to use when signing the message. </p>
|
|
4615
4698
|
* <p>Choose an algorithm that is compatible with the type and size of the specified asymmetric
|
|
4616
|
-
* KMS key.
|
|
4699
|
+
* KMS key. When signing with RSA key pairs, RSASSA-PSS algorithms are preferred. We include
|
|
4617
4700
|
* RSASSA-PKCS1-v1_5 algorithms for compatibility with existing applications.</p>
|
|
4618
4701
|
*/
|
|
4619
4702
|
SigningAlgorithm: SigningAlgorithmSpec | string | undefined;
|
|
4703
|
+
/**
|
|
4704
|
+
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
4705
|
+
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
4706
|
+
*/
|
|
4707
|
+
DryRun?: boolean;
|
|
4620
4708
|
}
|
|
4621
4709
|
/**
|
|
4622
4710
|
* @public
|
|
@@ -4672,8 +4760,8 @@ export interface TagResourceRequest {
|
|
|
4672
4760
|
*/
|
|
4673
4761
|
KeyId: string | undefined;
|
|
4674
4762
|
/**
|
|
4675
|
-
* <p>One or more tags. Each tag consists of a tag key and a tag value. The tag value can be an
|
|
4676
|
-
* string. </p>
|
|
4763
|
+
* <p>One or more tags. Each tag consists of a tag key and a tag value. The tag value can be an
|
|
4764
|
+
* empty (null) string. </p>
|
|
4677
4765
|
* <important>
|
|
4678
4766
|
* <p>Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p>
|
|
4679
4767
|
* </important>
|
|
@@ -4948,31 +5036,34 @@ export interface VerifyRequest {
|
|
|
4948
5036
|
KeyId: string | undefined;
|
|
4949
5037
|
/**
|
|
4950
5038
|
* <p>Specifies the message that was signed. You can submit a raw message of up to 4096 bytes,
|
|
4951
|
-
* or a hash digest of the message. If you submit a digest, use the <code>MessageType</code>
|
|
4952
|
-
* with a value of <code>DIGEST</code>.</p>
|
|
5039
|
+
* or a hash digest of the message. If you submit a digest, use the <code>MessageType</code>
|
|
5040
|
+
* parameter with a value of <code>DIGEST</code>.</p>
|
|
4953
5041
|
* <p>If the message specified here is different from the message that was signed, the signature
|
|
4954
5042
|
* verification fails. A message and its hash digest are considered to be the same
|
|
4955
5043
|
* message.</p>
|
|
4956
5044
|
*/
|
|
4957
5045
|
Message: Uint8Array | undefined;
|
|
4958
5046
|
/**
|
|
4959
|
-
* <p>Tells KMS whether the value of the <code>Message</code> parameter should be hashed
|
|
4960
|
-
*
|
|
4961
|
-
*
|
|
5047
|
+
* <p>Tells KMS whether the value of the <code>Message</code> parameter should be hashed as
|
|
5048
|
+
* part of the signing algorithm. Use <code>RAW</code> for unhashed messages; use
|
|
5049
|
+
* <code>DIGEST</code> for message digests, which are already hashed.</p>
|
|
4962
5050
|
* <p>When the value of <code>MessageType</code> is <code>RAW</code>, KMS uses the standard
|
|
4963
|
-
* signing algorithm, which begins with a hash function. When the value is <code>DIGEST</code>,
|
|
4964
|
-
* skips the hashing step in the signing algorithm.</p>
|
|
5051
|
+
* signing algorithm, which begins with a hash function. When the value is <code>DIGEST</code>,
|
|
5052
|
+
* KMS skips the hashing step in the signing algorithm.</p>
|
|
4965
5053
|
* <important>
|
|
4966
5054
|
* <p>Use the <code>DIGEST</code> value only when the value of the <code>Message</code>
|
|
4967
|
-
* parameter is a message digest. If you use the <code>DIGEST</code> value with an unhashed
|
|
4968
|
-
* the security of the verification operation can be compromised.</p>
|
|
5055
|
+
* parameter is a message digest. If you use the <code>DIGEST</code> value with an unhashed
|
|
5056
|
+
* message, the security of the verification operation can be compromised.</p>
|
|
4969
5057
|
* </important>
|
|
4970
|
-
* <p>When the value of <code>MessageType</code>is <code>DIGEST</code>, the length
|
|
4971
|
-
*
|
|
5058
|
+
* <p>When the value of <code>MessageType</code>is <code>DIGEST</code>, the length of the
|
|
5059
|
+
* <code>Message</code> value must match the length of hashed messages for the specified
|
|
5060
|
+
* signing algorithm.</p>
|
|
4972
5061
|
* <p>You can submit a message digest and omit the <code>MessageType</code> or specify
|
|
4973
|
-
*
|
|
4974
|
-
* while signing, but twice while verifying, verification fails, even when the
|
|
4975
|
-
*
|
|
5062
|
+
* <code>RAW</code> so the digest is hashed again while signing. However, if the signed message
|
|
5063
|
+
* is hashed once while signing, but twice while verifying, verification fails, even when the
|
|
5064
|
+
* message hasn't changed.</p>
|
|
5065
|
+
* <p>The hashing algorithm in that <code>Verify</code> uses is based on the
|
|
5066
|
+
* <code>SigningAlgorithm</code> value.</p>
|
|
4976
5067
|
* <ul>
|
|
4977
5068
|
* <li>
|
|
4978
5069
|
* <p>Signing algorithms that end in SHA_256 use the SHA_256 hashing algorithm.</p>
|
|
@@ -4984,7 +5075,8 @@ export interface VerifyRequest {
|
|
|
4984
5075
|
* <p>Signing algorithms that end in SHA_512 use the SHA_512 hashing algorithm.</p>
|
|
4985
5076
|
* </li>
|
|
4986
5077
|
* <li>
|
|
4987
|
-
* <p>SM2DSA uses the SM3 hashing algorithm. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification">Offline
|
|
5078
|
+
* <p>SM2DSA uses the SM3 hashing algorithm. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification">Offline
|
|
5079
|
+
* verification with SM2 key pairs</a>.</p>
|
|
4988
5080
|
* </li>
|
|
4989
5081
|
* </ul>
|
|
4990
5082
|
*/
|
|
@@ -5004,6 +5096,11 @@ export interface VerifyRequest {
|
|
|
5004
5096
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
5005
5097
|
*/
|
|
5006
5098
|
GrantTokens?: string[];
|
|
5099
|
+
/**
|
|
5100
|
+
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
5101
|
+
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
5102
|
+
*/
|
|
5103
|
+
DryRun?: boolean;
|
|
5007
5104
|
}
|
|
5008
5105
|
/**
|
|
5009
5106
|
* @public
|
|
@@ -5063,6 +5160,11 @@ export interface VerifyMacRequest {
|
|
|
5063
5160
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
5064
5161
|
*/
|
|
5065
5162
|
GrantTokens?: string[];
|
|
5163
|
+
/**
|
|
5164
|
+
* <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
|
|
5165
|
+
* <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
5166
|
+
*/
|
|
5167
|
+
DryRun?: boolean;
|
|
5066
5168
|
}
|
|
5067
5169
|
/**
|
|
5068
5170
|
* @public
|