aws-sdk 2.684.0 → 2.688.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/CHANGELOG.md +20 -1
- package/README.md +1 -1
- package/apis/athena-2017-05-18.min.json +287 -10
- package/apis/athena-2017-05-18.paginators.json +31 -7
- package/apis/elasticloadbalancingv2-2015-12-01.min.json +76 -63
- package/apis/elasticmapreduce-2009-03-31.min.json +3 -0
- package/apis/fsx-2018-03-01.min.json +49 -18
- package/apis/guardduty-2017-11-28.min.json +160 -26
- package/apis/kafka-2018-11-14.min.json +109 -7
- package/apis/marketplace-catalog-2018-09-17.min.json +1 -0
- package/apis/sagemaker-2017-07-24.min.json +4 -2
- package/apis/worklink-2018-09-25.min.json +102 -8
- package/apis/workmail-2017-10-01.min.json +106 -24
- package/clients/athena.d.ts +385 -30
- package/clients/elbv2.d.ts +15 -1
- package/clients/emr.d.ts +12 -0
- package/clients/fsx.d.ts +58 -13
- package/clients/guardduty.d.ts +144 -10
- package/clients/kafka.d.ts +131 -1
- package/clients/kms.d.ts +32 -32
- package/clients/marketplacecatalog.d.ts +10 -6
- package/clients/qldbsession.d.ts +9 -9
- package/clients/sagemaker.d.ts +53 -45
- package/clients/worklink.d.ts +80 -4
- package/clients/workmail.d.ts +104 -0
- package/dist/aws-sdk-core-react-native.js +1 -1
- package/dist/aws-sdk-react-native.js +14 -14
- package/dist/aws-sdk.js +83 -67
- package/dist/aws-sdk.min.js +43 -43
- package/dist/xml2js.js +1 -1
- package/lib/core.js +1 -1
- package/package.json +2 -2
package/clients/kafka.d.ts
CHANGED
|
@@ -107,6 +107,18 @@ declare class Kafka extends Service {
|
|
|
107
107
|
|
|
108
108
|
*/
|
|
109
109
|
getBootstrapBrokers(callback?: (err: AWSError, data: Kafka.Types.GetBootstrapBrokersResponse) => void): Request<Kafka.Types.GetBootstrapBrokersResponse, AWSError>;
|
|
110
|
+
/**
|
|
111
|
+
*
|
|
112
|
+
Gets the Apache Kafka versions to which you can update the MSK cluster.
|
|
113
|
+
|
|
114
|
+
*/
|
|
115
|
+
getCompatibleKafkaVersions(params: Kafka.Types.GetCompatibleKafkaVersionsRequest, callback?: (err: AWSError, data: Kafka.Types.GetCompatibleKafkaVersionsResponse) => void): Request<Kafka.Types.GetCompatibleKafkaVersionsResponse, AWSError>;
|
|
116
|
+
/**
|
|
117
|
+
*
|
|
118
|
+
Gets the Apache Kafka versions to which you can update the MSK cluster.
|
|
119
|
+
|
|
120
|
+
*/
|
|
121
|
+
getCompatibleKafkaVersions(callback?: (err: AWSError, data: Kafka.Types.GetCompatibleKafkaVersionsResponse) => void): Request<Kafka.Types.GetCompatibleKafkaVersionsResponse, AWSError>;
|
|
110
122
|
/**
|
|
111
123
|
*
|
|
112
124
|
Returns a list of all the operations that have been performed on the specified MSK cluster.
|
|
@@ -251,6 +263,18 @@ declare class Kafka extends Service {
|
|
|
251
263
|
|
|
252
264
|
*/
|
|
253
265
|
updateClusterConfiguration(callback?: (err: AWSError, data: Kafka.Types.UpdateClusterConfigurationResponse) => void): Request<Kafka.Types.UpdateClusterConfigurationResponse, AWSError>;
|
|
266
|
+
/**
|
|
267
|
+
*
|
|
268
|
+
Updates the Apache Kafka version for the cluster.
|
|
269
|
+
|
|
270
|
+
*/
|
|
271
|
+
updateClusterKafkaVersion(params: Kafka.Types.UpdateClusterKafkaVersionRequest, callback?: (err: AWSError, data: Kafka.Types.UpdateClusterKafkaVersionResponse) => void): Request<Kafka.Types.UpdateClusterKafkaVersionResponse, AWSError>;
|
|
272
|
+
/**
|
|
273
|
+
*
|
|
274
|
+
Updates the Apache Kafka version for the cluster.
|
|
275
|
+
|
|
276
|
+
*/
|
|
277
|
+
updateClusterKafkaVersion(callback?: (err: AWSError, data: Kafka.Types.UpdateClusterKafkaVersionResponse) => void): Request<Kafka.Types.UpdateClusterKafkaVersionResponse, AWSError>;
|
|
254
278
|
/**
|
|
255
279
|
*
|
|
256
280
|
Updates the monitoring settings for the cluster. You can use this operation to specify which Apache Kafka metrics you want Amazon MSK to send to Amazon CloudWatch. You can also specify settings for open monitoring with Prometheus.
|
|
@@ -527,6 +551,12 @@ kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.
|
|
|
527
551
|
|
|
528
552
|
*/
|
|
529
553
|
OperationState?: __string;
|
|
554
|
+
/**
|
|
555
|
+
*
|
|
556
|
+
Steps completed during the operation.
|
|
557
|
+
|
|
558
|
+
*/
|
|
559
|
+
OperationSteps?: __listOfClusterOperationStep;
|
|
530
560
|
/**
|
|
531
561
|
*
|
|
532
562
|
Type of the cluster operation.
|
|
@@ -546,7 +576,43 @@ kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.
|
|
|
546
576
|
*/
|
|
547
577
|
TargetClusterInfo?: MutableClusterInfo;
|
|
548
578
|
}
|
|
579
|
+
export interface ClusterOperationStep {
|
|
580
|
+
/**
|
|
581
|
+
*
|
|
582
|
+
Information about the step and its status.
|
|
583
|
+
|
|
584
|
+
*/
|
|
585
|
+
StepInfo?: ClusterOperationStepInfo;
|
|
586
|
+
/**
|
|
587
|
+
*
|
|
588
|
+
The name of the step.
|
|
589
|
+
|
|
590
|
+
*/
|
|
591
|
+
StepName?: __string;
|
|
592
|
+
}
|
|
593
|
+
export interface ClusterOperationStepInfo {
|
|
594
|
+
/**
|
|
595
|
+
*
|
|
596
|
+
The steps current status.
|
|
597
|
+
|
|
598
|
+
*/
|
|
599
|
+
StepStatus?: __string;
|
|
600
|
+
}
|
|
549
601
|
export type ClusterState = "ACTIVE"|"CREATING"|"UPDATING"|"DELETING"|"FAILED"|string;
|
|
602
|
+
export interface CompatibleKafkaVersion {
|
|
603
|
+
/**
|
|
604
|
+
*
|
|
605
|
+
A Kafka version.
|
|
606
|
+
|
|
607
|
+
*/
|
|
608
|
+
SourceVersion?: __string;
|
|
609
|
+
/**
|
|
610
|
+
*
|
|
611
|
+
A list of Kafka versions.
|
|
612
|
+
|
|
613
|
+
*/
|
|
614
|
+
TargetVersions?: __listOf__string;
|
|
615
|
+
}
|
|
550
616
|
export interface Configuration {
|
|
551
617
|
/**
|
|
552
618
|
*
|
|
@@ -714,7 +780,7 @@ kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.
|
|
|
714
780
|
The versions of Apache Kafka with which you can use this MSK configuration.
|
|
715
781
|
|
|
716
782
|
*/
|
|
717
|
-
KafkaVersions
|
|
783
|
+
KafkaVersions?: __listOf__string;
|
|
718
784
|
/**
|
|
719
785
|
*
|
|
720
786
|
The name of the configuration.
|
|
@@ -1001,6 +1067,22 @@ kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.
|
|
|
1001
1067
|
*/
|
|
1002
1068
|
BootstrapBrokerStringTls?: __string;
|
|
1003
1069
|
}
|
|
1070
|
+
export interface GetCompatibleKafkaVersionsRequest {
|
|
1071
|
+
/**
|
|
1072
|
+
*
|
|
1073
|
+
The Amazon Resource Name (ARN) of the cluster check.
|
|
1074
|
+
|
|
1075
|
+
*/
|
|
1076
|
+
ClusterArn?: __string;
|
|
1077
|
+
}
|
|
1078
|
+
export interface GetCompatibleKafkaVersionsResponse {
|
|
1079
|
+
/**
|
|
1080
|
+
*
|
|
1081
|
+
A list of CompatibleKafkaVersion objects.
|
|
1082
|
+
|
|
1083
|
+
*/
|
|
1084
|
+
CompatibleKafkaVersions?: __listOfCompatibleKafkaVersion;
|
|
1085
|
+
}
|
|
1004
1086
|
export interface KafkaVersion {
|
|
1005
1087
|
Version?: __string;
|
|
1006
1088
|
Status?: KafkaVersionStatus;
|
|
@@ -1245,6 +1327,12 @@ kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.
|
|
|
1245
1327
|
|
|
1246
1328
|
*/
|
|
1247
1329
|
OpenMonitoring?: OpenMonitoring;
|
|
1330
|
+
/**
|
|
1331
|
+
*
|
|
1332
|
+
The Kafka version.
|
|
1333
|
+
|
|
1334
|
+
*/
|
|
1335
|
+
KafkaVersion?: __string;
|
|
1248
1336
|
LoggingInfo?: LoggingInfo;
|
|
1249
1337
|
}
|
|
1250
1338
|
export interface NodeExporter {
|
|
@@ -1536,6 +1624,46 @@ kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.
|
|
|
1536
1624
|
*/
|
|
1537
1625
|
ClusterOperationArn?: __string;
|
|
1538
1626
|
}
|
|
1627
|
+
export interface UpdateClusterKafkaVersionRequest {
|
|
1628
|
+
/**
|
|
1629
|
+
*
|
|
1630
|
+
The Amazon Resource Name (ARN) of the cluster to be updated.
|
|
1631
|
+
|
|
1632
|
+
*/
|
|
1633
|
+
ClusterArn: __string;
|
|
1634
|
+
/**
|
|
1635
|
+
*
|
|
1636
|
+
The custom configuration that should be applied on the new version of cluster.
|
|
1637
|
+
|
|
1638
|
+
*/
|
|
1639
|
+
ConfigurationInfo?: ConfigurationInfo;
|
|
1640
|
+
/**
|
|
1641
|
+
*
|
|
1642
|
+
Current cluster version.
|
|
1643
|
+
|
|
1644
|
+
*/
|
|
1645
|
+
CurrentVersion: __string;
|
|
1646
|
+
/**
|
|
1647
|
+
*
|
|
1648
|
+
Target Kafka version.
|
|
1649
|
+
|
|
1650
|
+
*/
|
|
1651
|
+
TargetKafkaVersion: __string;
|
|
1652
|
+
}
|
|
1653
|
+
export interface UpdateClusterKafkaVersionResponse {
|
|
1654
|
+
/**
|
|
1655
|
+
*
|
|
1656
|
+
The Amazon Resource Name (ARN) of the cluster.
|
|
1657
|
+
|
|
1658
|
+
*/
|
|
1659
|
+
ClusterArn?: __string;
|
|
1660
|
+
/**
|
|
1661
|
+
*
|
|
1662
|
+
The Amazon Resource Name (ARN) of the cluster operation.
|
|
1663
|
+
|
|
1664
|
+
*/
|
|
1665
|
+
ClusterOperationArn?: __string;
|
|
1666
|
+
}
|
|
1539
1667
|
export interface UpdateMonitoringRequest {
|
|
1540
1668
|
/**
|
|
1541
1669
|
*
|
|
@@ -1618,6 +1746,8 @@ kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.
|
|
|
1618
1746
|
export type __listOfBrokerEBSVolumeInfo = BrokerEBSVolumeInfo[];
|
|
1619
1747
|
export type __listOfClusterInfo = ClusterInfo[];
|
|
1620
1748
|
export type __listOfClusterOperationInfo = ClusterOperationInfo[];
|
|
1749
|
+
export type __listOfClusterOperationStep = ClusterOperationStep[];
|
|
1750
|
+
export type __listOfCompatibleKafkaVersion = CompatibleKafkaVersion[];
|
|
1621
1751
|
export type __listOfConfiguration = Configuration[];
|
|
1622
1752
|
export type __listOfConfigurationRevision = ConfigurationRevision[];
|
|
1623
1753
|
export type __listOfKafkaVersion = KafkaVersion[];
|
package/clients/kms.d.ts
CHANGED
|
@@ -148,35 +148,35 @@ declare class KMS extends Service {
|
|
|
148
148
|
*/
|
|
149
149
|
enableKeyRotation(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
150
150
|
/**
|
|
151
|
-
* Encrypts plaintext into ciphertext by using a customer master key (CMK). The Encrypt operation has two primary use cases: You can encrypt small amounts of arbitrary data, such as a personal identifier or database password, or other sensitive information. You can use the Encrypt operation to move encrypted data from one AWS
|
|
151
|
+
* Encrypts plaintext into ciphertext by using a customer master key (CMK). The Encrypt operation has two primary use cases: You can encrypt small amounts of arbitrary data, such as a personal identifier or database password, or other sensitive information. You can use the Encrypt operation to move encrypted data from one AWS Region to another. For example, in Region A, generate a data key and use the plaintext key to encrypt your data. Then, in Region A, use the Encrypt operation to encrypt the plaintext data key under a CMK in Region B. Now, you can move the encrypted data and the encrypted data key to Region B. When necessary, you can decrypt the encrypted data key and the encrypted data entirely within in Region B. You don't need to use the Encrypt operation to encrypt a data key. The GenerateDataKey and GenerateDataKeyPair operations return a plaintext data key and an encrypted copy of that data key. When you encrypt data, you must specify a symmetric or asymmetric CMK to use in the encryption operation. The CMK must have a KeyUsage value of ENCRYPT_DECRYPT. To find the KeyUsage of a CMK, use the DescribeKey operation. If you use a symmetric CMK, you can use an encryption context to add additional security to your encryption operation. If you specify an EncryptionContext when encrypting data, you must specify the same encryption context (a case-sensitive exact match) when decrypting the data. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the AWS Key Management Service Developer Guide. If you specify an asymmetric CMK, you must also specify the encryption algorithm. The algorithm must be compatible with the CMK type. When you use an asymmetric CMK to encrypt or reencrypt data, be sure to record the CMK and encryption algorithm that you choose. You will be required to provide the same CMK and encryption algorithm when you decrypt the data. If the CMK and algorithm do not match the values used to encrypt the data, the decrypt operation fails. You are not required to supply the CMK ID and encryption algorithm when you decrypt with symmetric CMKs because AWS KMS stores this information in the ciphertext blob. AWS KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields. The maximum size of the data that you can encrypt varies with the type of CMK and the encryption algorithm that you choose. Symmetric CMKs SYMMETRIC_DEFAULT: 4096 bytes RSA_2048 RSAES_OAEP_SHA_1: 214 bytes RSAES_OAEP_SHA_256: 190 bytes RSA_3072 RSAES_OAEP_SHA_1: 342 bytes RSAES_OAEP_SHA_256: 318 bytes RSA_4096 RSAES_OAEP_SHA_1: 470 bytes RSAES_OAEP_SHA_256: 446 bytes The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
|
|
152
152
|
*/
|
|
153
153
|
encrypt(params: KMS.Types.EncryptRequest, callback?: (err: AWSError, data: KMS.Types.EncryptResponse) => void): Request<KMS.Types.EncryptResponse, AWSError>;
|
|
154
154
|
/**
|
|
155
|
-
* Encrypts plaintext into ciphertext by using a customer master key (CMK). The Encrypt operation has two primary use cases: You can encrypt small amounts of arbitrary data, such as a personal identifier or database password, or other sensitive information. You can use the Encrypt operation to move encrypted data from one AWS
|
|
155
|
+
* Encrypts plaintext into ciphertext by using a customer master key (CMK). The Encrypt operation has two primary use cases: You can encrypt small amounts of arbitrary data, such as a personal identifier or database password, or other sensitive information. You can use the Encrypt operation to move encrypted data from one AWS Region to another. For example, in Region A, generate a data key and use the plaintext key to encrypt your data. Then, in Region A, use the Encrypt operation to encrypt the plaintext data key under a CMK in Region B. Now, you can move the encrypted data and the encrypted data key to Region B. When necessary, you can decrypt the encrypted data key and the encrypted data entirely within in Region B. You don't need to use the Encrypt operation to encrypt a data key. The GenerateDataKey and GenerateDataKeyPair operations return a plaintext data key and an encrypted copy of that data key. When you encrypt data, you must specify a symmetric or asymmetric CMK to use in the encryption operation. The CMK must have a KeyUsage value of ENCRYPT_DECRYPT. To find the KeyUsage of a CMK, use the DescribeKey operation. If you use a symmetric CMK, you can use an encryption context to add additional security to your encryption operation. If you specify an EncryptionContext when encrypting data, you must specify the same encryption context (a case-sensitive exact match) when decrypting the data. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the AWS Key Management Service Developer Guide. If you specify an asymmetric CMK, you must also specify the encryption algorithm. The algorithm must be compatible with the CMK type. When you use an asymmetric CMK to encrypt or reencrypt data, be sure to record the CMK and encryption algorithm that you choose. You will be required to provide the same CMK and encryption algorithm when you decrypt the data. If the CMK and algorithm do not match the values used to encrypt the data, the decrypt operation fails. You are not required to supply the CMK ID and encryption algorithm when you decrypt with symmetric CMKs because AWS KMS stores this information in the ciphertext blob. AWS KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields. The maximum size of the data that you can encrypt varies with the type of CMK and the encryption algorithm that you choose. Symmetric CMKs SYMMETRIC_DEFAULT: 4096 bytes RSA_2048 RSAES_OAEP_SHA_1: 214 bytes RSAES_OAEP_SHA_256: 190 bytes RSA_3072 RSAES_OAEP_SHA_1: 342 bytes RSAES_OAEP_SHA_256: 318 bytes RSA_4096 RSAES_OAEP_SHA_1: 470 bytes RSAES_OAEP_SHA_256: 446 bytes The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
|
|
156
156
|
*/
|
|
157
157
|
encrypt(callback?: (err: AWSError, data: KMS.Types.EncryptResponse) => void): Request<KMS.Types.EncryptResponse, AWSError>;
|
|
158
158
|
/**
|
|
159
|
-
* Generates a unique symmetric data key. This operation returns a plaintext copy of the data key and a copy that is encrypted under a customer master key (CMK) that you specify. You can use the plaintext key to encrypt your data outside of AWS KMS and store the encrypted data key with the encrypted data. GenerateDataKey returns a unique data key for each request. The bytes in the key are not related to the caller or
|
|
159
|
+
* Generates a unique symmetric data key for client-side encryption. This operation returns a plaintext copy of the data key and a copy that is encrypted under a customer master key (CMK) that you specify. You can use the plaintext key to encrypt your data outside of AWS KMS and store the encrypted data key with the encrypted data. GenerateDataKey returns a unique data key for each request. The bytes in the plaintext key are not related to the caller or the CMK. To generate a data key, specify the symmetric CMK that will be used to encrypt the data key. You cannot use an asymmetric CMK to generate data keys. To get the type of your CMK, use the DescribeKey operation. You must also specify the length of the data key. Use either the KeySpec or NumberOfBytes parameters (but not both). For 128-bit and 256-bit data keys, use the KeySpec parameter. To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure random byte string, use GenerateRandom. You can use the optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the AWS Key Management Service Developer Guide. The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. How to use your data key We recommend that you use the following pattern to encrypt data locally in your application. You can write your own code or use a client-side encryption library, such as the AWS Encryption SDK, the Amazon DynamoDB Encryption Client, or Amazon S3 client-side encryption to do these tasks for you. To encrypt data outside of AWS KMS: Use the GenerateDataKey operation to get a data key. Use the plaintext data key (in the Plaintext field of the response) to encrypt your data outside of AWS KMS. Then erase the plaintext data key from memory. Store the encrypted data key (in the CiphertextBlob field of the response) with the encrypted data. To decrypt data outside of AWS KMS: Use the Decrypt operation to decrypt the encrypted data key. The operation returns a plaintext copy of the data key. Use the plaintext data key to decrypt data outside of AWS KMS, then erase the plaintext data key from memory.
|
|
160
160
|
*/
|
|
161
161
|
generateDataKey(params: KMS.Types.GenerateDataKeyRequest, callback?: (err: AWSError, data: KMS.Types.GenerateDataKeyResponse) => void): Request<KMS.Types.GenerateDataKeyResponse, AWSError>;
|
|
162
162
|
/**
|
|
163
|
-
* Generates a unique symmetric data key. This operation returns a plaintext copy of the data key and a copy that is encrypted under a customer master key (CMK) that you specify. You can use the plaintext key to encrypt your data outside of AWS KMS and store the encrypted data key with the encrypted data. GenerateDataKey returns a unique data key for each request. The bytes in the key are not related to the caller or
|
|
163
|
+
* Generates a unique symmetric data key for client-side encryption. This operation returns a plaintext copy of the data key and a copy that is encrypted under a customer master key (CMK) that you specify. You can use the plaintext key to encrypt your data outside of AWS KMS and store the encrypted data key with the encrypted data. GenerateDataKey returns a unique data key for each request. The bytes in the plaintext key are not related to the caller or the CMK. To generate a data key, specify the symmetric CMK that will be used to encrypt the data key. You cannot use an asymmetric CMK to generate data keys. To get the type of your CMK, use the DescribeKey operation. You must also specify the length of the data key. Use either the KeySpec or NumberOfBytes parameters (but not both). For 128-bit and 256-bit data keys, use the KeySpec parameter. To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure random byte string, use GenerateRandom. You can use the optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the AWS Key Management Service Developer Guide. The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. How to use your data key We recommend that you use the following pattern to encrypt data locally in your application. You can write your own code or use a client-side encryption library, such as the AWS Encryption SDK, the Amazon DynamoDB Encryption Client, or Amazon S3 client-side encryption to do these tasks for you. To encrypt data outside of AWS KMS: Use the GenerateDataKey operation to get a data key. Use the plaintext data key (in the Plaintext field of the response) to encrypt your data outside of AWS KMS. Then erase the plaintext data key from memory. Store the encrypted data key (in the CiphertextBlob field of the response) with the encrypted data. To decrypt data outside of AWS KMS: Use the Decrypt operation to decrypt the encrypted data key. The operation returns a plaintext copy of the data key. Use the plaintext data key to decrypt data outside of AWS KMS, then erase the plaintext data key from memory.
|
|
164
164
|
*/
|
|
165
165
|
generateDataKey(callback?: (err: AWSError, data: KMS.Types.GenerateDataKeyResponse) => void): Request<KMS.Types.GenerateDataKeyResponse, AWSError>;
|
|
166
166
|
/**
|
|
167
|
-
* Generates a unique asymmetric data key pair. The GenerateDataKeyPair operation returns a plaintext public key, a plaintext private key, and a copy of the private key that is encrypted under the symmetric CMK you specify. You can use the data key pair to perform asymmetric cryptography outside of AWS KMS. GenerateDataKeyPair returns a unique data key pair for each request. The bytes in the keys are not related to the caller or the CMK that is used to encrypt the private key. You can use the public key that GenerateDataKeyPair returns to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key. To generate a data key pair, you must specify a symmetric customer master key (CMK) to encrypt the private key in a data key pair. You cannot use an asymmetric CMK. To get the type of your CMK, use the DescribeKey operation.
|
|
167
|
+
* Generates a unique asymmetric data key pair. The GenerateDataKeyPair operation returns a plaintext public key, a plaintext private key, and a copy of the private key that is encrypted under the symmetric CMK you specify. You can use the data key pair to perform asymmetric cryptography outside of AWS KMS. GenerateDataKeyPair returns a unique data key pair for each request. The bytes in the keys are not related to the caller or the CMK that is used to encrypt the private key. You can use the public key that GenerateDataKeyPair returns to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key. To generate a data key pair, you must specify a symmetric customer master key (CMK) to encrypt the private key in a data key pair. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation. If you are using the data key pair to encrypt data, or for any operation where you don't immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation. GenerateDataKeyPairWithoutPlaintext returns a plaintext public key and an encrypted private key, but omits the plaintext private key that you need only to decrypt ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use the Decrypt operation to decrypt the encrypted private key in the data key pair. You can use the optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the AWS Key Management Service Developer Guide. The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
|
|
168
168
|
*/
|
|
169
169
|
generateDataKeyPair(params: KMS.Types.GenerateDataKeyPairRequest, callback?: (err: AWSError, data: KMS.Types.GenerateDataKeyPairResponse) => void): Request<KMS.Types.GenerateDataKeyPairResponse, AWSError>;
|
|
170
170
|
/**
|
|
171
|
-
* Generates a unique asymmetric data key pair. The GenerateDataKeyPair operation returns a plaintext public key, a plaintext private key, and a copy of the private key that is encrypted under the symmetric CMK you specify. You can use the data key pair to perform asymmetric cryptography outside of AWS KMS. GenerateDataKeyPair returns a unique data key pair for each request. The bytes in the keys are not related to the caller or the CMK that is used to encrypt the private key. You can use the public key that GenerateDataKeyPair returns to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key. To generate a data key pair, you must specify a symmetric customer master key (CMK) to encrypt the private key in a data key pair. You cannot use an asymmetric CMK. To get the type of your CMK, use the DescribeKey operation.
|
|
171
|
+
* Generates a unique asymmetric data key pair. The GenerateDataKeyPair operation returns a plaintext public key, a plaintext private key, and a copy of the private key that is encrypted under the symmetric CMK you specify. You can use the data key pair to perform asymmetric cryptography outside of AWS KMS. GenerateDataKeyPair returns a unique data key pair for each request. The bytes in the keys are not related to the caller or the CMK that is used to encrypt the private key. You can use the public key that GenerateDataKeyPair returns to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key. To generate a data key pair, you must specify a symmetric customer master key (CMK) to encrypt the private key in a data key pair. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation. If you are using the data key pair to encrypt data, or for any operation where you don't immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation. GenerateDataKeyPairWithoutPlaintext returns a plaintext public key and an encrypted private key, but omits the plaintext private key that you need only to decrypt ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use the Decrypt operation to decrypt the encrypted private key in the data key pair. You can use the optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the AWS Key Management Service Developer Guide. The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
|
|
172
172
|
*/
|
|
173
173
|
generateDataKeyPair(callback?: (err: AWSError, data: KMS.Types.GenerateDataKeyPairResponse) => void): Request<KMS.Types.GenerateDataKeyPairResponse, AWSError>;
|
|
174
174
|
/**
|
|
175
|
-
* Generates a unique asymmetric data key pair. The GenerateDataKeyPairWithoutPlaintext operation returns a plaintext public key and a copy of the private key that is encrypted under the symmetric CMK you specify. Unlike GenerateDataKeyPair, this operation does not return a plaintext private key. To generate a data key pair, you must specify a symmetric customer master key (CMK) to encrypt the private key in the data key pair. You cannot use an asymmetric CMK. To get the type of your CMK, use the KeySpec field in the DescribeKey response. You can use the public key that GenerateDataKeyPairWithoutPlaintext returns to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key. GenerateDataKeyPairWithoutPlaintext returns a unique data key pair for each request. The bytes in the key are not related to the caller or CMK that is used to encrypt the private key. You can use the optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the AWS Key Management Service Developer Guide. The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
|
|
175
|
+
* Generates a unique asymmetric data key pair. The GenerateDataKeyPairWithoutPlaintext operation returns a plaintext public key and a copy of the private key that is encrypted under the symmetric CMK you specify. Unlike GenerateDataKeyPair, this operation does not return a plaintext private key. To generate a data key pair, you must specify a symmetric customer master key (CMK) to encrypt the private key in the data key pair. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the KeySpec field in the DescribeKey response. You can use the public key that GenerateDataKeyPairWithoutPlaintext returns to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key. GenerateDataKeyPairWithoutPlaintext returns a unique data key pair for each request. The bytes in the key are not related to the caller or CMK that is used to encrypt the private key. You can use the optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the AWS Key Management Service Developer Guide. The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
|
|
176
176
|
*/
|
|
177
177
|
generateDataKeyPairWithoutPlaintext(params: KMS.Types.GenerateDataKeyPairWithoutPlaintextRequest, callback?: (err: AWSError, data: KMS.Types.GenerateDataKeyPairWithoutPlaintextResponse) => void): Request<KMS.Types.GenerateDataKeyPairWithoutPlaintextResponse, AWSError>;
|
|
178
178
|
/**
|
|
179
|
-
* Generates a unique asymmetric data key pair. The GenerateDataKeyPairWithoutPlaintext operation returns a plaintext public key and a copy of the private key that is encrypted under the symmetric CMK you specify. Unlike GenerateDataKeyPair, this operation does not return a plaintext private key. To generate a data key pair, you must specify a symmetric customer master key (CMK) to encrypt the private key in the data key pair. You cannot use an asymmetric CMK. To get the type of your CMK, use the KeySpec field in the DescribeKey response. You can use the public key that GenerateDataKeyPairWithoutPlaintext returns to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key. GenerateDataKeyPairWithoutPlaintext returns a unique data key pair for each request. The bytes in the key are not related to the caller or CMK that is used to encrypt the private key. You can use the optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the AWS Key Management Service Developer Guide. The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
|
|
179
|
+
* Generates a unique asymmetric data key pair. The GenerateDataKeyPairWithoutPlaintext operation returns a plaintext public key and a copy of the private key that is encrypted under the symmetric CMK you specify. Unlike GenerateDataKeyPair, this operation does not return a plaintext private key. To generate a data key pair, you must specify a symmetric customer master key (CMK) to encrypt the private key in the data key pair. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the KeySpec field in the DescribeKey response. You can use the public key that GenerateDataKeyPairWithoutPlaintext returns to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key. GenerateDataKeyPairWithoutPlaintext returns a unique data key pair for each request. The bytes in the key are not related to the caller or CMK that is used to encrypt the private key. You can use the optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the AWS Key Management Service Developer Guide. The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
|
|
180
180
|
*/
|
|
181
181
|
generateDataKeyPairWithoutPlaintext(callback?: (err: AWSError, data: KMS.Types.GenerateDataKeyPairWithoutPlaintextResponse) => void): Request<KMS.Types.GenerateDataKeyPairWithoutPlaintextResponse, AWSError>;
|
|
182
182
|
/**
|
|
@@ -244,11 +244,11 @@ declare class KMS extends Service {
|
|
|
244
244
|
*/
|
|
245
245
|
listAliases(callback?: (err: AWSError, data: KMS.Types.ListAliasesResponse) => void): Request<KMS.Types.ListAliasesResponse, AWSError>;
|
|
246
246
|
/**
|
|
247
|
-
* Gets a list of all grants for the specified customer master key (CMK). To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.
|
|
247
|
+
* Gets a list of all grants for the specified customer master key (CMK). To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter. The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an AWS service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals.
|
|
248
248
|
*/
|
|
249
249
|
listGrants(params: KMS.Types.ListGrantsRequest, callback?: (err: AWSError, data: KMS.Types.ListGrantsResponse) => void): Request<KMS.Types.ListGrantsResponse, AWSError>;
|
|
250
250
|
/**
|
|
251
|
-
* Gets a list of all grants for the specified customer master key (CMK). To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.
|
|
251
|
+
* Gets a list of all grants for the specified customer master key (CMK). To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter. The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an AWS service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals.
|
|
252
252
|
*/
|
|
253
253
|
listGrants(callback?: (err: AWSError, data: KMS.Types.ListGrantsResponse) => void): Request<KMS.Types.ListGrantsResponse, AWSError>;
|
|
254
254
|
/**
|
|
@@ -292,11 +292,11 @@ declare class KMS extends Service {
|
|
|
292
292
|
*/
|
|
293
293
|
putKeyPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
294
294
|
/**
|
|
295
|
-
* Decrypts ciphertext and then reencrypts it entirely within AWS KMS. You can use this operation to change the customer master key (CMK) under which data is encrypted, such as when you manually rotate a CMK or change the CMK that protects a ciphertext. You can also use it to reencrypt ciphertext under the same CMK, such as to change the encryption context of a ciphertext.
|
|
295
|
+
* Decrypts ciphertext and then reencrypts it entirely within AWS KMS. You can use this operation to change the customer master key (CMK) under which data is encrypted, such as when you manually rotate a CMK or change the CMK that protects a ciphertext. You can also use it to reencrypt ciphertext under the same CMK, such as to change the encryption context of a ciphertext. The ReEncrypt operation can decrypt ciphertext that was encrypted by using an AWS KMS CMK in an AWS KMS operation, such as Encrypt or GenerateDataKey. It can also decrypt ciphertext that was encrypted by using the public key of an asymmetric CMK outside of AWS KMS. However, it cannot decrypt ciphertext produced by other libraries, such as the AWS Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with AWS KMS. When you use the ReEncrypt operation, you need to provide information for the decrypt operation and the subsequent encrypt operation. If your ciphertext was encrypted under an asymmetric CMK, you must identify the source CMK, that is, the CMK that encrypted the ciphertext. You must also supply the encryption algorithm that was used. This information is required to decrypt the data. It is optional, but you can specify a source CMK even when the ciphertext was encrypted under a symmetric CMK. This ensures that the ciphertext is decrypted only by using a particular CMK. If the CMK that you specify cannot decrypt the ciphertext, the ReEncrypt operation fails. To reencrypt the data, you must specify the destination CMK, that is, the CMK that re-encrypts the data after it is decrypted. You can select a symmetric or asymmetric CMK. If the destination CMK is an asymmetric CMK, you must also provide the encryption algorithm. The algorithm that you choose must be compatible with the CMK. When you use an asymmetric CMK to encrypt or reencrypt data, be sure to record the CMK and encryption algorithm that you choose. You will be required to provide the same CMK and encryption algorithm when you decrypt the data. If the CMK and algorithm do not match the values used to encrypt the data, the decrypt operation fails. You are not required to supply the CMK ID and encryption algorithm when you decrypt with symmetric CMKs because AWS KMS stores this information in the ciphertext blob. AWS KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields. Unlike other AWS KMS API operations, ReEncrypt callers must have two permissions: kms:ReEncryptFrom permission on the source CMK kms:ReEncryptTo permission on the destination CMK To permit reencryption from or to a CMK, include the "kms:ReEncrypt*" permission in your key policy. This permission is automatically included in the key policy when you use the console to create a CMK. But you must include it manually when you create a CMK programmatically or when you use the PutKeyPolicy operation to set a key policy. The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
|
|
296
296
|
*/
|
|
297
297
|
reEncrypt(params: KMS.Types.ReEncryptRequest, callback?: (err: AWSError, data: KMS.Types.ReEncryptResponse) => void): Request<KMS.Types.ReEncryptResponse, AWSError>;
|
|
298
298
|
/**
|
|
299
|
-
* Decrypts ciphertext and then reencrypts it entirely within AWS KMS. You can use this operation to change the customer master key (CMK) under which data is encrypted, such as when you manually rotate a CMK or change the CMK that protects a ciphertext. You can also use it to reencrypt ciphertext under the same CMK, such as to change the encryption context of a ciphertext.
|
|
299
|
+
* Decrypts ciphertext and then reencrypts it entirely within AWS KMS. You can use this operation to change the customer master key (CMK) under which data is encrypted, such as when you manually rotate a CMK or change the CMK that protects a ciphertext. You can also use it to reencrypt ciphertext under the same CMK, such as to change the encryption context of a ciphertext. The ReEncrypt operation can decrypt ciphertext that was encrypted by using an AWS KMS CMK in an AWS KMS operation, such as Encrypt or GenerateDataKey. It can also decrypt ciphertext that was encrypted by using the public key of an asymmetric CMK outside of AWS KMS. However, it cannot decrypt ciphertext produced by other libraries, such as the AWS Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with AWS KMS. When you use the ReEncrypt operation, you need to provide information for the decrypt operation and the subsequent encrypt operation. If your ciphertext was encrypted under an asymmetric CMK, you must identify the source CMK, that is, the CMK that encrypted the ciphertext. You must also supply the encryption algorithm that was used. This information is required to decrypt the data. It is optional, but you can specify a source CMK even when the ciphertext was encrypted under a symmetric CMK. This ensures that the ciphertext is decrypted only by using a particular CMK. If the CMK that you specify cannot decrypt the ciphertext, the ReEncrypt operation fails. To reencrypt the data, you must specify the destination CMK, that is, the CMK that re-encrypts the data after it is decrypted. You can select a symmetric or asymmetric CMK. If the destination CMK is an asymmetric CMK, you must also provide the encryption algorithm. The algorithm that you choose must be compatible with the CMK. When you use an asymmetric CMK to encrypt or reencrypt data, be sure to record the CMK and encryption algorithm that you choose. You will be required to provide the same CMK and encryption algorithm when you decrypt the data. If the CMK and algorithm do not match the values used to encrypt the data, the decrypt operation fails. You are not required to supply the CMK ID and encryption algorithm when you decrypt with symmetric CMKs because AWS KMS stores this information in the ciphertext blob. AWS KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields. Unlike other AWS KMS API operations, ReEncrypt callers must have two permissions: kms:ReEncryptFrom permission on the source CMK kms:ReEncryptTo permission on the destination CMK To permit reencryption from or to a CMK, include the "kms:ReEncrypt*" permission in your key policy. This permission is automatically included in the key policy when you use the console to create a CMK. But you must include it manually when you create a CMK programmatically or when you use the PutKeyPolicy operation to set a key policy. The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
|
|
300
300
|
*/
|
|
301
301
|
reEncrypt(callback?: (err: AWSError, data: KMS.Types.ReEncryptResponse) => void): Request<KMS.Types.ReEncryptResponse, AWSError>;
|
|
302
302
|
/**
|
|
@@ -409,7 +409,7 @@ declare namespace KMS {
|
|
|
409
409
|
}
|
|
410
410
|
export interface CancelKeyDeletionResponse {
|
|
411
411
|
/**
|
|
412
|
-
* The
|
|
412
|
+
* The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.
|
|
413
413
|
*/
|
|
414
414
|
KeyId?: KeyIdType;
|
|
415
415
|
}
|
|
@@ -564,7 +564,7 @@ declare namespace KMS {
|
|
|
564
564
|
*/
|
|
565
565
|
ConnectionState?: ConnectionStateType;
|
|
566
566
|
/**
|
|
567
|
-
* Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide. Valid values are: CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID. INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM. INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again. INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store. NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store. SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets
|
|
567
|
+
* Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide. Valid values are: CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID. INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM. INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again. INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store. NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store. SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide. USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store. USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide. USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
|
|
568
568
|
*/
|
|
569
569
|
ConnectionErrorCode?: ConnectionErrorCodeType;
|
|
570
570
|
/**
|
|
@@ -600,7 +600,7 @@ declare namespace KMS {
|
|
|
600
600
|
}
|
|
601
601
|
export interface DecryptResponse {
|
|
602
602
|
/**
|
|
603
|
-
* The ARN of the
|
|
603
|
+
* The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
|
|
604
604
|
*/
|
|
605
605
|
KeyId?: KeyIdType;
|
|
606
606
|
/**
|
|
@@ -741,7 +741,7 @@ declare namespace KMS {
|
|
|
741
741
|
*/
|
|
742
742
|
CiphertextBlob?: CiphertextType;
|
|
743
743
|
/**
|
|
744
|
-
* The
|
|
744
|
+
* The Amazon Resource Name (key ARN) of the CMK that was used to encrypt the plaintext.
|
|
745
745
|
*/
|
|
746
746
|
KeyId?: KeyIdType;
|
|
747
747
|
/**
|
|
@@ -761,7 +761,7 @@ declare namespace KMS {
|
|
|
761
761
|
*/
|
|
762
762
|
EncryptionContext?: EncryptionContextType;
|
|
763
763
|
/**
|
|
764
|
-
* Specifies the symmetric CMK that encrypts the private key in the data key pair. You cannot specify an asymmetric
|
|
764
|
+
* Specifies the symmetric CMK that encrypts the private key in the data key pair. You cannot specify an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
|
|
765
765
|
*/
|
|
766
766
|
KeyId: KeyIdType;
|
|
767
767
|
/**
|
|
@@ -787,7 +787,7 @@ declare namespace KMS {
|
|
|
787
787
|
*/
|
|
788
788
|
PublicKey?: PublicKeyType;
|
|
789
789
|
/**
|
|
790
|
-
* The
|
|
790
|
+
* The Amazon Resource Name (key ARN) of the CMK that encrypted the private key.
|
|
791
791
|
*/
|
|
792
792
|
KeyId?: KeyIdType;
|
|
793
793
|
/**
|
|
@@ -801,7 +801,7 @@ declare namespace KMS {
|
|
|
801
801
|
*/
|
|
802
802
|
EncryptionContext?: EncryptionContextType;
|
|
803
803
|
/**
|
|
804
|
-
* Specifies the CMK that encrypts the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK. To get the type of your CMK, use the DescribeKey operation. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
|
|
804
|
+
* Specifies the CMK that encrypts the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
|
|
805
805
|
*/
|
|
806
806
|
KeyId: KeyIdType;
|
|
807
807
|
/**
|
|
@@ -823,7 +823,7 @@ declare namespace KMS {
|
|
|
823
823
|
*/
|
|
824
824
|
PublicKey?: PublicKeyType;
|
|
825
825
|
/**
|
|
826
|
-
*
|
|
826
|
+
* The Amazon Resource Name (key ARN) of the CMK that encrypted the private key.
|
|
827
827
|
*/
|
|
828
828
|
KeyId?: KeyIdType;
|
|
829
829
|
/**
|
|
@@ -863,7 +863,7 @@ declare namespace KMS {
|
|
|
863
863
|
*/
|
|
864
864
|
Plaintext?: PlaintextType;
|
|
865
865
|
/**
|
|
866
|
-
* The
|
|
866
|
+
* The Amazon Resource Name (key ARN) of the CMK that encrypted the data key.
|
|
867
867
|
*/
|
|
868
868
|
KeyId?: KeyIdType;
|
|
869
869
|
}
|
|
@@ -895,7 +895,7 @@ declare namespace KMS {
|
|
|
895
895
|
*/
|
|
896
896
|
CiphertextBlob?: CiphertextType;
|
|
897
897
|
/**
|
|
898
|
-
* The
|
|
898
|
+
* The Amazon Resource Name (key ARN) of the CMK that encrypted the data key.
|
|
899
899
|
*/
|
|
900
900
|
KeyId?: KeyIdType;
|
|
901
901
|
}
|
|
@@ -959,7 +959,7 @@ declare namespace KMS {
|
|
|
959
959
|
}
|
|
960
960
|
export interface GetParametersForImportResponse {
|
|
961
961
|
/**
|
|
962
|
-
* The
|
|
962
|
+
* The Amazon Resource Name (key ARN) of the CMK to use in a subsequent ImportKeyMaterial request. This is the same CMK specified in the GetParametersForImport request.
|
|
963
963
|
*/
|
|
964
964
|
KeyId?: KeyIdType;
|
|
965
965
|
/**
|
|
@@ -987,7 +987,7 @@ declare namespace KMS {
|
|
|
987
987
|
}
|
|
988
988
|
export interface GetPublicKeyResponse {
|
|
989
989
|
/**
|
|
990
|
-
* The
|
|
990
|
+
* The Amazon Resource Name (key ARN) of the asymmetric CMK from which the public key was downloaded.
|
|
991
991
|
*/
|
|
992
992
|
KeyId?: KeyIdType;
|
|
993
993
|
/**
|
|
@@ -1041,7 +1041,7 @@ declare namespace KMS {
|
|
|
1041
1041
|
*/
|
|
1042
1042
|
CreationDate?: DateType;
|
|
1043
1043
|
/**
|
|
1044
|
-
* The
|
|
1044
|
+
* The identity that gets the permissions in the grant. The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an AWS service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals.
|
|
1045
1045
|
*/
|
|
1046
1046
|
GranteePrincipal?: PrincipalIdType;
|
|
1047
1047
|
/**
|
|
@@ -1133,7 +1133,7 @@ declare namespace KMS {
|
|
|
1133
1133
|
*/
|
|
1134
1134
|
KeyUsage?: KeyUsageType;
|
|
1135
1135
|
/**
|
|
1136
|
-
* The
|
|
1136
|
+
* The current status of the CMK. For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.
|
|
1137
1137
|
*/
|
|
1138
1138
|
KeyState?: KeyState;
|
|
1139
1139
|
/**
|
|
@@ -1169,11 +1169,11 @@ declare namespace KMS {
|
|
|
1169
1169
|
*/
|
|
1170
1170
|
CustomerMasterKeySpec?: CustomerMasterKeySpec;
|
|
1171
1171
|
/**
|
|
1172
|
-
*
|
|
1172
|
+
* The encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS. This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.
|
|
1173
1173
|
*/
|
|
1174
1174
|
EncryptionAlgorithms?: EncryptionAlgorithmSpecList;
|
|
1175
1175
|
/**
|
|
1176
|
-
*
|
|
1176
|
+
* The signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS. This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.
|
|
1177
1177
|
*/
|
|
1178
1178
|
SigningAlgorithms?: SigningAlgorithmSpecList;
|
|
1179
1179
|
}
|
|
@@ -1404,7 +1404,7 @@ declare namespace KMS {
|
|
|
1404
1404
|
*/
|
|
1405
1405
|
SourceKeyId?: KeyIdType;
|
|
1406
1406
|
/**
|
|
1407
|
-
*
|
|
1407
|
+
* The Amazon Resource Name (key ARN) of the CMK that was used to reencrypt the data.
|
|
1408
1408
|
*/
|
|
1409
1409
|
KeyId?: KeyIdType;
|
|
1410
1410
|
/**
|
|
@@ -1452,7 +1452,7 @@ declare namespace KMS {
|
|
|
1452
1452
|
}
|
|
1453
1453
|
export interface ScheduleKeyDeletionResponse {
|
|
1454
1454
|
/**
|
|
1455
|
-
* The
|
|
1455
|
+
* The Amazon Resource Name (key ARN) of the CMK whose deletion is scheduled.
|
|
1456
1456
|
*/
|
|
1457
1457
|
KeyId?: KeyIdType;
|
|
1458
1458
|
/**
|
|
@@ -1484,7 +1484,7 @@ declare namespace KMS {
|
|
|
1484
1484
|
}
|
|
1485
1485
|
export interface SignResponse {
|
|
1486
1486
|
/**
|
|
1487
|
-
* The Amazon Resource Name (ARN) of the asymmetric CMK that was used to sign the message.
|
|
1487
|
+
* The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to sign the message.
|
|
1488
1488
|
*/
|
|
1489
1489
|
KeyId?: KeyIdType;
|
|
1490
1490
|
/**
|
|
@@ -1601,7 +1601,7 @@ declare namespace KMS {
|
|
|
1601
1601
|
}
|
|
1602
1602
|
export interface VerifyResponse {
|
|
1603
1603
|
/**
|
|
1604
|
-
* The
|
|
1604
|
+
* The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to verify the signature.
|
|
1605
1605
|
*/
|
|
1606
1606
|
KeyId?: KeyIdType;
|
|
1607
1607
|
/**
|
|
@@ -52,11 +52,11 @@ declare class MarketplaceCatalog extends Service {
|
|
|
52
52
|
*/
|
|
53
53
|
listEntities(callback?: (err: AWSError, data: MarketplaceCatalog.Types.ListEntitiesResponse) => void): Request<MarketplaceCatalog.Types.ListEntitiesResponse, AWSError>;
|
|
54
54
|
/**
|
|
55
|
-
* This operation allows you to request changes
|
|
55
|
+
* This operation allows you to request changes for your entities. Within a single ChangeSet, you cannot start the same change type against the same entity multiple times. Additionally, when a ChangeSet is running, all the entities targeted by the different changes are locked until the ChangeSet has completed (either succeeded, cancelled, or failed). If you try to start a ChangeSet containing a change against an entity that is already locked, you will receive a ResourceInUseException. For example, you cannot start the ChangeSet described in the example below because it contains two changes to execute the same change type (AddRevisions) against the same entity (entity-id@1).
|
|
56
56
|
*/
|
|
57
57
|
startChangeSet(params: MarketplaceCatalog.Types.StartChangeSetRequest, callback?: (err: AWSError, data: MarketplaceCatalog.Types.StartChangeSetResponse) => void): Request<MarketplaceCatalog.Types.StartChangeSetResponse, AWSError>;
|
|
58
58
|
/**
|
|
59
|
-
* This operation allows you to request changes
|
|
59
|
+
* This operation allows you to request changes for your entities. Within a single ChangeSet, you cannot start the same change type against the same entity multiple times. Additionally, when a ChangeSet is running, all the entities targeted by the different changes are locked until the ChangeSet has completed (either succeeded, cancelled, or failed). If you try to start a ChangeSet containing a change against an entity that is already locked, you will receive a ResourceInUseException. For example, you cannot start the ChangeSet described in the example below because it contains two changes to execute the same change type (AddRevisions) against the same entity (entity-id@1).
|
|
60
60
|
*/
|
|
61
61
|
startChangeSet(callback?: (err: AWSError, data: MarketplaceCatalog.Types.StartChangeSetResponse) => void): Request<MarketplaceCatalog.Types.StartChangeSetResponse, AWSError>;
|
|
62
62
|
}
|
|
@@ -140,6 +140,10 @@ declare namespace MarketplaceCatalog {
|
|
|
140
140
|
* The entity to be changed.
|
|
141
141
|
*/
|
|
142
142
|
Entity?: Entity;
|
|
143
|
+
/**
|
|
144
|
+
* This object contains details specific to the change type of the requested change.
|
|
145
|
+
*/
|
|
146
|
+
Details?: Json;
|
|
143
147
|
/**
|
|
144
148
|
* An array of ErrorDetail objects associated with the change.
|
|
145
149
|
*/
|
|
@@ -236,7 +240,7 @@ declare namespace MarketplaceCatalog {
|
|
|
236
240
|
}
|
|
237
241
|
export interface EntitySummary {
|
|
238
242
|
/**
|
|
239
|
-
* The name for the entity. This value is not unique. It is defined by the
|
|
243
|
+
* The name for the entity. This value is not unique. It is defined by the seller.
|
|
240
244
|
*/
|
|
241
245
|
Name?: StringValue;
|
|
242
246
|
/**
|
|
@@ -256,7 +260,7 @@ declare namespace MarketplaceCatalog {
|
|
|
256
260
|
*/
|
|
257
261
|
LastModifiedDate?: StringValue;
|
|
258
262
|
/**
|
|
259
|
-
* The visibility status of the entity to
|
|
263
|
+
* The visibility status of the entity to buyers. This value can be Public (everyone can view the entity), Limited (the entity is visible to limited accounts only), or Restricted (the entity was published and then unpublished and only existing buyers can view it).
|
|
260
264
|
*/
|
|
261
265
|
Visibility?: StringValue;
|
|
262
266
|
}
|
|
@@ -297,7 +301,7 @@ declare namespace MarketplaceCatalog {
|
|
|
297
301
|
*/
|
|
298
302
|
FilterList?: FilterList;
|
|
299
303
|
/**
|
|
300
|
-
* An object that contains two attributes,
|
|
304
|
+
* An object that contains two attributes, SortBy and SortOrder.
|
|
301
305
|
*/
|
|
302
306
|
Sort?: Sort;
|
|
303
307
|
/**
|
|
@@ -333,7 +337,7 @@ declare namespace MarketplaceCatalog {
|
|
|
333
337
|
*/
|
|
334
338
|
FilterList?: FilterList;
|
|
335
339
|
/**
|
|
336
|
-
* An object that contains two attributes,
|
|
340
|
+
* An object that contains two attributes, SortBy and SortOrder.
|
|
337
341
|
*/
|
|
338
342
|
Sort?: Sort;
|
|
339
343
|
/**
|