@aws-sdk/client-kms 3.835.0 → 3.838.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/README.md CHANGED
@@ -16,18 +16,20 @@ see the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/">
16
16
  <note>
17
17
  <p>KMS has replaced the term <i>customer master key (CMK)</i> with <i>KMS key</i> and <i>KMS key</i>. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.</p>
18
18
  <p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming
19
- languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a
20
- convenient way to create programmatic access to KMS and other Amazon Web Services services. For example,
21
- the SDKs take care of tasks such as signing requests (see below), managing errors, and
22
- retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to
23
- download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web
24
- Services</a>.</p>
19
+ languages and platforms (Java, Rust, Python, Ruby, .Net, macOS, Android, etc.). The SDKs
20
+ provide a convenient way to create programmatic access to KMS and other Amazon Web Services services.
21
+ For example, the SDKs take care of tasks such as signing requests (see below), managing
22
+ errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs,
23
+ including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools
24
+ for Amazon Web Services</a>.</p>
25
25
  </note>
26
26
  <p>We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.</p>
27
27
  <p>If you need to use FIPS 140-2 validated cryptographic modules when communicating with
28
- Amazon Web Services, use the FIPS endpoint in your preferred Amazon Web Services Region. For more information about the
29
- available FIPS endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/kms.html#kms_region">Service endpoints</a> in the Key Management Service topic of
30
- the <i>Amazon Web Services General Reference</i>.</p>
28
+ Amazon Web Services, use one of the FIPS endpoints in your preferred Amazon Web Services Region. If you need communicate
29
+ over IPv6, use the dual-stack endpoint in your preferred Amazon Web Services Region. For more information
30
+ see <a href="https://docs.aws.amazon.com/general/latest/gr/kms.html#kms_region">Service
31
+ endpoints</a> in the Key Management Service topic of the <i>Amazon Web Services General Reference</i> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/ipv6-kms.html">Dual-stack endpoint
32
+ support</a> in the KMS Developer Guide.</p>
31
33
  <p>All KMS API calls must be signed and be transmitted using Transport Layer Security
32
34
  (TLS). KMS recommends you always use the latest supported TLS version. Clients must also
33
35
  support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman
@@ -389,18 +389,20 @@ export interface KMS {
389
389
  * <note>
390
390
  * <p>KMS has replaced the term <i>customer master key (CMK)</i> with <i>KMS key</i> and <i>KMS key</i>. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.</p>
391
391
  * <p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming
392
- * languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a
393
- * convenient way to create programmatic access to KMS and other Amazon Web Services services. For example,
394
- * the SDKs take care of tasks such as signing requests (see below), managing errors, and
395
- * retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to
396
- * download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web
397
- * Services</a>.</p>
392
+ * languages and platforms (Java, Rust, Python, Ruby, .Net, macOS, Android, etc.). The SDKs
393
+ * provide a convenient way to create programmatic access to KMS and other Amazon Web Services services.
394
+ * For example, the SDKs take care of tasks such as signing requests (see below), managing
395
+ * errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs,
396
+ * including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools
397
+ * for Amazon Web Services</a>.</p>
398
398
  * </note>
399
399
  * <p>We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.</p>
400
400
  * <p>If you need to use FIPS 140-2 validated cryptographic modules when communicating with
401
- * Amazon Web Services, use the FIPS endpoint in your preferred Amazon Web Services Region. For more information about the
402
- * available FIPS endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/kms.html#kms_region">Service endpoints</a> in the Key Management Service topic of
403
- * the <i>Amazon Web Services General Reference</i>.</p>
401
+ * Amazon Web Services, use one of the FIPS endpoints in your preferred Amazon Web Services Region. If you need communicate
402
+ * over IPv6, use the dual-stack endpoint in your preferred Amazon Web Services Region. For more information
403
+ * see <a href="https://docs.aws.amazon.com/general/latest/gr/kms.html#kms_region">Service
404
+ * endpoints</a> in the Key Management Service topic of the <i>Amazon Web Services General Reference</i> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/ipv6-kms.html">Dual-stack endpoint
405
+ * support</a> in the KMS Developer Guide.</p>
404
406
  * <p>All KMS API calls must be signed and be transmitted using Transport Layer Security
405
407
  * (TLS). KMS recommends you always use the latest supported TLS version. Clients must also
406
408
  * support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman
@@ -231,18 +231,20 @@ export interface KMSClientResolvedConfig extends KMSClientResolvedConfigType {
231
231
  * <note>
232
232
  * <p>KMS has replaced the term <i>customer master key (CMK)</i> with <i>KMS key</i> and <i>KMS key</i>. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.</p>
233
233
  * <p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming
234
- * languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a
235
- * convenient way to create programmatic access to KMS and other Amazon Web Services services. For example,
236
- * the SDKs take care of tasks such as signing requests (see below), managing errors, and
237
- * retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to
238
- * download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web
239
- * Services</a>.</p>
234
+ * languages and platforms (Java, Rust, Python, Ruby, .Net, macOS, Android, etc.). The SDKs
235
+ * provide a convenient way to create programmatic access to KMS and other Amazon Web Services services.
236
+ * For example, the SDKs take care of tasks such as signing requests (see below), managing
237
+ * errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs,
238
+ * including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools
239
+ * for Amazon Web Services</a>.</p>
240
240
  * </note>
241
241
  * <p>We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.</p>
242
242
  * <p>If you need to use FIPS 140-2 validated cryptographic modules when communicating with
243
- * Amazon Web Services, use the FIPS endpoint in your preferred Amazon Web Services Region. For more information about the
244
- * available FIPS endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/kms.html#kms_region">Service endpoints</a> in the Key Management Service topic of
245
- * the <i>Amazon Web Services General Reference</i>.</p>
243
+ * Amazon Web Services, use one of the FIPS endpoints in your preferred Amazon Web Services Region. If you need communicate
244
+ * over IPv6, use the dual-stack endpoint in your preferred Amazon Web Services Region. For more information
245
+ * see <a href="https://docs.aws.amazon.com/general/latest/gr/kms.html#kms_region">Service
246
+ * endpoints</a> in the Key Management Service topic of the <i>Amazon Web Services General Reference</i> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/ipv6-kms.html">Dual-stack endpoint
247
+ * support</a> in the KMS Developer Guide.</p>
246
248
  * <p>All KMS API calls must be signed and be transmitted using Transport Layer Security
247
249
  * (TLS). KMS recommends you always use the latest supported TLS version. Clients must also
248
250
  * support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman
@@ -28,22 +28,22 @@ declare const ImportKeyMaterialCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Imports or reimports key material into an existing KMS key that was created without key
31
- * material. You can also use this operation to set or update the expiration model and expiration date of
32
- * the imported key material.</p>
33
- * <p>By default, KMS creates KMS keys with key material that it generates. You can also generate and
34
- * import your own key material. For more information about importing key material, see
35
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing key
31
+ * material. You can also use this operation to set or update the expiration model and expiration
32
+ * date of the imported key material.</p>
33
+ * <p>By default, KMS creates KMS keys with key material that it generates. You can also
34
+ * generate and import your own key material. For more information about importing key material,
35
+ * see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing key
36
36
  * material</a>.</p>
37
- * <p>For asymmetric, HMAC and multi-Region keys, you cannot change the key material after the initial import.
38
- * You can import multiple key materials into single-Region, symmetric encryption keys and rotate the key material
39
- * on demand using <code>RotateKeyOnDemand</code>.</p>
37
+ * <p>For asymmetric, HMAC and multi-Region keys, you cannot change the key material after the
38
+ * initial import. You can import multiple key materials into single-Region, symmetric encryption
39
+ * keys and rotate the key material on demand using <code>RotateKeyOnDemand</code>.</p>
40
40
  * <p>After you import key material, you can <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-import-key-material.html#reimport-key-material">reimport
41
- * the same key material</a> into that KMS key or, if the key supports on-demand rotation,
42
- * import new key material. You can use the <code>ImportType</code> parameter to indicate
43
- * whether you are importing new key material or re-importing previously imported key material.
44
- * You might reimport key material to replace key material that expired or key material
45
- * that you deleted. You might also reimport key material to change the expiration model or
46
- * expiration date of the key material.</p>
41
+ * the same key material</a> into that KMS key or, if the key supports on-demand rotation,
42
+ * import new key material. You can use the <code>ImportType</code> parameter to indicate whether
43
+ * you are importing new key material or re-importing previously imported key material. You might
44
+ * reimport key material to replace key material that expired or key material that you deleted.
45
+ * You might also reimport key material to change the expiration model or expiration date of the
46
+ * key material.</p>
47
47
  * <p>Each time you import key material into KMS, you can determine whether
48
48
  * (<code>ExpirationModel</code>) and when (<code>ValidTo</code>) the key material expires. To
49
49
  * change the expiration of your key material, you must import it again, either by calling
@@ -51,13 +51,13 @@ declare const ImportKeyMaterialCommand_base: {
51
51
  * <p>Before you call <code>ImportKeyMaterial</code>, complete these steps:</p>
52
52
  * <ul>
53
53
  * <li>
54
- * <p>Create or identify a KMS key with <code>EXTERNAL</code> origin, which indicates that the KMS key is
55
- * designed for imported key material. </p>
54
+ * <p>Create or identify a KMS key with <code>EXTERNAL</code> origin, which indicates that
55
+ * the KMS key is designed for imported key material. </p>
56
56
  * <p>To create a new KMS key for imported key material, call the <a>CreateKey</a> operation with an <code>Origin</code> value of <code>EXTERNAL</code>. You can create a
57
- * symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, asymmetric key agreement key,
58
- * or asymmetric signing KMS key. You can also import key material into a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">multi-Region key</a> of any
59
- * supported type. However, you can't import key material into a KMS key in a
60
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html">custom key store</a>.</p>
57
+ * symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, asymmetric key
58
+ * agreement key, or asymmetric signing KMS key. You can also import key material into a
59
+ * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">multi-Region key</a> of any supported type. However, you can't import key material
60
+ * into a KMS key in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html">custom key store</a>.</p>
61
61
  * </li>
62
62
  * <li>
63
63
  * <p>Call the <a>GetParametersForImport</a> operation to get a public key and
@@ -99,9 +99,9 @@ declare const ImportKeyMaterialCommand_base: {
99
99
  * <p>When this operation is successful, the key state of the KMS key changes from
100
100
  * <code>PendingImport</code> to <code>Enabled</code>, and you can use the KMS key in
101
101
  * cryptographic operations. For single-Region, symmetric encryption keys, you will need to
102
- * import all of the key materials associated with the KMS key to change its state to <code>Enabled</code>.
103
- * Use the <code>ListKeyRotations</code> operation to list the ID and import state of each key material
104
- * associated with a KMS key.</p>
102
+ * import all of the key materials associated with the KMS key to change its state to
103
+ * <code>Enabled</code>. Use the <code>ListKeyRotations</code> operation to list the ID and
104
+ * import state of each key material associated with a KMS key.</p>
105
105
  * <p>If this operation fails, use the exception to help determine the problem. If the error is
106
106
  * related to the key material, the import token, or wrapping key, use <a>GetParametersForImport</a> to get a new public key and import token for the KMS key
107
107
  * and repeat the import procedure. For help, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-conceptual.html">Create a KMS key with imported key
@@ -181,9 +181,9 @@ declare const ImportKeyMaterialCommand_base: {
181
181
  *
182
182
  * @throws {@link IncorrectKeyMaterialException} (client fault)
183
183
  * <p>The request was rejected because the key material in the request is, expired, invalid, or
184
- * does not meet expectations. For example, it is not the same key material that was previously imported or
185
- * KMS expected new key material but the key material being imported is already associated with
186
- * the KMS key.</p>
184
+ * does not meet expectations. For example, it is not the same key material that was previously
185
+ * imported or KMS expected new key material but the key material being imported is already
186
+ * associated with the KMS key.</p>
187
187
  *
188
188
  * @throws {@link InvalidArnException} (client fault)
189
189
  * <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
@@ -27,9 +27,9 @@ declare const ListKeyRotationsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns information about the key materials associated with the specified KMS
31
- * key. You can use the optional <code>IncludeKeyMaterial</code> parameter to control which key materials
32
- * are included in the response.</p>
30
+ * <p>Returns information about the key materials associated with the specified KMS key. You can
31
+ * use the optional <code>IncludeKeyMaterial</code> parameter to control which key materials are
32
+ * included in the response.</p>
33
33
  * <p>You must specify the KMS key in all requests. You can refine the key rotations list by
34
34
  * limiting the number of rotations returned.</p>
35
35
  * <p>For detailed information about automatic and on-demand key rotations, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">Rotate KMS keys</a> in the
@@ -46,15 +46,15 @@ declare const RotateKeyOnDemandCommand_base: {
46
46
  * on-demand rotations were performed. You can monitor rotation of the key material for your KMS
47
47
  * keys in CloudTrail and Amazon CloudWatch.</p>
48
48
  * <p>On-demand key rotation is supported only on symmetric encryption KMS keys. You cannot
49
- * perform on-demand rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">asymmetric KMS keys</a>,
50
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html">HMAC KMS keys</a>, multi-Region KMS keys
51
- * with <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key material</a>,
52
- * or KMS keys in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html">custom key store</a>. When you initiate on-demand key rotation on a symmetric encryption KMS key
53
- * with imported key material, you must have already imported
54
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-import-key-material.html">new key material</a>
55
- * and that key material's state should be <code>PENDING_ROTATION</code>. Use the <code>ListKeyRotations</code>
56
- * operation to check the state of all key materials associated with a KMS key. To perform on-demand rotation of
57
- * a set of related <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#multi-region-rotate">multi-Region keys</a>, invoke the on-demand rotation on the primary key.</p>
49
+ * perform on-demand rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">asymmetric KMS keys</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html">HMAC KMS keys</a>, multi-Region KMS
50
+ * keys with <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key
51
+ * material</a>, or KMS keys in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html">custom key store</a>. When you initiate on-demand key
52
+ * rotation on a symmetric encryption KMS key with imported key material, you must have already
53
+ * imported <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-import-key-material.html">new key material</a> and that
54
+ * key material's state should be <code>PENDING_ROTATION</code>. Use the
55
+ * <code>ListKeyRotations</code> operation to check the state of all key materials associated
56
+ * with a KMS key. To perform on-demand rotation of a set of related <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#multi-region-rotate">multi-Region keys</a>, invoke
57
+ * the on-demand rotation on the primary key.</p>
58
58
  * <p>You cannot initiate on-demand rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed KMS keys</a>. KMS
59
59
  * always rotates the key material of Amazon Web Services managed keys every year. Rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk">Amazon Web Services owned KMS
60
60
  * keys</a> is managed by the Amazon Web Services service that owns the key.</p>
@@ -8,18 +8,20 @@
8
8
  * <note>
9
9
  * <p>KMS has replaced the term <i>customer master key (CMK)</i> with <i>KMS key</i> and <i>KMS key</i>. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.</p>
10
10
  * <p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming
11
- * languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a
12
- * convenient way to create programmatic access to KMS and other Amazon Web Services services. For example,
13
- * the SDKs take care of tasks such as signing requests (see below), managing errors, and
14
- * retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to
15
- * download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web
16
- * Services</a>.</p>
11
+ * languages and platforms (Java, Rust, Python, Ruby, .Net, macOS, Android, etc.). The SDKs
12
+ * provide a convenient way to create programmatic access to KMS and other Amazon Web Services services.
13
+ * For example, the SDKs take care of tasks such as signing requests (see below), managing
14
+ * errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs,
15
+ * including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools
16
+ * for Amazon Web Services</a>.</p>
17
17
  * </note>
18
18
  * <p>We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.</p>
19
19
  * <p>If you need to use FIPS 140-2 validated cryptographic modules when communicating with
20
- * Amazon Web Services, use the FIPS endpoint in your preferred Amazon Web Services Region. For more information about the
21
- * available FIPS endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/kms.html#kms_region">Service endpoints</a> in the Key Management Service topic of
22
- * the <i>Amazon Web Services General Reference</i>.</p>
20
+ * Amazon Web Services, use one of the FIPS endpoints in your preferred Amazon Web Services Region. If you need communicate
21
+ * over IPv6, use the dual-stack endpoint in your preferred Amazon Web Services Region. For more information
22
+ * see <a href="https://docs.aws.amazon.com/general/latest/gr/kms.html#kms_region">Service
23
+ * endpoints</a> in the Key Management Service topic of the <i>Amazon Web Services General Reference</i> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/ipv6-kms.html">Dual-stack endpoint
24
+ * support</a> in the KMS Developer Guide.</p>
23
25
  * <p>All KMS API calls must be signed and be transmitted using Transport Layer Security
24
26
  * (TLS). KMS recommends you always use the latest supported TLS version. Clients must also
25
27
  * support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman
@@ -1810,10 +1810,11 @@ export interface KeyMetadata {
1810
1810
  */
1811
1811
  DeletionDate?: Date | undefined;
1812
1812
  /**
1813
- * <p>The earliest time at which any imported key material permanently associated with this KMS key expires. When
1814
- * a key material expires, KMS deletes the key material and the KMS key becomes unusable. This value is present
1815
- * only for KMS keys whose <code>Origin</code> is <code>EXTERNAL</code> and the <code>ExpirationModel</code>
1816
- * is <code>KEY_MATERIAL_EXPIRES</code>, otherwise this value is omitted.</p>
1813
+ * <p>The earliest time at which any imported key material permanently associated with this KMS
1814
+ * key expires. When a key material expires, KMS deletes the key material and the KMS key
1815
+ * becomes unusable. This value is present only for KMS keys whose <code>Origin</code> is
1816
+ * <code>EXTERNAL</code> and the <code>ExpirationModel</code> is
1817
+ * <code>KEY_MATERIAL_EXPIRES</code>, otherwise this value is omitted.</p>
1817
1818
  * @public
1818
1819
  */
1819
1820
  ValidTo?: Date | undefined;
@@ -1953,11 +1954,12 @@ export interface KeyMetadata {
1953
1954
  */
1954
1955
  XksKeyConfiguration?: XksKeyConfigurationType | undefined;
1955
1956
  /**
1956
- * <p>Identifies the current key material. This value is present for symmetric encryption keys with
1957
- * <code>AWS_KMS</code> origin and single-Region, symmetric encryption keys with <code>EXTERNAL</code>
1958
- * origin. These KMS keys support automatic or on-demand key rotation and can have multiple key materials
1959
- * associated with them. KMS uses the current key material for both encryption and decryption, and the non-current
1960
- * key material for decryption operations only.</p>
1957
+ * <p>Identifies the current key material. This value is present for symmetric encryption keys
1958
+ * with <code>AWS_KMS</code> origin and single-Region, symmetric encryption keys with
1959
+ * <code>EXTERNAL</code> origin. These KMS keys support automatic or on-demand key rotation and
1960
+ * can have multiple key materials associated with them. KMS uses the current key material for
1961
+ * both encryption and decryption, and the non-current key material for decryption operations
1962
+ * only.</p>
1961
1963
  * @public
1962
1964
  */
1963
1965
  CurrentKeyMaterialId?: string | undefined;
@@ -2562,9 +2564,9 @@ export interface DecryptResponse {
2562
2564
  */
2563
2565
  CiphertextForRecipient?: Uint8Array | undefined;
2564
2566
  /**
2565
- * <p>The identifier of the key material used to decrypt the ciphertext. This field is present only when
2566
- * the operation uses a symmetric encryption KMS key. This field is omitted if the request includes
2567
- * the <code>Recipient</code> parameter.</p>
2567
+ * <p>The identifier of the key material used to decrypt the ciphertext. This field is present
2568
+ * only when the operation uses a symmetric encryption KMS key. This field is omitted if the
2569
+ * request includes the <code>Recipient</code> parameter.</p>
2568
2570
  * @public
2569
2571
  */
2570
2572
  KeyMaterialId?: string | undefined;
@@ -2697,8 +2699,7 @@ export interface DeleteImportedKeyMaterialRequest {
2697
2699
  /**
2698
2700
  * <p>Identifies the imported key material you are deleting. </p>
2699
2701
  * <important>
2700
- * <p>If no KeyMaterialId is specified, KMS
2701
- * deletes the current key material.</p>
2702
+ * <p>If no KeyMaterialId is specified, KMS deletes the current key material.</p>
2702
2703
  * </important>
2703
2704
  * <p>To get the list of key material IDs associated with a KMS key, use <a>ListKeyRotations</a>.</p>
2704
2705
  * @public
@@ -3338,8 +3339,8 @@ export interface GenerateDataKeyResponse {
3338
3339
  */
3339
3340
  CiphertextForRecipient?: Uint8Array | undefined;
3340
3341
  /**
3341
- * <p>The identifier of the key material used to encrypt the data key. This field is omitted if the request
3342
- * includes the <code>Recipient</code> parameter.</p>
3342
+ * <p>The identifier of the key material used to encrypt the data key. This field is omitted if
3343
+ * the request includes the <code>Recipient</code> parameter.</p>
3343
3344
  * @public
3344
3345
  */
3345
3346
  KeyMaterialId?: string | undefined;
@@ -3878,10 +3879,9 @@ export interface GetKeyRotationStatusResponse {
3878
3879
  NextRotationDate?: Date | undefined;
3879
3880
  /**
3880
3881
  * <p>Identifies the date and time that an in progress on-demand rotation was initiated.</p>
3881
- * <p>KMS uses a background process to perform rotations. As a result, there
3882
- * might be a slight delay between initiating on-demand key rotation and the rotation's
3883
- * completion. Once the on-demand rotation is complete, KMS removes this field from the response. You can
3884
- * use <a>ListKeyRotations</a> to view the details of the completed on-demand rotation.</p>
3882
+ * <p>KMS uses a background process to perform rotations. As a result, there might be a slight
3883
+ * delay between initiating on-demand key rotation and the rotation's completion. Once the
3884
+ * on-demand rotation is complete, KMS removes this field from the response. You can use <a>ListKeyRotations</a> to view the details of the completed on-demand rotation.</p>
3885
3885
  * @public
3886
3886
  */
3887
3887
  OnDemandRotationStartDate?: Date | undefined;
@@ -4250,26 +4250,30 @@ export interface ImportKeyMaterialRequest {
4250
4250
  */
4251
4251
  ExpirationModel?: ExpirationModelType | undefined;
4252
4252
  /**
4253
- * <p>Indicates whether the key material being imported is previously associated with this KMS key or not.
4254
- * This parameter is optional and only usable with symmetric encryption keys. The default is
4255
- * <code>EXISTING_KEY_MATERIAL</code>. If no key material has ever been imported into the KMS key,
4256
- * and this parameter is omitted, the parameter defaults to <code>NEW_KEY_MATERIAL</code>.</p>
4253
+ * <p>Indicates whether the key material being imported is previously associated with this KMS
4254
+ * key or not. This parameter is optional and only usable with symmetric encryption keys. If no
4255
+ * key material has ever been imported into the KMS key, and this parameter is omitted, the
4256
+ * parameter defaults to <code>NEW_KEY_MATERIAL</code>. After the first key material is imported,
4257
+ * if this parameter is omitted then the parameter defaults to
4258
+ * <code>EXISTING_KEY_MATERIAL</code>.</p>
4257
4259
  * @public
4258
4260
  */
4259
4261
  ImportType?: ImportType | undefined;
4260
4262
  /**
4261
- * <p>Description for the key material being imported. This parameter is optional and only usable
4262
- * with symmetric encryption keys. If you do not specify a key material description, KMS retains
4263
- * the value you specified when you last imported the same key material into this KMS key.</p>
4263
+ * <p>Description for the key material being imported. This parameter is optional and only
4264
+ * usable with symmetric encryption keys. If you do not specify a key material description, KMS
4265
+ * retains the value you specified when you last imported the same key material into this KMS
4266
+ * key.</p>
4264
4267
  * @public
4265
4268
  */
4266
4269
  KeyMaterialDescription?: string | undefined;
4267
4270
  /**
4268
- * <p>Identifies the key material being imported. This parameter is optional and only usable with
4269
- * symmetric encryption keys. You cannot specify a key material ID with <code>ImportType</code> set
4270
- * to <code>NEW_KEY_MATERIAL</code>. Whenever you import key material into a symmetric encryption key,
4271
- * KMS assigns a unique identifier to the key material based on the KMS key ID and
4272
- * the imported key material. When you re-import key material with a specified key material ID, KMS:</p>
4271
+ * <p>Identifies the key material being imported. This parameter is optional and only usable
4272
+ * with symmetric encryption keys. You cannot specify a key material ID with
4273
+ * <code>ImportType</code> set to <code>NEW_KEY_MATERIAL</code>. Whenever you import key
4274
+ * material into a symmetric encryption key, KMS assigns a unique identifier to the key
4275
+ * material based on the KMS key ID and the imported key material. When you re-import key
4276
+ * material with a specified key material ID, KMS:</p>
4273
4277
  * <ul>
4274
4278
  * <li>
4275
4279
  * <p>Computes the identifier for the key material</p>
@@ -4303,9 +4307,9 @@ export interface ImportKeyMaterialResponse {
4303
4307
  }
4304
4308
  /**
4305
4309
  * <p>The request was rejected because the key material in the request is, expired, invalid, or
4306
- * does not meet expectations. For example, it is not the same key material that was previously imported or
4307
- * KMS expected new key material but the key material being imported is already associated with
4308
- * the KMS key.</p>
4310
+ * does not meet expectations. For example, it is not the same key material that was previously
4311
+ * imported or KMS expected new key material but the key material being imported is already
4312
+ * associated with the KMS key.</p>
4309
4313
  * @public
4310
4314
  */
4311
4315
  export declare class IncorrectKeyMaterialException extends __BaseException {
@@ -4652,12 +4656,12 @@ export interface ListKeyRotationsRequest {
4652
4656
  KeyId: string | undefined;
4653
4657
  /**
4654
4658
  * <p>Use this optional parameter to control which key materials associated with this key are
4655
- * listed in the response. The default value of this parameter is <code>ROTATIONS_ONLY</code>. If you omit this
4656
- * parameter, KMS returns information on the key materials created by automatic or on-demand key rotation. When you
4657
- * specify a value of <code>ALL_KEY_MATERIAL</code>, KMS adds the first key material and any imported key material
4658
- * pending rotation to the response. This parameter can only be used with KMS keys that support
4659
- * automatic or on-demand key rotation.
4660
- * </p>
4659
+ * listed in the response. The default value of this parameter is <code>ROTATIONS_ONLY</code>. If
4660
+ * you omit this parameter, KMS returns information on the key materials created by automatic
4661
+ * or on-demand key rotation. When you specify a value of <code>ALL_KEY_MATERIAL</code>, KMS
4662
+ * adds the first key material and any imported key material pending rotation to the response.
4663
+ * This parameter can only be used with KMS keys that support automatic or on-demand key
4664
+ * rotation. </p>
4661
4665
  * @public
4662
4666
  */
4663
4667
  IncludeKeyMaterial?: IncludeKeyMaterial | undefined;
@@ -4691,7 +4695,8 @@ export declare const RotationType: {
4691
4695
  */
4692
4696
  export type RotationType = (typeof RotationType)[keyof typeof RotationType];
4693
4697
  /**
4694
- * <p>Each entry contains information about one of the key materials associated with a KMS key.</p>
4698
+ * <p>Each entry contains information about one of the key materials associated with a KMS
4699
+ * key.</p>
4695
4700
  * @public
4696
4701
  */
4697
4702
  export interface RotationsListEntry {
@@ -4713,49 +4718,52 @@ export interface RotationsListEntry {
4713
4718
  KeyMaterialDescription?: string | undefined;
4714
4719
  /**
4715
4720
  * <p>Indicates if the key material is currently imported into KMS. It has two possible
4716
- * values: <code>IMPORTED</code> or <code>PENDING_IMPORT</code>. This field is only present
4717
- * for symmetric encryption KMS keys with <code>EXTERNAL</code> origin.</p>
4721
+ * values: <code>IMPORTED</code> or <code>PENDING_IMPORT</code>. This field is only present for
4722
+ * symmetric encryption KMS keys with <code>EXTERNAL</code> origin.</p>
4718
4723
  * @public
4719
4724
  */
4720
4725
  ImportState?: ImportState | undefined;
4721
4726
  /**
4722
- * <p>There are three possible values for this field: <code>CURRENT</code>, <code>NON_CURRENT</code>
4723
- * and <code>PENDING_ROTATION</code>. KMS uses <code>CURRENT</code> key material for both encryption
4724
- * and decryption and <code>NON_CURRENT</code> key material only for decryption. <code>PENDING_ROTATION</code>
4725
- * identifies key material that has been imported for on-demand key rotation but the rotation hasn't completed.
4726
- * Key material in <code>PENDING_ROTATION</code> is not permanently associated with the KMS key. You can
4727
- * delete this key material and import different key material in its place. The <code>PENDING_ROTATION</code>
4728
- * value is only used in symmetric encryption keys with imported key material. The other values,
4729
- * <code>CURRENT</code> and <code>NON_CURRENT</code>, are used for all KMS keys that support automatic or
4730
- * on-demand key rotation.</p>
4727
+ * <p>There are three possible values for this field: <code>CURRENT</code>,
4728
+ * <code>NON_CURRENT</code> and <code>PENDING_ROTATION</code>. KMS uses <code>CURRENT</code>
4729
+ * key material for both encryption and decryption and <code>NON_CURRENT</code> key material only
4730
+ * for decryption. <code>PENDING_ROTATION</code> identifies key material that has been imported
4731
+ * for on-demand key rotation but the rotation hasn't completed. Key material in
4732
+ * <code>PENDING_ROTATION</code> is not permanently associated with the KMS key. You can delete
4733
+ * this key material and import different key material in its place. The
4734
+ * <code>PENDING_ROTATION</code> value is only used in symmetric encryption keys with imported
4735
+ * key material. The other values, <code>CURRENT</code> and <code>NON_CURRENT</code>, are used
4736
+ * for all KMS keys that support automatic or on-demand key rotation.</p>
4731
4737
  * @public
4732
4738
  */
4733
4739
  KeyMaterialState?: KeyMaterialState | undefined;
4734
4740
  /**
4735
- * <p>Indicates if the key material is configured to automatically expire. There are two possible values for
4736
- * this field: <code>KEY_MATERIAL_EXPIRES</code> and <code>KEY_MATERIAL_DOES_NOT_EXPIRE</code>. For any key
4737
- * material that expires, the expiration date and time is indicated in <code>ValidTo</code>. This field
4738
- * is only present for symmetric encryption KMS keys with <code>EXTERNAL</code> origin.</p>
4741
+ * <p>Indicates if the key material is configured to automatically expire. There are two
4742
+ * possible values for this field: <code>KEY_MATERIAL_EXPIRES</code> and
4743
+ * <code>KEY_MATERIAL_DOES_NOT_EXPIRE</code>. For any key material that expires, the expiration
4744
+ * date and time is indicated in <code>ValidTo</code>. This field is only present for symmetric
4745
+ * encryption KMS keys with <code>EXTERNAL</code> origin.</p>
4739
4746
  * @public
4740
4747
  */
4741
4748
  ExpirationModel?: ExpirationModelType | undefined;
4742
4749
  /**
4743
- * <p>Date and time at which the key material expires. This field is only present for symmetric encryption KMS
4744
- * keys with <code>EXTERNAL</code> origin in rotation list entries with an <code>ExpirationModel</code>
4745
- * value of <code>KEY_MATERIAL_EXPIRES</code>.</p>
4750
+ * <p>Date and time at which the key material expires. This field is only present for symmetric
4751
+ * encryption KMS keys with <code>EXTERNAL</code> origin in rotation list entries with an
4752
+ * <code>ExpirationModel</code> value of <code>KEY_MATERIAL_EXPIRES</code>.</p>
4746
4753
  * @public
4747
4754
  */
4748
4755
  ValidTo?: Date | undefined;
4749
4756
  /**
4750
- * <p>Date and time that the key material rotation completed. Formatted as Unix time. This field is not present
4751
- * for the first key material or an imported key material in <code>PENDING_ROTATION</code> state.</p>
4757
+ * <p>Date and time that the key material rotation completed. Formatted as Unix time. This field
4758
+ * is not present for the first key material or an imported key material in
4759
+ * <code>PENDING_ROTATION</code> state.</p>
4752
4760
  * @public
4753
4761
  */
4754
4762
  RotationDate?: Date | undefined;
4755
4763
  /**
4756
4764
  * <p>Identifies whether the key material rotation was a scheduled <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotating-keys-enable-disable.html">automatic rotation</a> or an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotating-keys-on-demand.html">on-demand
4757
- * rotation</a>. This field is not present for the first key material or an imported key material
4758
- * in <code>PENDING_ROTATION</code> state.</p>
4765
+ * rotation</a>. This field is not present for the first key material or an imported key
4766
+ * material in <code>PENDING_ROTATION</code> state.</p>
4759
4767
  * @public
4760
4768
  */
4761
4769
  RotationType?: RotationType | undefined;
@@ -4765,10 +4773,10 @@ export interface RotationsListEntry {
4765
4773
  */
4766
4774
  export interface ListKeyRotationsResponse {
4767
4775
  /**
4768
- * <p>A list of completed key material rotations. When the optional input
4769
- * parameter <code>IncludeKeyMaterial</code> is specified with a value of
4770
- * <code>ALL_KEY_MATERIAL</code>, this list includes the first key material
4771
- * and any imported key material pending rotation.</p>
4776
+ * <p>A list of completed key material rotations. When the optional input parameter
4777
+ * <code>IncludeKeyMaterial</code> is specified with a value of <code>ALL_KEY_MATERIAL</code>,
4778
+ * this list includes the first key material and any imported key material pending
4779
+ * rotation.</p>
4772
4780
  * @public
4773
4781
  */
4774
4782
  Rotations?: RotationsListEntry[] | undefined;
@@ -5204,14 +5212,14 @@ export interface ReEncryptResponse {
5204
5212
  */
5205
5213
  DestinationEncryptionAlgorithm?: EncryptionAlgorithmSpec | undefined;
5206
5214
  /**
5207
- * <p>The identifier of the key material used to originally encrypt the data. This field is present only when
5208
- * the original encryption used a symmetric encryption KMS key.</p>
5215
+ * <p>The identifier of the key material used to originally encrypt the data. This field is
5216
+ * present only when the original encryption used a symmetric encryption KMS key.</p>
5209
5217
  * @public
5210
5218
  */
5211
5219
  SourceKeyMaterialId?: string | undefined;
5212
5220
  /**
5213
- * <p>The identifier of the key material used to reencrypt the data. This field is present only when
5214
- * data is reencrypted using a symmetric encryption KMS key.</p>
5221
+ * <p>The identifier of the key material used to reencrypt the data. This field is present only
5222
+ * when data is reencrypted using a symmetric encryption KMS key.</p>
5215
5223
  * @public
5216
5224
  */
5217
5225
  DestinationKeyMaterialId?: string | undefined;
@@ -5454,9 +5462,9 @@ export interface RotateKeyOnDemandRequest {
5454
5462
  /**
5455
5463
  * <p>Identifies a symmetric encryption KMS key. You cannot perform on-demand rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">asymmetric KMS
5456
5464
  * keys</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html">HMAC KMS
5457
- * keys</a>, multi-Region KMS keys with <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key material</a>, or KMS keys in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html">custom key store</a>. To perform on-demand
5458
- * rotation of a set of related <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#multi-region-rotate">multi-Region keys</a>, invoke
5459
- * the on-demand rotation on the primary key.</p>
5465
+ * keys</a>, multi-Region KMS keys with <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key material</a>, or KMS keys in a
5466
+ * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html">custom key store</a>. To perform on-demand rotation of a set of related <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#multi-region-rotate">multi-Region
5467
+ * keys</a>, invoke the on-demand rotation on the primary key.</p>
5460
5468
  * <p>Specify the key ID or key ARN of the KMS key.</p>
5461
5469
  * <p>For example:</p>
5462
5470
  * <ul>
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-kms",
3
3
  "description": "AWS SDK for JavaScript Kms Client for Node.js, Browser and React Native",
4
- "version": "3.835.0",
4
+ "version": "3.838.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-kms",