Skip to content

Commit 3015df3

Browse files
author
awstools
committed
docs(client-kms): Doc only update: fixed grammatical errors.
1 parent d557c50 commit 3015df3

File tree

14 files changed

+44
-39
lines changed

14 files changed

+44
-39
lines changed

clients/client-kms/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ see the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/">
1414
<i>Key Management Service Developer Guide</i>
1515
</a>.</p>
1616
<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>
1819
<p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming
1920
languages and platforms (Java, Rust, Python, Ruby, .Net, macOS, Android, etc.). The SDKs
2021
provide a convenient way to create programmatic access to KMS and other Amazon Web Services services.

clients/client-kms/src/KMS.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -989,7 +989,8 @@ export interface KMS {
989989
* <i>Key Management Service Developer Guide</i>
990990
* </a>.</p>
991991
* <note>
992-
* <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>
992+
* <p>KMS has replaced the term <i>customer master key (CMK)</i> with <i>Key Management Service key</i>
993+
* and <i>KMS key</i>. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.</p>
993994
* <p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming
994995
* languages and platforms (Java, Rust, Python, Ruby, .Net, macOS, Android, etc.). The SDKs
995996
* provide a convenient way to create programmatic access to KMS and other Amazon Web Services services.

clients/client-kms/src/KMSClient.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -479,7 +479,8 @@ export interface KMSClientResolvedConfig extends KMSClientResolvedConfigType {}
479479
* <i>Key Management Service Developer Guide</i>
480480
* </a>.</p>
481481
* <note>
482-
* <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>
482+
* <p>KMS has replaced the term <i>customer master key (CMK)</i> with <i>Key Management Service key</i>
483+
* and <i>KMS key</i>. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.</p>
483484
* <p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming
484485
* languages and platforms (Java, Rust, Python, Ruby, .Net, macOS, Android, etc.). The SDKs
485486
* provide a convenient way to create programmatic access to KMS and other Amazon Web Services services.

clients/client-kms/src/commands/CreateKeyCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ export interface CreateKeyCommandOutput extends CreateKeyResponse, __MetadataBea
3838
* <p>Use the parameters of <code>CreateKey</code> to specify the type of KMS key, the source of
3939
* its key material, its key policy, description, tags, and other properties.</p>
4040
* <note>
41-
* <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>
41+
* <p>KMS has replaced the term <i>customer master key (CMK)</i> with <i>Key Management Service key</i>
42+
* and <i>KMS key</i>. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.</p>
4243
* </note>
4344
* <p>To create different types of KMS keys, use the following guidance:</p>
4445
* <dl>

clients/client-kms/src/commands/DescribeKeyCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ export interface DescribeKeyCommandOutput extends DescribeKeyResponse, __Metadat
2929

3030
/**
3131
* <p>Provides detailed information about a KMS key. You can run <code>DescribeKey</code> on a
32-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed
33-
* 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>
32+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-mgn-key">customer managed
33+
* 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>
3434
* <p>This detailed information includes the key ARN, creation date (and deletion date, if
3535
* applicable), the key state, and the origin and expiration date (if any) of the key material.
3636
* It includes fields, like <code>KeySpec</code>, that help you distinguish different types of
@@ -61,7 +61,7 @@ export interface DescribeKeyCommandOutput extends DescribeKeyResponse, __Metadat
6161
* </ul>
6262
* <p>In general, <code>DescribeKey</code> is a non-mutating operation. It returns data about
6363
* KMS keys, but doesn't change them. However, Amazon Web Services services use <code>DescribeKey</code> to
64-
* create <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services
64+
* create <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-key">Amazon Web Services
6565
* managed keys</a> from a <i>predefined Amazon Web Services alias</i> with no key
6666
* ID.</p>
6767
* <p>

clients/client-kms/src/commands/DisableKeyRotationCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ export interface DisableKeyRotationCommandOutput extends __MetadataBearer {}
3333
* <p>Automatic key rotation is supported only on symmetric encryption KMS keys.
3434
* 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>
3535
* <p>You can enable (<a>EnableKeyRotation</a>) and disable automatic rotation of the
36-
* 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
37-
* 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
36+
* 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
37+
* 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
3838
* keys</a> varies.</p>
3939
* <note>
4040
* <p>In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three

clients/client-kms/src/commands/EnableKeyRotationCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export interface EnableKeyRotationCommandOutput extends __MetadataBearer {}
3030
/**
3131
* <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
3232
* key. </p>
33-
* <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
33+
* <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
3434
* rotates the key material of the KMS key one year (approximately 365 days) from the enable date
3535
* and every year thereafter. You can use the optional <code>RotationPeriodInDays</code>
3636
* parameter to specify a custom rotation period when you enable key rotation, or you can use
@@ -41,8 +41,8 @@ export interface EnableKeyRotationCommandOutput extends __MetadataBearer {}
4141
* use the <a>ListKeyRotations</a> operation to view the details of completed
4242
* rotations.</p>
4343
* <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>
44-
* <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
45-
* 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
44+
* <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
45+
* 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
4646
* keys</a> is managed by the Amazon Web Services service that owns the key.</p>
4747
* <note>
4848
* <p>In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three

clients/client-kms/src/commands/GetKeyRotationStatusCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ export interface GetKeyRotationStatusCommandOutput extends GetKeyRotationStatusR
3535
* <p>Automatic key rotation is supported only on symmetric encryption KMS keys.
3636
* 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>
3737
* <p>You can enable (<a>EnableKeyRotation</a>) and disable automatic rotation (<a>DisableKeyRotation</a>) of the key material in customer managed KMS keys. Key
38-
* 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
38+
* 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
3939
* configurable. KMS always rotates the key material in Amazon Web Services managed KMS keys every year. The
4040
* key rotation status for Amazon Web Services managed KMS keys is always <code>true</code>.</p>
4141
* <p>You can perform on-demand (<a>RotateKeyOnDemand</a>) rotation of the key

clients/client-kms/src/commands/RotateKeyOnDemandCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ export interface RotateKeyOnDemandCommandOutput extends RotateKeyOnDemandRespons
5656
* <code>ListKeyRotations</code> operation to check the state of all key materials associated
5757
* 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
5858
* the on-demand rotation on the primary key.</p>
59-
* <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
60-
* 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
59+
* <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
60+
* 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
6161
* keys</a> is managed by the Amazon Web Services service that owns the key.</p>
6262
* <p>The KMS key that you use for this operation must be in a compatible key state. For
6363
* 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>

clients/client-kms/src/commands/TagResourceCommand.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,16 @@ export interface TagResourceCommandInput extends TagResourceRequest {}
2828
export interface TagResourceCommandOutput extends __MetadataBearer {}
2929

3030
/**
31-
* <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>
31+
* <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>
3232
* <note>
3333
* <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>
3434
* </note>
3535
* <p>Each tag consists of a tag key and a tag value, both of which are case-sensitive strings.
3636
* The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag
3737
* value. To edit a tag, specify an existing tag key and a new tag value.</p>
38-
* <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
39-
* tag an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services
40-
* 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>,
38+
* <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
39+
* tag an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-key">Amazon Web Services
40+
* 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>,
4141
* or an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html">alias</a>.</p>
4242
* <p>You can also add tags to a KMS key while creating it (<a>CreateKey</a>) or
4343
* replicating it (<a>ReplicateKey</a>).</p>

0 commit comments

Comments
 (0)