@aws-sdk/client-kms 3.324.0 → 3.326.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 +6 -0
  2. package/dist-types/commands/ConnectCustomKeyStoreCommand.d.ts +4 -0
  3. package/dist-types/commands/CreateAliasCommand.d.ts +4 -0
  4. package/dist-types/commands/CreateCustomKeyStoreCommand.d.ts +7 -1
  5. package/dist-types/commands/CreateGrantCommand.d.ts +7 -0
  6. package/dist-types/commands/CreateKeyCommand.d.ts +52 -1
  7. package/dist-types/commands/DecryptCommand.d.ts +98 -3
  8. package/dist-types/commands/DeleteAliasCommand.d.ts +4 -0
  9. package/dist-types/commands/DeleteCustomKeyStoreCommand.d.ts +4 -0
  10. package/dist-types/commands/DeleteImportedKeyMaterialCommand.d.ts +4 -0
  11. package/dist-types/commands/DescribeCustomKeyStoresCommand.d.ts +27 -1
  12. package/dist-types/commands/DescribeKeyCommand.d.ts +52 -1
  13. package/dist-types/commands/DisableKeyCommand.d.ts +4 -0
  14. package/dist-types/commands/DisableKeyRotationCommand.d.ts +4 -0
  15. package/dist-types/commands/DisconnectCustomKeyStoreCommand.d.ts +16 -1
  16. package/dist-types/commands/EnableKeyCommand.d.ts +4 -0
  17. package/dist-types/commands/EnableKeyRotationCommand.d.ts +4 -0
  18. package/dist-types/commands/EncryptCommand.d.ts +52 -3
  19. package/dist-types/commands/GenerateDataKeyCommand.d.ts +57 -1
  20. package/dist-types/commands/GenerateDataKeyPairCommand.d.ts +63 -1
  21. package/dist-types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +9 -0
  22. package/dist-types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +7 -0
  23. package/dist-types/commands/GenerateMacCommand.d.ts +8 -0
  24. package/dist-types/commands/GenerateRandomCommand.d.ts +49 -1
  25. package/dist-types/commands/GetKeyPolicyCommand.d.ts +6 -0
  26. package/dist-types/commands/GetKeyRotationStatusCommand.d.ts +6 -0
  27. package/dist-types/commands/GetParametersForImportCommand.d.ts +9 -0
  28. package/dist-types/commands/GetPublicKeyCommand.d.ts +16 -0
  29. package/dist-types/commands/ImportKeyMaterialCommand.d.ts +4 -0
  30. package/dist-types/commands/ListAliasesCommand.d.ts +16 -0
  31. package/dist-types/commands/ListGrantsCommand.d.ts +29 -0
  32. package/dist-types/commands/ListKeyPoliciesCommand.d.ts +10 -0
  33. package/dist-types/commands/ListKeysCommand.d.ts +13 -0
  34. package/dist-types/commands/ListResourceTagsCommand.d.ts +13 -0
  35. package/dist-types/commands/ListRetirableGrantsCommand.d.ts +29 -0
  36. package/dist-types/commands/PutKeyPolicyCommand.d.ts +4 -0
  37. package/dist-types/commands/ReEncryptCommand.d.ts +10 -0
  38. package/dist-types/commands/ReplicateKeyCommand.d.ts +58 -0
  39. package/dist-types/commands/RetireGrantCommand.d.ts +4 -0
  40. package/dist-types/commands/RevokeGrantCommand.d.ts +4 -0
  41. package/dist-types/commands/ScheduleKeyDeletionCommand.d.ts +9 -0
  42. package/dist-types/commands/SignCommand.d.ts +8 -0
  43. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  44. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  45. package/dist-types/commands/UpdateAliasCommand.d.ts +4 -0
  46. package/dist-types/commands/UpdateCustomKeyStoreCommand.d.ts +5 -1
  47. package/dist-types/commands/UpdateKeyDescriptionCommand.d.ts +4 -0
  48. package/dist-types/commands/UpdatePrimaryRegionCommand.d.ts +4 -0
  49. package/dist-types/commands/VerifyCommand.d.ts +8 -0
  50. package/dist-types/commands/VerifyMacCommand.d.ts +8 -0
  51. package/package.json +16 -16
@@ -75,6 +75,33 @@ export interface ListRetirableGrantsCommandOutput extends ListGrantsResponse, __
75
75
  * };
76
76
  * const command = new ListRetirableGrantsCommand(input);
77
77
  * const response = await client.send(command);
78
+ * // { // ListGrantsResponse
79
+ * // Grants: [ // GrantList
80
+ * // { // GrantListEntry
81
+ * // KeyId: "STRING_VALUE",
82
+ * // GrantId: "STRING_VALUE",
83
+ * // Name: "STRING_VALUE",
84
+ * // CreationDate: new Date("TIMESTAMP"),
85
+ * // GranteePrincipal: "STRING_VALUE",
86
+ * // RetiringPrincipal: "STRING_VALUE",
87
+ * // IssuingAccount: "STRING_VALUE",
88
+ * // Operations: [ // GrantOperationList
89
+ * // "Decrypt" || "Encrypt" || "GenerateDataKey" || "GenerateDataKeyWithoutPlaintext" || "ReEncryptFrom" || "ReEncryptTo" || "Sign" || "Verify" || "GetPublicKey" || "CreateGrant" || "RetireGrant" || "DescribeKey" || "GenerateDataKeyPair" || "GenerateDataKeyPairWithoutPlaintext" || "GenerateMac" || "VerifyMac",
90
+ * // ],
91
+ * // Constraints: { // GrantConstraints
92
+ * // EncryptionContextSubset: { // EncryptionContextType
93
+ * // "<keys>": "STRING_VALUE",
94
+ * // },
95
+ * // EncryptionContextEquals: {
96
+ * // "<keys>": "STRING_VALUE",
97
+ * // },
98
+ * // },
99
+ * // },
100
+ * // ],
101
+ * // NextMarker: "STRING_VALUE",
102
+ * // Truncated: true || false,
103
+ * // };
104
+ *
78
105
  * ```
79
106
  *
80
107
  * @param ListRetirableGrantsCommandInput - {@link ListRetirableGrantsCommandInput}
@@ -103,6 +130,8 @@ export interface ListRetirableGrantsCommandOutput extends ListGrantsResponse, __
103
130
  * <p>The request was rejected because the specified entity or resource could not be
104
131
  * found.</p>
105
132
  *
133
+ * @throws {@link KMSServiceException}
134
+ * <p>Base exception class for all service exceptions from KMS service.</p>
106
135
  *
107
136
  * @example To list grants that the specified principal can retire
108
137
  * ```javascript
@@ -46,6 +46,8 @@ export interface PutKeyPolicyCommandOutput extends __MetadataBearer {
46
46
  * };
47
47
  * const command = new PutKeyPolicyCommand(input);
48
48
  * const response = await client.send(command);
49
+ * // {};
50
+ *
49
51
  * ```
50
52
  *
51
53
  * @param PutKeyPolicyCommandInput - {@link PutKeyPolicyCommandInput}
@@ -100,6 +102,8 @@ export interface PutKeyPolicyCommandOutput extends __MetadataBearer {
100
102
  * <p>The request was rejected because a specified parameter is not supported or a specified
101
103
  * resource is not valid for this operation.</p>
102
104
  *
105
+ * @throws {@link KMSServiceException}
106
+ * <p>Base exception class for all service exceptions from KMS service.</p>
103
107
  *
104
108
  * @example To attach a key policy to a KMS key
105
109
  * ```javascript
@@ -138,6 +138,14 @@ export interface ReEncryptCommandOutput extends ReEncryptResponse, __MetadataBea
138
138
  * };
139
139
  * const command = new ReEncryptCommand(input);
140
140
  * const response = await client.send(command);
141
+ * // { // ReEncryptResponse
142
+ * // CiphertextBlob: "BLOB_VALUE",
143
+ * // SourceKeyId: "STRING_VALUE",
144
+ * // KeyId: "STRING_VALUE",
145
+ * // SourceEncryptionAlgorithm: "SYMMETRIC_DEFAULT" || "RSAES_OAEP_SHA_1" || "RSAES_OAEP_SHA_256" || "SM2PKE",
146
+ * // DestinationEncryptionAlgorithm: "SYMMETRIC_DEFAULT" || "RSAES_OAEP_SHA_1" || "RSAES_OAEP_SHA_256" || "SM2PKE",
147
+ * // };
148
+ *
141
149
  * ```
142
150
  *
143
151
  * @param ReEncryptCommandInput - {@link ReEncryptCommandInput}
@@ -221,6 +229,8 @@ export interface ReEncryptCommandOutput extends ReEncryptResponse, __MetadataBea
221
229
  * <p>The request was rejected because the specified entity or resource could not be
222
230
  * found.</p>
223
231
  *
232
+ * @throws {@link KMSServiceException}
233
+ * <p>Base exception class for all service exceptions from KMS service.</p>
224
234
  *
225
235
  * @example To reencrypt data
226
236
  * ```javascript
@@ -123,6 +123,62 @@ export interface ReplicateKeyCommandOutput extends ReplicateKeyResponse, __Metad
123
123
  * };
124
124
  * const command = new ReplicateKeyCommand(input);
125
125
  * const response = await client.send(command);
126
+ * // { // ReplicateKeyResponse
127
+ * // ReplicaKeyMetadata: { // KeyMetadata
128
+ * // AWSAccountId: "STRING_VALUE",
129
+ * // KeyId: "STRING_VALUE", // required
130
+ * // Arn: "STRING_VALUE",
131
+ * // CreationDate: new Date("TIMESTAMP"),
132
+ * // Enabled: true || false,
133
+ * // Description: "STRING_VALUE",
134
+ * // KeyUsage: "SIGN_VERIFY" || "ENCRYPT_DECRYPT" || "GENERATE_VERIFY_MAC",
135
+ * // KeyState: "Creating" || "Enabled" || "Disabled" || "PendingDeletion" || "PendingImport" || "PendingReplicaDeletion" || "Unavailable" || "Updating",
136
+ * // DeletionDate: new Date("TIMESTAMP"),
137
+ * // ValidTo: new Date("TIMESTAMP"),
138
+ * // Origin: "AWS_KMS" || "EXTERNAL" || "AWS_CLOUDHSM" || "EXTERNAL_KEY_STORE",
139
+ * // CustomKeyStoreId: "STRING_VALUE",
140
+ * // CloudHsmClusterId: "STRING_VALUE",
141
+ * // ExpirationModel: "KEY_MATERIAL_EXPIRES" || "KEY_MATERIAL_DOES_NOT_EXPIRE",
142
+ * // KeyManager: "AWS" || "CUSTOMER",
143
+ * // CustomerMasterKeySpec: "RSA_2048" || "RSA_3072" || "RSA_4096" || "ECC_NIST_P256" || "ECC_NIST_P384" || "ECC_NIST_P521" || "ECC_SECG_P256K1" || "SYMMETRIC_DEFAULT" || "HMAC_224" || "HMAC_256" || "HMAC_384" || "HMAC_512" || "SM2",
144
+ * // KeySpec: "RSA_2048" || "RSA_3072" || "RSA_4096" || "ECC_NIST_P256" || "ECC_NIST_P384" || "ECC_NIST_P521" || "ECC_SECG_P256K1" || "SYMMETRIC_DEFAULT" || "HMAC_224" || "HMAC_256" || "HMAC_384" || "HMAC_512" || "SM2",
145
+ * // EncryptionAlgorithms: [ // EncryptionAlgorithmSpecList
146
+ * // "SYMMETRIC_DEFAULT" || "RSAES_OAEP_SHA_1" || "RSAES_OAEP_SHA_256" || "SM2PKE",
147
+ * // ],
148
+ * // SigningAlgorithms: [ // SigningAlgorithmSpecList
149
+ * // "RSASSA_PSS_SHA_256" || "RSASSA_PSS_SHA_384" || "RSASSA_PSS_SHA_512" || "RSASSA_PKCS1_V1_5_SHA_256" || "RSASSA_PKCS1_V1_5_SHA_384" || "RSASSA_PKCS1_V1_5_SHA_512" || "ECDSA_SHA_256" || "ECDSA_SHA_384" || "ECDSA_SHA_512" || "SM2DSA",
150
+ * // ],
151
+ * // MultiRegion: true || false,
152
+ * // MultiRegionConfiguration: { // MultiRegionConfiguration
153
+ * // MultiRegionKeyType: "PRIMARY" || "REPLICA",
154
+ * // PrimaryKey: { // MultiRegionKey
155
+ * // Arn: "STRING_VALUE",
156
+ * // Region: "STRING_VALUE",
157
+ * // },
158
+ * // ReplicaKeys: [ // MultiRegionKeyList
159
+ * // {
160
+ * // Arn: "STRING_VALUE",
161
+ * // Region: "STRING_VALUE",
162
+ * // },
163
+ * // ],
164
+ * // },
165
+ * // PendingDeletionWindowInDays: Number("int"),
166
+ * // MacAlgorithms: [ // MacAlgorithmSpecList
167
+ * // "HMAC_SHA_224" || "HMAC_SHA_256" || "HMAC_SHA_384" || "HMAC_SHA_512",
168
+ * // ],
169
+ * // XksKeyConfiguration: { // XksKeyConfigurationType
170
+ * // Id: "STRING_VALUE",
171
+ * // },
172
+ * // },
173
+ * // ReplicaPolicy: "STRING_VALUE",
174
+ * // ReplicaTags: [ // TagList
175
+ * // { // Tag
176
+ * // TagKey: "STRING_VALUE", // required
177
+ * // TagValue: "STRING_VALUE", // required
178
+ * // },
179
+ * // ],
180
+ * // };
181
+ *
126
182
  * ```
127
183
  *
128
184
  * @param ReplicateKeyCommandInput - {@link ReplicateKeyCommandInput}
@@ -183,6 +239,8 @@ export interface ReplicateKeyCommandOutput extends ReplicateKeyResponse, __Metad
183
239
  * <p>The request was rejected because a specified parameter is not supported or a specified
184
240
  * resource is not valid for this operation.</p>
185
241
  *
242
+ * @throws {@link KMSServiceException}
243
+ * <p>Base exception class for all service exceptions from KMS service.</p>
186
244
  *
187
245
  * @example To replicate a multi-Region key in a different AWS Region
188
246
  * ```javascript
@@ -78,6 +78,8 @@ export interface RetireGrantCommandOutput extends __MetadataBearer {
78
78
  * };
79
79
  * const command = new RetireGrantCommand(input);
80
80
  * const response = await client.send(command);
81
+ * // {};
82
+ *
81
83
  * ```
82
84
  *
83
85
  * @param RetireGrantCommandInput - {@link RetireGrantCommandInput}
@@ -126,6 +128,8 @@ export interface RetireGrantCommandOutput extends __MetadataBearer {
126
128
  * <p>The request was rejected because the specified entity or resource could not be
127
129
  * found.</p>
128
130
  *
131
+ * @throws {@link KMSServiceException}
132
+ * <p>Base exception class for all service exceptions from KMS service.</p>
129
133
  *
130
134
  * @example To retire a grant
131
135
  * ```javascript
@@ -75,6 +75,8 @@ export interface RevokeGrantCommandOutput extends __MetadataBearer {
75
75
  * };
76
76
  * const command = new RevokeGrantCommand(input);
77
77
  * const response = await client.send(command);
78
+ * // {};
79
+ *
78
80
  * ```
79
81
  *
80
82
  * @param RevokeGrantCommandInput - {@link RevokeGrantCommandInput}
@@ -120,6 +122,8 @@ export interface RevokeGrantCommandOutput extends __MetadataBearer {
120
122
  * <p>The request was rejected because the specified entity or resource could not be
121
123
  * found.</p>
122
124
  *
125
+ * @throws {@link KMSServiceException}
126
+ * <p>Base exception class for all service exceptions from KMS service.</p>
123
127
  *
124
128
  * @example To revoke a grant
125
129
  * ```javascript
@@ -87,6 +87,13 @@ export interface ScheduleKeyDeletionCommandOutput extends ScheduleKeyDeletionRes
87
87
  * };
88
88
  * const command = new ScheduleKeyDeletionCommand(input);
89
89
  * const response = await client.send(command);
90
+ * // { // ScheduleKeyDeletionResponse
91
+ * // KeyId: "STRING_VALUE",
92
+ * // DeletionDate: new Date("TIMESTAMP"),
93
+ * // KeyState: "Creating" || "Enabled" || "Disabled" || "PendingDeletion" || "PendingImport" || "PendingReplicaDeletion" || "Unavailable" || "Updating",
94
+ * // PendingWindowInDays: Number("int"),
95
+ * // };
96
+ *
90
97
  * ```
91
98
  *
92
99
  * @param ScheduleKeyDeletionCommandInput - {@link ScheduleKeyDeletionCommandInput}
@@ -129,6 +136,8 @@ export interface ScheduleKeyDeletionCommandOutput extends ScheduleKeyDeletionRes
129
136
  * <p>The request was rejected because the specified entity or resource could not be
130
137
  * found.</p>
131
138
  *
139
+ * @throws {@link KMSServiceException}
140
+ * <p>Base exception class for all service exceptions from KMS service.</p>
132
141
  *
133
142
  * @example To schedule a KMS key for deletion
134
143
  * ```javascript
@@ -88,6 +88,12 @@ export interface SignCommandOutput extends SignResponse, __MetadataBearer {
88
88
  * };
89
89
  * const command = new SignCommand(input);
90
90
  * const response = await client.send(command);
91
+ * // { // SignResponse
92
+ * // KeyId: "STRING_VALUE",
93
+ * // Signature: "BLOB_VALUE",
94
+ * // SigningAlgorithm: "RSASSA_PSS_SHA_256" || "RSASSA_PSS_SHA_384" || "RSASSA_PSS_SHA_512" || "RSASSA_PKCS1_V1_5_SHA_256" || "RSASSA_PKCS1_V1_5_SHA_384" || "RSASSA_PKCS1_V1_5_SHA_512" || "ECDSA_SHA_256" || "ECDSA_SHA_384" || "ECDSA_SHA_512" || "SM2DSA",
95
+ * // };
96
+ *
91
97
  * ```
92
98
  *
93
99
  * @param SignCommandInput - {@link SignCommandInput}
@@ -157,6 +163,8 @@ export interface SignCommandOutput extends SignResponse, __MetadataBearer {
157
163
  * <p>The request was rejected because the specified entity or resource could not be
158
164
  * found.</p>
159
165
  *
166
+ * @throws {@link KMSServiceException}
167
+ * <p>Base exception class for all service exceptions from KMS service.</p>
160
168
  *
161
169
  * @example To digitally sign a message with an asymmetric KMS key.
162
170
  * ```javascript
@@ -83,6 +83,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
83
83
  * };
84
84
  * const command = new TagResourceCommand(input);
85
85
  * const response = await client.send(command);
86
+ * // {};
87
+ *
86
88
  * ```
87
89
  *
88
90
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -128,6 +130,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
128
130
  * @throws {@link TagException} (client fault)
129
131
  * <p>The request was rejected because one or more tags are not valid.</p>
130
132
  *
133
+ * @throws {@link KMSServiceException}
134
+ * <p>Base exception class for all service exceptions from KMS service.</p>
131
135
  *
132
136
  * @example To tag a KMS key
133
137
  * ```javascript
@@ -75,6 +75,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
75
75
  * };
76
76
  * const command = new UntagResourceCommand(input);
77
77
  * const response = await client.send(command);
78
+ * // {};
79
+ *
78
80
  * ```
79
81
  *
80
82
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -116,6 +118,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
116
118
  * @throws {@link TagException} (client fault)
117
119
  * <p>The request was rejected because one or more tags are not valid.</p>
118
120
  *
121
+ * @throws {@link KMSServiceException}
122
+ * <p>Base exception class for all service exceptions from KMS service.</p>
119
123
  *
120
124
  * @example To remove tags from a KMS key
121
125
  * ```javascript
@@ -94,6 +94,8 @@ export interface UpdateAliasCommandOutput extends __MetadataBearer {
94
94
  * };
95
95
  * const command = new UpdateAliasCommand(input);
96
96
  * const response = await client.send(command);
97
+ * // {};
98
+ *
97
99
  * ```
98
100
  *
99
101
  * @param UpdateAliasCommandInput - {@link UpdateAliasCommandInput}
@@ -136,6 +138,8 @@ export interface UpdateAliasCommandOutput extends __MetadataBearer {
136
138
  * <p>The request was rejected because the specified entity or resource could not be
137
139
  * found.</p>
138
140
  *
141
+ * @throws {@link KMSServiceException}
142
+ * <p>Base exception class for all service exceptions from KMS service.</p>
139
143
  *
140
144
  * @example To update an alias
141
145
  * ```javascript
@@ -134,6 +134,8 @@ export interface UpdateCustomKeyStoreCommandOutput extends UpdateCustomKeyStoreR
134
134
  * };
135
135
  * const command = new UpdateCustomKeyStoreCommand(input);
136
136
  * const response = await client.send(command);
137
+ * // {};
138
+ *
137
139
  * ```
138
140
  *
139
141
  * @param UpdateCustomKeyStoreCommandInput - {@link UpdateCustomKeyStoreCommandInput}
@@ -298,6 +300,8 @@ export interface UpdateCustomKeyStoreCommandOutput extends UpdateCustomKeyStoreR
298
300
  * endpoint service includes the KMS service principal for the Region, such as
299
301
  * <code>cks.kms.us-east-1.amazonaws.com</code>.</p>
300
302
  *
303
+ * @throws {@link KMSServiceException}
304
+ * <p>Base exception class for all service exceptions from KMS service.</p>
301
305
  *
302
306
  * @example To edit the friendly name of a custom key store
303
307
  * ```javascript
@@ -327,7 +331,7 @@ export interface UpdateCustomKeyStoreCommandOutput extends UpdateCustomKeyStoreR
327
331
  * ```javascript
328
332
  * // This example changes the AWS CloudHSM cluster that is associated with an AWS CloudHSM key store to a related cluster, such as a different backup of the same cluster. This operation does not return any data. To verify that the operation worked, use the DescribeCustomKeyStores operation.
329
333
  * const input = {
330
- * "CloudHsmClusterId": "cluster-1a23b4cdefg",
334
+ * "CloudHsmClusterId": "cluster-234abcdefABC",
331
335
  * "CustomKeyStoreId": "cks-1234567890abcdef0"
332
336
  * };
333
337
  * const command = new UpdateCustomKeyStoreCommand(input);
@@ -53,6 +53,8 @@ export interface UpdateKeyDescriptionCommandOutput extends __MetadataBearer {
53
53
  * };
54
54
  * const command = new UpdateKeyDescriptionCommand(input);
55
55
  * const response = await client.send(command);
56
+ * // {};
57
+ *
56
58
  * ```
57
59
  *
58
60
  * @param UpdateKeyDescriptionCommandInput - {@link UpdateKeyDescriptionCommandInput}
@@ -95,6 +97,8 @@ export interface UpdateKeyDescriptionCommandOutput extends __MetadataBearer {
95
97
  * <p>The request was rejected because the specified entity or resource could not be
96
98
  * found.</p>
97
99
  *
100
+ * @throws {@link KMSServiceException}
101
+ * <p>Base exception class for all service exceptions from KMS service.</p>
98
102
  *
99
103
  * @example To update the description of a KMS key
100
104
  * ```javascript
@@ -96,6 +96,8 @@ export interface UpdatePrimaryRegionCommandOutput extends __MetadataBearer {
96
96
  * };
97
97
  * const command = new UpdatePrimaryRegionCommand(input);
98
98
  * const response = await client.send(command);
99
+ * // {};
100
+ *
99
101
  * ```
100
102
  *
101
103
  * @param UpdatePrimaryRegionCommandInput - {@link UpdatePrimaryRegionCommandInput}
@@ -141,6 +143,8 @@ export interface UpdatePrimaryRegionCommandOutput extends __MetadataBearer {
141
143
  * <p>The request was rejected because a specified parameter is not supported or a specified
142
144
  * resource is not valid for this operation.</p>
143
145
  *
146
+ * @throws {@link KMSServiceException}
147
+ * <p>Base exception class for all service exceptions from KMS service.</p>
144
148
  *
145
149
  * @example To update the primary Region of a multi-Region KMS key
146
150
  * ```javascript
@@ -73,6 +73,12 @@ export interface VerifyCommandOutput extends VerifyResponse, __MetadataBearer {
73
73
  * };
74
74
  * const command = new VerifyCommand(input);
75
75
  * const response = await client.send(command);
76
+ * // { // VerifyResponse
77
+ * // KeyId: "STRING_VALUE",
78
+ * // SignatureValid: true || false,
79
+ * // SigningAlgorithm: "RSASSA_PSS_SHA_256" || "RSASSA_PSS_SHA_384" || "RSASSA_PSS_SHA_512" || "RSASSA_PKCS1_V1_5_SHA_256" || "RSASSA_PKCS1_V1_5_SHA_384" || "RSASSA_PKCS1_V1_5_SHA_512" || "ECDSA_SHA_256" || "ECDSA_SHA_384" || "ECDSA_SHA_512" || "SM2DSA",
80
+ * // };
81
+ *
76
82
  * ```
77
83
  *
78
84
  * @param VerifyCommandInput - {@link VerifyCommandInput}
@@ -147,6 +153,8 @@ export interface VerifyCommandOutput extends VerifyResponse, __MetadataBearer {
147
153
  * <p>The request was rejected because the specified entity or resource could not be
148
154
  * found.</p>
149
155
  *
156
+ * @throws {@link KMSServiceException}
157
+ * <p>Base exception class for all service exceptions from KMS service.</p>
150
158
  *
151
159
  * @example To use an asymmetric KMS key to verify a digital signature
152
160
  * ```javascript
@@ -57,6 +57,12 @@ export interface VerifyMacCommandOutput extends VerifyMacResponse, __MetadataBea
57
57
  * };
58
58
  * const command = new VerifyMacCommand(input);
59
59
  * const response = await client.send(command);
60
+ * // { // VerifyMacResponse
61
+ * // KeyId: "STRING_VALUE",
62
+ * // MacValid: true || false,
63
+ * // MacAlgorithm: "HMAC_SHA_224" || "HMAC_SHA_256" || "HMAC_SHA_384" || "HMAC_SHA_512",
64
+ * // };
65
+ *
60
66
  * ```
61
67
  *
62
68
  * @param VerifyMacCommandInput - {@link VerifyMacCommandInput}
@@ -127,6 +133,8 @@ export interface VerifyMacCommandOutput extends VerifyMacResponse, __MetadataBea
127
133
  * <p>The request was rejected because the specified entity or resource could not be
128
134
  * found.</p>
129
135
  *
136
+ * @throws {@link KMSServiceException}
137
+ * <p>Base exception class for all service exceptions from KMS service.</p>
130
138
  *
131
139
  * @example To verify an HMAC
132
140
  * ```javascript
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.324.0",
4
+ "version": "3.326.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",
@@ -21,33 +21,33 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.321.1",
24
+ "@aws-sdk/client-sts": "3.326.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.321.1",
26
+ "@aws-sdk/credential-provider-node": "3.326.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
30
- "@aws-sdk/middleware-content-length": "3.310.0",
31
- "@aws-sdk/middleware-endpoint": "3.310.0",
32
- "@aws-sdk/middleware-host-header": "3.310.0",
33
- "@aws-sdk/middleware-logger": "3.310.0",
34
- "@aws-sdk/middleware-recursion-detection": "3.310.0",
35
- "@aws-sdk/middleware-retry": "3.310.0",
36
- "@aws-sdk/middleware-serde": "3.310.0",
37
- "@aws-sdk/middleware-signing": "3.310.0",
38
- "@aws-sdk/middleware-stack": "3.310.0",
39
- "@aws-sdk/middleware-user-agent": "3.319.0",
30
+ "@aws-sdk/middleware-content-length": "3.325.0",
31
+ "@aws-sdk/middleware-endpoint": "3.325.0",
32
+ "@aws-sdk/middleware-host-header": "3.325.0",
33
+ "@aws-sdk/middleware-logger": "3.325.0",
34
+ "@aws-sdk/middleware-recursion-detection": "3.325.0",
35
+ "@aws-sdk/middleware-retry": "3.325.0",
36
+ "@aws-sdk/middleware-serde": "3.325.0",
37
+ "@aws-sdk/middleware-signing": "3.325.0",
38
+ "@aws-sdk/middleware-stack": "3.325.0",
39
+ "@aws-sdk/middleware-user-agent": "3.325.0",
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.321.1",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
43
- "@aws-sdk/smithy-client": "3.316.0",
43
+ "@aws-sdk/smithy-client": "3.325.0",
44
44
  "@aws-sdk/types": "3.310.0",
45
45
  "@aws-sdk/url-parser": "3.310.0",
46
46
  "@aws-sdk/util-base64": "3.310.0",
47
47
  "@aws-sdk/util-body-length-browser": "3.310.0",
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
- "@aws-sdk/util-defaults-mode-browser": "3.316.0",
50
- "@aws-sdk/util-defaults-mode-node": "3.316.0",
49
+ "@aws-sdk/util-defaults-mode-browser": "3.325.0",
50
+ "@aws-sdk/util-defaults-mode-node": "3.325.0",
51
51
  "@aws-sdk/util-endpoints": "3.319.0",
52
52
  "@aws-sdk/util-retry": "3.310.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",