@aws-sdk/client-kms 3.474.0 → 3.476.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.
Files changed (52) hide show
  1. package/dist-types/commands/CancelKeyDeletionCommand.d.ts +3 -0
  2. package/dist-types/commands/ConnectCustomKeyStoreCommand.d.ts +3 -0
  3. package/dist-types/commands/CreateAliasCommand.d.ts +3 -0
  4. package/dist-types/commands/CreateCustomKeyStoreCommand.d.ts +4 -2
  5. package/dist-types/commands/CreateGrantCommand.d.ts +4 -3
  6. package/dist-types/commands/CreateKeyCommand.d.ts +3 -0
  7. package/dist-types/commands/DecryptCommand.d.ts +5 -4
  8. package/dist-types/commands/DeleteAliasCommand.d.ts +3 -0
  9. package/dist-types/commands/DeleteCustomKeyStoreCommand.d.ts +3 -0
  10. package/dist-types/commands/DeleteImportedKeyMaterialCommand.d.ts +3 -0
  11. package/dist-types/commands/DescribeCustomKeyStoresCommand.d.ts +3 -0
  12. package/dist-types/commands/DescribeKeyCommand.d.ts +7 -6
  13. package/dist-types/commands/DisableKeyCommand.d.ts +3 -0
  14. package/dist-types/commands/DisableKeyRotationCommand.d.ts +3 -0
  15. package/dist-types/commands/DisconnectCustomKeyStoreCommand.d.ts +3 -0
  16. package/dist-types/commands/EnableKeyCommand.d.ts +3 -0
  17. package/dist-types/commands/EnableKeyRotationCommand.d.ts +4 -1
  18. package/dist-types/commands/EncryptCommand.d.ts +4 -3
  19. package/dist-types/commands/GenerateDataKeyCommand.d.ts +4 -3
  20. package/dist-types/commands/GenerateDataKeyPairCommand.d.ts +5 -4
  21. package/dist-types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +4 -3
  22. package/dist-types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +4 -3
  23. package/dist-types/commands/GenerateMacCommand.d.ts +4 -3
  24. package/dist-types/commands/GenerateRandomCommand.d.ts +3 -0
  25. package/dist-types/commands/GetKeyPolicyCommand.d.ts +4 -1
  26. package/dist-types/commands/GetKeyRotationStatusCommand.d.ts +3 -0
  27. package/dist-types/commands/GetParametersForImportCommand.d.ts +9 -4
  28. package/dist-types/commands/GetPublicKeyCommand.d.ts +3 -0
  29. package/dist-types/commands/ImportKeyMaterialCommand.d.ts +3 -0
  30. package/dist-types/commands/ListAliasesCommand.d.ts +3 -0
  31. package/dist-types/commands/ListGrantsCommand.d.ts +3 -0
  32. package/dist-types/commands/ListKeyPoliciesCommand.d.ts +4 -1
  33. package/dist-types/commands/ListKeysCommand.d.ts +3 -0
  34. package/dist-types/commands/ListResourceTagsCommand.d.ts +3 -0
  35. package/dist-types/commands/ListRetirableGrantsCommand.d.ts +13 -1
  36. package/dist-types/commands/PutKeyPolicyCommand.d.ts +3 -0
  37. package/dist-types/commands/ReEncryptCommand.d.ts +4 -3
  38. package/dist-types/commands/ReplicateKeyCommand.d.ts +4 -1
  39. package/dist-types/commands/RetireGrantCommand.d.ts +5 -4
  40. package/dist-types/commands/RevokeGrantCommand.d.ts +4 -3
  41. package/dist-types/commands/ScheduleKeyDeletionCommand.d.ts +4 -2
  42. package/dist-types/commands/SignCommand.d.ts +4 -3
  43. package/dist-types/commands/TagResourceCommand.d.ts +3 -0
  44. package/dist-types/commands/UntagResourceCommand.d.ts +3 -0
  45. package/dist-types/commands/UpdateAliasCommand.d.ts +3 -0
  46. package/dist-types/commands/UpdateCustomKeyStoreCommand.d.ts +4 -2
  47. package/dist-types/commands/UpdateKeyDescriptionCommand.d.ts +3 -0
  48. package/dist-types/commands/UpdatePrimaryRegionCommand.d.ts +3 -0
  49. package/dist-types/commands/VerifyCommand.d.ts +4 -3
  50. package/dist-types/commands/VerifyMacCommand.d.ts +4 -3
  51. package/dist-types/models/models_0.d.ts +13 -13
  52. package/package.json +4 -4
@@ -36,6 +36,9 @@ export interface CancelKeyDeletionCommandOutput extends CancelKeyDeletionRespons
36
36
  * <p>
37
37
  * <b>Related operations</b>: <a>ScheduleKeyDeletion</a>
38
38
  * </p>
39
+ * <p>
40
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
41
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
39
42
  * @example
40
43
  * Use a bare-bones client and the command you need to make an API call.
41
44
  * ```javascript
@@ -110,6 +110,9 @@ export interface ConnectCustomKeyStoreCommandOutput extends ConnectCustomKeyStor
110
110
  * </p>
111
111
  * </li>
112
112
  * </ul>
113
+ * <p>
114
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
115
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
113
116
  * @example
114
117
  * Use a bare-bones client and the command you need to make an API call.
115
118
  * ```javascript
@@ -80,6 +80,9 @@ export interface CreateAliasCommandOutput extends __MetadataBearer {
80
80
  * </p>
81
81
  * </li>
82
82
  * </ul>
83
+ * <p>
84
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
85
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
83
86
  * @example
84
87
  * Use a bare-bones client and the command you need to make an API call.
85
88
  * ```javascript
@@ -112,6 +112,9 @@ export interface CreateCustomKeyStoreCommandOutput extends CreateCustomKeyStoreR
112
112
  * </p>
113
113
  * </li>
114
114
  * </ul>
115
+ * <p>
116
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
117
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
115
118
  * @example
116
119
  * Use a bare-bones client and the command you need to make an API call.
117
120
  * ```javascript
@@ -262,8 +265,7 @@ export interface CreateCustomKeyStoreCommandOutput extends CreateCustomKeyStoreR
262
265
  * @throws {@link XksProxyVpcEndpointServiceInvalidConfigurationException} (client fault)
263
266
  * <p>The request was rejected because the Amazon VPC endpoint service configuration does not fulfill
264
267
  * the requirements for an external key store proxy. For details, see the exception message and
265
- * <a href="kms/latest/developerguide/vpc-connectivity.html#xks-vpc-requirements">review the
266
- * requirements</a> for Amazon VPC endpoint service connectivity for an external key
268
+ * <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
267
269
  * store.</p>
268
270
  *
269
271
  * @throws {@link XksProxyVpcEndpointServiceNotFoundException} (client fault)
@@ -85,6 +85,9 @@ export interface CreateGrantCommandOutput extends CreateGrantResponse, __Metadat
85
85
  * </p>
86
86
  * </li>
87
87
  * </ul>
88
+ * <p>
89
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
90
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
88
91
  * @example
89
92
  * Use a bare-bones client and the command you need to make an API call.
90
93
  * ```javascript
@@ -135,9 +138,7 @@ export interface CreateGrantCommandOutput extends CreateGrantResponse, __Metadat
135
138
  * <p>The request was rejected because the specified KMS key is not enabled.</p>
136
139
  *
137
140
  * @throws {@link DryRunOperationException} (client fault)
138
- * <p>
139
- * The request was rejected because the DryRun parameter was specified.
140
- * </p>
141
+ * <p> The request was rejected because the DryRun parameter was specified. </p>
141
142
  *
142
143
  * @throws {@link InvalidArnException} (client fault)
143
144
  * <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
@@ -187,6 +187,9 @@ export interface CreateKeyCommandOutput extends CreateKeyResponse, __MetadataBea
187
187
  * </p>
188
188
  * </li>
189
189
  * </ul>
190
+ * <p>
191
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
192
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
190
193
  * @example
191
194
  * Use a bare-bones client and the command you need to make an API call.
192
195
  * ```javascript
@@ -83,7 +83,7 @@ export interface DecryptCommandOutput extends DecryptResponse, __MetadataBearer
83
83
  * 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
84
84
  * attestation document for the enclave. Instead of the plaintext data, the response includes the
85
85
  * plaintext data encrypted with the public key from the attestation document
86
- * (<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>
86
+ * (<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>
87
87
  * <p>The KMS key that you use for this operation must be in a compatible key state. For
88
88
  * 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>
89
89
  * <p>
@@ -117,6 +117,9 @@ export interface DecryptCommandOutput extends DecryptResponse, __MetadataBearer
117
117
  * </p>
118
118
  * </li>
119
119
  * </ul>
120
+ * <p>
121
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
122
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
120
123
  * @example
121
124
  * Use a bare-bones client and the command you need to make an API call.
122
125
  * ```javascript
@@ -164,9 +167,7 @@ export interface DecryptCommandOutput extends DecryptResponse, __MetadataBearer
164
167
  * <p>The request was rejected because the specified KMS key is not enabled.</p>
165
168
  *
166
169
  * @throws {@link DryRunOperationException} (client fault)
167
- * <p>
168
- * The request was rejected because the DryRun parameter was specified.
169
- * </p>
170
+ * <p> The request was rejected because the DryRun parameter was specified. </p>
170
171
  *
171
172
  * @throws {@link IncorrectKeyException} (client fault)
172
173
  * <p>The request was rejected because the specified KMS key cannot decrypt the data. The
@@ -71,6 +71,9 @@ export interface DeleteAliasCommandOutput extends __MetadataBearer {
71
71
  * </p>
72
72
  * </li>
73
73
  * </ul>
74
+ * <p>
75
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
76
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
74
77
  * @example
75
78
  * Use a bare-bones client and the command you need to make an API call.
76
79
  * ```javascript
@@ -82,6 +82,9 @@ export interface DeleteCustomKeyStoreCommandOutput extends DeleteCustomKeyStoreR
82
82
  * </p>
83
83
  * </li>
84
84
  * </ul>
85
+ * <p>
86
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
87
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
85
88
  * @example
86
89
  * Use a bare-bones client and the command you need to make an API call.
87
90
  * ```javascript
@@ -51,6 +51,9 @@ export interface DeleteImportedKeyMaterialCommandOutput extends __MetadataBearer
51
51
  * </p>
52
52
  * </li>
53
53
  * </ul>
54
+ * <p>
55
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
56
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
54
57
  * @example
55
58
  * Use a bare-bones client and the command you need to make an API call.
56
59
  * ```javascript
@@ -82,6 +82,9 @@ export interface DescribeCustomKeyStoresCommandOutput extends DescribeCustomKeyS
82
82
  * </p>
83
83
  * </li>
84
84
  * </ul>
85
+ * <p>
86
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
87
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
85
88
  * @example
86
89
  * Use a bare-bones client and the command you need to make an API call.
87
90
  * ```javascript
@@ -31,12 +31,10 @@ export interface DescribeKeyCommandOutput extends DescribeKeyResponse, __Metadat
31
31
  * It includes fields, like <code>KeySpec</code>, that help you distinguish different types of
32
32
  * KMS keys. It also displays the key usage (encryption, signing, or generating and verifying
33
33
  * MACs) and the algorithms that the KMS key supports. </p>
34
- * <p>For <a href="kms/latest/developerguide/multi-region-keys-overview.html">multi-Region keys</a>,
35
- * <code>DescribeKey</code> displays the primary key and all related replica keys. For KMS keys
36
- * in <a href="kms/latest/developerguide/keystore-cloudhsm.html">CloudHSM key stores</a>, it includes
37
- * information about the key store, such as the key store ID and the CloudHSM cluster ID. For KMS
38
- * keys in <a href="kms/latest/developerguide/keystore-external.html">external key stores</a>, it
39
- * includes the custom key store ID and the ID of the external key.</p>
34
+ * <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
35
+ * 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
36
+ * 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>,
37
+ * it includes the custom key store ID and the ID of the external key.</p>
40
38
  * <p>
41
39
  * <code>DescribeKey</code> does not return the following information:</p>
42
40
  * <ul>
@@ -106,6 +104,9 @@ export interface DescribeKeyCommandOutput extends DescribeKeyResponse, __Metadat
106
104
  * </p>
107
105
  * </li>
108
106
  * </ul>
107
+ * <p>
108
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
109
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
109
110
  * @example
110
111
  * Use a bare-bones client and the command you need to make an API call.
111
112
  * ```javascript
@@ -38,6 +38,9 @@ export interface DisableKeyCommandOutput extends __MetadataBearer {
38
38
  * <p>
39
39
  * <b>Related operations</b>: <a>EnableKey</a>
40
40
  * </p>
41
+ * <p>
42
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
43
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
41
44
  * @example
42
45
  * Use a bare-bones client and the command you need to make an API call.
43
46
  * ```javascript
@@ -56,6 +56,9 @@ export interface DisableKeyRotationCommandOutput extends __MetadataBearer {
56
56
  * </p>
57
57
  * </li>
58
58
  * </ul>
59
+ * <p>
60
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
61
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
59
62
  * @example
60
63
  * Use a bare-bones client and the command you need to make an API call.
61
64
  * ```javascript
@@ -75,6 +75,9 @@ export interface DisconnectCustomKeyStoreCommandOutput extends DisconnectCustomK
75
75
  * </p>
76
76
  * </li>
77
77
  * </ul>
78
+ * <p>
79
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
80
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
78
81
  * @example
79
82
  * Use a bare-bones client and the command you need to make an API call.
80
83
  * ```javascript
@@ -34,6 +34,9 @@ export interface EnableKeyCommandOutput extends __MetadataBearer {
34
34
  * <p>
35
35
  * <b>Related operations</b>: <a>DisableKey</a>
36
36
  * </p>
37
+ * <p>
38
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
39
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
37
40
  * @example
38
41
  * Use a bare-bones client and the command you need to make an API call.
39
42
  * ```javascript
@@ -25,7 +25,7 @@ export interface EnableKeyRotationCommandOutput extends __MetadataBearer {
25
25
  * @public
26
26
  * <p>Enables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic rotation
27
27
  * of the key material</a> of the specified symmetric encryption KMS key. </p>
28
- * <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
28
+ * <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
29
29
  * rotates the key material of the KMS key one year (approximately 365 days) from the enable date
30
30
  * and every year thereafter. You can monitor rotation of the key material for your KMS keys in
31
31
  * CloudTrail and Amazon CloudWatch. To disable rotation of the key material in a customer
@@ -64,6 +64,9 @@ export interface EnableKeyRotationCommandOutput extends __MetadataBearer {
64
64
  * </p>
65
65
  * </li>
66
66
  * </ul>
67
+ * <p>
68
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
69
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
67
70
  * @example
68
71
  * Use a bare-bones client and the command you need to make an API call.
69
72
  * ```javascript
@@ -132,6 +132,9 @@ export interface EncryptCommandOutput extends EncryptResponse, __MetadataBearer
132
132
  * </p>
133
133
  * </li>
134
134
  * </ul>
135
+ * <p>
136
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
137
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
135
138
  * @example
136
139
  * Use a bare-bones client and the command you need to make an API call.
137
140
  * ```javascript
@@ -174,9 +177,7 @@ export interface EncryptCommandOutput extends EncryptResponse, __MetadataBearer
174
177
  * <p>The request was rejected because the specified KMS key is not enabled.</p>
175
178
  *
176
179
  * @throws {@link DryRunOperationException} (client fault)
177
- * <p>
178
- * The request was rejected because the DryRun parameter was specified.
179
- * </p>
180
+ * <p> The request was rejected because the DryRun parameter was specified. </p>
180
181
  *
181
182
  * @throws {@link InvalidGrantTokenException} (client fault)
182
183
  * <p>The request was rejected because the specified grant token is not valid.</p>
@@ -126,6 +126,9 @@ export interface GenerateDataKeyCommandOutput extends GenerateDataKeyResponse, _
126
126
  * </p>
127
127
  * </li>
128
128
  * </ul>
129
+ * <p>
130
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
131
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
129
132
  * @example
130
133
  * Use a bare-bones client and the command you need to make an API call.
131
134
  * ```javascript
@@ -173,9 +176,7 @@ export interface GenerateDataKeyCommandOutput extends GenerateDataKeyResponse, _
173
176
  * <p>The request was rejected because the specified KMS key is not enabled.</p>
174
177
  *
175
178
  * @throws {@link DryRunOperationException} (client fault)
176
- * <p>
177
- * The request was rejected because the DryRun parameter was specified.
178
- * </p>
179
+ * <p> The request was rejected because the DryRun parameter was specified. </p>
179
180
  *
180
181
  * @throws {@link InvalidGrantTokenException} (client fault)
181
182
  * <p>The request was rejected because the specified grant token is not valid.</p>
@@ -27,7 +27,7 @@ export interface GenerateDataKeyPairCommandOutput extends GenerateDataKeyPairRes
27
27
  * a plaintext public key, a plaintext private key, and a copy of the private key that is
28
28
  * encrypted under the symmetric encryption KMS key you specify. You can use the data key pair to
29
29
  * perform asymmetric cryptography and implement digital signatures outside of KMS. The bytes
30
- * in the keys are random; they not related to the caller or to the KMS key that is used to
30
+ * in the keys are random; they are not related to the caller or to the KMS key that is used to
31
31
  * encrypt the private key. </p>
32
32
  * <p>You can use the public key that <code>GenerateDataKeyPair</code> returns to encrypt data
33
33
  * or verify a signature outside of KMS. Then, store the encrypted private key with the data.
@@ -105,6 +105,9 @@ export interface GenerateDataKeyPairCommandOutput extends GenerateDataKeyPairRes
105
105
  * </p>
106
106
  * </li>
107
107
  * </ul>
108
+ * <p>
109
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
110
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
108
111
  * @example
109
112
  * Use a bare-bones client and the command you need to make an API call.
110
113
  * ```javascript
@@ -153,9 +156,7 @@ export interface GenerateDataKeyPairCommandOutput extends GenerateDataKeyPairRes
153
156
  * <p>The request was rejected because the specified KMS key is not enabled.</p>
154
157
  *
155
158
  * @throws {@link DryRunOperationException} (client fault)
156
- * <p>
157
- * The request was rejected because the DryRun parameter was specified.
158
- * </p>
159
+ * <p> The request was rejected because the DryRun parameter was specified. </p>
159
160
  *
160
161
  * @throws {@link InvalidGrantTokenException} (client fault)
161
162
  * <p>The request was rejected because the specified grant token is not valid.</p>
@@ -87,6 +87,9 @@ export interface GenerateDataKeyPairWithoutPlaintextCommandOutput extends Genera
87
87
  * </p>
88
88
  * </li>
89
89
  * </ul>
90
+ * <p>
91
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
92
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
90
93
  * @example
91
94
  * Use a bare-bones client and the command you need to make an API call.
92
95
  * ```javascript
@@ -129,9 +132,7 @@ export interface GenerateDataKeyPairWithoutPlaintextCommandOutput extends Genera
129
132
  * <p>The request was rejected because the specified KMS key is not enabled.</p>
130
133
  *
131
134
  * @throws {@link DryRunOperationException} (client fault)
132
- * <p>
133
- * The request was rejected because the DryRun parameter was specified.
134
- * </p>
135
+ * <p> The request was rejected because the DryRun parameter was specified. </p>
135
136
  *
136
137
  * @throws {@link InvalidGrantTokenException} (client fault)
137
138
  * <p>The request was rejected because the specified grant token is not valid.</p>
@@ -96,6 +96,9 @@ export interface GenerateDataKeyWithoutPlaintextCommandOutput extends GenerateDa
96
96
  * </p>
97
97
  * </li>
98
98
  * </ul>
99
+ * <p>
100
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
101
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
99
102
  * @example
100
103
  * Use a bare-bones client and the command you need to make an API call.
101
104
  * ```javascript
@@ -137,9 +140,7 @@ export interface GenerateDataKeyWithoutPlaintextCommandOutput extends GenerateDa
137
140
  * <p>The request was rejected because the specified KMS key is not enabled.</p>
138
141
  *
139
142
  * @throws {@link DryRunOperationException} (client fault)
140
- * <p>
141
- * The request was rejected because the DryRun parameter was specified.
142
- * </p>
143
+ * <p> The request was rejected because the DryRun parameter was specified. </p>
143
144
  *
144
145
  * @throws {@link InvalidGrantTokenException} (client fault)
145
146
  * <p>The request was rejected because the specified grant token is not valid.</p>
@@ -52,6 +52,9 @@ export interface GenerateMacCommandOutput extends GenerateMacResponse, __Metadat
52
52
  * <p>
53
53
  * <b>Related operations</b>: <a>VerifyMac</a>
54
54
  * </p>
55
+ * <p>
56
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
57
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
55
58
  * @example
56
59
  * Use a bare-bones client and the command you need to make an API call.
57
60
  * ```javascript
@@ -87,9 +90,7 @@ export interface GenerateMacCommandOutput extends GenerateMacResponse, __Metadat
87
90
  * <p>The request was rejected because the specified KMS key is not enabled.</p>
88
91
  *
89
92
  * @throws {@link DryRunOperationException} (client fault)
90
- * <p>
91
- * The request was rejected because the DryRun parameter was specified.
92
- * </p>
93
+ * <p> The request was rejected because the DryRun parameter was specified. </p>
93
94
  *
94
95
  * @throws {@link InvalidGrantTokenException} (client fault)
95
96
  * <p>The request was rejected because the specified grant token is not valid.</p>
@@ -44,6 +44,9 @@ export interface GenerateRandomCommandOutput extends GenerateRandomResponse, __M
44
44
  * keys.</p>
45
45
  * <p>
46
46
  * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GenerateRandom</a> (IAM policy)</p>
47
+ * <p>
48
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
49
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
47
50
  * @example
48
51
  * Use a bare-bones client and the command you need to make an API call.
49
52
  * ```javascript
@@ -29,8 +29,11 @@ export interface GetKeyPolicyCommandOutput extends GetKeyPolicyResponse, __Metad
29
29
  * <p>
30
30
  * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GetKeyPolicy</a> (key policy)</p>
31
31
  * <p>
32
- * <b>Related operations</b>: <a>PutKeyPolicy</a>
32
+ * <b>Related operations</b>: <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html">PutKeyPolicy</a>
33
33
  * </p>
34
+ * <p>
35
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
36
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
34
37
  * @example
35
38
  * Use a bare-bones client and the command you need to make an API call.
36
39
  * ```javascript
@@ -76,6 +76,9 @@ export interface GetKeyRotationStatusCommandOutput extends GetKeyRotationStatusR
76
76
  * </p>
77
77
  * </li>
78
78
  * </ul>
79
+ * <p>
80
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
81
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
79
82
  * @example
80
83
  * Use a bare-bones client and the command you need to make an API call.
81
84
  * ```javascript
@@ -35,10 +35,12 @@ export interface GetParametersForImportCommandOutput extends GetParametersForImp
35
35
  * operation with an <code>Origin</code> value of <code>EXTERNAL</code> to create a KMS key with
36
36
  * no key material. You can import key material for a symmetric encryption KMS key, HMAC KMS key,
37
37
  * asymmetric encryption KMS key, or asymmetric signing KMS key. You can also import key material
38
- * into a <a href="kms/latest/developerguide/multi-region-keys-overview.html">multi-Region key</a> of
39
- * any supported type. However, you can't import key material into a KMS key in a <a href="kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. You can also use
40
- * <code>GetParametersForImport</code> to get a public key and import token to <a href="kms/latest/developerguide/importing-keys.html#reimport-key-material">reimport the original key
41
- * material</a> into a KMS key whose key material expired or was deleted.</p>
38
+ * into a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">multi-Region key</a> of
39
+ * any supported type. However, you can't import key material into a KMS key in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key
40
+ * store</a>. You can also use <code>GetParametersForImport</code> to get a public key and
41
+ * import token to <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#reimport-key-material">reimport
42
+ * the original key material</a> into a KMS key whose key material expired or was
43
+ * deleted.</p>
42
44
  * <p>
43
45
  * <code>GetParametersForImport</code> returns the items that you need to import your key
44
46
  * material.</p>
@@ -97,6 +99,9 @@ export interface GetParametersForImportCommandOutput extends GetParametersForImp
97
99
  * </p>
98
100
  * </li>
99
101
  * </ul>
102
+ * <p>
103
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
104
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
100
105
  * @example
101
106
  * Use a bare-bones client and the command you need to make an API call.
102
107
  * ```javascript
@@ -71,6 +71,9 @@ export interface GetPublicKeyCommandOutput extends GetPublicKeyResponse, __Metad
71
71
  * <p>
72
72
  * <b>Related operations</b>: <a>CreateKey</a>
73
73
  * </p>
74
+ * <p>
75
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
76
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
74
77
  * @example
75
78
  * Use a bare-bones client and the command you need to make an API call.
76
79
  * ```javascript
@@ -125,6 +125,9 @@ export interface ImportKeyMaterialCommandOutput extends ImportKeyMaterialRespons
125
125
  * </p>
126
126
  * </li>
127
127
  * </ul>
128
+ * <p>
129
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
130
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
128
131
  * @example
129
132
  * Use a bare-bones client and the command you need to make an API call.
130
133
  * ```javascript
@@ -64,6 +64,9 @@ export interface ListAliasesCommandOutput extends ListAliasesResponse, __Metadat
64
64
  * </p>
65
65
  * </li>
66
66
  * </ul>
67
+ * <p>
68
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
69
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
67
70
  * @example
68
71
  * Use a bare-bones client and the command you need to make an API call.
69
72
  * ```javascript
@@ -68,6 +68,9 @@ export interface ListGrantsCommandOutput extends ListGrantsResponse, __MetadataB
68
68
  * </p>
69
69
  * </li>
70
70
  * </ul>
71
+ * <p>
72
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
73
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
71
74
  * @example
72
75
  * Use a bare-bones client and the command you need to make an API call.
73
76
  * ```javascript
@@ -41,10 +41,13 @@ export interface ListKeyPoliciesCommandOutput extends ListKeyPoliciesResponse, _
41
41
  * </li>
42
42
  * <li>
43
43
  * <p>
44
- * <a>PutKeyPolicy</a>
44
+ * <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html">PutKeyPolicy</a>
45
45
  * </p>
46
46
  * </li>
47
47
  * </ul>
48
+ * <p>
49
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
50
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
48
51
  * @example
49
52
  * Use a bare-bones client and the command you need to make an API call.
50
53
  * ```javascript
@@ -53,6 +53,9 @@ export interface ListKeysCommandOutput extends ListKeysResponse, __MetadataBeare
53
53
  * </p>
54
54
  * </li>
55
55
  * </ul>
56
+ * <p>
57
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
58
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
56
59
  * @example
57
60
  * Use a bare-bones client and the command you need to make an API call.
58
61
  * ```javascript
@@ -57,6 +57,9 @@ export interface ListResourceTagsCommandOutput extends ListResourceTagsResponse,
57
57
  * </p>
58
58
  * </li>
59
59
  * </ul>
60
+ * <p>
61
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
62
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
60
63
  * @example
61
64
  * Use a bare-bones client and the command you need to make an API call.
62
65
  * ```javascript
@@ -35,12 +35,21 @@ export interface ListRetirableGrantsCommandOutput extends ListGrantsResponse, __
35
35
  * programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a>. </p>
36
36
  * <p>
37
37
  * <b>Cross-account use</b>: You must specify a principal in your
38
- * Amazon Web Services account. However, this operation can return grants in any Amazon Web Services account. You do not need
38
+ * Amazon Web Services account. This operation returns a list of grants where the retiring principal specified
39
+ * in the <code>ListRetirableGrants</code> request is the same retiring principal on the grant.
40
+ * This can include grants on KMS keys owned by other Amazon Web Services accounts, but you do not need
39
41
  * <code>kms:ListRetirableGrants</code> permission (or any other additional permission) in any
40
42
  * Amazon Web Services account other than your own.</p>
41
43
  * <p>
42
44
  * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListRetirableGrants</a> (IAM policy) in your
43
45
  * Amazon Web Services account.</p>
46
+ * <note>
47
+ * <p>KMS authorizes <code>ListRetirableGrants</code> requests by evaluating the caller
48
+ * account's kms:ListRetirableGrants permissions. The authorized resource in
49
+ * <code>ListRetirableGrants</code> calls is the retiring principal specified in the request.
50
+ * KMS does not evaluate the caller's permissions to verify their access to any KMS keys or
51
+ * grants that might be returned by the <code>ListRetirableGrants</code> call.</p>
52
+ * </note>
44
53
  * <p>
45
54
  * <b>Related operations:</b>
46
55
  * </p>
@@ -66,6 +75,9 @@ export interface ListRetirableGrantsCommandOutput extends ListGrantsResponse, __
66
75
  * </p>
67
76
  * </li>
68
77
  * </ul>
78
+ * <p>
79
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
80
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
69
81
  * @example
70
82
  * Use a bare-bones client and the command you need to make an API call.
71
83
  * ```javascript
@@ -36,6 +36,9 @@ export interface PutKeyPolicyCommandOutput extends __MetadataBearer {
36
36
  * <p>
37
37
  * <b>Related operations</b>: <a>GetKeyPolicy</a>
38
38
  * </p>
39
+ * <p>
40
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
41
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
39
42
  * @example
40
43
  * Use a bare-bones client and the command you need to make an API call.
41
44
  * ```javascript
@@ -118,6 +118,9 @@ export interface ReEncryptCommandOutput extends ReEncryptResponse, __MetadataBea
118
118
  * </p>
119
119
  * </li>
120
120
  * </ul>
121
+ * <p>
122
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
123
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
121
124
  * @example
122
125
  * Use a bare-bones client and the command you need to make an API call.
123
126
  * ```javascript
@@ -167,9 +170,7 @@ export interface ReEncryptCommandOutput extends ReEncryptResponse, __MetadataBea
167
170
  * <p>The request was rejected because the specified KMS key is not enabled.</p>
168
171
  *
169
172
  * @throws {@link DryRunOperationException} (client fault)
170
- * <p>
171
- * The request was rejected because the DryRun parameter was specified.
172
- * </p>
173
+ * <p> The request was rejected because the DryRun parameter was specified. </p>
173
174
  *
174
175
  * @throws {@link IncorrectKeyException} (client fault)
175
176
  * <p>The request was rejected because the specified KMS key cannot decrypt the data. The
@@ -62,7 +62,7 @@ export interface ReplicateKeyCommandOutput extends ReplicateKeyResponse, __Metad
62
62
  * <code>ReplicateKey</code> operation in the primary key's Region and a <a>CreateKey</a> operation in the replica key's Region.</p>
63
63
  * <p>If you replicate a multi-Region primary key with imported key material, the replica key is
64
64
  * created with no key material. You must import the same key material that you imported into the
65
- * primary key. For details, see <a href="kms/latest/developerguide/multi-region-keys-import.html">Importing key material into multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
65
+ * primary key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-import.html">Importing key material into multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
66
66
  * <p>To convert a replica key to a primary key, use the <a>UpdatePrimaryRegion</a>
67
67
  * operation.</p>
68
68
  * <note>
@@ -106,6 +106,9 @@ export interface ReplicateKeyCommandOutput extends ReplicateKeyResponse, __Metad
106
106
  * </p>
107
107
  * </li>
108
108
  * </ul>
109
+ * <p>
110
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
111
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
109
112
  * @example
110
113
  * Use a bare-bones client and the command you need to make an API call.
111
114
  * ```javascript
@@ -41,7 +41,7 @@ export interface RetireGrantCommandOutput extends __MetadataBearer {
41
41
  * <b>Cross-account use</b>: Yes. You can retire a grant on a KMS
42
42
  * key in a different Amazon Web Services account.</p>
43
43
  * <p>
44
- * <b>Required permissions:</b>:Permission to retire a grant is
44
+ * <b>Required permissions</b>: Permission to retire a grant is
45
45
  * determined primarily by the grant. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete">Retiring and revoking grants</a> in
46
46
  * the <i>Key Management Service Developer Guide</i>.</p>
47
47
  * <p>
@@ -69,6 +69,9 @@ export interface RetireGrantCommandOutput extends __MetadataBearer {
69
69
  * </p>
70
70
  * </li>
71
71
  * </ul>
72
+ * <p>
73
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
74
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
72
75
  * @example
73
76
  * Use a bare-bones client and the command you need to make an API call.
74
77
  * ```javascript
@@ -98,9 +101,7 @@ export interface RetireGrantCommandOutput extends __MetadataBearer {
98
101
  * request.</p>
99
102
  *
100
103
  * @throws {@link DryRunOperationException} (client fault)
101
- * <p>
102
- * The request was rejected because the DryRun parameter was specified.
103
- * </p>
104
+ * <p> The request was rejected because the DryRun parameter was specified. </p>
104
105
  *
105
106
  * @throws {@link InvalidArnException} (client fault)
106
107
  * <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
@@ -67,6 +67,9 @@ export interface RevokeGrantCommandOutput extends __MetadataBearer {
67
67
  * </p>
68
68
  * </li>
69
69
  * </ul>
70
+ * <p>
71
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
72
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
70
73
  * @example
71
74
  * Use a bare-bones client and the command you need to make an API call.
72
75
  * ```javascript
@@ -95,9 +98,7 @@ export interface RevokeGrantCommandOutput extends __MetadataBearer {
95
98
  * request.</p>
96
99
  *
97
100
  * @throws {@link DryRunOperationException} (client fault)
98
- * <p>
99
- * The request was rejected because the DryRun parameter was specified.
100
- * </p>
101
+ * <p> The request was rejected because the DryRun parameter was specified. </p>
101
102
  *
102
103
  * @throws {@link InvalidArnException} (client fault)
103
104
  * <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
@@ -34,8 +34,7 @@ export interface ScheduleKeyDeletionCommandOutput extends ScheduleKeyDeletionRes
34
34
  * <important>
35
35
  * <p>Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS key
36
36
  * is deleted, all data that was encrypted under the KMS key is unrecoverable. (The only
37
- * exception is a <a href="kms/latest/developerguide/multi-region-keys-delete.html">multi-Region replica
38
- * key</a>, or an <a href="kms/latest/developerguide/importing-keys-managing.html#import-delete-key">asymmetric or HMAC KMS
37
+ * exception is a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html">multi-Region replica key</a>, or an <a href="kms/latest/developerguide/importing-keys-managing.html#import-delete-key">asymmetric or HMAC KMS
39
38
  * key with imported key material</a>.) To prevent the use of a KMS key without deleting
40
39
  * it, use <a>DisableKey</a>. </p>
41
40
  * </important>
@@ -81,6 +80,9 @@ export interface ScheduleKeyDeletionCommandOutput extends ScheduleKeyDeletionRes
81
80
  * </p>
82
81
  * </li>
83
82
  * </ul>
83
+ * <p>
84
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
85
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
84
86
  * @example
85
87
  * Use a bare-bones client and the command you need to make an API call.
86
88
  * ```javascript
@@ -75,6 +75,9 @@ export interface SignCommandOutput extends SignResponse, __MetadataBearer {
75
75
  * <p>
76
76
  * <b>Related operations</b>: <a>Verify</a>
77
77
  * </p>
78
+ * <p>
79
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
80
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
78
81
  * @example
79
82
  * Use a bare-bones client and the command you need to make an API call.
80
83
  * ```javascript
@@ -115,9 +118,7 @@ export interface SignCommandOutput extends SignResponse, __MetadataBearer {
115
118
  * <p>The request was rejected because the specified KMS key is not enabled.</p>
116
119
  *
117
120
  * @throws {@link DryRunOperationException} (client fault)
118
- * <p>
119
- * The request was rejected because the DryRun parameter was specified.
120
- * </p>
121
+ * <p> The request was rejected because the DryRun parameter was specified. </p>
121
122
  *
122
123
  * @throws {@link InvalidGrantTokenException} (client fault)
123
124
  * <p>The request was rejected because the specified grant token is not valid.</p>
@@ -70,6 +70,9 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
70
70
  * </p>
71
71
  * </li>
72
72
  * </ul>
73
+ * <p>
74
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
75
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
73
76
  * @example
74
77
  * Use a bare-bones client and the command you need to make an API call.
75
78
  * ```javascript
@@ -65,6 +65,9 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
65
65
  * </p>
66
66
  * </li>
67
67
  * </ul>
68
+ * <p>
69
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
70
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
68
71
  * @example
69
72
  * Use a bare-bones client and the command you need to make an API call.
70
73
  * ```javascript
@@ -86,6 +86,9 @@ export interface UpdateAliasCommandOutput extends __MetadataBearer {
86
86
  * </p>
87
87
  * </li>
88
88
  * </ul>
89
+ * <p>
90
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
91
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
89
92
  * @example
90
93
  * Use a bare-bones client and the command you need to make an API call.
91
94
  * ```javascript
@@ -116,6 +116,9 @@ export interface UpdateCustomKeyStoreCommandOutput extends UpdateCustomKeyStoreR
116
116
  * </p>
117
117
  * </li>
118
118
  * </ul>
119
+ * <p>
120
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
121
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
119
122
  * @example
120
123
  * Use a bare-bones client and the command you need to make an API call.
121
124
  * ```javascript
@@ -295,8 +298,7 @@ export interface UpdateCustomKeyStoreCommandOutput extends UpdateCustomKeyStoreR
295
298
  * @throws {@link XksProxyVpcEndpointServiceInvalidConfigurationException} (client fault)
296
299
  * <p>The request was rejected because the Amazon VPC endpoint service configuration does not fulfill
297
300
  * the requirements for an external key store proxy. For details, see the exception message and
298
- * <a href="kms/latest/developerguide/vpc-connectivity.html#xks-vpc-requirements">review the
299
- * requirements</a> for Amazon VPC endpoint service connectivity for an external key
301
+ * <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
300
302
  * store.</p>
301
303
  *
302
304
  * @throws {@link XksProxyVpcEndpointServiceNotFoundException} (client fault)
@@ -45,6 +45,9 @@ export interface UpdateKeyDescriptionCommandOutput extends __MetadataBearer {
45
45
  * </p>
46
46
  * </li>
47
47
  * </ul>
48
+ * <p>
49
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
50
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
48
51
  * @example
49
52
  * Use a bare-bones client and the command you need to make an API call.
50
53
  * ```javascript
@@ -88,6 +88,9 @@ export interface UpdatePrimaryRegionCommandOutput extends __MetadataBearer {
88
88
  * </p>
89
89
  * </li>
90
90
  * </ul>
91
+ * <p>
92
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
93
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
91
94
  * @example
92
95
  * Use a bare-bones client and the command you need to make an API call.
93
96
  * ```javascript
@@ -58,6 +58,9 @@ export interface VerifyCommandOutput extends VerifyResponse, __MetadataBearer {
58
58
  * <p>
59
59
  * <b>Related operations</b>: <a>Sign</a>
60
60
  * </p>
61
+ * <p>
62
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
63
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
61
64
  * @example
62
65
  * Use a bare-bones client and the command you need to make an API call.
63
66
  * ```javascript
@@ -99,9 +102,7 @@ export interface VerifyCommandOutput extends VerifyResponse, __MetadataBearer {
99
102
  * <p>The request was rejected because the specified KMS key is not enabled.</p>
100
103
  *
101
104
  * @throws {@link DryRunOperationException} (client fault)
102
- * <p>
103
- * The request was rejected because the DryRun parameter was specified.
104
- * </p>
105
+ * <p> The request was rejected because the DryRun parameter was specified. </p>
105
106
  *
106
107
  * @throws {@link InvalidGrantTokenException} (client fault)
107
108
  * <p>The request was rejected because the specified grant token is not valid.</p>
@@ -44,6 +44,9 @@ export interface VerifyMacCommandOutput extends VerifyMacResponse, __MetadataBea
44
44
  * <p>
45
45
  * <b>Related operations</b>: <a>GenerateMac</a>
46
46
  * </p>
47
+ * <p>
48
+ * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
49
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
47
50
  * @example
48
51
  * Use a bare-bones client and the command you need to make an API call.
49
52
  * ```javascript
@@ -80,9 +83,7 @@ export interface VerifyMacCommandOutput extends VerifyMacResponse, __MetadataBea
80
83
  * <p>The request was rejected because the specified KMS key is not enabled.</p>
81
84
  *
82
85
  * @throws {@link DryRunOperationException} (client fault)
83
- * <p>
84
- * The request was rejected because the DryRun parameter was specified.
85
- * </p>
86
+ * <p> The request was rejected because the DryRun parameter was specified. </p>
86
87
  *
87
88
  * @throws {@link InvalidGrantTokenException} (client fault)
88
89
  * <p>The request was rejected because the specified grant token is not valid.</p>
@@ -831,8 +831,7 @@ export declare class XksProxyVpcEndpointServiceInUseException extends __BaseExce
831
831
  * @public
832
832
  * <p>The request was rejected because the Amazon VPC endpoint service configuration does not fulfill
833
833
  * the requirements for an external key store proxy. For details, see the exception message and
834
- * <a href="kms/latest/developerguide/vpc-connectivity.html#xks-vpc-requirements">review the
835
- * requirements</a> for Amazon VPC endpoint service connectivity for an external key
834
+ * <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
836
835
  * store.</p>
837
836
  */
838
837
  export declare class XksProxyVpcEndpointServiceInvalidConfigurationException extends __BaseException {
@@ -1079,9 +1078,7 @@ export declare class DisabledException extends __BaseException {
1079
1078
  }
1080
1079
  /**
1081
1080
  * @public
1082
- * <p>
1083
- * The request was rejected because the DryRun parameter was specified.
1084
- * </p>
1081
+ * <p> The request was rejected because the DryRun parameter was specified. </p>
1085
1082
  */
1086
1083
  export declare class DryRunOperationException extends __BaseException {
1087
1084
  readonly name: "DryRunOperationException";
@@ -1444,7 +1441,8 @@ export interface CreateKeyRequest {
1444
1441
  * <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key">Default key policy</a> in the <i>Key Management Service Developer Guide</i>.</p>
1445
1442
  * </important>
1446
1443
  * <p>Use this parameter only when you intend to prevent the principal that is making the
1447
- * request from making a subsequent <a>PutKeyPolicy</a> request on the KMS key.</p>
1444
+ * request from making a subsequent <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html">PutKeyPolicy</a>
1445
+ * request on the KMS key.</p>
1448
1446
  */
1449
1447
  BypassPolicyLockoutSafetyCheck?: boolean;
1450
1448
  /**
@@ -2424,9 +2422,9 @@ export interface DecryptRequest {
2424
2422
  EncryptionAlgorithm?: EncryptionAlgorithmSpec;
2425
2423
  /**
2426
2424
  * @public
2427
- * <p>A signed <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc">attestation document</a> from
2428
- * an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The
2429
- * only valid encryption algorithm is <code>RSAES_OAEP_SHA_256</code>. </p>
2425
+ * <p>A signed <a href="https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-concepts.html#term-attestdoc">attestation
2426
+ * document</a> from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the
2427
+ * enclave's public key. The only valid encryption algorithm is <code>RSAES_OAEP_SHA_256</code>. </p>
2430
2428
  * <p>This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this
2431
2429
  * parameter, use 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.</p>
2432
2430
  * <p>When you use this parameter, instead of returning the plaintext data, KMS encrypts the
@@ -3637,8 +3635,8 @@ export interface GetParametersForImportRequest {
3637
3635
  * </li>
3638
3636
  * <li>
3639
3637
  * <p>
3640
- * <b>RSAES_PKCS1_V1_5</b> (Deprecated) — Supported only
3641
- * for symmetric encryption key material (and only in legacy mode).</p>
3638
+ * <b>RSAES_PKCS1_V1_5</b> (Deprecated) — As of October
3639
+ * 10, 2023, KMS does not support the RSAES_PKCS1_V1_5 wrapping algorithm.</p>
3642
3640
  * </li>
3643
3641
  * </ul>
3644
3642
  */
@@ -4433,7 +4431,8 @@ export interface PutKeyPolicyRequest {
4433
4431
  * <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key">Default key policy</a> in the <i>Key Management Service Developer Guide</i>.</p>
4434
4432
  * </important>
4435
4433
  * <p>Use this parameter only when you intend to prevent the principal that is making the
4436
- * request from making a subsequent <a>PutKeyPolicy</a> request on the KMS key.</p>
4434
+ * request from making a subsequent <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html">PutKeyPolicy</a>
4435
+ * request on the KMS key.</p>
4437
4436
  */
4438
4437
  BypassPolicyLockoutSafetyCheck?: boolean;
4439
4438
  }
@@ -4698,7 +4697,8 @@ export interface ReplicateKeyRequest {
4698
4697
  * <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key">Default key policy</a> in the <i>Key Management Service Developer Guide</i>.</p>
4699
4698
  * </important>
4700
4699
  * <p>Use this parameter only when you intend to prevent the principal that is making the
4701
- * request from making a subsequent <a>PutKeyPolicy</a> request on the KMS key.</p>
4700
+ * request from making a subsequent <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html">PutKeyPolicy</a>
4701
+ * request on the KMS key.</p>
4702
4702
  */
4703
4703
  BypassPolicyLockoutSafetyCheck?: boolean;
4704
4704
  /**
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.474.0",
4
+ "version": "3.476.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,9 +20,9 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.474.0",
24
- "@aws-sdk/core": "3.474.0",
25
- "@aws-sdk/credential-provider-node": "3.474.0",
23
+ "@aws-sdk/client-sts": "3.476.0",
24
+ "@aws-sdk/core": "3.476.0",
25
+ "@aws-sdk/credential-provider-node": "3.476.0",
26
26
  "@aws-sdk/middleware-host-header": "3.468.0",
27
27
  "@aws-sdk/middleware-logger": "3.468.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.468.0",