@aws-sdk/client-kms 3.775.0 → 3.782.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 (54) hide show
  1. package/dist-types/commands/CancelKeyDeletionCommand.d.ts +5 -5
  2. package/dist-types/commands/ConnectCustomKeyStoreCommand.d.ts +7 -4
  3. package/dist-types/commands/CreateAliasCommand.d.ts +8 -5
  4. package/dist-types/commands/CreateCustomKeyStoreCommand.d.ts +8 -57
  5. package/dist-types/commands/CreateGrantCommand.d.ts +8 -8
  6. package/dist-types/commands/CreateKeyCommand.d.ts +1 -283
  7. package/dist-types/commands/DecryptCommand.d.ts +15 -39
  8. package/dist-types/commands/DeleteAliasCommand.d.ts +7 -4
  9. package/dist-types/commands/DeleteCustomKeyStoreCommand.d.ts +7 -4
  10. package/dist-types/commands/DeleteImportedKeyMaterialCommand.d.ts +7 -4
  11. package/dist-types/commands/DeriveSharedSecretCommand.d.ts +10 -10
  12. package/dist-types/commands/DescribeCustomKeyStoresCommand.d.ts +5 -92
  13. package/dist-types/commands/DescribeKeyCommand.d.ts +101 -138
  14. package/dist-types/commands/DisableKeyCommand.d.ts +7 -4
  15. package/dist-types/commands/DisableKeyRotationCommand.d.ts +7 -4
  16. package/dist-types/commands/DisconnectCustomKeyStoreCommand.d.ts +7 -4
  17. package/dist-types/commands/EnableKeyCommand.d.ts +7 -4
  18. package/dist-types/commands/EnableKeyRotationCommand.d.ts +8 -5
  19. package/dist-types/commands/EncryptCommand.d.ts +15 -16
  20. package/dist-types/commands/GenerateDataKeyCommand.d.ts +8 -32
  21. package/dist-types/commands/GenerateDataKeyPairCommand.d.ts +10 -36
  22. package/dist-types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +9 -9
  23. package/dist-types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +7 -7
  24. package/dist-types/commands/GenerateMacCommand.d.ts +9 -9
  25. package/dist-types/commands/GenerateRandomCommand.d.ts +5 -26
  26. package/dist-types/commands/GetKeyPolicyCommand.d.ts +18 -6
  27. package/dist-types/commands/GetKeyRotationStatusCommand.d.ts +1 -20
  28. package/dist-types/commands/GetParametersForImportCommand.d.ts +1 -84
  29. package/dist-types/commands/GetPublicKeyCommand.d.ts +9 -9
  30. package/dist-types/commands/ImportKeyMaterialCommand.d.ts +10 -22
  31. package/dist-types/commands/ListAliasesCommand.d.ts +30 -30
  32. package/dist-types/commands/ListGrantsCommand.d.ts +1 -69
  33. package/dist-types/commands/ListKeyPoliciesCommand.d.ts +6 -6
  34. package/dist-types/commands/ListKeyRotationsCommand.d.ts +1 -28
  35. package/dist-types/commands/ListKeysCommand.d.ts +20 -20
  36. package/dist-types/commands/ListResourceTagsCommand.d.ts +12 -12
  37. package/dist-types/commands/ListRetirableGrantsCommand.d.ts +1 -30
  38. package/dist-types/commands/PutKeyPolicyCommand.d.ts +82 -6
  39. package/dist-types/commands/ReEncryptCommand.d.ts +8 -8
  40. package/dist-types/commands/ReplicateKeyCommand.d.ts +31 -29
  41. package/dist-types/commands/RetireGrantCommand.d.ts +8 -5
  42. package/dist-types/commands/RevokeGrantCommand.d.ts +8 -5
  43. package/dist-types/commands/RotateKeyOnDemandCommand.d.ts +5 -5
  44. package/dist-types/commands/ScheduleKeyDeletionCommand.d.ts +1 -18
  45. package/dist-types/commands/SignCommand.d.ts +18 -19
  46. package/dist-types/commands/TagResourceCommand.d.ts +10 -7
  47. package/dist-types/commands/UntagResourceCommand.d.ts +8 -5
  48. package/dist-types/commands/UpdateAliasCommand.d.ts +8 -5
  49. package/dist-types/commands/UpdateCustomKeyStoreCommand.d.ts +34 -38
  50. package/dist-types/commands/UpdateKeyDescriptionCommand.d.ts +8 -5
  51. package/dist-types/commands/UpdatePrimaryRegionCommand.d.ts +12 -9
  52. package/dist-types/commands/VerifyCommand.d.ts +20 -21
  53. package/dist-types/commands/VerifyMacCommand.d.ts +10 -10
  54. package/package.json +5 -5
@@ -129,63 +129,63 @@ declare const ListAliasesCommand_base: {
129
129
  * @throws {@link KMSServiceException}
130
130
  * <p>Base exception class for all service exceptions from KMS service.</p>
131
131
  *
132
- * @public
132
+ *
133
133
  * @example To list aliases
134
134
  * ```javascript
135
135
  * // The following example lists aliases.
136
- * const input = {};
136
+ * const input = { /* empty *\/ };
137
137
  * const command = new ListAliasesCommand(input);
138
138
  * const response = await client.send(command);
139
- * /* response ==
139
+ * /* response is
140
140
  * {
141
- * "Aliases": [
141
+ * Aliases: [
142
142
  * {
143
- * "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/aws/acm",
144
- * "AliasName": "alias/aws/acm",
145
- * "TargetKeyId": "da03f6f7-d279-427a-9cae-de48d07e5b66"
143
+ * AliasArn: "arn:aws:kms:us-east-2:111122223333:alias/aws/acm",
144
+ * AliasName: "alias/aws/acm",
145
+ * TargetKeyId: "da03f6f7-d279-427a-9cae-de48d07e5b66"
146
146
  * },
147
147
  * {
148
- * "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/aws/ebs",
149
- * "AliasName": "alias/aws/ebs",
150
- * "TargetKeyId": "25a217e7-7170-4b8c-8bf6-045ea5f70e5b"
148
+ * AliasArn: "arn:aws:kms:us-east-2:111122223333:alias/aws/ebs",
149
+ * AliasName: "alias/aws/ebs",
150
+ * TargetKeyId: "25a217e7-7170-4b8c-8bf6-045ea5f70e5b"
151
151
  * },
152
152
  * {
153
- * "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/aws/rds",
154
- * "AliasName": "alias/aws/rds",
155
- * "TargetKeyId": "7ec3104e-c3f2-4b5c-bf42-bfc4772c6685"
153
+ * AliasArn: "arn:aws:kms:us-east-2:111122223333:alias/aws/rds",
154
+ * AliasName: "alias/aws/rds",
155
+ * TargetKeyId: "7ec3104e-c3f2-4b5c-bf42-bfc4772c6685"
156
156
  * },
157
157
  * {
158
- * "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/aws/redshift",
159
- * "AliasName": "alias/aws/redshift",
160
- * "TargetKeyId": "08f7a25a-69e2-4fb5-8f10-393db27326fa"
158
+ * AliasArn: "arn:aws:kms:us-east-2:111122223333:alias/aws/redshift",
159
+ * AliasName: "alias/aws/redshift",
160
+ * TargetKeyId: "08f7a25a-69e2-4fb5-8f10-393db27326fa"
161
161
  * },
162
162
  * {
163
- * "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/aws/s3",
164
- * "AliasName": "alias/aws/s3",
165
- * "TargetKeyId": "d2b0f1a3-580d-4f79-b836-bc983be8cfa5"
163
+ * AliasArn: "arn:aws:kms:us-east-2:111122223333:alias/aws/s3",
164
+ * AliasName: "alias/aws/s3",
165
+ * TargetKeyId: "d2b0f1a3-580d-4f79-b836-bc983be8cfa5"
166
166
  * },
167
167
  * {
168
- * "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/example1",
169
- * "AliasName": "alias/example1",
170
- * "TargetKeyId": "4da1e216-62d0-46c5-a7c0-5f3a3d2f8046"
168
+ * AliasArn: "arn:aws:kms:us-east-2:111122223333:alias/example1",
169
+ * AliasName: "alias/example1",
170
+ * TargetKeyId: "4da1e216-62d0-46c5-a7c0-5f3a3d2f8046"
171
171
  * },
172
172
  * {
173
- * "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/example2",
174
- * "AliasName": "alias/example2",
175
- * "TargetKeyId": "f32fef59-2cc2-445b-8573-2d73328acbee"
173
+ * AliasArn: "arn:aws:kms:us-east-2:111122223333:alias/example2",
174
+ * AliasName: "alias/example2",
175
+ * TargetKeyId: "f32fef59-2cc2-445b-8573-2d73328acbee"
176
176
  * },
177
177
  * {
178
- * "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/example3",
179
- * "AliasName": "alias/example3",
180
- * "TargetKeyId": "1374ef38-d34e-4d5f-b2c9-4e0daee38855"
178
+ * AliasArn: "arn:aws:kms:us-east-2:111122223333:alias/example3",
179
+ * AliasName: "alias/example3",
180
+ * TargetKeyId: "1374ef38-d34e-4d5f-b2c9-4e0daee38855"
181
181
  * }
182
182
  * ],
183
- * "Truncated": false
183
+ * Truncated: false
184
184
  * }
185
185
  * *\/
186
- * // example id: to-list-aliases-1480729693349
187
186
  * ```
188
187
  *
188
+ * @public
189
189
  */
190
190
  export declare class ListAliasesCommand extends ListAliasesCommand_base {
191
191
  /** @internal type navigation helper, not in runtime. */
@@ -171,76 +171,8 @@ declare const ListGrantsCommand_base: {
171
171
  * @throws {@link KMSServiceException}
172
172
  * <p>Base exception class for all service exceptions from KMS service.</p>
173
173
  *
174
- * @public
175
- * @example To list grants for a KMS key
176
- * ```javascript
177
- * // The following example lists grants for the specified KMS key.
178
- * const input = {
179
- * "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
180
- * };
181
- * const command = new ListGrantsCommand(input);
182
- * const response = await client.send(command);
183
- * /* response ==
184
- * {
185
- * "Grants": [
186
- * {
187
- * "CreationDate": "2016-10-25T14:37:41-07:00",
188
- * "GrantId": "91ad875e49b04a9d1f3bdeb84d821f9db6ea95e1098813f6d47f0c65fbe2a172",
189
- * "GranteePrincipal": "acm.us-east-2.amazonaws.com",
190
- * "IssuingAccount": "arn:aws:iam::111122223333:root",
191
- * "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
192
- * "Operations": [
193
- * "Encrypt",
194
- * "ReEncryptFrom",
195
- * "ReEncryptTo"
196
- * ],
197
- * "RetiringPrincipal": "acm.us-east-2.amazonaws.com"
198
- * },
199
- * {
200
- * "CreationDate": "2016-10-25T14:37:41-07:00",
201
- * "GrantId": "a5d67d3e207a8fc1f4928749ee3e52eb0440493a8b9cf05bbfad91655b056200",
202
- * "GranteePrincipal": "acm.us-east-2.amazonaws.com",
203
- * "IssuingAccount": "arn:aws:iam::111122223333:root",
204
- * "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
205
- * "Operations": [
206
- * "ReEncryptFrom",
207
- * "ReEncryptTo"
208
- * ],
209
- * "RetiringPrincipal": "acm.us-east-2.amazonaws.com"
210
- * },
211
- * {
212
- * "CreationDate": "2016-10-25T14:37:41-07:00",
213
- * "GrantId": "c541aaf05d90cb78846a73b346fc43e65be28b7163129488c738e0c9e0628f4f",
214
- * "GranteePrincipal": "acm.us-east-2.amazonaws.com",
215
- * "IssuingAccount": "arn:aws:iam::111122223333:root",
216
- * "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
217
- * "Operations": [
218
- * "Encrypt",
219
- * "ReEncryptFrom",
220
- * "ReEncryptTo"
221
- * ],
222
- * "RetiringPrincipal": "acm.us-east-2.amazonaws.com"
223
- * },
224
- * {
225
- * "CreationDate": "2016-10-25T14:37:41-07:00",
226
- * "GrantId": "dd2052c67b4c76ee45caf1dc6a1e2d24e8dc744a51b36ae2f067dc540ce0105c",
227
- * "GranteePrincipal": "acm.us-east-2.amazonaws.com",
228
- * "IssuingAccount": "arn:aws:iam::111122223333:root",
229
- * "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
230
- * "Operations": [
231
- * "Encrypt",
232
- * "ReEncryptFrom",
233
- * "ReEncryptTo"
234
- * ],
235
- * "RetiringPrincipal": "acm.us-east-2.amazonaws.com"
236
- * }
237
- * ],
238
- * "Truncated": true
239
- * }
240
- * *\/
241
- * // example id: to-list-grants-for-a-cmk-1481067365389
242
- * ```
243
174
  *
175
+ * @public
244
176
  */
245
177
  export declare class ListGrantsCommand extends ListGrantsCommand_base {
246
178
  /** @internal type navigation helper, not in runtime. */
@@ -120,26 +120,26 @@ declare const ListKeyPoliciesCommand_base: {
120
120
  * @throws {@link KMSServiceException}
121
121
  * <p>Base exception class for all service exceptions from KMS service.</p>
122
122
  *
123
- * @public
123
+ *
124
124
  * @example To list key policies for a KMS key
125
125
  * ```javascript
126
126
  * // The following example lists key policies for the specified KMS key.
127
127
  * const input = {
128
- * "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
128
+ * KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab"
129
129
  * };
130
130
  * const command = new ListKeyPoliciesCommand(input);
131
131
  * const response = await client.send(command);
132
- * /* response ==
132
+ * /* response is
133
133
  * {
134
- * "PolicyNames": [
134
+ * PolicyNames: [
135
135
  * "default"
136
136
  * ],
137
- * "Truncated": false
137
+ * Truncated: false
138
138
  * }
139
139
  * *\/
140
- * // example id: to-list-key-policies-for-a-cmk-1481069780998
141
140
  * ```
142
141
  *
142
+ * @public
143
143
  */
144
144
  export declare class ListKeyPoliciesCommand extends ListKeyPoliciesCommand_base {
145
145
  /** @internal type navigation helper, not in runtime. */
@@ -141,35 +141,8 @@ declare const ListKeyRotationsCommand_base: {
141
141
  * @throws {@link KMSServiceException}
142
142
  * <p>Base exception class for all service exceptions from KMS service.</p>
143
143
  *
144
- * @public
145
- * @example To retrieve information about all completed key material rotations
146
- * ```javascript
147
- * // The following example returns information about all completed key material rotations for the specified KMS key.
148
- * const input = {
149
- * "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
150
- * };
151
- * const command = new ListKeyRotationsCommand(input);
152
- * const response = await client.send(command);
153
- * /* response ==
154
- * {
155
- * "Rotations": [
156
- * {
157
- * "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
158
- * "RotationDate": "2024-03-02T10:11:36.564000+00:00",
159
- * "RotationType": "AUTOMATIC"
160
- * },
161
- * {
162
- * "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
163
- * "RotationDate": "2024-04-05T15:14:47.757000+00:00",
164
- * "RotationType": "ON_DEMAND"
165
- * }
166
- * ],
167
- * "Truncated": false
168
- * }
169
- * *\/
170
- * // example id: to-retrieve-information-about-all-completed-key-material-rotations-1712585167775
171
- * ```
172
144
  *
145
+ * @public
173
146
  */
174
147
  export declare class ListKeyRotationsCommand extends ListKeyRotationsCommand_base {
175
148
  /** @internal type navigation helper, not in runtime. */
@@ -106,51 +106,51 @@ declare const ListKeysCommand_base: {
106
106
  * @throws {@link KMSServiceException}
107
107
  * <p>Base exception class for all service exceptions from KMS service.</p>
108
108
  *
109
- * @public
109
+ *
110
110
  * @example To list KMS keys
111
111
  * ```javascript
112
112
  * // The following example lists KMS keys.
113
- * const input = {};
113
+ * const input = { /* empty *\/ };
114
114
  * const command = new ListKeysCommand(input);
115
115
  * const response = await client.send(command);
116
- * /* response ==
116
+ * /* response is
117
117
  * {
118
- * "Keys": [
118
+ * Keys: [
119
119
  * {
120
- * "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/0d990263-018e-4e65-a703-eff731de951e",
121
- * "KeyId": "0d990263-018e-4e65-a703-eff731de951e"
120
+ * KeyArn: "arn:aws:kms:us-east-2:111122223333:key/0d990263-018e-4e65-a703-eff731de951e",
121
+ * KeyId: "0d990263-018e-4e65-a703-eff731de951e"
122
122
  * },
123
123
  * {
124
- * "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/144be297-0ae1-44ac-9c8f-93cd8c82f841",
125
- * "KeyId": "144be297-0ae1-44ac-9c8f-93cd8c82f841"
124
+ * KeyArn: "arn:aws:kms:us-east-2:111122223333:key/144be297-0ae1-44ac-9c8f-93cd8c82f841",
125
+ * KeyId: "144be297-0ae1-44ac-9c8f-93cd8c82f841"
126
126
  * },
127
127
  * {
128
- * "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/21184251-b765-428e-b852-2c7353e72571",
129
- * "KeyId": "21184251-b765-428e-b852-2c7353e72571"
128
+ * KeyArn: "arn:aws:kms:us-east-2:111122223333:key/21184251-b765-428e-b852-2c7353e72571",
129
+ * KeyId: "21184251-b765-428e-b852-2c7353e72571"
130
130
  * },
131
131
  * {
132
- * "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/214fe92f-5b03-4ae1-b350-db2a45dbe10c",
133
- * "KeyId": "214fe92f-5b03-4ae1-b350-db2a45dbe10c"
132
+ * KeyArn: "arn:aws:kms:us-east-2:111122223333:key/214fe92f-5b03-4ae1-b350-db2a45dbe10c",
133
+ * KeyId: "214fe92f-5b03-4ae1-b350-db2a45dbe10c"
134
134
  * },
135
135
  * {
136
- * "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/339963f2-e523-49d3-af24-a0fe752aa458",
137
- * "KeyId": "339963f2-e523-49d3-af24-a0fe752aa458"
136
+ * KeyArn: "arn:aws:kms:us-east-2:111122223333:key/339963f2-e523-49d3-af24-a0fe752aa458",
137
+ * KeyId: "339963f2-e523-49d3-af24-a0fe752aa458"
138
138
  * },
139
139
  * {
140
- * "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/b776a44b-df37-4438-9be4-a27494e4271a",
141
- * "KeyId": "b776a44b-df37-4438-9be4-a27494e4271a"
140
+ * KeyArn: "arn:aws:kms:us-east-2:111122223333:key/b776a44b-df37-4438-9be4-a27494e4271a",
141
+ * KeyId: "b776a44b-df37-4438-9be4-a27494e4271a"
142
142
  * },
143
143
  * {
144
- * "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/deaf6c9e-cf2c-46a6-bf6d-0b6d487cffbb",
145
- * "KeyId": "deaf6c9e-cf2c-46a6-bf6d-0b6d487cffbb"
144
+ * KeyArn: "arn:aws:kms:us-east-2:111122223333:key/deaf6c9e-cf2c-46a6-bf6d-0b6d487cffbb",
145
+ * KeyId: "deaf6c9e-cf2c-46a6-bf6d-0b6d487cffbb"
146
146
  * }
147
147
  * ],
148
- * "Truncated": false
148
+ * Truncated: false
149
149
  * }
150
150
  * *\/
151
- * // example id: to-list-cmks-1481071643069
152
151
  * ```
153
152
  *
153
+ * @public
154
154
  */
155
155
  export declare class ListKeysCommand extends ListKeysCommand_base {
156
156
  /** @internal type navigation helper, not in runtime. */
@@ -115,37 +115,37 @@ declare const ListResourceTagsCommand_base: {
115
115
  * @throws {@link KMSServiceException}
116
116
  * <p>Base exception class for all service exceptions from KMS service.</p>
117
117
  *
118
- * @public
118
+ *
119
119
  * @example To list tags for a KMS key
120
120
  * ```javascript
121
121
  * // The following example lists tags for a KMS key.
122
122
  * const input = {
123
- * "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
123
+ * KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab"
124
124
  * };
125
125
  * const command = new ListResourceTagsCommand(input);
126
126
  * const response = await client.send(command);
127
- * /* response ==
127
+ * /* response is
128
128
  * {
129
- * "Tags": [
129
+ * Tags: [
130
130
  * {
131
- * "TagKey": "CostCenter",
132
- * "TagValue": "87654"
131
+ * TagKey: "CostCenter",
132
+ * TagValue: "87654"
133
133
  * },
134
134
  * {
135
- * "TagKey": "CreatedBy",
136
- * "TagValue": "ExampleUser"
135
+ * TagKey: "CreatedBy",
136
+ * TagValue: "ExampleUser"
137
137
  * },
138
138
  * {
139
- * "TagKey": "Purpose",
140
- * "TagValue": "Test"
139
+ * TagKey: "Purpose",
140
+ * TagValue: "Test"
141
141
  * }
142
142
  * ],
143
- * "Truncated": false
143
+ * Truncated: false
144
144
  * }
145
145
  * *\/
146
- * // example id: to-list-tags-for-a-cmk-1483996855796
147
146
  * ```
148
147
  *
148
+ * @public
149
149
  */
150
150
  export declare class ListResourceTagsCommand extends ListResourceTagsCommand_base {
151
151
  /** @internal type navigation helper, not in runtime. */
@@ -153,37 +153,8 @@ declare const ListRetirableGrantsCommand_base: {
153
153
  * @throws {@link KMSServiceException}
154
154
  * <p>Base exception class for all service exceptions from KMS service.</p>
155
155
  *
156
- * @public
157
- * @example To list grants that the specified principal can retire
158
- * ```javascript
159
- * // The following example lists the grants that the specified principal (identity) can retire.
160
- * const input = {
161
- * "RetiringPrincipal": "arn:aws:iam::111122223333:role/ExampleRole"
162
- * };
163
- * const command = new ListRetirableGrantsCommand(input);
164
- * const response = await client.send(command);
165
- * /* response ==
166
- * {
167
- * "Grants": [
168
- * {
169
- * "CreationDate": "2016-12-07T11:09:35-08:00",
170
- * "GrantId": "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60",
171
- * "GranteePrincipal": "arn:aws:iam::111122223333:role/ExampleRole",
172
- * "IssuingAccount": "arn:aws:iam::444455556666:root",
173
- * "KeyId": "arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab",
174
- * "Operations": [
175
- * "Decrypt",
176
- * "Encrypt"
177
- * ],
178
- * "RetiringPrincipal": "arn:aws:iam::111122223333:role/ExampleRole"
179
- * }
180
- * ],
181
- * "Truncated": false
182
- * }
183
- * *\/
184
- * // example id: to-list-grants-that-the-specified-principal-can-retire-1481140499620
185
- * ```
186
156
  *
157
+ * @public
187
158
  */
188
159
  export declare class ListRetirableGrantsCommand extends ListRetirableGrantsCommand_base {
189
160
  /** @internal type navigation helper, not in runtime. */
@@ -118,20 +118,96 @@ declare const PutKeyPolicyCommand_base: {
118
118
  * @throws {@link KMSServiceException}
119
119
  * <p>Base exception class for all service exceptions from KMS service.</p>
120
120
  *
121
- * @public
121
+ *
122
122
  * @example To attach a key policy to a KMS key
123
123
  * ```javascript
124
124
  * // The following example attaches a key policy to the specified KMS key.
125
125
  * const input = {
126
- * "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
127
- * "Policy": "{\n \"Version\": \"2012-10-17\",\n \"Id\": \"custom-policy-2016-12-07\",\n \"Statement\": [\n {\n \"Sid\": \"Enable IAM User Permissions\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": \"arn:aws:iam::111122223333:root\"\n },\n \"Action\": \"kms:*\",\n \"Resource\": \"*\"\n },\n {\n \"Sid\": \"Allow access for Key Administrators\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": [\n \"arn:aws:iam::111122223333:user/ExampleAdminUser\",\n \"arn:aws:iam::111122223333:role/ExampleAdminRole\"\n ]\n },\n \"Action\": [\n \"kms:Create*\",\n \"kms:Describe*\",\n \"kms:Enable*\",\n \"kms:List*\",\n \"kms:Put*\",\n \"kms:Update*\",\n \"kms:Revoke*\",\n \"kms:Disable*\",\n \"kms:Get*\",\n \"kms:Delete*\",\n \"kms:ScheduleKeyDeletion\",\n \"kms:CancelKeyDeletion\"\n ],\n \"Resource\": \"*\"\n },\n {\n \"Sid\": \"Allow use of the key\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": \"arn:aws:iam::111122223333:role/ExamplePowerUserRole\"\n },\n \"Action\": [\n \"kms:Encrypt\",\n \"kms:Decrypt\",\n \"kms:ReEncrypt*\",\n \"kms:GenerateDataKey*\",\n \"kms:DescribeKey\"\n ],\n \"Resource\": \"*\"\n },\n {\n \"Sid\": \"Allow attachment of persistent resources\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": \"arn:aws:iam::111122223333:role/ExamplePowerUserRole\"\n },\n \"Action\": [\n \"kms:CreateGrant\",\n \"kms:ListGrants\",\n \"kms:RevokeGrant\"\n ],\n \"Resource\": \"*\",\n \"Condition\": {\n \"Bool\": {\n \"kms:GrantIsForAWSResource\": \"true\"\n }\n }\n }\n ]\n}\n",
128
- * "PolicyName": "default"
126
+ * KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab",
127
+ * Policy: `{
128
+ * "Version": "2012-10-17",
129
+ * "Id": "custom-policy-2016-12-07",
130
+ * "Statement": [
131
+ * {
132
+ * "Sid": "Enable IAM User Permissions",
133
+ * "Effect": "Allow",
134
+ * "Principal": {
135
+ * "AWS": "arn:aws:iam::111122223333:root"
136
+ * },
137
+ * "Action": "kms:*",
138
+ * "Resource": "*"
139
+ * },
140
+ * {
141
+ * "Sid": "Allow access for Key Administrators",
142
+ * "Effect": "Allow",
143
+ * "Principal": {
144
+ * "AWS": [
145
+ * "arn:aws:iam::111122223333:user/ExampleAdminUser",
146
+ * "arn:aws:iam::111122223333:role/ExampleAdminRole"
147
+ * ]
148
+ * },
149
+ * "Action": [
150
+ * "kms:Create*",
151
+ * "kms:Describe*",
152
+ * "kms:Enable*",
153
+ * "kms:List*",
154
+ * "kms:Put*",
155
+ * "kms:Update*",
156
+ * "kms:Revoke*",
157
+ * "kms:Disable*",
158
+ * "kms:Get*",
159
+ * "kms:Delete*",
160
+ * "kms:ScheduleKeyDeletion",
161
+ * "kms:CancelKeyDeletion"
162
+ * ],
163
+ * "Resource": "*"
164
+ * },
165
+ * {
166
+ * "Sid": "Allow use of the key",
167
+ * "Effect": "Allow",
168
+ * "Principal": {
169
+ * "AWS": "arn:aws:iam::111122223333:role/ExamplePowerUserRole"
170
+ * },
171
+ * "Action": [
172
+ * "kms:Encrypt",
173
+ * "kms:Decrypt",
174
+ * "kms:ReEncrypt*",
175
+ * "kms:GenerateDataKey*",
176
+ * "kms:DescribeKey"
177
+ * ],
178
+ * "Resource": "*"
179
+ * },
180
+ * {
181
+ * "Sid": "Allow attachment of persistent resources",
182
+ * "Effect": "Allow",
183
+ * "Principal": {
184
+ * "AWS": "arn:aws:iam::111122223333:role/ExamplePowerUserRole"
185
+ * },
186
+ * "Action": [
187
+ * "kms:CreateGrant",
188
+ * "kms:ListGrants",
189
+ * "kms:RevokeGrant"
190
+ * ],
191
+ * "Resource": "*",
192
+ * "Condition": {
193
+ * "Bool": {
194
+ * "kms:GrantIsForAWSResource": "true"
195
+ * }
196
+ * }
197
+ * }
198
+ * ]
199
+ * }
200
+ * `,
201
+ * PolicyName: "default"
129
202
  * };
130
203
  * const command = new PutKeyPolicyCommand(input);
131
- * await client.send(command);
132
- * // example id: to-attach-a-key-policy-to-a-cmk-1481147345018
204
+ * const response = await client.send(command);
205
+ * /* response is
206
+ * { /* metadata only *\/ }
207
+ * *\/
133
208
  * ```
134
209
  *
210
+ * @public
135
211
  */
136
212
  export declare class PutKeyPolicyCommand extends PutKeyPolicyCommand_base {
137
213
  /** @internal type navigation helper, not in runtime. */
@@ -250,26 +250,26 @@ declare const ReEncryptCommand_base: {
250
250
  * @throws {@link KMSServiceException}
251
251
  * <p>Base exception class for all service exceptions from KMS service.</p>
252
252
  *
253
- * @public
253
+ *
254
254
  * @example To reencrypt data
255
255
  * ```javascript
256
256
  * // The following example reencrypts data with the specified KMS key.
257
257
  * const input = {
258
- * "CiphertextBlob": "<binary data>",
259
- * "DestinationKeyId": "0987dcba-09fe-87dc-65ba-ab0987654321"
258
+ * CiphertextBlob: "<binary data>",
259
+ * DestinationKeyId: "0987dcba-09fe-87dc-65ba-ab0987654321"
260
260
  * };
261
261
  * const command = new ReEncryptCommand(input);
262
262
  * const response = await client.send(command);
263
- * /* response ==
263
+ * /* response is
264
264
  * {
265
- * "CiphertextBlob": "<binary data>",
266
- * "KeyId": "arn:aws:kms:us-east-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321",
267
- * "SourceKeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
265
+ * CiphertextBlob: "<binary data>",
266
+ * KeyId: "arn:aws:kms:us-east-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321",
267
+ * SourceKeyId: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
268
268
  * }
269
269
  * *\/
270
- * // example id: to-reencrypt-data-1481230358001
271
270
  * ```
272
271
  *
272
+ * @public
273
273
  */
274
274
  export declare class ReEncryptCommand extends ReEncryptCommand_base {
275
275
  /** @internal type navigation helper, not in runtime. */
@@ -259,55 +259,57 @@ declare const ReplicateKeyCommand_base: {
259
259
  * @throws {@link KMSServiceException}
260
260
  * <p>Base exception class for all service exceptions from KMS service.</p>
261
261
  *
262
- * @public
262
+ *
263
263
  * @example To replicate a multi-Region key in a different AWS Region
264
264
  * ```javascript
265
265
  * // This example creates a multi-Region replica key in us-west-2 of a multi-Region primary key in us-east-1.
266
266
  * const input = {
267
- * "KeyId": "arn:aws:kms:us-east-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
268
- * "ReplicaRegion": "us-west-2"
267
+ * KeyId: "arn:aws:kms:us-east-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
268
+ * ReplicaRegion: "us-west-2"
269
269
  * };
270
270
  * const command = new ReplicateKeyCommand(input);
271
271
  * const response = await client.send(command);
272
- * /* response ==
272
+ * /* response is
273
273
  * {
274
- * "ReplicaKeyMetadata": {
275
- * "AWSAccountId": "111122223333",
276
- * "Arn": "arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
277
- * "CreationDate": 1607472987.918,
278
- * "CustomerMasterKeySpec": "SYMMETRIC_DEFAULT",
279
- * "Description": "",
280
- * "Enabled": true,
281
- * "EncryptionAlgorithms": [
274
+ * ReplicaKeyMetadata: {
275
+ * AWSAccountId: "111122223333",
276
+ * Arn: "arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
277
+ * CreationDate: 1.607472987918E9,
278
+ * CustomerMasterKeySpec: "SYMMETRIC_DEFAULT",
279
+ * Description: "",
280
+ * Enabled: true,
281
+ * EncryptionAlgorithms: [
282
282
  * "SYMMETRIC_DEFAULT"
283
283
  * ],
284
- * "KeyId": "mrk-1234abcd12ab34cd56ef1234567890ab",
285
- * "KeyManager": "CUSTOMER",
286
- * "KeyState": "Enabled",
287
- * "KeyUsage": "ENCRYPT_DECRYPT",
288
- * "MultiRegion": true,
289
- * "MultiRegionConfiguration": {
290
- * "MultiRegionKeyType": "REPLICA",
291
- * "PrimaryKey": {
292
- * "Arn": "arn:aws:kms:us-east-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
293
- * "Region": "us-east-1"
284
+ * KeyId: "mrk-1234abcd12ab34cd56ef1234567890ab",
285
+ * KeyManager: "CUSTOMER",
286
+ * KeyState: "Enabled",
287
+ * KeyUsage: "ENCRYPT_DECRYPT",
288
+ * MultiRegion: true,
289
+ * MultiRegionConfiguration: {
290
+ * MultiRegionKeyType: "REPLICA",
291
+ * PrimaryKey: {
292
+ * Arn: "arn:aws:kms:us-east-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
293
+ * Region: "us-east-1"
294
294
  * },
295
- * "ReplicaKeys": [
295
+ * ReplicaKeys: [
296
296
  * {
297
- * "Arn": "arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
298
- * "Region": "us-west-2"
297
+ * Arn: "arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
298
+ * Region: "us-west-2"
299
299
  * }
300
300
  * ]
301
301
  * },
302
- * "Origin": "AWS_KMS"
302
+ * Origin: "AWS_KMS"
303
303
  * },
304
- * "ReplicaPolicy": "{\n \"Version\" : \"2012-10-17\",\n \"Id\" : \"key-default-1\",...}",
305
- * "ReplicaTags": []
304
+ * ReplicaPolicy: `{
305
+ * "Version" : "2012-10-17",
306
+ * "Id" : "key-default-1",...}`,
307
+ * ReplicaTags: []
306
308
  * }
307
309
  * *\/
308
- * // example id: to-replicate-a-multi-region-key-in-a-different-aws-region-1628622402887
309
310
  * ```
310
311
  *
312
+ * @public
311
313
  */
312
314
  export declare class ReplicateKeyCommand extends ReplicateKeyCommand_base {
313
315
  /** @internal type navigation helper, not in runtime. */