@aws-sdk/client-kms 3.289.0 → 3.290.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 (51) hide show
  1. package/dist-types/commands/CancelKeyDeletionCommand.d.ts +35 -0
  2. package/dist-types/commands/ConnectCustomKeyStoreCommand.d.ts +85 -0
  3. package/dist-types/commands/CreateAliasCommand.d.ts +42 -0
  4. package/dist-types/commands/CreateCustomKeyStoreCommand.d.ts +125 -0
  5. package/dist-types/commands/CreateGrantCommand.d.ts +45 -0
  6. package/dist-types/commands/CreateKeyCommand.d.ts +122 -0
  7. package/dist-types/commands/DecryptCommand.d.ts +76 -0
  8. package/dist-types/commands/DeleteAliasCommand.d.ts +31 -0
  9. package/dist-types/commands/DeleteCustomKeyStoreCommand.d.ts +51 -0
  10. package/dist-types/commands/DeleteImportedKeyMaterialCommand.d.ts +39 -0
  11. package/dist-types/commands/DescribeCustomKeyStoresCommand.d.ts +13 -0
  12. package/dist-types/commands/DescribeKeyCommand.d.ts +17 -0
  13. package/dist-types/commands/DisableKeyCommand.d.ts +35 -0
  14. package/dist-types/commands/DisableKeyRotationCommand.d.ts +42 -0
  15. package/dist-types/commands/DisconnectCustomKeyStoreCommand.d.ts +45 -0
  16. package/dist-types/commands/EnableKeyCommand.d.ts +39 -0
  17. package/dist-types/commands/EnableKeyRotationCommand.d.ts +42 -0
  18. package/dist-types/commands/EncryptCommand.d.ts +62 -0
  19. package/dist-types/commands/GenerateDataKeyCommand.d.ts +62 -0
  20. package/dist-types/commands/GenerateDataKeyPairCommand.d.ts +66 -0
  21. package/dist-types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +66 -0
  22. package/dist-types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +62 -0
  23. package/dist-types/commands/GenerateMacCommand.d.ts +58 -0
  24. package/dist-types/commands/GenerateRandomCommand.d.ts +53 -0
  25. package/dist-types/commands/GetKeyPolicyCommand.d.ts +35 -0
  26. package/dist-types/commands/GetKeyRotationStatusCommand.d.ts +39 -0
  27. package/dist-types/commands/GetParametersForImportCommand.d.ts +39 -0
  28. package/dist-types/commands/GetPublicKeyCommand.d.ts +70 -0
  29. package/dist-types/commands/ImportKeyMaterialCommand.d.ts +59 -0
  30. package/dist-types/commands/ListAliasesCommand.d.ts +21 -0
  31. package/dist-types/commands/ListGrantsCommand.d.ts +42 -0
  32. package/dist-types/commands/ListKeyPoliciesCommand.d.ts +35 -0
  33. package/dist-types/commands/ListKeysCommand.d.ts +13 -0
  34. package/dist-types/commands/ListResourceTagsCommand.d.ts +17 -0
  35. package/dist-types/commands/ListRetirableGrantsCommand.d.ts +21 -0
  36. package/dist-types/commands/PutKeyPolicyCommand.d.ts +47 -0
  37. package/dist-types/commands/ReEncryptCommand.d.ts +76 -0
  38. package/dist-types/commands/ReplicateKeyCommand.d.ts +53 -0
  39. package/dist-types/commands/RetireGrantCommand.d.ts +41 -0
  40. package/dist-types/commands/RevokeGrantCommand.d.ts +38 -0
  41. package/dist-types/commands/ScheduleKeyDeletionCommand.d.ts +35 -0
  42. package/dist-types/commands/SignCommand.d.ts +62 -0
  43. package/dist-types/commands/TagResourceCommand.d.ts +38 -0
  44. package/dist-types/commands/UntagResourceCommand.d.ts +34 -0
  45. package/dist-types/commands/UpdateAliasCommand.d.ts +35 -0
  46. package/dist-types/commands/UpdateCustomKeyStoreCommand.d.ts +157 -0
  47. package/dist-types/commands/UpdateKeyDescriptionCommand.d.ts +35 -0
  48. package/dist-types/commands/UpdatePrimaryRegionCommand.d.ts +38 -0
  49. package/dist-types/commands/VerifyCommand.d.ts +67 -0
  50. package/dist-types/commands/VerifyMacCommand.d.ts +63 -0
  51. package/package.json +29 -29
@@ -121,6 +121,163 @@ export interface UpdateCustomKeyStoreCommandOutput extends UpdateCustomKeyStoreR
121
121
  * @see {@link UpdateCustomKeyStoreCommandOutput} for command's `response` shape.
122
122
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
123
123
  *
124
+ * @throws {@link CloudHsmClusterInvalidConfigurationException} (client fault)
125
+ * <p>The request was rejected because the associated CloudHSM cluster did not meet the
126
+ * configuration requirements for an CloudHSM key store.</p>
127
+ * <ul>
128
+ * <li>
129
+ * <p>The CloudHSM cluster must be configured with private subnets in at least two different
130
+ * Availability Zones in the Region.</p>
131
+ * </li>
132
+ * <li>
133
+ * <p>The <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html">security group for
134
+ * the cluster</a> (cloudhsm-cluster-<i><cluster-id></i>-sg) must
135
+ * include inbound rules and outbound rules that allow TCP traffic on ports 2223-2225. The
136
+ * <b>Source</b> in the inbound rules and the <b>Destination</b> in the outbound rules must match the security group
137
+ * ID. These rules are set by default when you create the CloudHSM cluster. Do not delete or
138
+ * change them. To get information about a particular security group, use the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSecurityGroups.html">DescribeSecurityGroups</a> operation.</p>
139
+ * </li>
140
+ * <li>
141
+ * <p>The CloudHSM cluster must contain at least as many HSMs as the operation requires. To add
142
+ * HSMs, use the CloudHSM <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html">CreateHsm</a> operation.</p>
143
+ * <p>For the <a>CreateCustomKeyStore</a>, <a>UpdateCustomKeyStore</a>, and <a>CreateKey</a> operations, the CloudHSM cluster must have at least two
144
+ * active HSMs, each in a different Availability Zone. For the <a>ConnectCustomKeyStore</a> operation, the CloudHSM must contain at least one active
145
+ * HSM.</p>
146
+ * </li>
147
+ * </ul>
148
+ * <p>For information about the requirements for an CloudHSM cluster that is associated with an
149
+ * CloudHSM key store, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore">Assemble the Prerequisites</a>
150
+ * in the <i>Key Management Service Developer Guide</i>. For information about creating a private subnet for an CloudHSM cluster,
151
+ * see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/create-subnets.html">Create a Private
152
+ * Subnet</a> in the <i>CloudHSM User Guide</i>. For information about cluster security groups, see
153
+ * <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html">Configure a Default Security
154
+ * Group</a> in the <i>
155
+ * <i>CloudHSM User Guide</i>
156
+ * </i>. </p>
157
+ *
158
+ * @throws {@link CloudHsmClusterNotActiveException} (client fault)
159
+ * <p>The request was rejected because the CloudHSM cluster associated with the CloudHSM key store is
160
+ * not active. Initialize and activate the cluster and try the command again. For detailed
161
+ * instructions, see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/getting-started.html">Getting
162
+ * Started</a> in the <i>CloudHSM User Guide</i>.</p>
163
+ *
164
+ * @throws {@link CloudHsmClusterNotFoundException} (client fault)
165
+ * <p>The request was rejected because KMS cannot find the CloudHSM cluster with the specified
166
+ * cluster ID. Retry the request with a different cluster ID.</p>
167
+ *
168
+ * @throws {@link CloudHsmClusterNotRelatedException} (client fault)
169
+ * <p>The request was rejected because the specified CloudHSM cluster has a different cluster
170
+ * certificate than the original cluster. You cannot use the operation to specify an unrelated
171
+ * cluster for an CloudHSM key store.</p>
172
+ * <p>Specify an CloudHSM cluster that shares a backup history with the original cluster. This
173
+ * includes clusters that were created from a backup of the current cluster, and clusters that
174
+ * were created from the same backup that produced the current cluster.</p>
175
+ * <p>CloudHSM clusters that share a backup history have the same cluster certificate. To view the
176
+ * cluster certificate of an CloudHSM cluster, use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html">DescribeClusters</a> operation.</p>
177
+ *
178
+ * @throws {@link CustomKeyStoreInvalidStateException} (client fault)
179
+ * <p>The request was rejected because of the <code>ConnectionState</code> of the custom key
180
+ * store. To get the <code>ConnectionState</code> of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p>
181
+ * <p>This exception is thrown under the following conditions:</p>
182
+ * <ul>
183
+ * <li>
184
+ * <p>You requested the <a>ConnectCustomKeyStore</a> operation on a custom key
185
+ * store with a <code>ConnectionState</code> of <code>DISCONNECTING</code> or
186
+ * <code>FAILED</code>. This operation is valid for all other <code>ConnectionState</code>
187
+ * values. To reconnect a custom key store in a <code>FAILED</code> state, disconnect it
188
+ * (<a>DisconnectCustomKeyStore</a>), then connect it
189
+ * (<code>ConnectCustomKeyStore</code>).</p>
190
+ * </li>
191
+ * <li>
192
+ * <p>You requested the <a>CreateKey</a> operation in a custom key store that is
193
+ * not connected. This operations is valid only when the custom key store
194
+ * <code>ConnectionState</code> is <code>CONNECTED</code>.</p>
195
+ * </li>
196
+ * <li>
197
+ * <p>You requested the <a>DisconnectCustomKeyStore</a> operation on a custom key
198
+ * store with a <code>ConnectionState</code> of <code>DISCONNECTING</code> or
199
+ * <code>DISCONNECTED</code>. This operation is valid for all other
200
+ * <code>ConnectionState</code> values.</p>
201
+ * </li>
202
+ * <li>
203
+ * <p>You requested the <a>UpdateCustomKeyStore</a> or <a>DeleteCustomKeyStore</a> operation on a custom key store that is not
204
+ * disconnected. This operation is valid only when the custom key store
205
+ * <code>ConnectionState</code> is <code>DISCONNECTED</code>.</p>
206
+ * </li>
207
+ * <li>
208
+ * <p>You requested the <a>GenerateRandom</a> operation in an CloudHSM key store
209
+ * that is not connected. This operation is valid only when the CloudHSM key store
210
+ * <code>ConnectionState</code> is <code>CONNECTED</code>. </p>
211
+ * </li>
212
+ * </ul>
213
+ *
214
+ * @throws {@link CustomKeyStoreNameInUseException} (client fault)
215
+ * <p>The request was rejected because the specified custom key store name is already assigned
216
+ * to another custom key store in the account. Try again with a custom key store name that is
217
+ * unique in the account.</p>
218
+ *
219
+ * @throws {@link CustomKeyStoreNotFoundException} (client fault)
220
+ * <p>The request was rejected because KMS cannot find a custom key store with the specified
221
+ * key store name or ID.</p>
222
+ *
223
+ * @throws {@link KMSInternalException} (server fault)
224
+ * <p>The request was rejected because an internal exception occurred. The request can be
225
+ * retried.</p>
226
+ *
227
+ * @throws {@link XksProxyIncorrectAuthenticationCredentialException} (client fault)
228
+ * <p>The request was rejected because the proxy credentials failed to authenticate to the
229
+ * specified external key store proxy. The specified external key store proxy rejected a status
230
+ * request from KMS due to invalid credentials. This can indicate an error in the credentials
231
+ * or in the identification of the external key store proxy.</p>
232
+ *
233
+ * @throws {@link XksProxyInvalidConfigurationException} (client fault)
234
+ * <p>The request was rejected because the Amazon VPC endpoint service configuration does not fulfill
235
+ * the requirements for an external key store proxy. For details, see the exception
236
+ * message.</p>
237
+ *
238
+ * @throws {@link XksProxyInvalidResponseException} (client fault)
239
+ * <p></p>
240
+ * <p>KMS cannot interpret the response it received from the external key store proxy. The
241
+ * problem might be a poorly constructed response, but it could also be a transient network
242
+ * issue. If you see this error repeatedly, report it to the proxy vendor.</p>
243
+ *
244
+ * @throws {@link XksProxyUriEndpointInUseException} (client fault)
245
+ * <p>The request was rejected because the concatenation of the <code>XksProxyUriEndpoint</code>
246
+ * is already associated with an external key store in the Amazon Web Services account and Region. Each
247
+ * external key store in an account and Region must use a unique external key store proxy
248
+ * address.</p>
249
+ *
250
+ * @throws {@link XksProxyUriInUseException} (client fault)
251
+ * <p>The request was rejected because the concatenation of the <code>XksProxyUriEndpoint</code>
252
+ * and <code>XksProxyUriPath</code> is already associated with an external key store in the
253
+ * Amazon Web Services account and Region. Each external key store in an account and Region must use a unique
254
+ * external key store proxy API address.</p>
255
+ *
256
+ * @throws {@link XksProxyUriUnreachableException} (client fault)
257
+ * <p>KMS was unable to reach the specified <code>XksProxyUriPath</code>. The path must be
258
+ * reachable before you create the external key store or update its settings.</p>
259
+ * <p>This exception is also thrown when the external key store proxy response to a <code>GetHealthStatus</code>
260
+ * request indicates that all external key manager instances are unavailable.</p>
261
+ *
262
+ * @throws {@link XksProxyVpcEndpointServiceInUseException} (client fault)
263
+ * <p>The request was rejected because the specified Amazon VPC endpoint service is already
264
+ * associated with an external key store in the Amazon Web Services account and Region. Each external key store
265
+ * in an Amazon Web Services account and Region must use a different Amazon VPC endpoint service.</p>
266
+ *
267
+ * @throws {@link XksProxyVpcEndpointServiceInvalidConfigurationException} (client fault)
268
+ * <p>The request was rejected because the Amazon VPC endpoint service configuration does not fulfill
269
+ * the requirements for an external key store proxy. For details, see the exception message and
270
+ * <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
271
+ * store.</p>
272
+ *
273
+ * @throws {@link XksProxyVpcEndpointServiceNotFoundException} (client fault)
274
+ * <p>The request was rejected because KMS could not find the specified VPC endpoint service.
275
+ * Use <a>DescribeCustomKeyStores</a> to verify the VPC endpoint service name for the
276
+ * external key store. Also, confirm that the <code>Allow principals</code> list for the VPC
277
+ * endpoint service includes the KMS service principal for the Region, such as
278
+ * <code>cks.kms.us-east-1.amazonaws.com</code>.</p>
279
+ *
280
+ *
124
281
  * @example To edit the friendly name of a custom key store
125
282
  * ```javascript
126
283
  * // This example changes the friendly name of the AWS KMS custom key store to the name that you specify. This operation does not return any data. To verify that the operation worked, use the DescribeCustomKeyStores operation.
@@ -50,6 +50,41 @@ export interface UpdateKeyDescriptionCommandOutput extends __MetadataBearer {
50
50
  * @see {@link UpdateKeyDescriptionCommandOutput} for command's `response` shape.
51
51
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
52
52
  *
53
+ * @throws {@link DependencyTimeoutException} (server fault)
54
+ * <p>The system timed out while trying to fulfill the request. You can retry the
55
+ * request.</p>
56
+ *
57
+ * @throws {@link InvalidArnException} (client fault)
58
+ * <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
59
+ * valid.</p>
60
+ *
61
+ * @throws {@link KMSInternalException} (server fault)
62
+ * <p>The request was rejected because an internal exception occurred. The request can be
63
+ * retried.</p>
64
+ *
65
+ * @throws {@link KMSInvalidStateException} (client fault)
66
+ * <p>The request was rejected because the state of the specified resource is not valid for this
67
+ * request.</p>
68
+ * <p>This exceptions means one of the following:</p>
69
+ * <ul>
70
+ * <li>
71
+ * <p>The key state of the KMS key is not compatible with the operation. </p>
72
+ * <p>To find the key state, use the <a>DescribeKey</a> operation. For more
73
+ * information about which key states are compatible with each KMS operation, see
74
+ * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>
75
+ * <i>Key Management Service Developer Guide</i>
76
+ * </i>.</p>
77
+ * </li>
78
+ * <li>
79
+ * <p>For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.</p>
80
+ * </li>
81
+ * </ul>
82
+ *
83
+ * @throws {@link NotFoundException} (client fault)
84
+ * <p>The request was rejected because the specified entity or resource could not be
85
+ * found.</p>
86
+ *
87
+ *
53
88
  * @example To update the description of a KMS key
54
89
  * ```javascript
55
90
  * // The following example updates the description of the specified KMS key.
@@ -93,6 +93,44 @@ export interface UpdatePrimaryRegionCommandOutput extends __MetadataBearer {
93
93
  * @see {@link UpdatePrimaryRegionCommandOutput} for command's `response` shape.
94
94
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
95
95
  *
96
+ * @throws {@link DisabledException} (client fault)
97
+ * <p>The request was rejected because the specified KMS key is not enabled.</p>
98
+ *
99
+ * @throws {@link InvalidArnException} (client fault)
100
+ * <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
101
+ * valid.</p>
102
+ *
103
+ * @throws {@link KMSInternalException} (server fault)
104
+ * <p>The request was rejected because an internal exception occurred. The request can be
105
+ * retried.</p>
106
+ *
107
+ * @throws {@link KMSInvalidStateException} (client fault)
108
+ * <p>The request was rejected because the state of the specified resource is not valid for this
109
+ * request.</p>
110
+ * <p>This exceptions means one of the following:</p>
111
+ * <ul>
112
+ * <li>
113
+ * <p>The key state of the KMS key is not compatible with the operation. </p>
114
+ * <p>To find the key state, use the <a>DescribeKey</a> operation. For more
115
+ * information about which key states are compatible with each KMS operation, see
116
+ * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>
117
+ * <i>Key Management Service Developer Guide</i>
118
+ * </i>.</p>
119
+ * </li>
120
+ * <li>
121
+ * <p>For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.</p>
122
+ * </li>
123
+ * </ul>
124
+ *
125
+ * @throws {@link NotFoundException} (client fault)
126
+ * <p>The request was rejected because the specified entity or resource could not be
127
+ * found.</p>
128
+ *
129
+ * @throws {@link UnsupportedOperationException} (client fault)
130
+ * <p>The request was rejected because a specified parameter is not supported or a specified
131
+ * resource is not valid for this operation.</p>
132
+ *
133
+ *
96
134
  * @example To update the primary Region of a multi-Region KMS key
97
135
  * ```javascript
98
136
  * // The following UpdatePrimaryRegion example changes the multi-Region replica key in the eu-central-1 Region to the primary key. The current primary key in the us-west-1 Region becomes a replica key.
@@ -64,6 +64,73 @@ export interface VerifyCommandOutput extends VerifyResponse, __MetadataBearer {
64
64
  * @see {@link VerifyCommandOutput} for command's `response` shape.
65
65
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
66
66
  *
67
+ * @throws {@link DependencyTimeoutException} (server fault)
68
+ * <p>The system timed out while trying to fulfill the request. You can retry the
69
+ * request.</p>
70
+ *
71
+ * @throws {@link DisabledException} (client fault)
72
+ * <p>The request was rejected because the specified KMS key is not enabled.</p>
73
+ *
74
+ * @throws {@link InvalidGrantTokenException} (client fault)
75
+ * <p>The request was rejected because the specified grant token is not valid.</p>
76
+ *
77
+ * @throws {@link InvalidKeyUsageException} (client fault)
78
+ * <p>The request was rejected for one of the following reasons: </p>
79
+ * <ul>
80
+ * <li>
81
+ * <p>The <code>KeyUsage</code> value of the KMS key is incompatible with the API
82
+ * operation.</p>
83
+ * </li>
84
+ * <li>
85
+ * <p>The encryption algorithm or signing algorithm specified for the operation is
86
+ * incompatible with the type of key material in the KMS key <code>(KeySpec</code>).</p>
87
+ * </li>
88
+ * </ul>
89
+ * <p>For encrypting, decrypting, re-encrypting, and generating data keys, the
90
+ * <code>KeyUsage</code> must be <code>ENCRYPT_DECRYPT</code>. For signing and verifying
91
+ * messages, the <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. For generating and
92
+ * verifying message authentication codes (MACs), the <code>KeyUsage</code> must be
93
+ * <code>GENERATE_VERIFY_MAC</code>. To find the <code>KeyUsage</code> of a KMS key, use the
94
+ * <a>DescribeKey</a> operation.</p>
95
+ * <p>To find the encryption or signing algorithms supported for a particular KMS key, use the
96
+ * <a>DescribeKey</a> operation.</p>
97
+ *
98
+ * @throws {@link KeyUnavailableException} (server fault)
99
+ * <p>The request was rejected because the specified KMS key was not available. You can retry
100
+ * the request.</p>
101
+ *
102
+ * @throws {@link KMSInternalException} (server fault)
103
+ * <p>The request was rejected because an internal exception occurred. The request can be
104
+ * retried.</p>
105
+ *
106
+ * @throws {@link KMSInvalidSignatureException} (client fault)
107
+ * <p>The request was rejected because the signature verification failed. Signature verification
108
+ * fails when it cannot confirm that signature was produced by signing the specified message with
109
+ * the specified KMS key and signing algorithm.</p>
110
+ *
111
+ * @throws {@link KMSInvalidStateException} (client fault)
112
+ * <p>The request was rejected because the state of the specified resource is not valid for this
113
+ * request.</p>
114
+ * <p>This exceptions means one of the following:</p>
115
+ * <ul>
116
+ * <li>
117
+ * <p>The key state of the KMS key is not compatible with the operation. </p>
118
+ * <p>To find the key state, use the <a>DescribeKey</a> operation. For more
119
+ * information about which key states are compatible with each KMS operation, see
120
+ * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>
121
+ * <i>Key Management Service Developer Guide</i>
122
+ * </i>.</p>
123
+ * </li>
124
+ * <li>
125
+ * <p>For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.</p>
126
+ * </li>
127
+ * </ul>
128
+ *
129
+ * @throws {@link NotFoundException} (client fault)
130
+ * <p>The request was rejected because the specified entity or resource could not be
131
+ * found.</p>
132
+ *
133
+ *
67
134
  * @example To use an asymmetric KMS key to verify a digital signature
68
135
  * ```javascript
69
136
  * // This operation uses the public key in an elliptic curve (ECC) asymmetric key to verify a digital signature within AWS KMS.
@@ -49,6 +49,69 @@ export interface VerifyMacCommandOutput extends VerifyMacResponse, __MetadataBea
49
49
  * @see {@link VerifyMacCommandOutput} for command's `response` shape.
50
50
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
51
51
  *
52
+ * @throws {@link DisabledException} (client fault)
53
+ * <p>The request was rejected because the specified KMS key is not enabled.</p>
54
+ *
55
+ * @throws {@link InvalidGrantTokenException} (client fault)
56
+ * <p>The request was rejected because the specified grant token is not valid.</p>
57
+ *
58
+ * @throws {@link InvalidKeyUsageException} (client fault)
59
+ * <p>The request was rejected for one of the following reasons: </p>
60
+ * <ul>
61
+ * <li>
62
+ * <p>The <code>KeyUsage</code> value of the KMS key is incompatible with the API
63
+ * operation.</p>
64
+ * </li>
65
+ * <li>
66
+ * <p>The encryption algorithm or signing algorithm specified for the operation is
67
+ * incompatible with the type of key material in the KMS key <code>(KeySpec</code>).</p>
68
+ * </li>
69
+ * </ul>
70
+ * <p>For encrypting, decrypting, re-encrypting, and generating data keys, the
71
+ * <code>KeyUsage</code> must be <code>ENCRYPT_DECRYPT</code>. For signing and verifying
72
+ * messages, the <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. For generating and
73
+ * verifying message authentication codes (MACs), the <code>KeyUsage</code> must be
74
+ * <code>GENERATE_VERIFY_MAC</code>. To find the <code>KeyUsage</code> of a KMS key, use the
75
+ * <a>DescribeKey</a> operation.</p>
76
+ * <p>To find the encryption or signing algorithms supported for a particular KMS key, use the
77
+ * <a>DescribeKey</a> operation.</p>
78
+ *
79
+ * @throws {@link KeyUnavailableException} (server fault)
80
+ * <p>The request was rejected because the specified KMS key was not available. You can retry
81
+ * the request.</p>
82
+ *
83
+ * @throws {@link KMSInternalException} (server fault)
84
+ * <p>The request was rejected because an internal exception occurred. The request can be
85
+ * retried.</p>
86
+ *
87
+ * @throws {@link KMSInvalidMacException} (client fault)
88
+ * <p>The request was rejected because the HMAC verification failed. HMAC verification fails
89
+ * when the HMAC computed by using the specified message, HMAC KMS key, and MAC algorithm does
90
+ * not match the HMAC specified in the request.</p>
91
+ *
92
+ * @throws {@link KMSInvalidStateException} (client fault)
93
+ * <p>The request was rejected because the state of the specified resource is not valid for this
94
+ * request.</p>
95
+ * <p>This exceptions means one of the following:</p>
96
+ * <ul>
97
+ * <li>
98
+ * <p>The key state of the KMS key is not compatible with the operation. </p>
99
+ * <p>To find the key state, use the <a>DescribeKey</a> operation. For more
100
+ * information about which key states are compatible with each KMS operation, see
101
+ * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>
102
+ * <i>Key Management Service Developer Guide</i>
103
+ * </i>.</p>
104
+ * </li>
105
+ * <li>
106
+ * <p>For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.</p>
107
+ * </li>
108
+ * </ul>
109
+ *
110
+ * @throws {@link NotFoundException} (client fault)
111
+ * <p>The request was rejected because the specified entity or resource could not be
112
+ * found.</p>
113
+ *
114
+ *
52
115
  * @example To verify an HMAC
53
116
  * ```javascript
54
117
  * // This example verifies an HMAC for a particular message, HMAC KMS keys, and MAC algorithm. A value of 'true' in the MacValid value in the response indicates that the HMAC is valid.
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.289.0",
4
+ "version": "3.290.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,37 +20,37 @@
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.289.0",
24
- "@aws-sdk/config-resolver": "3.289.0",
25
- "@aws-sdk/credential-provider-node": "3.289.0",
26
- "@aws-sdk/fetch-http-handler": "3.289.0",
27
- "@aws-sdk/hash-node": "3.289.0",
28
- "@aws-sdk/invalid-dependency": "3.289.0",
29
- "@aws-sdk/middleware-content-length": "3.289.0",
30
- "@aws-sdk/middleware-endpoint": "3.289.0",
31
- "@aws-sdk/middleware-host-header": "3.289.0",
32
- "@aws-sdk/middleware-logger": "3.289.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.289.0",
34
- "@aws-sdk/middleware-retry": "3.289.0",
35
- "@aws-sdk/middleware-serde": "3.289.0",
36
- "@aws-sdk/middleware-signing": "3.289.0",
37
- "@aws-sdk/middleware-stack": "3.289.0",
38
- "@aws-sdk/middleware-user-agent": "3.289.0",
39
- "@aws-sdk/node-config-provider": "3.289.0",
40
- "@aws-sdk/node-http-handler": "3.289.0",
41
- "@aws-sdk/protocol-http": "3.289.0",
42
- "@aws-sdk/smithy-client": "3.289.0",
43
- "@aws-sdk/types": "3.289.0",
44
- "@aws-sdk/url-parser": "3.289.0",
23
+ "@aws-sdk/client-sts": "3.290.0",
24
+ "@aws-sdk/config-resolver": "3.290.0",
25
+ "@aws-sdk/credential-provider-node": "3.290.0",
26
+ "@aws-sdk/fetch-http-handler": "3.290.0",
27
+ "@aws-sdk/hash-node": "3.290.0",
28
+ "@aws-sdk/invalid-dependency": "3.290.0",
29
+ "@aws-sdk/middleware-content-length": "3.290.0",
30
+ "@aws-sdk/middleware-endpoint": "3.290.0",
31
+ "@aws-sdk/middleware-host-header": "3.290.0",
32
+ "@aws-sdk/middleware-logger": "3.290.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.290.0",
34
+ "@aws-sdk/middleware-retry": "3.290.0",
35
+ "@aws-sdk/middleware-serde": "3.290.0",
36
+ "@aws-sdk/middleware-signing": "3.290.0",
37
+ "@aws-sdk/middleware-stack": "3.290.0",
38
+ "@aws-sdk/middleware-user-agent": "3.290.0",
39
+ "@aws-sdk/node-config-provider": "3.290.0",
40
+ "@aws-sdk/node-http-handler": "3.290.0",
41
+ "@aws-sdk/protocol-http": "3.290.0",
42
+ "@aws-sdk/smithy-client": "3.290.0",
43
+ "@aws-sdk/types": "3.290.0",
44
+ "@aws-sdk/url-parser": "3.290.0",
45
45
  "@aws-sdk/util-base64": "3.208.0",
46
46
  "@aws-sdk/util-body-length-browser": "3.188.0",
47
47
  "@aws-sdk/util-body-length-node": "3.208.0",
48
- "@aws-sdk/util-defaults-mode-browser": "3.289.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.289.0",
50
- "@aws-sdk/util-endpoints": "3.289.0",
51
- "@aws-sdk/util-retry": "3.289.0",
52
- "@aws-sdk/util-user-agent-browser": "3.289.0",
53
- "@aws-sdk/util-user-agent-node": "3.289.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.290.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.290.0",
50
+ "@aws-sdk/util-endpoints": "3.290.0",
51
+ "@aws-sdk/util-retry": "3.290.0",
52
+ "@aws-sdk/util-user-agent-browser": "3.290.0",
53
+ "@aws-sdk/util-user-agent-node": "3.290.0",
54
54
  "@aws-sdk/util-utf8": "3.254.0",
55
55
  "tslib": "^2.3.1"
56
56
  },