@aws-sdk/client-kms 3.848.0 → 3.854.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
@@ -14,7 +14,8 @@ see the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/">
14
14
  <i>Key Management Service Developer Guide</i>
15
15
  </a>.</p>
16
16
  <note>
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>
17
+ <p>KMS has replaced the term <i>customer master key (CMK)</i> with <i>Key Management Service key</i>
18
+ and <i>KMS key</i>. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.</p>
18
19
  <p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming
19
20
  languages and platforms (Java, Rust, Python, Ruby, .Net, macOS, Android, etc.). The SDKs
20
21
  provide a convenient way to create programmatic access to KMS and other Amazon Web Services services.
@@ -387,7 +387,8 @@ export interface KMS {
387
387
  * <i>Key Management Service Developer Guide</i>
388
388
  * </a>.</p>
389
389
  * <note>
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>
390
+ * <p>KMS has replaced the term <i>customer master key (CMK)</i> with <i>Key Management Service key</i>
391
+ * and <i>KMS key</i>. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.</p>
391
392
  * <p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming
392
393
  * languages and platforms (Java, Rust, Python, Ruby, .Net, macOS, Android, etc.). The SDKs
393
394
  * provide a convenient way to create programmatic access to KMS and other Amazon Web Services services.
@@ -229,7 +229,8 @@ export interface KMSClientResolvedConfig extends KMSClientResolvedConfigType {
229
229
  * <i>Key Management Service Developer Guide</i>
230
230
  * </a>.</p>
231
231
  * <note>
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>
232
+ * <p>KMS has replaced the term <i>customer master key (CMK)</i> with <i>Key Management Service key</i>
233
+ * and <i>KMS key</i>. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.</p>
233
234
  * <p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming
234
235
  * languages and platforms (Java, Rust, Python, Ruby, .Net, macOS, Android, etc.). The SDKs
235
236
  * provide a convenient way to create programmatic access to KMS and other Amazon Web Services services.
@@ -37,7 +37,8 @@ declare const CreateKeyCommand_base: {
37
37
  * <p>Use the parameters of <code>CreateKey</code> to specify the type of KMS key, the source of
38
38
  * its key material, its key policy, description, tags, and other properties.</p>
39
39
  * <note>
40
- * <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>
40
+ * <p>KMS has replaced the term <i>customer master key (CMK)</i> with <i>Key Management Service key</i>
41
+ * and <i>KMS key</i>. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.</p>
41
42
  * </note>
42
43
  * <p>To create different types of KMS keys, use the following guidance:</p>
43
44
  * <dl>
@@ -28,8 +28,8 @@ declare const DescribeKeyCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Provides detailed information about a KMS key. You can run <code>DescribeKey</code> on a
31
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed
32
- * key</a> or an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed key</a>.</p>
31
+ * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-mgn-key">customer managed
32
+ * key</a> or an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-key">Amazon Web Services managed key</a>.</p>
33
33
  * <p>This detailed information includes the key ARN, creation date (and deletion date, if
34
34
  * applicable), the key state, and the origin and expiration date (if any) of the key material.
35
35
  * It includes fields, like <code>KeySpec</code>, that help you distinguish different types of
@@ -60,7 +60,7 @@ declare const DescribeKeyCommand_base: {
60
60
  * </ul>
61
61
  * <p>In general, <code>DescribeKey</code> is a non-mutating operation. It returns data about
62
62
  * KMS keys, but doesn't change them. However, Amazon Web Services services use <code>DescribeKey</code> to
63
- * create <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services
63
+ * create <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-key">Amazon Web Services
64
64
  * managed keys</a> from a <i>predefined Amazon Web Services alias</i> with no key
65
65
  * ID.</p>
66
66
  * <p>
@@ -32,8 +32,8 @@ declare const DisableKeyRotationCommand_base: {
32
32
  * <p>Automatic key rotation is supported only on symmetric encryption KMS keys.
33
33
  * You cannot enable automatic rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">asymmetric KMS keys</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html">HMAC KMS keys</a>, KMS keys with <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key material</a>, or KMS keys in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html">custom key store</a>. To enable or disable automatic rotation of a set of related <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#multi-region-rotate">multi-Region keys</a>, set the property on the primary key.</p>
34
34
  * <p>You can enable (<a>EnableKeyRotation</a>) and disable automatic rotation of the
35
- * key material in <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed KMS keys</a>. Key material rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed KMS keys</a> is not
36
- * configurable. KMS always rotates the key material for every year. Rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk">Amazon Web Services owned KMS
35
+ * key material in <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-mgn-key">customer managed KMS keys</a>. Key material rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-key">Amazon Web Services managed KMS keys</a> is not
36
+ * configurable. KMS always rotates the key material for every year. Rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-key">Amazon Web Services owned KMS
37
37
  * keys</a> varies.</p>
38
38
  * <note>
39
39
  * <p>In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three
@@ -29,7 +29,7 @@ declare const EnableKeyRotationCommand_base: {
29
29
  /**
30
30
  * <p>Enables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotating-keys-enable-disable.html">automatic rotation of the key material</a> of the specified symmetric encryption KMS
31
31
  * key. </p>
32
- * <p>By default, when you enable automatic rotation of a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed KMS key</a>, KMS
32
+ * <p>By default, when you enable automatic rotation of a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-mgn-key">customer managed KMS key</a>, KMS
33
33
  * rotates the key material of the KMS key one year (approximately 365 days) from the enable date
34
34
  * and every year thereafter. You can use the optional <code>RotationPeriodInDays</code>
35
35
  * parameter to specify a custom rotation period when you enable key rotation, or you can use
@@ -40,8 +40,8 @@ declare const EnableKeyRotationCommand_base: {
40
40
  * use the <a>ListKeyRotations</a> operation to view the details of completed
41
41
  * rotations.</p>
42
42
  * <p>Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">asymmetric KMS keys</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html">HMAC KMS keys</a>, KMS keys with <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key material</a>, or KMS keys in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html">custom key store</a>. To enable or disable automatic rotation of a set of related <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#multi-region-rotate">multi-Region keys</a>, set the property on the primary key. </p>
43
- * <p>You cannot enable or disable automatic 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
44
- * 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
43
+ * <p>You cannot enable or disable automatic rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-key">Amazon Web Services managed KMS keys</a>. KMS
44
+ * 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-key">Amazon Web Services owned KMS
45
45
  * keys</a> is managed by the Amazon Web Services service that owns the key.</p>
46
46
  * <note>
47
47
  * <p>In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three
@@ -34,7 +34,7 @@ declare const GetKeyRotationStatusCommand_base: {
34
34
  * <p>Automatic key rotation is supported only on symmetric encryption KMS keys.
35
35
  * You cannot enable automatic rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">asymmetric KMS keys</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html">HMAC KMS keys</a>, KMS keys with <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key material</a>, or KMS keys in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html">custom key store</a>. To enable or disable automatic rotation of a set of related <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#multi-region-rotate">multi-Region keys</a>, set the property on the primary key.</p>
36
36
  * <p>You can enable (<a>EnableKeyRotation</a>) and disable automatic rotation (<a>DisableKeyRotation</a>) of the key material in customer managed KMS keys. Key
37
- * material rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed KMS keys</a> is not
37
+ * material rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-key">Amazon Web Services managed KMS keys</a> is not
38
38
  * configurable. KMS always rotates the key material in Amazon Web Services managed KMS keys every year. The
39
39
  * key rotation status for Amazon Web Services managed KMS keys is always <code>true</code>.</p>
40
40
  * <p>You can perform on-demand (<a>RotateKeyOnDemand</a>) rotation of the key
@@ -55,8 +55,8 @@ declare const RotateKeyOnDemandCommand_base: {
55
55
  * <code>ListKeyRotations</code> operation to check the state of all key materials associated
56
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
57
  * the on-demand rotation on the primary key.</p>
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
- * 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
58
+ * <p>You cannot initiate on-demand rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-key">Amazon Web Services managed KMS keys</a>. KMS
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-key">Amazon Web Services owned KMS
60
60
  * keys</a> is managed by the Amazon Web Services service that owns the key.</p>
61
61
  * <p>The KMS key that you use for this operation must be in a compatible key state. For
62
62
  * details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
@@ -27,16 +27,16 @@ declare const TagResourceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Adds or edits tags on a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>.</p>
30
+ * <p>Adds or edits tags on a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-mgn-key">customer managed key</a>.</p>
31
31
  * <note>
32
32
  * <p>Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">ABAC for KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
33
33
  * </note>
34
34
  * <p>Each tag consists of a tag key and a tag value, both of which are case-sensitive strings.
35
35
  * The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag
36
36
  * value. To edit a tag, specify an existing tag key and a new tag value.</p>
37
- * <p>You can use this operation to tag a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>, but you cannot
38
- * tag an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services
39
- * managed key</a>, an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk">Amazon Web Services owned key</a>, a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html">custom key store</a>,
37
+ * <p>You can use this operation to tag a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-mgn-key">customer managed key</a>, but you cannot
38
+ * tag an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-key">Amazon Web Services
39
+ * managed key</a>, an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-key">Amazon Web Services owned key</a>, a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html">custom key store</a>,
40
40
  * or an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html">alias</a>.</p>
41
41
  * <p>You can also add tags to a KMS key while creating it (<a>CreateKey</a>) or
42
42
  * replicating it (<a>ReplicateKey</a>).</p>
@@ -27,7 +27,7 @@ declare const UntagResourceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes tags from a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>. To delete a tag,
30
+ * <p>Deletes tags from a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-mgn-key">customer managed key</a>. To delete a tag,
31
31
  * specify the tag key and the KMS key.</p>
32
32
  * <note>
33
33
  * <p>Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">ABAC for KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
@@ -6,7 +6,8 @@
6
6
  * <i>Key Management Service Developer Guide</i>
7
7
  * </a>.</p>
8
8
  * <note>
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>
9
+ * <p>KMS has replaced the term <i>customer master key (CMK)</i> with <i>Key Management Service key</i>
10
+ * and <i>KMS key</i>. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.</p>
10
11
  * <p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming
11
12
  * languages and platforms (Java, Rust, Python, Ruby, .Net, macOS, Android, etc.). The SDKs
12
13
  * provide a convenient way to create programmatic access to KMS and other Amazon Web Services services.
@@ -426,13 +426,13 @@ export interface CreateAliasRequest {
426
426
  * <p>The <code>AliasName</code> value must be string of 1-256 characters. It can contain only
427
427
  * alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name
428
428
  * cannot begin with <code>alias/aws/</code>. The <code>alias/aws/</code> prefix is reserved for
429
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed
429
+ * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-key">Amazon Web Services managed
430
430
  * keys</a>.</p>
431
431
  * @public
432
432
  */
433
433
  AliasName: string | undefined;
434
434
  /**
435
- * <p>Associates the alias with the specified <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>. The KMS key must
435
+ * <p>Associates the alias with the specified <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-mgn-key">customer managed key</a>. The KMS key must
436
436
  * be in the same Amazon Web Services Region. </p>
437
437
  * <p>A valid key ID is required. If you supply a null or empty string value, this operation
438
438
  * returns an error.</p>
@@ -2938,7 +2938,7 @@ export interface DescribeKeyRequest {
2938
2938
  /**
2939
2939
  * <p>Describes the specified KMS key. </p>
2940
2940
  * <p>If you specify a predefined Amazon Web Services alias (an Amazon Web Services alias with no key ID), KMS associates
2941
- * the alias with an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html##aws-managed-cmk">Amazon Web Services managed key</a> and returns its
2941
+ * the alias with an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-key">Amazon Web Services managed key</a> and returns its
2942
2942
  * <code>KeyId</code> and <code>Arn</code> in the response.</p>
2943
2943
  * <p>To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.</p>
2944
2944
  * <p>For example:</p>
@@ -5787,8 +5787,8 @@ export interface UpdateAliasRequest {
5787
5787
  */
5788
5788
  AliasName: string | undefined;
5789
5789
  /**
5790
- * <p>Identifies the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a> to associate with the alias. You don't have permission to
5791
- * associate an alias with an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed key</a>.</p>
5790
+ * <p>Identifies the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-mgn-key">customer managed key</a> to associate with the alias. You don't have permission to
5791
+ * associate an alias with an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-key">Amazon Web Services managed key</a>.</p>
5792
5792
  * <p>The KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the new
5793
5793
  * target KMS key must be the same type as the current target KMS key (both symmetric or both
5794
5794
  * asymmetric or both HMAC) and they must have the same key usage. </p>
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.848.0",
4
+ "version": "3.854.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",