Skip to content

Commit

Permalink
docs(client-kms): Documentation updates for AWS Key Management Service
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Dec 15, 2023
1 parent ad9fb3c commit f824e6c
Show file tree
Hide file tree
Showing 52 changed files with 265 additions and 137 deletions.
3 changes: 3 additions & 0 deletions clients/client-kms/src/commands/CancelKeyDeletionCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,9 @@ export interface CancelKeyDeletionCommandOutput extends CancelKeyDeletionRespons
* <p>
* <b>Related operations</b>: <a>ScheduleKeyDeletion</a>
* </p>
* <p>
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,9 @@ export interface ConnectCustomKeyStoreCommandOutput extends ConnectCustomKeyStor
* </p>
* </li>
* </ul>
* <p>
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
3 changes: 3 additions & 0 deletions clients/client-kms/src/commands/CreateAliasCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,9 @@ export interface CreateAliasCommandOutput extends __MetadataBearer {}
* </p>
* </li>
* </ul>
* <p>
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,9 @@ export interface CreateCustomKeyStoreCommandOutput extends CreateCustomKeyStoreR
* </p>
* </li>
* </ul>
* <p>
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -280,8 +283,7 @@ export interface CreateCustomKeyStoreCommandOutput extends CreateCustomKeyStoreR
* @throws {@link XksProxyVpcEndpointServiceInvalidConfigurationException} (client fault)
* <p>The request was rejected because the Amazon VPC endpoint service configuration does not fulfill
* the requirements for an external key store proxy. For details, see the exception message and
* <a href="kms/latest/developerguide/vpc-connectivity.html#xks-vpc-requirements">review the
* requirements</a> for Amazon VPC endpoint service connectivity for an external key
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/vpc-connectivity.html#xks-vpc-requirements">review the requirements</a> for Amazon VPC endpoint service connectivity for an external key
* store.</p>
*
* @throws {@link XksProxyVpcEndpointServiceNotFoundException} (client fault)
Expand Down
7 changes: 4 additions & 3 deletions clients/client-kms/src/commands/CreateGrantCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,9 @@ export interface CreateGrantCommandOutput extends CreateGrantResponse, __Metadat
* </p>
* </li>
* </ul>
* <p>
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -149,9 +152,7 @@ export interface CreateGrantCommandOutput extends CreateGrantResponse, __Metadat
* <p>The request was rejected because the specified KMS key is not enabled.</p>
*
* @throws {@link DryRunOperationException} (client fault)
* <p>
* The request was rejected because the DryRun parameter was specified.
* </p>
* <p> The request was rejected because the DryRun parameter was specified. </p>
*
* @throws {@link InvalidArnException} (client fault)
* <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
Expand Down
3 changes: 3 additions & 0 deletions clients/client-kms/src/commands/CreateKeyCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,9 @@ export interface CreateKeyCommandOutput extends CreateKeyResponse, __MetadataBea
* </p>
* </li>
* </ul>
* <p>
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
9 changes: 5 additions & 4 deletions clients/client-kms/src/commands/DecryptCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ export interface DecryptCommandOutput extends DecryptResponse, __MetadataBearer
* the <a href="https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk">Amazon Web Services Nitro Enclaves SDK</a> or any Amazon Web Services SDK. Use the <code>Recipient</code> parameter to provide the
* attestation document for the enclave. Instead of the plaintext data, the response includes the
* plaintext data encrypted with the public key from the attestation document
* (<code>CiphertextForRecipient</code>).For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves uses KMS</a> in the <i>Key Management Service Developer Guide</i>..</p>
* (<code>CiphertextForRecipient</code>). For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves uses KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
* <p>The KMS key that you use for this operation must be in a compatible key state. For
* 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>
* <p>
Expand Down Expand Up @@ -131,6 +131,9 @@ export interface DecryptCommandOutput extends DecryptResponse, __MetadataBearer
* </p>
* </li>
* </ul>
* <p>
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -178,9 +181,7 @@ export interface DecryptCommandOutput extends DecryptResponse, __MetadataBearer
* <p>The request was rejected because the specified KMS key is not enabled.</p>
*
* @throws {@link DryRunOperationException} (client fault)
* <p>
* The request was rejected because the DryRun parameter was specified.
* </p>
* <p> The request was rejected because the DryRun parameter was specified. </p>
*
* @throws {@link IncorrectKeyException} (client fault)
* <p>The request was rejected because the specified KMS key cannot decrypt the data. The
Expand Down
3 changes: 3 additions & 0 deletions clients/client-kms/src/commands/DeleteAliasCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,9 @@ export interface DeleteAliasCommandOutput extends __MetadataBearer {}
* </p>
* </li>
* </ul>
* <p>
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,9 @@ export interface DeleteCustomKeyStoreCommandOutput extends DeleteCustomKeyStoreR
* </p>
* </li>
* </ul>
* <p>
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,9 @@ export interface DeleteImportedKeyMaterialCommandOutput extends __MetadataBearer
* </p>
* </li>
* </ul>
* <p>
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,9 @@ export interface DescribeCustomKeyStoresCommandOutput extends DescribeCustomKeyS
* </p>
* </li>
* </ul>
* <p>
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
13 changes: 7 additions & 6 deletions clients/client-kms/src/commands/DescribeKeyCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,10 @@ export interface DescribeKeyCommandOutput extends DescribeKeyResponse, __Metadat
* It includes fields, like <code>KeySpec</code>, that help you distinguish different types of
* KMS keys. It also displays the key usage (encryption, signing, or generating and verifying
* MACs) and the algorithms that the KMS key supports. </p>
* <p>For <a href="kms/latest/developerguide/multi-region-keys-overview.html">multi-Region keys</a>,
* <code>DescribeKey</code> displays the primary key and all related replica keys. For KMS keys
* in <a href="kms/latest/developerguide/keystore-cloudhsm.html">CloudHSM key stores</a>, it includes
* information about the key store, such as the key store ID and the CloudHSM cluster ID. For KMS
* keys in <a href="kms/latest/developerguide/keystore-external.html">external key stores</a>, it
* includes the custom key store ID and the ID of the external key.</p>
* <p>For <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">multi-Region keys</a>, <code>DescribeKey</code> displays the primary key and all
* related replica keys. For KMS keys in <a href="https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html">CloudHSM key stores</a>, it includes information
* about the key store, such as the key store ID and the CloudHSM cluster ID. For KMS keys in <a href="https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html">external key stores</a>,
* it includes the custom key store ID and the ID of the external key.</p>
* <p>
* <code>DescribeKey</code> does not return the following information:</p>
* <ul>
Expand Down Expand Up @@ -120,6 +118,9 @@ export interface DescribeKeyCommandOutput extends DescribeKeyResponse, __Metadat
* </p>
* </li>
* </ul>
* <p>
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
3 changes: 3 additions & 0 deletions clients/client-kms/src/commands/DisableKeyCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ export interface DisableKeyCommandOutput extends __MetadataBearer {}
* <p>
* <b>Related operations</b>: <a>EnableKey</a>
* </p>
* <p>
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
3 changes: 3 additions & 0 deletions clients/client-kms/src/commands/DisableKeyRotationCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,9 @@ export interface DisableKeyRotationCommandOutput extends __MetadataBearer {}
* </p>
* </li>
* </ul>
* <p>
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,9 @@ export interface DisconnectCustomKeyStoreCommandOutput extends DisconnectCustomK
* </p>
* </li>
* </ul>
* <p>
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
3 changes: 3 additions & 0 deletions clients/client-kms/src/commands/EnableKeyCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@ export interface EnableKeyCommandOutput extends __MetadataBearer {}
* <p>
* <b>Related operations</b>: <a>DisableKey</a>
* </p>
* <p>
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
5 changes: 4 additions & 1 deletion clients/client-kms/src/commands/EnableKeyRotationCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export interface EnableKeyRotationCommandOutput extends __MetadataBearer {}
* @public
* <p>Enables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic rotation
* of the key material</a> of the specified symmetric encryption KMS key. </p>
* <p>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
* <p>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
* rotates the key material of the KMS key one year (approximately 365 days) from the enable date
* and every year thereafter. You can monitor rotation of the key material for your KMS keys in
* CloudTrail and Amazon CloudWatch. To disable rotation of the key material in a customer
Expand Down Expand Up @@ -78,6 +78,9 @@ export interface EnableKeyRotationCommandOutput extends __MetadataBearer {}
* </p>
* </li>
* </ul>
* <p>
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
7 changes: 4 additions & 3 deletions clients/client-kms/src/commands/EncryptCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,9 @@ export interface EncryptCommandOutput extends EncryptResponse, __MetadataBearer
* </p>
* </li>
* </ul>
* <p>
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -188,9 +191,7 @@ export interface EncryptCommandOutput extends EncryptResponse, __MetadataBearer
* <p>The request was rejected because the specified KMS key is not enabled.</p>
*
* @throws {@link DryRunOperationException} (client fault)
* <p>
* The request was rejected because the DryRun parameter was specified.
* </p>
* <p> The request was rejected because the DryRun parameter was specified. </p>
*
* @throws {@link InvalidGrantTokenException} (client fault)
* <p>The request was rejected because the specified grant token is not valid.</p>
Expand Down
7 changes: 4 additions & 3 deletions clients/client-kms/src/commands/GenerateDataKeyCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,9 @@ export interface GenerateDataKeyCommandOutput extends GenerateDataKeyResponse, _
* </p>
* </li>
* </ul>
* <p>
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -191,9 +194,7 @@ export interface GenerateDataKeyCommandOutput extends GenerateDataKeyResponse, _
* <p>The request was rejected because the specified KMS key is not enabled.</p>
*
* @throws {@link DryRunOperationException} (client fault)
* <p>
* The request was rejected because the DryRun parameter was specified.
* </p>
* <p> The request was rejected because the DryRun parameter was specified. </p>
*
* @throws {@link InvalidGrantTokenException} (client fault)
* <p>The request was rejected because the specified grant token is not valid.</p>
Expand Down
9 changes: 5 additions & 4 deletions clients/client-kms/src/commands/GenerateDataKeyPairCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ export interface GenerateDataKeyPairCommandOutput extends GenerateDataKeyPairRes
* a plaintext public key, a plaintext private key, and a copy of the private key that is
* encrypted under the symmetric encryption KMS key you specify. You can use the data key pair to
* perform asymmetric cryptography and implement digital signatures outside of KMS. The bytes
* in the keys are random; they not related to the caller or to the KMS key that is used to
* in the keys are random; they are not related to the caller or to the KMS key that is used to
* encrypt the private key. </p>
* <p>You can use the public key that <code>GenerateDataKeyPair</code> returns to encrypt data
* or verify a signature outside of KMS. Then, store the encrypted private key with the data.
Expand Down Expand Up @@ -123,6 +123,9 @@ export interface GenerateDataKeyPairCommandOutput extends GenerateDataKeyPairRes
* </p>
* </li>
* </ul>
* <p>
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -171,9 +174,7 @@ export interface GenerateDataKeyPairCommandOutput extends GenerateDataKeyPairRes
* <p>The request was rejected because the specified KMS key is not enabled.</p>
*
* @throws {@link DryRunOperationException} (client fault)
* <p>
* The request was rejected because the DryRun parameter was specified.
* </p>
* <p> The request was rejected because the DryRun parameter was specified. </p>
*
* @throws {@link InvalidGrantTokenException} (client fault)
* <p>The request was rejected because the specified grant token is not valid.</p>
Expand Down
Loading

0 comments on commit f824e6c

Please sign in to comment.