@aws-sdk/client-kms 3.533.0 → 3.535.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 (105) hide show
  1. package/dist-types/KMS.d.ts +7 -1
  2. package/dist-types/KMSClient.d.ts +1 -1
  3. package/dist-types/commands/CancelKeyDeletionCommand.d.ts +2 -1
  4. package/dist-types/commands/ConnectCustomKeyStoreCommand.d.ts +2 -1
  5. package/dist-types/commands/CreateAliasCommand.d.ts +2 -1
  6. package/dist-types/commands/CreateCustomKeyStoreCommand.d.ts +2 -1
  7. package/dist-types/commands/CreateGrantCommand.d.ts +2 -1
  8. package/dist-types/commands/CreateKeyCommand.d.ts +2 -1
  9. package/dist-types/commands/DecryptCommand.d.ts +2 -1
  10. package/dist-types/commands/DeleteAliasCommand.d.ts +2 -1
  11. package/dist-types/commands/DeleteCustomKeyStoreCommand.d.ts +2 -1
  12. package/dist-types/commands/DeleteImportedKeyMaterialCommand.d.ts +2 -1
  13. package/dist-types/commands/DescribeCustomKeyStoresCommand.d.ts +2 -1
  14. package/dist-types/commands/DescribeKeyCommand.d.ts +2 -1
  15. package/dist-types/commands/DisableKeyCommand.d.ts +2 -1
  16. package/dist-types/commands/DisableKeyRotationCommand.d.ts +2 -1
  17. package/dist-types/commands/DisconnectCustomKeyStoreCommand.d.ts +2 -1
  18. package/dist-types/commands/EnableKeyCommand.d.ts +2 -1
  19. package/dist-types/commands/EnableKeyRotationCommand.d.ts +2 -1
  20. package/dist-types/commands/EncryptCommand.d.ts +2 -1
  21. package/dist-types/commands/GenerateDataKeyCommand.d.ts +2 -1
  22. package/dist-types/commands/GenerateDataKeyPairCommand.d.ts +2 -1
  23. package/dist-types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +2 -1
  24. package/dist-types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +2 -1
  25. package/dist-types/commands/GenerateMacCommand.d.ts +2 -1
  26. package/dist-types/commands/GenerateRandomCommand.d.ts +2 -1
  27. package/dist-types/commands/GetKeyPolicyCommand.d.ts +2 -1
  28. package/dist-types/commands/GetKeyRotationStatusCommand.d.ts +2 -1
  29. package/dist-types/commands/GetParametersForImportCommand.d.ts +2 -1
  30. package/dist-types/commands/GetPublicKeyCommand.d.ts +2 -1
  31. package/dist-types/commands/ImportKeyMaterialCommand.d.ts +2 -1
  32. package/dist-types/commands/ListAliasesCommand.d.ts +2 -1
  33. package/dist-types/commands/ListGrantsCommand.d.ts +2 -1
  34. package/dist-types/commands/ListKeyPoliciesCommand.d.ts +2 -1
  35. package/dist-types/commands/ListKeysCommand.d.ts +2 -1
  36. package/dist-types/commands/ListResourceTagsCommand.d.ts +2 -1
  37. package/dist-types/commands/ListRetirableGrantsCommand.d.ts +2 -1
  38. package/dist-types/commands/PutKeyPolicyCommand.d.ts +2 -1
  39. package/dist-types/commands/ReEncryptCommand.d.ts +2 -1
  40. package/dist-types/commands/ReplicateKeyCommand.d.ts +2 -1
  41. package/dist-types/commands/RetireGrantCommand.d.ts +2 -1
  42. package/dist-types/commands/RevokeGrantCommand.d.ts +2 -1
  43. package/dist-types/commands/ScheduleKeyDeletionCommand.d.ts +2 -1
  44. package/dist-types/commands/SignCommand.d.ts +2 -1
  45. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  46. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  47. package/dist-types/commands/UpdateAliasCommand.d.ts +2 -1
  48. package/dist-types/commands/UpdateCustomKeyStoreCommand.d.ts +2 -1
  49. package/dist-types/commands/UpdateKeyDescriptionCommand.d.ts +2 -1
  50. package/dist-types/commands/UpdatePrimaryRegionCommand.d.ts +2 -1
  51. package/dist-types/commands/VerifyCommand.d.ts +2 -1
  52. package/dist-types/commands/VerifyMacCommand.d.ts +2 -1
  53. package/dist-types/models/models_0.d.ts +404 -404
  54. package/dist-types/ts3.4/KMS.d.ts +6 -0
  55. package/dist-types/ts3.4/commands/CancelKeyDeletionCommand.d.ts +9 -0
  56. package/dist-types/ts3.4/commands/ConnectCustomKeyStoreCommand.d.ts +9 -0
  57. package/dist-types/ts3.4/commands/CreateAliasCommand.d.ts +9 -0
  58. package/dist-types/ts3.4/commands/CreateCustomKeyStoreCommand.d.ts +9 -0
  59. package/dist-types/ts3.4/commands/CreateGrantCommand.d.ts +9 -0
  60. package/dist-types/ts3.4/commands/CreateKeyCommand.d.ts +9 -0
  61. package/dist-types/ts3.4/commands/DecryptCommand.d.ts +7 -0
  62. package/dist-types/ts3.4/commands/DeleteAliasCommand.d.ts +9 -0
  63. package/dist-types/ts3.4/commands/DeleteCustomKeyStoreCommand.d.ts +9 -0
  64. package/dist-types/ts3.4/commands/DeleteImportedKeyMaterialCommand.d.ts +9 -0
  65. package/dist-types/ts3.4/commands/DescribeCustomKeyStoresCommand.d.ts +9 -0
  66. package/dist-types/ts3.4/commands/DescribeKeyCommand.d.ts +9 -0
  67. package/dist-types/ts3.4/commands/DisableKeyCommand.d.ts +9 -0
  68. package/dist-types/ts3.4/commands/DisableKeyRotationCommand.d.ts +9 -0
  69. package/dist-types/ts3.4/commands/DisconnectCustomKeyStoreCommand.d.ts +9 -0
  70. package/dist-types/ts3.4/commands/EnableKeyCommand.d.ts +9 -0
  71. package/dist-types/ts3.4/commands/EnableKeyRotationCommand.d.ts +9 -0
  72. package/dist-types/ts3.4/commands/EncryptCommand.d.ts +7 -0
  73. package/dist-types/ts3.4/commands/GenerateDataKeyCommand.d.ts +9 -0
  74. package/dist-types/ts3.4/commands/GenerateDataKeyPairCommand.d.ts +9 -0
  75. package/dist-types/ts3.4/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +9 -0
  76. package/dist-types/ts3.4/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +9 -0
  77. package/dist-types/ts3.4/commands/GenerateMacCommand.d.ts +9 -0
  78. package/dist-types/ts3.4/commands/GenerateRandomCommand.d.ts +9 -0
  79. package/dist-types/ts3.4/commands/GetKeyPolicyCommand.d.ts +9 -0
  80. package/dist-types/ts3.4/commands/GetKeyRotationStatusCommand.d.ts +9 -0
  81. package/dist-types/ts3.4/commands/GetParametersForImportCommand.d.ts +9 -0
  82. package/dist-types/ts3.4/commands/GetPublicKeyCommand.d.ts +9 -0
  83. package/dist-types/ts3.4/commands/ImportKeyMaterialCommand.d.ts +9 -0
  84. package/dist-types/ts3.4/commands/ListAliasesCommand.d.ts +9 -0
  85. package/dist-types/ts3.4/commands/ListGrantsCommand.d.ts +9 -0
  86. package/dist-types/ts3.4/commands/ListKeyPoliciesCommand.d.ts +9 -0
  87. package/dist-types/ts3.4/commands/ListKeysCommand.d.ts +9 -0
  88. package/dist-types/ts3.4/commands/ListResourceTagsCommand.d.ts +9 -0
  89. package/dist-types/ts3.4/commands/ListRetirableGrantsCommand.d.ts +9 -0
  90. package/dist-types/ts3.4/commands/PutKeyPolicyCommand.d.ts +9 -0
  91. package/dist-types/ts3.4/commands/ReEncryptCommand.d.ts +9 -0
  92. package/dist-types/ts3.4/commands/ReplicateKeyCommand.d.ts +9 -0
  93. package/dist-types/ts3.4/commands/RetireGrantCommand.d.ts +9 -0
  94. package/dist-types/ts3.4/commands/RevokeGrantCommand.d.ts +9 -0
  95. package/dist-types/ts3.4/commands/ScheduleKeyDeletionCommand.d.ts +9 -0
  96. package/dist-types/ts3.4/commands/SignCommand.d.ts +7 -0
  97. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  98. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  99. package/dist-types/ts3.4/commands/UpdateAliasCommand.d.ts +9 -0
  100. package/dist-types/ts3.4/commands/UpdateCustomKeyStoreCommand.d.ts +9 -0
  101. package/dist-types/ts3.4/commands/UpdateKeyDescriptionCommand.d.ts +9 -0
  102. package/dist-types/ts3.4/commands/UpdatePrimaryRegionCommand.d.ts +9 -0
  103. package/dist-types/ts3.4/commands/VerifyCommand.d.ts +7 -0
  104. package/dist-types/ts3.4/commands/VerifyMacCommand.d.ts +9 -0
  105. package/package.json +40 -40
@@ -16,42 +16,42 @@ export declare const AlgorithmSpec: {
16
16
  */
17
17
  export type AlgorithmSpec = (typeof AlgorithmSpec)[keyof typeof AlgorithmSpec];
18
18
  /**
19
- * @public
20
19
  * <p>Contains information about an alias.</p>
20
+ * @public
21
21
  */
22
22
  export interface AliasListEntry {
23
23
  /**
24
- * @public
25
24
  * <p>String that contains the alias. This value begins with <code>alias/</code>.</p>
25
+ * @public
26
26
  */
27
27
  AliasName?: string;
28
28
  /**
29
- * @public
30
29
  * <p>String that contains the key ARN.</p>
30
+ * @public
31
31
  */
32
32
  AliasArn?: string;
33
33
  /**
34
- * @public
35
34
  * <p>String that contains the key identifier of the KMS key associated with the alias.</p>
35
+ * @public
36
36
  */
37
37
  TargetKeyId?: string;
38
38
  /**
39
- * @public
40
39
  * <p>Date and time that the alias was most recently created in the account and Region.
41
40
  * Formatted as Unix time.</p>
41
+ * @public
42
42
  */
43
43
  CreationDate?: Date;
44
44
  /**
45
- * @public
46
45
  * <p>Date and time that the alias was most recently associated with a KMS key in the account
47
46
  * and Region. Formatted as Unix time.</p>
47
+ * @public
48
48
  */
49
49
  LastUpdatedDate?: Date;
50
50
  }
51
51
  /**
52
- * @public
53
52
  * <p>The request was rejected because it attempted to create a resource that already
54
53
  * exists.</p>
54
+ * @public
55
55
  */
56
56
  export declare class AlreadyExistsException extends __BaseException {
57
57
  readonly name: "AlreadyExistsException";
@@ -66,7 +66,6 @@ export declare class AlreadyExistsException extends __BaseException {
66
66
  */
67
67
  export interface CancelKeyDeletionRequest {
68
68
  /**
69
- * @public
70
69
  * <p>Identifies the KMS key whose deletion is being canceled.</p>
71
70
  * <p>Specify the key ID or key ARN of the KMS key.</p>
72
71
  * <p>For example:</p>
@@ -81,6 +80,7 @@ export interface CancelKeyDeletionRequest {
81
80
  * </li>
82
81
  * </ul>
83
82
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
83
+ * @public
84
84
  */
85
85
  KeyId: string | undefined;
86
86
  }
@@ -89,15 +89,15 @@ export interface CancelKeyDeletionRequest {
89
89
  */
90
90
  export interface CancelKeyDeletionResponse {
91
91
  /**
92
- * @public
93
92
  * <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the KMS key whose deletion is canceled.</p>
93
+ * @public
94
94
  */
95
95
  KeyId?: string;
96
96
  }
97
97
  /**
98
- * @public
99
98
  * <p>The system timed out while trying to fulfill the request. You can retry the
100
99
  * request.</p>
100
+ * @public
101
101
  */
102
102
  export declare class DependencyTimeoutException extends __BaseException {
103
103
  readonly name: "DependencyTimeoutException";
@@ -108,9 +108,9 @@ export declare class DependencyTimeoutException extends __BaseException {
108
108
  constructor(opts: __ExceptionOptionType<DependencyTimeoutException, __BaseException>);
109
109
  }
110
110
  /**
111
- * @public
112
111
  * <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
113
112
  * valid.</p>
113
+ * @public
114
114
  */
115
115
  export declare class InvalidArnException extends __BaseException {
116
116
  readonly name: "InvalidArnException";
@@ -121,9 +121,9 @@ export declare class InvalidArnException extends __BaseException {
121
121
  constructor(opts: __ExceptionOptionType<InvalidArnException, __BaseException>);
122
122
  }
123
123
  /**
124
- * @public
125
124
  * <p>The request was rejected because an internal exception occurred. The request can be
126
125
  * retried.</p>
126
+ * @public
127
127
  */
128
128
  export declare class KMSInternalException extends __BaseException {
129
129
  readonly name: "KMSInternalException";
@@ -134,7 +134,6 @@ export declare class KMSInternalException extends __BaseException {
134
134
  constructor(opts: __ExceptionOptionType<KMSInternalException, __BaseException>);
135
135
  }
136
136
  /**
137
- * @public
138
137
  * <p>The request was rejected because the state of the specified resource is not valid for this
139
138
  * request.</p>
140
139
  * <p>This exceptions means one of the following:</p>
@@ -153,6 +152,7 @@ export declare class KMSInternalException extends __BaseException {
153
152
  * error message that accompanies the exception.</p>
154
153
  * </li>
155
154
  * </ul>
155
+ * @public
156
156
  */
157
157
  export declare class KMSInvalidStateException extends __BaseException {
158
158
  readonly name: "KMSInvalidStateException";
@@ -163,9 +163,9 @@ export declare class KMSInvalidStateException extends __BaseException {
163
163
  constructor(opts: __ExceptionOptionType<KMSInvalidStateException, __BaseException>);
164
164
  }
165
165
  /**
166
- * @public
167
166
  * <p>The request was rejected because the specified entity or resource could not be
168
167
  * found.</p>
168
+ * @public
169
169
  */
170
170
  export declare class NotFoundException extends __BaseException {
171
171
  readonly name: "NotFoundException";
@@ -176,13 +176,13 @@ export declare class NotFoundException extends __BaseException {
176
176
  constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
177
177
  }
178
178
  /**
179
- * @public
180
179
  * <p>The request was rejected because the specified CloudHSM cluster is already associated with an
181
180
  * CloudHSM key store in the account, or it shares a backup history with an CloudHSM key store in the
182
181
  * account. Each CloudHSM key store in the account must be associated with a different CloudHSM
183
182
  * cluster.</p>
184
183
  * <p>CloudHSM clusters that share a backup history have the same cluster certificate. To view the
185
184
  * 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>
185
+ * @public
186
186
  */
187
187
  export declare class CloudHsmClusterInUseException extends __BaseException {
188
188
  readonly name: "CloudHsmClusterInUseException";
@@ -193,7 +193,6 @@ export declare class CloudHsmClusterInUseException extends __BaseException {
193
193
  constructor(opts: __ExceptionOptionType<CloudHsmClusterInUseException, __BaseException>);
194
194
  }
195
195
  /**
196
- * @public
197
196
  * <p>The request was rejected because the associated CloudHSM cluster did not meet the
198
197
  * configuration requirements for an CloudHSM key store.</p>
199
198
  * <ul>
@@ -226,6 +225,7 @@ export declare class CloudHsmClusterInUseException extends __BaseException {
226
225
  * Group</a> in the <i>
227
226
  * <i>CloudHSM User Guide</i>
228
227
  * </i>. </p>
228
+ * @public
229
229
  */
230
230
  export declare class CloudHsmClusterInvalidConfigurationException extends __BaseException {
231
231
  readonly name: "CloudHsmClusterInvalidConfigurationException";
@@ -236,11 +236,11 @@ export declare class CloudHsmClusterInvalidConfigurationException extends __Base
236
236
  constructor(opts: __ExceptionOptionType<CloudHsmClusterInvalidConfigurationException, __BaseException>);
237
237
  }
238
238
  /**
239
- * @public
240
239
  * <p>The request was rejected because the CloudHSM cluster associated with the CloudHSM key store is
241
240
  * not active. Initialize and activate the cluster and try the command again. For detailed
242
241
  * instructions, see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/getting-started.html">Getting
243
242
  * Started</a> in the <i>CloudHSM User Guide</i>.</p>
243
+ * @public
244
244
  */
245
245
  export declare class CloudHsmClusterNotActiveException extends __BaseException {
246
246
  readonly name: "CloudHsmClusterNotActiveException";
@@ -251,9 +251,9 @@ export declare class CloudHsmClusterNotActiveException extends __BaseException {
251
251
  constructor(opts: __ExceptionOptionType<CloudHsmClusterNotActiveException, __BaseException>);
252
252
  }
253
253
  /**
254
- * @public
255
254
  * <p>The request was rejected because KMS cannot find the CloudHSM cluster with the specified
256
255
  * cluster ID. Retry the request with a different cluster ID.</p>
256
+ * @public
257
257
  */
258
258
  export declare class CloudHsmClusterNotFoundException extends __BaseException {
259
259
  readonly name: "CloudHsmClusterNotFoundException";
@@ -264,7 +264,6 @@ export declare class CloudHsmClusterNotFoundException extends __BaseException {
264
264
  constructor(opts: __ExceptionOptionType<CloudHsmClusterNotFoundException, __BaseException>);
265
265
  }
266
266
  /**
267
- * @public
268
267
  * <p>The request was rejected because the specified CloudHSM cluster has a different cluster
269
268
  * certificate than the original cluster. You cannot use the operation to specify an unrelated
270
269
  * cluster for an CloudHSM key store.</p>
@@ -273,6 +272,7 @@ export declare class CloudHsmClusterNotFoundException extends __BaseException {
273
272
  * were created from the same backup that produced the current cluster.</p>
274
273
  * <p>CloudHSM clusters that share a backup history have the same cluster certificate. To view the
275
274
  * 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>
275
+ * @public
276
276
  */
277
277
  export declare class CloudHsmClusterNotRelatedException extends __BaseException {
278
278
  readonly name: "CloudHsmClusterNotRelatedException";
@@ -287,9 +287,9 @@ export declare class CloudHsmClusterNotRelatedException extends __BaseException
287
287
  */
288
288
  export interface ConnectCustomKeyStoreRequest {
289
289
  /**
290
- * @public
291
290
  * <p>Enter the key store ID of the custom key store that you want to connect.
292
291
  * To find the ID of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p>
292
+ * @public
293
293
  */
294
294
  CustomKeyStoreId: string | undefined;
295
295
  }
@@ -299,7 +299,6 @@ export interface ConnectCustomKeyStoreRequest {
299
299
  export interface ConnectCustomKeyStoreResponse {
300
300
  }
301
301
  /**
302
- * @public
303
302
  * <p>The request was rejected because of the <code>ConnectionState</code> of the custom key
304
303
  * store. To get the <code>ConnectionState</code> of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p>
305
304
  * <p>This exception is thrown under the following conditions:</p>
@@ -334,6 +333,7 @@ export interface ConnectCustomKeyStoreResponse {
334
333
  * <code>ConnectionState</code> is <code>CONNECTED</code>. </p>
335
334
  * </li>
336
335
  * </ul>
336
+ * @public
337
337
  */
338
338
  export declare class CustomKeyStoreInvalidStateException extends __BaseException {
339
339
  readonly name: "CustomKeyStoreInvalidStateException";
@@ -344,9 +344,9 @@ export declare class CustomKeyStoreInvalidStateException extends __BaseException
344
344
  constructor(opts: __ExceptionOptionType<CustomKeyStoreInvalidStateException, __BaseException>);
345
345
  }
346
346
  /**
347
- * @public
348
347
  * <p>The request was rejected because KMS cannot find a custom key store with the specified
349
348
  * key store name or ID.</p>
349
+ * @public
350
350
  */
351
351
  export declare class CustomKeyStoreNotFoundException extends __BaseException {
352
352
  readonly name: "CustomKeyStoreNotFoundException";
@@ -404,7 +404,6 @@ export type ConnectionStateType = (typeof ConnectionStateType)[keyof typeof Conn
404
404
  */
405
405
  export interface CreateAliasRequest {
406
406
  /**
407
- * @public
408
407
  * <p>Specifies the alias name. This value must begin with <code>alias/</code> followed by a
409
408
  * name, such as <code>alias/ExampleAlias</code>. </p>
410
409
  * <important>
@@ -415,10 +414,10 @@ export interface CreateAliasRequest {
415
414
  * cannot begin with <code>alias/aws/</code>. The <code>alias/aws/</code> prefix is reserved for
416
415
  * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed
417
416
  * keys</a>.</p>
417
+ * @public
418
418
  */
419
419
  AliasName: string | undefined;
420
420
  /**
421
- * @public
422
421
  * <p>Associates the alias with the specified <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>. The KMS key must
423
422
  * be in the same Amazon Web Services Region. </p>
424
423
  * <p>A valid key ID is required. If you supply a null or empty string value, this operation
@@ -440,12 +439,13 @@ export interface CreateAliasRequest {
440
439
  * </li>
441
440
  * </ul>
442
441
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
442
+ * @public
443
443
  */
444
444
  TargetKeyId: string | undefined;
445
445
  }
446
446
  /**
447
- * @public
448
447
  * <p>The request was rejected because the specified alias name is not valid.</p>
448
+ * @public
449
449
  */
450
450
  export declare class InvalidAliasNameException extends __BaseException {
451
451
  readonly name: "InvalidAliasNameException";
@@ -456,9 +456,9 @@ export declare class InvalidAliasNameException extends __BaseException {
456
456
  constructor(opts: __ExceptionOptionType<InvalidAliasNameException, __BaseException>);
457
457
  }
458
458
  /**
459
- * @public
460
459
  * <p>The request was rejected because a quota was exceeded. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Quotas</a> in the
461
460
  * <i>Key Management Service Developer Guide</i>.</p>
461
+ * @public
462
462
  */
463
463
  export declare class LimitExceededException extends __BaseException {
464
464
  readonly name: "LimitExceededException";
@@ -481,22 +481,22 @@ export declare const CustomKeyStoreType: {
481
481
  */
482
482
  export type CustomKeyStoreType = (typeof CustomKeyStoreType)[keyof typeof CustomKeyStoreType];
483
483
  /**
484
- * @public
485
484
  * <p>KMS uses the authentication credential to sign requests that it sends to the external
486
485
  * key store proxy (XKS proxy) on your behalf. You establish these credentials on your external
487
486
  * key store proxy and report them to KMS.</p>
488
487
  * <p>The <code>XksProxyAuthenticationCredential</code> includes two required elements.</p>
488
+ * @public
489
489
  */
490
490
  export interface XksProxyAuthenticationCredentialType {
491
491
  /**
492
- * @public
493
492
  * <p>A unique identifier for the raw secret access key.</p>
493
+ * @public
494
494
  */
495
495
  AccessKeyId: string | undefined;
496
496
  /**
497
- * @public
498
497
  * <p>A secret string of 43-64 characters. Valid characters are a-z, A-Z, 0-9, /, +, and
499
498
  * =.</p>
499
+ * @public
500
500
  */
501
501
  RawSecretAccessKey: string | undefined;
502
502
  }
@@ -517,33 +517,32 @@ export type XksProxyConnectivityType = (typeof XksProxyConnectivityType)[keyof t
517
517
  */
518
518
  export interface CreateCustomKeyStoreRequest {
519
519
  /**
520
- * @public
521
520
  * <p>Specifies a friendly name for the custom key store. The name must be unique in your
522
521
  * Amazon Web Services account and Region. This parameter is required for all custom key stores.</p>
523
522
  * <important>
524
523
  * <p>Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p>
525
524
  * </important>
525
+ * @public
526
526
  */
527
527
  CustomKeyStoreName: string | undefined;
528
528
  /**
529
- * @public
530
529
  * <p>Identifies the CloudHSM cluster for an CloudHSM key store. This parameter is required for custom
531
530
  * key stores with <code>CustomKeyStoreType</code> of <code>AWS_CLOUDHSM</code>.</p>
532
531
  * <p>Enter the cluster ID of any active CloudHSM cluster that is not already associated with a
533
532
  * custom key store. To find the cluster ID, use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html">DescribeClusters</a> operation.</p>
533
+ * @public
534
534
  */
535
535
  CloudHsmClusterId?: string;
536
536
  /**
537
- * @public
538
537
  * <p>Specifies the certificate for an CloudHSM key store. This parameter is required for custom
539
538
  * key stores with a <code>CustomKeyStoreType</code> of <code>AWS_CLOUDHSM</code>.</p>
540
539
  * <p>Enter the content of the trust anchor certificate for the CloudHSM cluster. This is the
541
540
  * content of the <code>customerCA.crt</code> file that you created when you <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html">initialized the
542
541
  * cluster</a>.</p>
542
+ * @public
543
543
  */
544
544
  TrustAnchorCertificate?: string;
545
545
  /**
546
- * @public
547
546
  * <p>Specifies the <code>kmsuser</code> password for an CloudHSM key store. This parameter is
548
547
  * required for custom key stores with a <code>CustomKeyStoreType</code> of
549
548
  * <code>AWS_CLOUDHSM</code>.</p>
@@ -554,20 +553,20 @@ export interface CreateCustomKeyStoreRequest {
554
553
  * <p>The password must be a string of 7 to 32 characters. Its value is case sensitive.</p>
555
554
  * <p>This parameter tells KMS the <code>kmsuser</code> account password; it does not change
556
555
  * the password in the CloudHSM cluster.</p>
556
+ * @public
557
557
  */
558
558
  KeyStorePassword?: string;
559
559
  /**
560
- * @public
561
560
  * <p>Specifies the type of custom key store. The default value is
562
561
  * <code>AWS_CLOUDHSM</code>.</p>
563
562
  * <p>For a custom key store backed by an CloudHSM cluster, omit the parameter or enter
564
563
  * <code>AWS_CLOUDHSM</code>. For a custom key store backed by an external key manager outside
565
564
  * of Amazon Web Services, enter <code>EXTERNAL_KEY_STORE</code>. You cannot change this property after the key
566
565
  * store is created.</p>
566
+ * @public
567
567
  */
568
568
  CustomKeyStoreType?: CustomKeyStoreType;
569
569
  /**
570
- * @public
571
570
  * <p>Specifies the endpoint that KMS uses to send requests to the external key store proxy
572
571
  * (XKS proxy). This parameter is required for custom key stores with a
573
572
  * <code>CustomKeyStoreType</code> of <code>EXTERNAL_KEY_STORE</code>.</p>
@@ -604,10 +603,10 @@ export interface CreateCustomKeyStoreRequest {
604
603
  * unique in the Amazon Web Services account and Region.</p>
605
604
  * </li>
606
605
  * </ul>
606
+ * @public
607
607
  */
608
608
  XksProxyUriEndpoint?: string;
609
609
  /**
610
- * @public
611
610
  * <p>Specifies the base path to the proxy APIs for this external key store. To find this value,
612
611
  * see the documentation for your external key store proxy. This parameter is required for all
613
612
  * custom key stores with a <code>CustomKeyStoreType</code> of
@@ -625,10 +624,10 @@ export interface CreateCustomKeyStoreRequest {
625
624
  * must be unique in the Amazon Web Services account and Region.</p>
626
625
  * </li>
627
626
  * </ul>
627
+ * @public
628
628
  */
629
629
  XksProxyUriPath?: string;
630
630
  /**
631
- * @public
632
631
  * <p>Specifies the name of the Amazon VPC endpoint service for interface endpoints that is used to
633
632
  * communicate with your external key store proxy (XKS proxy). This parameter is required when
634
633
  * the value of <code>CustomKeyStoreType</code> is <code>EXTERNAL_KEY_STORE</code> and the value
@@ -645,10 +644,10 @@ export interface CreateCustomKeyStoreRequest {
645
644
  * name.</p>
646
645
  * </li>
647
646
  * </ul>
647
+ * @public
648
648
  */
649
649
  XksProxyVpcEndpointServiceName?: string;
650
650
  /**
651
- * @public
652
651
  * <p>Specifies an authentication credential for the external key store proxy (XKS proxy). This
653
652
  * parameter is required for all custom key stores with a <code>CustomKeyStoreType</code> of
654
653
  * <code>EXTERNAL_KEY_STORE</code>.</p>
@@ -661,10 +660,10 @@ export interface CreateCustomKeyStoreRequest {
661
660
  * just tells KMS the credential that you established on your external key store proxy. If you
662
661
  * rotate your proxy authentication credential, use the <a>UpdateCustomKeyStore</a>
663
662
  * operation to provide the new credential to KMS.</p>
663
+ * @public
664
664
  */
665
665
  XksProxyAuthenticationCredential?: XksProxyAuthenticationCredentialType;
666
666
  /**
667
- * @public
668
667
  * <p>Indicates how KMS communicates with the external key store proxy. This parameter is
669
668
  * required for custom key stores with a <code>CustomKeyStoreType</code> of
670
669
  * <code>EXTERNAL_KEY_STORE</code>.</p>
@@ -681,6 +680,7 @@ export interface CreateCustomKeyStoreRequest {
681
680
  * choice does not determine the location of the external key store proxy. Even if you choose a
682
681
  * VPC endpoint service, the proxy can be hosted within the VPC or outside of Amazon Web Services such as in
683
682
  * your corporate data center.</p>
683
+ * @public
684
684
  */
685
685
  XksProxyConnectivity?: XksProxyConnectivityType;
686
686
  }
@@ -689,16 +689,16 @@ export interface CreateCustomKeyStoreRequest {
689
689
  */
690
690
  export interface CreateCustomKeyStoreResponse {
691
691
  /**
692
- * @public
693
692
  * <p>A unique identifier for the new custom key store.</p>
693
+ * @public
694
694
  */
695
695
  CustomKeyStoreId?: string;
696
696
  }
697
697
  /**
698
- * @public
699
698
  * <p>The request was rejected because the specified custom key store name is already assigned
700
699
  * to another custom key store in the account. Try again with a custom key store name that is
701
700
  * unique in the account.</p>
701
+ * @public
702
702
  */
703
703
  export declare class CustomKeyStoreNameInUseException extends __BaseException {
704
704
  readonly name: "CustomKeyStoreNameInUseException";
@@ -709,11 +709,11 @@ export declare class CustomKeyStoreNameInUseException extends __BaseException {
709
709
  constructor(opts: __ExceptionOptionType<CustomKeyStoreNameInUseException, __BaseException>);
710
710
  }
711
711
  /**
712
- * @public
713
712
  * <p>The request was rejected because the trust anchor certificate in the request to create an
714
713
  * CloudHSM key store is not the trust anchor certificate for the specified CloudHSM cluster.</p>
715
714
  * <p>When you <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr">initialize the CloudHSM cluster</a>, you create the trust anchor certificate and save it
716
715
  * in the <code>customerCA.crt</code> file.</p>
716
+ * @public
717
717
  */
718
718
  export declare class IncorrectTrustAnchorException extends __BaseException {
719
719
  readonly name: "IncorrectTrustAnchorException";
@@ -724,11 +724,11 @@ export declare class IncorrectTrustAnchorException extends __BaseException {
724
724
  constructor(opts: __ExceptionOptionType<IncorrectTrustAnchorException, __BaseException>);
725
725
  }
726
726
  /**
727
- * @public
728
727
  * <p>The request was rejected because the proxy credentials failed to authenticate to the
729
728
  * specified external key store proxy. The specified external key store proxy rejected a status
730
729
  * request from KMS due to invalid credentials. This can indicate an error in the credentials
731
730
  * or in the identification of the external key store proxy.</p>
731
+ * @public
732
732
  */
733
733
  export declare class XksProxyIncorrectAuthenticationCredentialException extends __BaseException {
734
734
  readonly name: "XksProxyIncorrectAuthenticationCredentialException";
@@ -739,9 +739,9 @@ export declare class XksProxyIncorrectAuthenticationCredentialException extends
739
739
  constructor(opts: __ExceptionOptionType<XksProxyIncorrectAuthenticationCredentialException, __BaseException>);
740
740
  }
741
741
  /**
742
- * @public
743
742
  * <p>The request was rejected because the external key store proxy is not configured correctly.
744
743
  * To identify the cause, see the error message that accompanies the exception.</p>
744
+ * @public
745
745
  */
746
746
  export declare class XksProxyInvalidConfigurationException extends __BaseException {
747
747
  readonly name: "XksProxyInvalidConfigurationException";
@@ -752,11 +752,11 @@ export declare class XksProxyInvalidConfigurationException extends __BaseExcepti
752
752
  constructor(opts: __ExceptionOptionType<XksProxyInvalidConfigurationException, __BaseException>);
753
753
  }
754
754
  /**
755
- * @public
756
755
  * <p></p>
757
756
  * <p>KMS cannot interpret the response it received from the external key store proxy. The
758
757
  * problem might be a poorly constructed response, but it could also be a transient network
759
758
  * issue. If you see this error repeatedly, report it to the proxy vendor.</p>
759
+ * @public
760
760
  */
761
761
  export declare class XksProxyInvalidResponseException extends __BaseException {
762
762
  readonly name: "XksProxyInvalidResponseException";
@@ -767,10 +767,10 @@ export declare class XksProxyInvalidResponseException extends __BaseException {
767
767
  constructor(opts: __ExceptionOptionType<XksProxyInvalidResponseException, __BaseException>);
768
768
  }
769
769
  /**
770
- * @public
771
770
  * <p>The request was rejected because the <code>XksProxyUriEndpoint</code> is already
772
771
  * associated with another external key store in this Amazon Web Services Region. To identify the cause,
773
772
  * see the error message that accompanies the exception. </p>
773
+ * @public
774
774
  */
775
775
  export declare class XksProxyUriEndpointInUseException extends __BaseException {
776
776
  readonly name: "XksProxyUriEndpointInUseException";
@@ -781,11 +781,11 @@ export declare class XksProxyUriEndpointInUseException extends __BaseException {
781
781
  constructor(opts: __ExceptionOptionType<XksProxyUriEndpointInUseException, __BaseException>);
782
782
  }
783
783
  /**
784
- * @public
785
784
  * <p>The request was rejected because the concatenation of the <code>XksProxyUriEndpoint</code>
786
785
  * and <code>XksProxyUriPath</code> is already associated with another external key store in this
787
786
  * Amazon Web Services Region. Each external key store in a Region must use a unique external key store proxy
788
787
  * API address.</p>
788
+ * @public
789
789
  */
790
790
  export declare class XksProxyUriInUseException extends __BaseException {
791
791
  readonly name: "XksProxyUriInUseException";
@@ -796,12 +796,12 @@ export declare class XksProxyUriInUseException extends __BaseException {
796
796
  constructor(opts: __ExceptionOptionType<XksProxyUriInUseException, __BaseException>);
797
797
  }
798
798
  /**
799
- * @public
800
799
  * <p>KMS was unable to reach the specified <code>XksProxyUriPath</code>. The path must be
801
800
  * reachable before you create the external key store or update its settings.</p>
802
801
  * <p>This exception is also thrown when the external key store proxy response to a
803
802
  * <code>GetHealthStatus</code> request indicates that all external key manager instances are
804
803
  * unavailable.</p>
804
+ * @public
805
805
  */
806
806
  export declare class XksProxyUriUnreachableException extends __BaseException {
807
807
  readonly name: "XksProxyUriUnreachableException";
@@ -812,10 +812,10 @@ export declare class XksProxyUriUnreachableException extends __BaseException {
812
812
  constructor(opts: __ExceptionOptionType<XksProxyUriUnreachableException, __BaseException>);
813
813
  }
814
814
  /**
815
- * @public
816
815
  * <p>The request was rejected because the specified Amazon VPC endpoint service is already
817
816
  * associated with another external key store in this Amazon Web Services Region. Each external key store in a
818
817
  * Region must use a different Amazon VPC endpoint service.</p>
818
+ * @public
819
819
  */
820
820
  export declare class XksProxyVpcEndpointServiceInUseException extends __BaseException {
821
821
  readonly name: "XksProxyVpcEndpointServiceInUseException";
@@ -826,12 +826,12 @@ export declare class XksProxyVpcEndpointServiceInUseException extends __BaseExce
826
826
  constructor(opts: __ExceptionOptionType<XksProxyVpcEndpointServiceInUseException, __BaseException>);
827
827
  }
828
828
  /**
829
- * @public
830
829
  * <p>The request was rejected because the Amazon VPC endpoint service configuration does not fulfill
831
830
  * the requirements for an external key store. To identify the cause, see the error message that
832
831
  * accompanies the exception and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/vpc-connectivity.html#xks-vpc-requirements">review the
833
832
  * requirements</a> for Amazon VPC endpoint service connectivity for an external key
834
833
  * store.</p>
834
+ * @public
835
835
  */
836
836
  export declare class XksProxyVpcEndpointServiceInvalidConfigurationException extends __BaseException {
837
837
  readonly name: "XksProxyVpcEndpointServiceInvalidConfigurationException";
@@ -842,12 +842,12 @@ export declare class XksProxyVpcEndpointServiceInvalidConfigurationException ext
842
842
  constructor(opts: __ExceptionOptionType<XksProxyVpcEndpointServiceInvalidConfigurationException, __BaseException>);
843
843
  }
844
844
  /**
845
- * @public
846
845
  * <p>The request was rejected because KMS could not find the specified VPC endpoint service.
847
846
  * Use <a>DescribeCustomKeyStores</a> to verify the VPC endpoint service name for the
848
847
  * external key store. Also, confirm that the <code>Allow principals</code> list for the VPC
849
848
  * endpoint service includes the KMS service principal for the Region, such as
850
849
  * <code>cks.kms.us-east-1.amazonaws.com</code>.</p>
850
+ * @public
851
851
  */
852
852
  export declare class XksProxyVpcEndpointServiceNotFoundException extends __BaseException {
853
853
  readonly name: "XksProxyVpcEndpointServiceNotFoundException";
@@ -858,7 +858,6 @@ export declare class XksProxyVpcEndpointServiceNotFoundException extends __BaseE
858
858
  constructor(opts: __ExceptionOptionType<XksProxyVpcEndpointServiceNotFoundException, __BaseException>);
859
859
  }
860
860
  /**
861
- * @public
862
861
  * <p>Use this structure to allow <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> in the grant only when the operation request
863
862
  * includes the specified <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">encryption context</a>. </p>
864
863
  * <p>KMS applies the grant constraints only to cryptographic operations that support an
@@ -878,21 +877,22 @@ export declare class XksProxyVpcEndpointServiceNotFoundException extends __BaseE
878
877
  * <i>Key Management Service Developer Guide</i>
879
878
  * </i>.</p>
880
879
  * </important>
880
+ * @public
881
881
  */
882
882
  export interface GrantConstraints {
883
883
  /**
884
- * @public
885
884
  * <p>A list of key-value pairs that must be included in the encryption context of the
886
885
  * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operation</a> request. The grant allows the cryptographic operation only when the encryption
887
886
  * context in the request includes the key-value pairs specified in this constraint, although it
888
887
  * can include additional key-value pairs.</p>
888
+ * @public
889
889
  */
890
890
  EncryptionContextSubset?: Record<string, string>;
891
891
  /**
892
- * @public
893
892
  * <p>A list of key-value pairs that must match the encryption context in the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operation</a>
894
893
  * request. The grant allows the operation only when the encryption context in the request is the
895
894
  * same as the encryption context specified in this constraint.</p>
895
+ * @public
896
896
  */
897
897
  EncryptionContextEquals?: Record<string, string>;
898
898
  }
@@ -927,7 +927,6 @@ export type GrantOperation = (typeof GrantOperation)[keyof typeof GrantOperation
927
927
  */
928
928
  export interface CreateGrantRequest {
929
929
  /**
930
- * @public
931
930
  * <p>Identifies the KMS key for the grant. The grant gives principals permission to use this
932
931
  * KMS key.</p>
933
932
  * <p>Specify the key ID or key ARN of the KMS key. To specify a KMS key in a
@@ -944,10 +943,10 @@ export interface CreateGrantRequest {
944
943
  * </li>
945
944
  * </ul>
946
945
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
946
+ * @public
947
947
  */
948
948
  KeyId: string | undefined;
949
949
  /**
950
- * @public
951
950
  * <p>The identity that gets the permissions specified in the grant.</p>
952
951
  * <p>To specify the grantee principal, use the Amazon Resource Name (ARN) of an Amazon Web Services
953
952
  * principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles,
@@ -955,10 +954,10 @@ export interface CreateGrantRequest {
955
954
  * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM ARNs</a> in the <i>
956
955
  * <i>Identity and Access Management User Guide</i>
957
956
  * </i>.</p>
957
+ * @public
958
958
  */
959
959
  GranteePrincipal: string | undefined;
960
960
  /**
961
- * @public
962
961
  * <p>The principal that has permission to use the <a>RetireGrant</a> operation to
963
962
  * retire the grant. </p>
964
963
  * <p>To specify the principal, use the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of an
@@ -971,10 +970,10 @@ export interface CreateGrantRequest {
971
970
  * retire the grant or revoke the grant. For details, see <a>RevokeGrant</a> and
972
971
  * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete">Retiring and
973
972
  * revoking grants</a> in the <i>Key Management Service Developer Guide</i>. </p>
973
+ * @public
974
974
  */
975
975
  RetiringPrincipal?: string;
976
976
  /**
977
- * @public
978
977
  * <p>A list of operations that the grant permits. </p>
979
978
  * <p>This list must include only operations that are permitted in a grant. Also, the operation
980
979
  * must be supported on the KMS key. For example, you cannot create a grant for a symmetric
@@ -982,10 +981,10 @@ export interface CreateGrantRequest {
982
981
  * asymmetric KMS key that allows the <a>GenerateDataKey</a> operation. If you try,
983
982
  * KMS returns a <code>ValidationError</code> exception. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-grant-operations">Grant
984
983
  * operations</a> in the <i>Key Management Service Developer Guide</i>.</p>
984
+ * @public
985
985
  */
986
986
  Operations: GrantOperation[] | undefined;
987
987
  /**
988
- * @public
989
988
  * <p>Specifies a grant constraint.</p>
990
989
  * <important>
991
990
  * <p>Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p>
@@ -1012,17 +1011,17 @@ export interface CreateGrantRequest {
1012
1011
  * context</a> in the <i>
1013
1012
  * <i>Key Management Service Developer Guide</i>
1014
1013
  * </i>. </p>
1014
+ * @public
1015
1015
  */
1016
1016
  Constraints?: GrantConstraints;
1017
1017
  /**
1018
- * @public
1019
1018
  * <p>A list of grant tokens. </p>
1020
1019
  * <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
1021
1020
  * <i>Key Management Service Developer Guide</i>.</p>
1021
+ * @public
1022
1022
  */
1023
1023
  GrantTokens?: string[];
1024
1024
  /**
1025
- * @public
1026
1025
  * <p>A friendly name for the grant. Use this value to prevent the unintended creation of
1027
1026
  * duplicate grants when retrying this request.</p>
1028
1027
  * <important>
@@ -1036,12 +1035,13 @@ export interface CreateGrantRequest {
1036
1035
  * returned without creating a new grant. Note that the returned grant token is unique with every
1037
1036
  * <code>CreateGrant</code> request, even when a duplicate <code>GrantId</code> is returned.
1038
1037
  * All grant tokens for the same grant ID can be used interchangeably.</p>
1038
+ * @public
1039
1039
  */
1040
1040
  Name?: string;
1041
1041
  /**
1042
- * @public
1043
1042
  * <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
1044
1043
  * <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
1044
+ * @public
1045
1045
  */
1046
1046
  DryRun?: boolean;
1047
1047
  }
@@ -1050,22 +1050,22 @@ export interface CreateGrantRequest {
1050
1050
  */
1051
1051
  export interface CreateGrantResponse {
1052
1052
  /**
1053
- * @public
1054
1053
  * <p>The grant token.</p>
1055
1054
  * <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
1056
1055
  * <i>Key Management Service Developer Guide</i>.</p>
1056
+ * @public
1057
1057
  */
1058
1058
  GrantToken?: string;
1059
1059
  /**
1060
- * @public
1061
1060
  * <p>The unique identifier for the grant.</p>
1062
1061
  * <p>You can use the <code>GrantId</code> in a <a>ListGrants</a>, <a>RetireGrant</a>, or <a>RevokeGrant</a> operation.</p>
1062
+ * @public
1063
1063
  */
1064
1064
  GrantId?: string;
1065
1065
  }
1066
1066
  /**
1067
- * @public
1068
1067
  * <p>The request was rejected because the specified KMS key is not enabled.</p>
1068
+ * @public
1069
1069
  */
1070
1070
  export declare class DisabledException extends __BaseException {
1071
1071
  readonly name: "DisabledException";
@@ -1076,8 +1076,8 @@ export declare class DisabledException extends __BaseException {
1076
1076
  constructor(opts: __ExceptionOptionType<DisabledException, __BaseException>);
1077
1077
  }
1078
1078
  /**
1079
- * @public
1080
1079
  * <p> The request was rejected because the DryRun parameter was specified. </p>
1080
+ * @public
1081
1081
  */
1082
1082
  export declare class DryRunOperationException extends __BaseException {
1083
1083
  readonly name: "DryRunOperationException";
@@ -1088,8 +1088,8 @@ export declare class DryRunOperationException extends __BaseException {
1088
1088
  constructor(opts: __ExceptionOptionType<DryRunOperationException, __BaseException>);
1089
1089
  }
1090
1090
  /**
1091
- * @public
1092
1091
  * <p>The request was rejected because the specified grant token is not valid.</p>
1092
+ * @public
1093
1093
  */
1094
1094
  export declare class InvalidGrantTokenException extends __BaseException {
1095
1095
  readonly name: "InvalidGrantTokenException";
@@ -1173,7 +1173,6 @@ export declare const OriginType: {
1173
1173
  */
1174
1174
  export type OriginType = (typeof OriginType)[keyof typeof OriginType];
1175
1175
  /**
1176
- * @public
1177
1176
  * <p>A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are
1178
1177
  * both required, but tag values can be empty (null) strings.</p>
1179
1178
  * <important>
@@ -1181,16 +1180,17 @@ export type OriginType = (typeof OriginType)[keyof typeof OriginType];
1181
1180
  * </important>
1182
1181
  * <p>For information about the rules that apply to tag keys and tag values, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html">User-Defined Tag Restrictions</a> in the <i>Amazon Web Services Billing and Cost Management
1183
1182
  * User Guide</i>.</p>
1183
+ * @public
1184
1184
  */
1185
1185
  export interface Tag {
1186
1186
  /**
1187
- * @public
1188
1187
  * <p>The key of the tag.</p>
1188
+ * @public
1189
1189
  */
1190
1190
  TagKey: string | undefined;
1191
1191
  /**
1192
- * @public
1193
1192
  * <p>The value of the tag.</p>
1193
+ * @public
1194
1194
  */
1195
1195
  TagValue: string | undefined;
1196
1196
  }
@@ -1199,7 +1199,6 @@ export interface Tag {
1199
1199
  */
1200
1200
  export interface CreateKeyRequest {
1201
1201
  /**
1202
- * @public
1203
1202
  * <p>The key policy to attach to the KMS key.</p>
1204
1203
  * <p>If you provide a key policy, it must meet the following criteria:</p>
1205
1204
  * <ul>
@@ -1225,20 +1224,20 @@ export interface CreateKeyRequest {
1225
1224
  * <p>For help writing and formatting a JSON policy document, see the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html">IAM JSON Policy Reference</a> in the <i>
1226
1225
  * <i>Identity and Access Management User Guide</i>
1227
1226
  * </i>.</p>
1227
+ * @public
1228
1228
  */
1229
1229
  Policy?: string;
1230
1230
  /**
1231
- * @public
1232
1231
  * <p>A description of the KMS key. Use a description that helps you decide whether the KMS key
1233
1232
  * is appropriate for a task. The default value is an empty string (no description).</p>
1234
1233
  * <important>
1235
1234
  * <p>Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p>
1236
1235
  * </important>
1237
1236
  * <p>To set or change the description after the key is created, use <a>UpdateKeyDescription</a>.</p>
1237
+ * @public
1238
1238
  */
1239
1239
  Description?: string;
1240
1240
  /**
1241
- * @public
1242
1241
  * <p>Determines the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> for which you can use the KMS key. The default value is
1243
1242
  * <code>ENCRYPT_DECRYPT</code>. This parameter is optional when you are creating a symmetric
1244
1243
  * encryption KMS key; otherwise, it is required. You can't change the <code>KeyUsage</code>
@@ -1265,20 +1264,20 @@ export interface CreateKeyRequest {
1265
1264
  * <code>ENCRYPT_DECRYPT</code> or <code>SIGN_VERIFY</code>.</p>
1266
1265
  * </li>
1267
1266
  * </ul>
1267
+ * @public
1268
1268
  */
1269
1269
  KeyUsage?: KeyUsageType;
1270
1270
  /**
1271
- * @public
1272
1271
  * @deprecated
1273
1272
  *
1274
1273
  * <p>Instead, use the <code>KeySpec</code> parameter.</p>
1275
1274
  * <p>The <code>KeySpec</code> and <code>CustomerMasterKeySpec</code> parameters work the same
1276
1275
  * way. Only the names differ. We recommend that you use <code>KeySpec</code> parameter in your
1277
1276
  * code. However, to avoid breaking changes, KMS supports both parameters.</p>
1277
+ * @public
1278
1278
  */
1279
1279
  CustomerMasterKeySpec?: CustomerMasterKeySpec;
1280
1280
  /**
1281
- * @public
1282
1281
  * <p>Specifies the type of KMS key to create. The default value,
1283
1282
  * <code>SYMMETRIC_DEFAULT</code>, creates a KMS key with a 256-bit AES-GCM key that is used for
1284
1283
  * encryption and decryption, except in China Regions, where it creates a 128-bit symmetric key
@@ -1393,10 +1392,10 @@ export interface CreateKeyRequest {
1393
1392
  * </ul>
1394
1393
  * </li>
1395
1394
  * </ul>
1395
+ * @public
1396
1396
  */
1397
1397
  KeySpec?: KeySpec;
1398
1398
  /**
1399
- * @public
1400
1399
  * <p>The source of the key material for the KMS key. You cannot change the origin after you
1401
1400
  * create the KMS key. The default is <code>AWS_KMS</code>, which means that KMS creates the
1402
1401
  * key material.</p>
@@ -1416,10 +1415,10 @@ export interface CreateKeyRequest {
1416
1415
  * also use the <code>CustomKeyStoreId</code> parameter to identify the external key store and
1417
1416
  * the <code>XksKeyId</code> parameter to identify the associated external key. The
1418
1417
  * <code>KeySpec</code> value must be <code>SYMMETRIC_DEFAULT</code>.</p>
1418
+ * @public
1419
1419
  */
1420
1420
  Origin?: OriginType;
1421
1421
  /**
1422
- * @public
1423
1422
  * <p>Creates the KMS key in the specified <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. The <code>ConnectionState</code> of
1424
1423
  * the custom key store must be <code>CONNECTED</code>. To find the CustomKeyStoreID and
1425
1424
  * ConnectionState use the <a>DescribeCustomKeyStores</a> operation.</p>
@@ -1429,10 +1428,10 @@ export interface CreateKeyRequest {
1429
1428
  * symmetric key in its associated CloudHSM cluster and associates it with the KMS key. When you
1430
1429
  * create a KMS key in an external key store, you must use the <code>XksKeyId</code> parameter to
1431
1430
  * specify an external key that serves as key material for the KMS key.</p>
1431
+ * @public
1432
1432
  */
1433
1433
  CustomKeyStoreId?: string;
1434
1434
  /**
1435
- * @public
1436
1435
  * <p>Skips ("bypasses") the key policy lockout safety check. The default value is false.</p>
1437
1436
  * <important>
1438
1437
  * <p>Setting this value to true increases the risk that the KMS key becomes unmanageable. Do
@@ -1442,10 +1441,10 @@ export interface CreateKeyRequest {
1442
1441
  * <p>Use this parameter only when you intend to prevent the principal that is making the
1443
1442
  * request from making a subsequent <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html">PutKeyPolicy</a>
1444
1443
  * request on the KMS key.</p>
1444
+ * @public
1445
1445
  */
1446
1446
  BypassPolicyLockoutSafetyCheck?: boolean;
1447
1447
  /**
1448
- * @public
1449
1448
  * <p>Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is
1450
1449
  * created. To tag an existing KMS key, use the <a>TagResource</a> operation.</p>
1451
1450
  * <important>
@@ -1462,10 +1461,10 @@ export interface CreateKeyRequest {
1462
1461
  * <p>When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation
1463
1462
  * report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details,
1464
1463
  * see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">Tagging Keys</a>.</p>
1464
+ * @public
1465
1465
  */
1466
1466
  Tags?: Tag[];
1467
1467
  /**
1468
- * @public
1469
1468
  * <p>Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You
1470
1469
  * cannot change this value after you create the KMS key. </p>
1471
1470
  * <p>For a multi-Region key, set this parameter to <code>True</code>. For a single-Region KMS
@@ -1480,10 +1479,10 @@ export interface CreateKeyRequest {
1480
1479
  * <p>You can create a symmetric or asymmetric multi-Region key, and you can create a
1481
1480
  * multi-Region key with imported key material. However, you cannot create a multi-Region key in
1482
1481
  * a custom key store.</p>
1482
+ * @public
1483
1483
  */
1484
1484
  MultiRegion?: boolean;
1485
1485
  /**
1486
- * @public
1487
1486
  * <p>Identifies the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key">external key</a> that
1488
1487
  * serves as key material for the KMS key in an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html">external key store</a>. Specify the ID that
1489
1488
  * the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-xks-proxy">external key store proxy</a> uses to refer to the external key. For help, see the
@@ -1504,6 +1503,7 @@ export interface CreateKeyRequest {
1504
1503
  * specified external key, a process known as <i>double encryption</i>. For
1505
1504
  * details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-double-encryption">Double
1506
1505
  * encryption</a> in the <i>Key Management Service Developer Guide</i>.</p>
1506
+ * @public
1507
1507
  */
1508
1508
  XksKeyId?: string;
1509
1509
  }
@@ -1590,45 +1590,45 @@ export declare const MultiRegionKeyType: {
1590
1590
  */
1591
1591
  export type MultiRegionKeyType = (typeof MultiRegionKeyType)[keyof typeof MultiRegionKeyType];
1592
1592
  /**
1593
- * @public
1594
1593
  * <p>Describes the primary or replica key in a multi-Region key.</p>
1594
+ * @public
1595
1595
  */
1596
1596
  export interface MultiRegionKey {
1597
1597
  /**
1598
- * @public
1599
1598
  * <p>Displays the key ARN of a primary or replica key of a multi-Region key.</p>
1599
+ * @public
1600
1600
  */
1601
1601
  Arn?: string;
1602
1602
  /**
1603
- * @public
1604
1603
  * <p>Displays the Amazon Web Services Region of a primary or replica key in a multi-Region key.</p>
1604
+ * @public
1605
1605
  */
1606
1606
  Region?: string;
1607
1607
  }
1608
1608
  /**
1609
- * @public
1610
1609
  * <p>Describes the configuration of this multi-Region key. This field appears only when the KMS
1611
1610
  * key is a primary or replica of a multi-Region key.</p>
1612
1611
  * <p>For more information about any listed KMS key, use the <a>DescribeKey</a>
1613
1612
  * operation.</p>
1613
+ * @public
1614
1614
  */
1615
1615
  export interface MultiRegionConfiguration {
1616
1616
  /**
1617
- * @public
1618
1617
  * <p>Indicates whether the KMS key is a <code>PRIMARY</code> or <code>REPLICA</code>
1619
1618
  * key.</p>
1619
+ * @public
1620
1620
  */
1621
1621
  MultiRegionKeyType?: MultiRegionKeyType;
1622
1622
  /**
1623
- * @public
1624
1623
  * <p>Displays the key ARN and Region of the primary key. This field includes the current KMS
1625
1624
  * key if it is the primary key.</p>
1625
+ * @public
1626
1626
  */
1627
1627
  PrimaryKey?: MultiRegionKey;
1628
1628
  /**
1629
- * @public
1630
1629
  * <p>displays the key ARNs and Regions of all replica keys. This field includes the current KMS
1631
1630
  * key if it is a replica key.</p>
1631
+ * @public
1632
1632
  */
1633
1633
  ReplicaKeys?: MultiRegionKey[];
1634
1634
  }
@@ -1653,7 +1653,6 @@ export declare const SigningAlgorithmSpec: {
1653
1653
  */
1654
1654
  export type SigningAlgorithmSpec = (typeof SigningAlgorithmSpec)[keyof typeof SigningAlgorithmSpec];
1655
1655
  /**
1656
- * @public
1657
1656
  * <p>Information about the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key">external key </a>that is
1658
1657
  * associated with a KMS key in an external key store. </p>
1659
1658
  * <p>This element appears in a <a>CreateKey</a> or <a>DescribeKey</a>
@@ -1663,159 +1662,159 @@ export type SigningAlgorithmSpec = (typeof SigningAlgorithmSpec)[keyof typeof Si
1663
1662
  * cryptographic operation, the cryptographic operation is performed in the external key manager
1664
1663
  * using the specified external key. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key">External key</a> in the
1665
1664
  * <i>Key Management Service Developer Guide</i>.</p>
1665
+ * @public
1666
1666
  */
1667
1667
  export interface XksKeyConfigurationType {
1668
1668
  /**
1669
- * @public
1670
1669
  * <p>The ID of the external key in its external key manager. This is the ID that the external
1671
1670
  * key store proxy uses to identify the external key.</p>
1671
+ * @public
1672
1672
  */
1673
1673
  Id?: string;
1674
1674
  }
1675
1675
  /**
1676
- * @public
1677
1676
  * <p>Contains metadata about a KMS key.</p>
1678
1677
  * <p>This data type is used as a response element for the <a>CreateKey</a>, <a>DescribeKey</a>, and <a>ReplicateKey</a> operations.</p>
1678
+ * @public
1679
1679
  */
1680
1680
  export interface KeyMetadata {
1681
1681
  /**
1682
- * @public
1683
1682
  * <p>The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.</p>
1683
+ * @public
1684
1684
  */
1685
1685
  AWSAccountId?: string;
1686
1686
  /**
1687
- * @public
1688
1687
  * <p>The globally unique identifier for the KMS key.</p>
1688
+ * @public
1689
1689
  */
1690
1690
  KeyId: string | undefined;
1691
1691
  /**
1692
- * @public
1693
1692
  * <p>The Amazon Resource Name (ARN) of the KMS key. For examples, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms">Key Management Service (KMS)</a> in the Example ARNs section of the <i>Amazon Web Services General
1694
1693
  * Reference</i>.</p>
1694
+ * @public
1695
1695
  */
1696
1696
  Arn?: string;
1697
1697
  /**
1698
- * @public
1699
1698
  * <p>The date and time when the KMS key was created.</p>
1699
+ * @public
1700
1700
  */
1701
1701
  CreationDate?: Date;
1702
1702
  /**
1703
- * @public
1704
1703
  * <p>Specifies whether the KMS key is enabled. When <code>KeyState</code> is
1705
1704
  * <code>Enabled</code> this value is true, otherwise it is false.</p>
1705
+ * @public
1706
1706
  */
1707
1707
  Enabled?: boolean;
1708
1708
  /**
1709
- * @public
1710
1709
  * <p>The description of the KMS key.</p>
1710
+ * @public
1711
1711
  */
1712
1712
  Description?: string;
1713
1713
  /**
1714
- * @public
1715
1714
  * <p>The <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> for which you can use the KMS key.</p>
1715
+ * @public
1716
1716
  */
1717
1717
  KeyUsage?: KeyUsageType;
1718
1718
  /**
1719
- * @public
1720
1719
  * <p>The current status of the KMS key.</p>
1721
1720
  * <p>For more information about how key state affects the use of a KMS key, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in
1722
1721
  * the <i>Key Management Service Developer Guide</i>.</p>
1722
+ * @public
1723
1723
  */
1724
1724
  KeyState?: KeyState;
1725
1725
  /**
1726
- * @public
1727
1726
  * <p>The date and time after which KMS deletes this KMS key. This value is present only when
1728
1727
  * the KMS key is scheduled for deletion, that is, when its <code>KeyState</code> is
1729
1728
  * <code>PendingDeletion</code>.</p>
1730
1729
  * <p>When the primary key in a multi-Region key is scheduled for deletion but still has replica
1731
1730
  * keys, its key state is <code>PendingReplicaDeletion</code> and the length of its waiting
1732
1731
  * period is displayed in the <code>PendingDeletionWindowInDays</code> field.</p>
1732
+ * @public
1733
1733
  */
1734
1734
  DeletionDate?: Date;
1735
1735
  /**
1736
- * @public
1737
1736
  * <p>The time at which the imported key material expires. When the key material expires, KMS
1738
1737
  * deletes the key material and the KMS key becomes unusable. This value is present only for KMS
1739
1738
  * keys whose <code>Origin</code> is <code>EXTERNAL</code> and whose <code>ExpirationModel</code>
1740
1739
  * is <code>KEY_MATERIAL_EXPIRES</code>, otherwise this value is omitted.</p>
1740
+ * @public
1741
1741
  */
1742
1742
  ValidTo?: Date;
1743
1743
  /**
1744
- * @public
1745
1744
  * <p>The source of the key material for the KMS key. When this value is <code>AWS_KMS</code>,
1746
1745
  * KMS created the key material. When this value is <code>EXTERNAL</code>, the key material was
1747
1746
  * imported or the KMS key doesn't have any key material. When this value is
1748
1747
  * <code>AWS_CLOUDHSM</code>, the key material was created in the CloudHSM cluster associated with
1749
1748
  * a custom key store.</p>
1749
+ * @public
1750
1750
  */
1751
1751
  Origin?: OriginType;
1752
1752
  /**
1753
- * @public
1754
1753
  * <p>A unique identifier for the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> that contains the KMS key. This field is
1755
1754
  * present only when the KMS key is created in a custom key store.</p>
1755
+ * @public
1756
1756
  */
1757
1757
  CustomKeyStoreId?: string;
1758
1758
  /**
1759
- * @public
1760
1759
  * <p>The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When
1761
1760
  * you create a KMS key in an CloudHSM <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>, KMS creates the key material for the KMS
1762
1761
  * key in the associated CloudHSM cluster. This field is present only when the KMS key is created in
1763
1762
  * an CloudHSM key store.</p>
1763
+ * @public
1764
1764
  */
1765
1765
  CloudHsmClusterId?: string;
1766
1766
  /**
1767
- * @public
1768
1767
  * <p>Specifies whether the KMS key's key material expires. This value is present only when
1769
1768
  * <code>Origin</code> is <code>EXTERNAL</code>, otherwise this value is omitted.</p>
1769
+ * @public
1770
1770
  */
1771
1771
  ExpirationModel?: ExpirationModelType;
1772
1772
  /**
1773
- * @public
1774
1773
  * <p>The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or
1775
1774
  * Amazon Web Services managed. For more information about the difference, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys">KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
1775
+ * @public
1776
1776
  */
1777
1777
  KeyManager?: KeyManagerType;
1778
1778
  /**
1779
- * @public
1780
1779
  * @deprecated
1781
1780
  *
1782
1781
  * <p>Instead, use the <code>KeySpec</code> field.</p>
1783
1782
  * <p>The <code>KeySpec</code> and <code>CustomerMasterKeySpec</code> fields have the same
1784
1783
  * value. We recommend that you use the <code>KeySpec</code> field in your code. However, to
1785
1784
  * avoid breaking changes, KMS supports both fields.</p>
1785
+ * @public
1786
1786
  */
1787
1787
  CustomerMasterKeySpec?: CustomerMasterKeySpec;
1788
1788
  /**
1789
- * @public
1790
1789
  * <p>Describes the type of key material in the KMS key.</p>
1790
+ * @public
1791
1791
  */
1792
1792
  KeySpec?: KeySpec;
1793
1793
  /**
1794
- * @public
1795
1794
  * <p>The encryption algorithms that the KMS key supports. You cannot use the KMS key with other
1796
1795
  * encryption algorithms within KMS.</p>
1797
1796
  * <p>This value is present only when the <code>KeyUsage</code> of the KMS key is
1798
1797
  * <code>ENCRYPT_DECRYPT</code>.</p>
1798
+ * @public
1799
1799
  */
1800
1800
  EncryptionAlgorithms?: EncryptionAlgorithmSpec[];
1801
1801
  /**
1802
- * @public
1803
1802
  * <p>The signing algorithms that the KMS key supports. You cannot use the KMS key with other
1804
1803
  * signing algorithms within KMS.</p>
1805
1804
  * <p>This field appears only when the <code>KeyUsage</code> of the KMS key is
1806
1805
  * <code>SIGN_VERIFY</code>.</p>
1806
+ * @public
1807
1807
  */
1808
1808
  SigningAlgorithms?: SigningAlgorithmSpec[];
1809
1809
  /**
1810
- * @public
1811
1810
  * <p>Indicates whether the KMS key is a multi-Region (<code>True</code>) or regional
1812
1811
  * (<code>False</code>) key. This value is <code>True</code> for multi-Region primary and
1813
1812
  * replica keys and <code>False</code> for regional KMS keys.</p>
1814
1813
  * <p>For more information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Multi-Region keys in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
1814
+ * @public
1815
1815
  */
1816
1816
  MultiRegion?: boolean;
1817
1817
  /**
1818
- * @public
1819
1818
  * <p>Lists the primary and replica keys in same multi-Region key. This field is present only
1820
1819
  * when the value of the <code>MultiRegion</code> field is <code>True</code>.</p>
1821
1820
  * <p>For more information about any listed KMS key, use the <a>DescribeKey</a>
@@ -1837,10 +1836,10 @@ export interface KeyMetadata {
1837
1836
  * field includes the current KMS key if it is a replica key.</p>
1838
1837
  * </li>
1839
1838
  * </ul>
1839
+ * @public
1840
1840
  */
1841
1841
  MultiRegionConfiguration?: MultiRegionConfiguration;
1842
1842
  /**
1843
- * @public
1844
1843
  * <p>The waiting period before the primary key in a multi-Region key is deleted. This waiting
1845
1844
  * period begins when the last of its replica keys is deleted. This value is present only when
1846
1845
  * the <code>KeyState</code> of the KMS key is <code>PendingReplicaDeletion</code>. That
@@ -1853,21 +1852,22 @@ export interface KeyMetadata {
1853
1852
  * replica key in the multi-Region key is deleted, the <code>KeyState</code> of the scheduled
1854
1853
  * primary key changes from <code>PendingReplicaDeletion</code> to <code>PendingDeletion</code>
1855
1854
  * and the deletion date appears in the <code>DeletionDate</code> field.</p>
1855
+ * @public
1856
1856
  */
1857
1857
  PendingDeletionWindowInDays?: number;
1858
1858
  /**
1859
- * @public
1860
1859
  * <p>The message authentication code (MAC) algorithm that the HMAC KMS key supports.</p>
1861
1860
  * <p>This value is present only when the <code>KeyUsage</code> of the KMS key is
1862
1861
  * <code>GENERATE_VERIFY_MAC</code>.</p>
1862
+ * @public
1863
1863
  */
1864
1864
  MacAlgorithms?: MacAlgorithmSpec[];
1865
1865
  /**
1866
- * @public
1867
1866
  * <p>Information about the external key that is associated with a KMS key in an external key
1868
1867
  * store.</p>
1869
1868
  * <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key">External key</a> in the
1870
1869
  * <i>Key Management Service Developer Guide</i>.</p>
1870
+ * @public
1871
1871
  */
1872
1872
  XksKeyConfiguration?: XksKeyConfigurationType;
1873
1873
  }
@@ -1876,15 +1876,15 @@ export interface KeyMetadata {
1876
1876
  */
1877
1877
  export interface CreateKeyResponse {
1878
1878
  /**
1879
- * @public
1880
1879
  * <p>Metadata associated with the KMS key.</p>
1880
+ * @public
1881
1881
  */
1882
1882
  KeyMetadata?: KeyMetadata;
1883
1883
  }
1884
1884
  /**
1885
- * @public
1886
1885
  * <p>The request was rejected because the specified policy is not syntactically or semantically
1887
1886
  * correct.</p>
1887
+ * @public
1888
1888
  */
1889
1889
  export declare class MalformedPolicyDocumentException extends __BaseException {
1890
1890
  readonly name: "MalformedPolicyDocumentException";
@@ -1895,8 +1895,8 @@ export declare class MalformedPolicyDocumentException extends __BaseException {
1895
1895
  constructor(opts: __ExceptionOptionType<MalformedPolicyDocumentException, __BaseException>);
1896
1896
  }
1897
1897
  /**
1898
- * @public
1899
1898
  * <p>The request was rejected because one or more tags are not valid.</p>
1899
+ * @public
1900
1900
  */
1901
1901
  export declare class TagException extends __BaseException {
1902
1902
  readonly name: "TagException";
@@ -1907,9 +1907,9 @@ export declare class TagException extends __BaseException {
1907
1907
  constructor(opts: __ExceptionOptionType<TagException, __BaseException>);
1908
1908
  }
1909
1909
  /**
1910
- * @public
1911
1910
  * <p>The request was rejected because a specified parameter is not supported or a specified
1912
1911
  * resource is not valid for this operation.</p>
1912
+ * @public
1913
1913
  */
1914
1914
  export declare class UnsupportedOperationException extends __BaseException {
1915
1915
  readonly name: "UnsupportedOperationException";
@@ -1920,10 +1920,10 @@ export declare class UnsupportedOperationException extends __BaseException {
1920
1920
  constructor(opts: __ExceptionOptionType<UnsupportedOperationException, __BaseException>);
1921
1921
  }
1922
1922
  /**
1923
- * @public
1924
1923
  * <p>The request was rejected because the (<code>XksKeyId</code>) is already associated with
1925
1924
  * another KMS key in this external key store. Each KMS key in an external key store must be
1926
1925
  * associated with a different external key.</p>
1926
+ * @public
1927
1927
  */
1928
1928
  export declare class XksKeyAlreadyInUseException extends __BaseException {
1929
1929
  readonly name: "XksKeyAlreadyInUseException";
@@ -1934,11 +1934,11 @@ export declare class XksKeyAlreadyInUseException extends __BaseException {
1934
1934
  constructor(opts: __ExceptionOptionType<XksKeyAlreadyInUseException, __BaseException>);
1935
1935
  }
1936
1936
  /**
1937
- * @public
1938
1937
  * <p>The request was rejected because the external key specified by the <code>XksKeyId</code>
1939
1938
  * parameter did not meet the configuration requirements for an external key store.</p>
1940
1939
  * <p>The external key must be an AES-256 symmetric key that is enabled and performs encryption
1941
1940
  * and decryption.</p>
1941
+ * @public
1942
1942
  */
1943
1943
  export declare class XksKeyInvalidConfigurationException extends __BaseException {
1944
1944
  readonly name: "XksKeyInvalidConfigurationException";
@@ -1949,7 +1949,6 @@ export declare class XksKeyInvalidConfigurationException extends __BaseException
1949
1949
  constructor(opts: __ExceptionOptionType<XksKeyInvalidConfigurationException, __BaseException>);
1950
1950
  }
1951
1951
  /**
1952
- * @public
1953
1952
  * <p>The request was rejected because the external key store proxy could not find the external
1954
1953
  * key. This exception is thrown when the value of the <code>XksKeyId</code> parameter doesn't
1955
1954
  * identify a key in the external key manager associated with the external key proxy.</p>
@@ -1957,6 +1956,7 @@ export declare class XksKeyInvalidConfigurationException extends __BaseException
1957
1956
  * manager. Use the key identifier that the external key store proxy uses to identify the key.
1958
1957
  * For details, see the documentation provided with your external key store proxy or key
1959
1958
  * manager.</p>
1959
+ * @public
1960
1960
  */
1961
1961
  export declare class XksKeyNotFoundException extends __BaseException {
1962
1962
  readonly name: "XksKeyNotFoundException";
@@ -1967,11 +1967,11 @@ export declare class XksKeyNotFoundException extends __BaseException {
1967
1967
  constructor(opts: __ExceptionOptionType<XksKeyNotFoundException, __BaseException>);
1968
1968
  }
1969
1969
  /**
1970
- * @public
1971
1970
  * <p>The request was rejected because the custom key store contains KMS keys. After verifying
1972
1971
  * that you do not need to use the KMS keys, use the <a>ScheduleKeyDeletion</a>
1973
1972
  * operation to delete the KMS keys. After they are deleted, you can delete the custom key
1974
1973
  * store.</p>
1974
+ * @public
1975
1975
  */
1976
1976
  export declare class CustomKeyStoreHasCMKsException extends __BaseException {
1977
1977
  readonly name: "CustomKeyStoreHasCMKsException";
@@ -1982,80 +1982,79 @@ export declare class CustomKeyStoreHasCMKsException extends __BaseException {
1982
1982
  constructor(opts: __ExceptionOptionType<CustomKeyStoreHasCMKsException, __BaseException>);
1983
1983
  }
1984
1984
  /**
1985
- * @public
1986
1985
  * <p>Detailed information about the external key store proxy (XKS proxy). Your external key
1987
1986
  * store proxy translates KMS requests into a format that your external key manager can
1988
1987
  * understand. These fields appear in a <a>DescribeCustomKeyStores</a> response only
1989
1988
  * when the <code>CustomKeyStoreType</code> is <code>EXTERNAL_KEY_STORE</code>.</p>
1989
+ * @public
1990
1990
  */
1991
1991
  export interface XksProxyConfigurationType {
1992
1992
  /**
1993
- * @public
1994
1993
  * <p>Indicates whether the external key store proxy uses a public endpoint or an Amazon VPC endpoint
1995
1994
  * service to communicate with KMS.</p>
1995
+ * @public
1996
1996
  */
1997
1997
  Connectivity?: XksProxyConnectivityType;
1998
1998
  /**
1999
- * @public
2000
1999
  * <p>The part of the external key store <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateCustomKeyStore.html#KMS-CreateCustomKeyStore-request-XksProxyAuthenticationCredential">proxy authentication credential</a> that uniquely identifies the secret access
2001
2000
  * key.</p>
2001
+ * @public
2002
2002
  */
2003
2003
  AccessKeyId?: string;
2004
2004
  /**
2005
- * @public
2006
2005
  * <p>The URI endpoint for the external key store proxy.</p>
2007
2006
  * <p>If the external key store proxy has a public endpoint, it is displayed here.</p>
2008
2007
  * <p>If the external key store proxy uses an Amazon VPC endpoint service name, this field displays
2009
2008
  * the private DNS name associated with the VPC endpoint service.</p>
2009
+ * @public
2010
2010
  */
2011
2011
  UriEndpoint?: string;
2012
2012
  /**
2013
- * @public
2014
2013
  * <p>The path to the external key store proxy APIs.</p>
2014
+ * @public
2015
2015
  */
2016
2016
  UriPath?: string;
2017
2017
  /**
2018
- * @public
2019
2018
  * <p>The Amazon VPC endpoint service used to communicate with the external key store proxy. This
2020
2019
  * field appears only when the external key store proxy uses an Amazon VPC endpoint service to
2021
2020
  * communicate with KMS.</p>
2021
+ * @public
2022
2022
  */
2023
2023
  VpcEndpointServiceName?: string;
2024
2024
  }
2025
2025
  /**
2026
- * @public
2027
2026
  * <p>Contains information about each custom key store in the custom key store list.</p>
2027
+ * @public
2028
2028
  */
2029
2029
  export interface CustomKeyStoresListEntry {
2030
2030
  /**
2031
- * @public
2032
2031
  * <p>A unique identifier for the custom key store.</p>
2032
+ * @public
2033
2033
  */
2034
2034
  CustomKeyStoreId?: string;
2035
2035
  /**
2036
- * @public
2037
2036
  * <p>The user-specified friendly name for the custom key store.</p>
2037
+ * @public
2038
2038
  */
2039
2039
  CustomKeyStoreName?: string;
2040
2040
  /**
2041
- * @public
2042
2041
  * <p>A unique identifier for the CloudHSM cluster that is associated with an CloudHSM key store. This
2043
2042
  * field appears only when the <code>CustomKeyStoreType</code> is
2044
2043
  * <code>AWS_CLOUDHSM</code>.</p>
2044
+ * @public
2045
2045
  */
2046
2046
  CloudHsmClusterId?: string;
2047
2047
  /**
2048
- * @public
2049
2048
  * <p>The trust anchor certificate of the CloudHSM cluster associated with an CloudHSM key store. When
2050
2049
  * you <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr">initialize
2051
2050
  * the cluster</a>, you create this certificate and save it in the
2052
2051
  * <code>customerCA.crt</code> file.</p>
2053
2052
  * <p>This field appears only when the <code>CustomKeyStoreType</code> is
2054
2053
  * <code>AWS_CLOUDHSM</code>.</p>
2054
+ * @public
2055
2055
  */
2056
2056
  TrustAnchorCertificate?: string;
2057
2057
  /**
2058
- * @public
2059
2058
  * <p>Indicates whether the custom key store is connected to its backing key store. For an CloudHSM
2060
2059
  * key store, the <code>ConnectionState</code> indicates whether it is connected to its CloudHSM
2061
2060
  * cluster. For an external key store, the <code>ConnectionState</code> indicates whether it is
@@ -2074,10 +2073,10 @@ export interface CustomKeyStoresListEntry {
2074
2073
  * <code>ConnectionErrorCode</code> field in the response indicates the cause of the failure.
2075
2074
  * For help resolving a connection failure, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html">Troubleshooting a custom key store</a> in the
2076
2075
  * <i>Key Management Service Developer Guide</i>.</p>
2076
+ * @public
2077
2077
  */
2078
2078
  ConnectionState?: ConnectionStateType;
2079
2079
  /**
2080
- * @public
2081
2080
  * <p>Describes the connection error. This field appears in the response only when the
2082
2081
  * <code>ConnectionState</code> is <code>FAILED</code>.</p>
2083
2082
  * <p>Many failures can be resolved by updating the properties of the custom key store. To
@@ -2261,28 +2260,29 @@ export interface CustomKeyStoresListEntry {
2261
2260
  * principal has service consumer permissions on the Amazon VPC endpoint service.</p>
2262
2261
  * </li>
2263
2262
  * </ul>
2263
+ * @public
2264
2264
  */
2265
2265
  ConnectionErrorCode?: ConnectionErrorCodeType;
2266
2266
  /**
2267
- * @public
2268
2267
  * <p>The date and time when the custom key store was created.</p>
2268
+ * @public
2269
2269
  */
2270
2270
  CreationDate?: Date;
2271
2271
  /**
2272
- * @public
2273
2272
  * <p>Indicates the type of the custom key store. <code>AWS_CLOUDHSM</code> indicates a custom
2274
2273
  * key store backed by an CloudHSM cluster. <code>EXTERNAL_KEY_STORE</code> indicates a custom key
2275
2274
  * store backed by an external key store proxy and external key manager outside of Amazon Web Services.</p>
2275
+ * @public
2276
2276
  */
2277
2277
  CustomKeyStoreType?: CustomKeyStoreType;
2278
2278
  /**
2279
- * @public
2280
2279
  * <p>Configuration settings for the external key store proxy (XKS proxy). The external key
2281
2280
  * store proxy translates KMS requests into a format that your external key manager can
2282
2281
  * understand. The proxy configuration includes connection information that KMS
2283
2282
  * requires.</p>
2284
2283
  * <p>This field appears only when the <code>CustomKeyStoreType</code> is
2285
2284
  * <code>EXTERNAL_KEY_STORE</code>.</p>
2285
+ * @public
2286
2286
  */
2287
2287
  XksProxyConfiguration?: XksProxyConfigurationType;
2288
2288
  }
@@ -2328,24 +2328,24 @@ export declare const KeyEncryptionMechanism: {
2328
2328
  */
2329
2329
  export type KeyEncryptionMechanism = (typeof KeyEncryptionMechanism)[keyof typeof KeyEncryptionMechanism];
2330
2330
  /**
2331
- * @public
2332
2331
  * <p>Contains information about the party that receives the response from the API
2333
2332
  * operation.</p>
2334
2333
  * <p>This data type is designed to support Amazon Web Services Nitro Enclaves, which lets you create an isolated
2335
2334
  * compute environment in Amazon EC2. 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>
2335
+ * @public
2336
2336
  */
2337
2337
  export interface RecipientInfo {
2338
2338
  /**
2339
- * @public
2340
2339
  * <p>The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro
2341
2340
  * Enclave to encrypt plaintext values for the response. The only valid value is
2342
2341
  * <code>RSAES_OAEP_SHA_256</code>.</p>
2342
+ * @public
2343
2343
  */
2344
2344
  KeyEncryptionAlgorithm?: KeyEncryptionMechanism;
2345
2345
  /**
2346
- * @public
2347
2346
  * <p>The attestation document for an Amazon Web Services Nitro Enclave. This document includes the enclave's
2348
2347
  * public key.</p>
2348
+ * @public
2349
2349
  */
2350
2350
  AttestationDocument?: Uint8Array;
2351
2351
  }
@@ -2354,12 +2354,11 @@ export interface RecipientInfo {
2354
2354
  */
2355
2355
  export interface DecryptRequest {
2356
2356
  /**
2357
- * @public
2358
2357
  * <p>Ciphertext to be decrypted. The blob includes metadata.</p>
2358
+ * @public
2359
2359
  */
2360
2360
  CiphertextBlob: Uint8Array | undefined;
2361
2361
  /**
2362
- * @public
2363
2362
  * <p>Specifies the encryption context to use when decrypting the data.
2364
2363
  * An encryption context is valid only for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.</p>
2365
2364
  * <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represent additional authenticated data.
@@ -2367,17 +2366,17 @@ export interface DecryptRequest {
2367
2366
  * only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.</p>
2368
2367
  * <p>For more information, see
2369
2368
  * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption context</a> in the <i>Key Management Service Developer Guide</i>.</p>
2369
+ * @public
2370
2370
  */
2371
2371
  EncryptionContext?: Record<string, string>;
2372
2372
  /**
2373
- * @public
2374
2373
  * <p>A list of grant tokens. </p>
2375
2374
  * <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
2376
2375
  * <i>Key Management Service Developer Guide</i>.</p>
2376
+ * @public
2377
2377
  */
2378
2378
  GrantTokens?: string[];
2379
2379
  /**
2380
- * @public
2381
2380
  * <p>Specifies the KMS key that KMS uses to decrypt the ciphertext.</p>
2382
2381
  * <p>Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a
2383
2382
  * different KMS key, the <code>Decrypt</code> operation throws an
@@ -2407,20 +2406,20 @@ export interface DecryptRequest {
2407
2406
  * </li>
2408
2407
  * </ul>
2409
2408
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>
2409
+ * @public
2410
2410
  */
2411
2411
  KeyId?: string;
2412
2412
  /**
2413
- * @public
2414
2413
  * <p>Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify
2415
2414
  * the same algorithm that was used to encrypt the data. If you specify a different algorithm,
2416
2415
  * the <code>Decrypt</code> operation fails.</p>
2417
2416
  * <p>This parameter is required only when the ciphertext was encrypted under an asymmetric KMS
2418
2417
  * key. The default value, <code>SYMMETRIC_DEFAULT</code>, represents the only supported
2419
2418
  * algorithm that is valid for symmetric encryption KMS keys.</p>
2419
+ * @public
2420
2420
  */
2421
2421
  EncryptionAlgorithm?: EncryptionAlgorithmSpec;
2422
2422
  /**
2423
- * @public
2424
2423
  * <p>A signed <a href="https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-concepts.html#term-attestdoc">attestation
2425
2424
  * document</a> from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the
2426
2425
  * enclave's public key. The only valid encryption algorithm is <code>RSAES_OAEP_SHA_256</code>. </p>
@@ -2432,12 +2431,13 @@ export interface DecryptRequest {
2432
2431
  * can be decrypted only with the private key in the enclave. The <code>Plaintext</code> field in
2433
2432
  * the response is null or empty.</p>
2434
2433
  * <p>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>
2434
+ * @public
2435
2435
  */
2436
2436
  Recipient?: RecipientInfo;
2437
2437
  /**
2438
- * @public
2439
2438
  * <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
2440
2439
  * <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
2440
+ * @public
2441
2441
  */
2442
2442
  DryRun?: boolean;
2443
2443
  }
@@ -2446,37 +2446,37 @@ export interface DecryptRequest {
2446
2446
  */
2447
2447
  export interface DecryptResponse {
2448
2448
  /**
2449
- * @public
2450
2449
  * <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the KMS key that was used to decrypt the ciphertext.</p>
2450
+ * @public
2451
2451
  */
2452
2452
  KeyId?: string;
2453
2453
  /**
2454
- * @public
2455
2454
  * <p>Decrypted plaintext data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
2456
2455
  * <p>If the response includes the <code>CiphertextForRecipient</code> field, the
2457
2456
  * <code>Plaintext</code> field is null or empty.</p>
2457
+ * @public
2458
2458
  */
2459
2459
  Plaintext?: Uint8Array;
2460
2460
  /**
2461
- * @public
2462
2461
  * <p>The encryption algorithm that was used to decrypt the ciphertext.</p>
2462
+ * @public
2463
2463
  */
2464
2464
  EncryptionAlgorithm?: EncryptionAlgorithmSpec;
2465
2465
  /**
2466
- * @public
2467
2466
  * <p>The plaintext data encrypted with the public key in the attestation document. </p>
2468
2467
  * <p>This field is included in the response only when the <code>Recipient</code> parameter in
2469
2468
  * the request includes a valid attestation document from an Amazon Web Services Nitro enclave.
2470
2469
  * 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>
2470
+ * @public
2471
2471
  */
2472
2472
  CiphertextForRecipient?: Uint8Array;
2473
2473
  }
2474
2474
  /**
2475
- * @public
2476
2475
  * <p>The request was rejected because the specified KMS key cannot decrypt the data. The
2477
2476
  * <code>KeyId</code> in a <a>Decrypt</a> request and the <code>SourceKeyId</code>
2478
2477
  * in a <a>ReEncrypt</a> request must identify the same KMS key that was used to
2479
2478
  * encrypt the ciphertext.</p>
2479
+ * @public
2480
2480
  */
2481
2481
  export declare class IncorrectKeyException extends __BaseException {
2482
2482
  readonly name: "IncorrectKeyException";
@@ -2487,13 +2487,13 @@ export declare class IncorrectKeyException extends __BaseException {
2487
2487
  constructor(opts: __ExceptionOptionType<IncorrectKeyException, __BaseException>);
2488
2488
  }
2489
2489
  /**
2490
- * @public
2491
2490
  * <p>From the <a>Decrypt</a> or <a>ReEncrypt</a> operation, the request
2492
2491
  * was rejected because the specified ciphertext, or additional authenticated data incorporated
2493
2492
  * into the ciphertext, such as the encryption context, is corrupted, missing, or otherwise
2494
2493
  * invalid.</p>
2495
2494
  * <p>From the <a>ImportKeyMaterial</a> operation, the request was rejected because
2496
2495
  * KMS could not decrypt the encrypted (wrapped) key material. </p>
2496
+ * @public
2497
2497
  */
2498
2498
  export declare class InvalidCiphertextException extends __BaseException {
2499
2499
  readonly name: "InvalidCiphertextException";
@@ -2504,7 +2504,6 @@ export declare class InvalidCiphertextException extends __BaseException {
2504
2504
  constructor(opts: __ExceptionOptionType<InvalidCiphertextException, __BaseException>);
2505
2505
  }
2506
2506
  /**
2507
- * @public
2508
2507
  * <p>The request was rejected for one of the following reasons: </p>
2509
2508
  * <ul>
2510
2509
  * <li>
@@ -2524,6 +2523,7 @@ export declare class InvalidCiphertextException extends __BaseException {
2524
2523
  * <a>DescribeKey</a> operation.</p>
2525
2524
  * <p>To find the encryption or signing algorithms supported for a particular KMS key, use the
2526
2525
  * <a>DescribeKey</a> operation.</p>
2526
+ * @public
2527
2527
  */
2528
2528
  export declare class InvalidKeyUsageException extends __BaseException {
2529
2529
  readonly name: "InvalidKeyUsageException";
@@ -2534,9 +2534,9 @@ export declare class InvalidKeyUsageException extends __BaseException {
2534
2534
  constructor(opts: __ExceptionOptionType<InvalidKeyUsageException, __BaseException>);
2535
2535
  }
2536
2536
  /**
2537
- * @public
2538
2537
  * <p>The request was rejected because the specified KMS key was not available. You can retry
2539
2538
  * the request.</p>
2539
+ * @public
2540
2540
  */
2541
2541
  export declare class KeyUnavailableException extends __BaseException {
2542
2542
  readonly name: "KeyUnavailableException";
@@ -2551,9 +2551,9 @@ export declare class KeyUnavailableException extends __BaseException {
2551
2551
  */
2552
2552
  export interface DeleteAliasRequest {
2553
2553
  /**
2554
- * @public
2555
2554
  * <p>The alias to be deleted. The alias name must begin with <code>alias/</code> followed by
2556
2555
  * the alias name, such as <code>alias/ExampleAlias</code>.</p>
2556
+ * @public
2557
2557
  */
2558
2558
  AliasName: string | undefined;
2559
2559
  }
@@ -2562,8 +2562,8 @@ export interface DeleteAliasRequest {
2562
2562
  */
2563
2563
  export interface DeleteCustomKeyStoreRequest {
2564
2564
  /**
2565
- * @public
2566
2565
  * <p>Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p>
2566
+ * @public
2567
2567
  */
2568
2568
  CustomKeyStoreId: string | undefined;
2569
2569
  }
@@ -2577,7 +2577,6 @@ export interface DeleteCustomKeyStoreResponse {
2577
2577
  */
2578
2578
  export interface DeleteImportedKeyMaterialRequest {
2579
2579
  /**
2580
- * @public
2581
2580
  * <p>Identifies the KMS key from which you are deleting imported key material. The
2582
2581
  * <code>Origin</code> of the KMS key must be <code>EXTERNAL</code>.</p>
2583
2582
  * <p>Specify the key ID or key ARN of the KMS key.</p>
@@ -2593,6 +2592,7 @@ export interface DeleteImportedKeyMaterialRequest {
2593
2592
  * </li>
2594
2593
  * </ul>
2595
2594
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
2595
+ * @public
2596
2596
  */
2597
2597
  KeyId: string | undefined;
2598
2598
  }
@@ -2601,36 +2601,36 @@ export interface DeleteImportedKeyMaterialRequest {
2601
2601
  */
2602
2602
  export interface DescribeCustomKeyStoresRequest {
2603
2603
  /**
2604
- * @public
2605
2604
  * <p>Gets only information about the specified custom key store. Enter the key store ID.</p>
2606
2605
  * <p>By default, this operation gets information about all custom key stores in the account and
2607
2606
  * Region. To limit the output to a particular custom key store, provide either the
2608
2607
  * <code>CustomKeyStoreId</code> or <code>CustomKeyStoreName</code> parameter, but not
2609
2608
  * both.</p>
2609
+ * @public
2610
2610
  */
2611
2611
  CustomKeyStoreId?: string;
2612
2612
  /**
2613
- * @public
2614
2613
  * <p>Gets only information about the specified custom key store. Enter the friendly name of the
2615
2614
  * custom key store.</p>
2616
2615
  * <p>By default, this operation gets information about all custom key stores in the account and
2617
2616
  * Region. To limit the output to a particular custom key store, provide either the
2618
2617
  * <code>CustomKeyStoreId</code> or <code>CustomKeyStoreName</code> parameter, but not
2619
2618
  * both.</p>
2619
+ * @public
2620
2620
  */
2621
2621
  CustomKeyStoreName?: string;
2622
2622
  /**
2623
- * @public
2624
2623
  * <p>Use this parameter to specify the maximum number of items to return. When this
2625
2624
  * value is present, KMS does not return more than the specified number of items, but it might
2626
2625
  * return fewer.</p>
2626
+ * @public
2627
2627
  */
2628
2628
  Limit?: number;
2629
2629
  /**
2630
- * @public
2631
2630
  * <p>Use this parameter in a subsequent request after you receive a response with
2632
2631
  * truncated results. Set it to the value of <code>NextMarker</code> from the truncated response
2633
2632
  * you just received.</p>
2633
+ * @public
2634
2634
  */
2635
2635
  Marker?: string;
2636
2636
  }
@@ -2639,29 +2639,29 @@ export interface DescribeCustomKeyStoresRequest {
2639
2639
  */
2640
2640
  export interface DescribeCustomKeyStoresResponse {
2641
2641
  /**
2642
- * @public
2643
2642
  * <p>Contains metadata about each custom key store.</p>
2643
+ * @public
2644
2644
  */
2645
2645
  CustomKeyStores?: CustomKeyStoresListEntry[];
2646
2646
  /**
2647
- * @public
2648
2647
  * <p>When <code>Truncated</code> is true, this element is present and contains the
2649
2648
  * value to use for the <code>Marker</code> parameter in a subsequent request.</p>
2649
+ * @public
2650
2650
  */
2651
2651
  NextMarker?: string;
2652
2652
  /**
2653
- * @public
2654
2653
  * <p>A flag that indicates whether there are more items in the list. When this
2655
2654
  * value is true, the list in this response is truncated. To get more items, pass the value of
2656
2655
  * the <code>NextMarker</code> element in thisresponse to the <code>Marker</code> parameter in a
2657
2656
  * subsequent request.</p>
2657
+ * @public
2658
2658
  */
2659
2659
  Truncated?: boolean;
2660
2660
  }
2661
2661
  /**
2662
- * @public
2663
2662
  * <p>The request was rejected because the marker that specifies where pagination should next
2664
2663
  * begin is not valid.</p>
2664
+ * @public
2665
2665
  */
2666
2666
  export declare class InvalidMarkerException extends __BaseException {
2667
2667
  readonly name: "InvalidMarkerException";
@@ -2676,7 +2676,6 @@ export declare class InvalidMarkerException extends __BaseException {
2676
2676
  */
2677
2677
  export interface DescribeKeyRequest {
2678
2678
  /**
2679
- * @public
2680
2679
  * <p>Describes the specified KMS key. </p>
2681
2680
  * <p>If you specify a predefined Amazon Web Services alias (an Amazon Web Services alias with no key ID), KMS associates
2682
2681
  * the alias with an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html##aws-managed-cmk">Amazon Web Services managed key</a> and returns its
@@ -2702,13 +2701,14 @@ export interface DescribeKeyRequest {
2702
2701
  * </li>
2703
2702
  * </ul>
2704
2703
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>
2704
+ * @public
2705
2705
  */
2706
2706
  KeyId: string | undefined;
2707
2707
  /**
2708
- * @public
2709
2708
  * <p>A list of grant tokens.</p>
2710
2709
  * <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
2711
2710
  * <i>Key Management Service Developer Guide</i>.</p>
2711
+ * @public
2712
2712
  */
2713
2713
  GrantTokens?: string[];
2714
2714
  }
@@ -2717,8 +2717,8 @@ export interface DescribeKeyRequest {
2717
2717
  */
2718
2718
  export interface DescribeKeyResponse {
2719
2719
  /**
2720
- * @public
2721
2720
  * <p>Metadata associated with the key.</p>
2721
+ * @public
2722
2722
  */
2723
2723
  KeyMetadata?: KeyMetadata;
2724
2724
  }
@@ -2727,7 +2727,6 @@ export interface DescribeKeyResponse {
2727
2727
  */
2728
2728
  export interface DisableKeyRequest {
2729
2729
  /**
2730
- * @public
2731
2730
  * <p>Identifies the KMS key to disable.</p>
2732
2731
  * <p>Specify the key ID or key ARN of the KMS key.</p>
2733
2732
  * <p>For example:</p>
@@ -2742,6 +2741,7 @@ export interface DisableKeyRequest {
2742
2741
  * </li>
2743
2742
  * </ul>
2744
2743
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
2744
+ * @public
2745
2745
  */
2746
2746
  KeyId: string | undefined;
2747
2747
  }
@@ -2750,7 +2750,6 @@ export interface DisableKeyRequest {
2750
2750
  */
2751
2751
  export interface DisableKeyRotationRequest {
2752
2752
  /**
2753
- * @public
2754
2753
  * <p>Identifies a symmetric encryption KMS key. You cannot enable or disable automatic rotation
2755
2754
  * of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html#asymmetric-cmks">asymmetric KMS keys</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html">HMAC
2756
2755
  * KMS keys</a>, KMS keys with <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key material</a>, or KMS keys in a
@@ -2768,6 +2767,7 @@ export interface DisableKeyRotationRequest {
2768
2767
  * </li>
2769
2768
  * </ul>
2770
2769
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
2770
+ * @public
2771
2771
  */
2772
2772
  KeyId: string | undefined;
2773
2773
  }
@@ -2776,8 +2776,8 @@ export interface DisableKeyRotationRequest {
2776
2776
  */
2777
2777
  export interface DisconnectCustomKeyStoreRequest {
2778
2778
  /**
2779
- * @public
2780
2779
  * <p>Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p>
2780
+ * @public
2781
2781
  */
2782
2782
  CustomKeyStoreId: string | undefined;
2783
2783
  }
@@ -2791,7 +2791,6 @@ export interface DisconnectCustomKeyStoreResponse {
2791
2791
  */
2792
2792
  export interface EnableKeyRequest {
2793
2793
  /**
2794
- * @public
2795
2794
  * <p>Identifies the KMS key to enable.</p>
2796
2795
  * <p>Specify the key ID or key ARN of the KMS key.</p>
2797
2796
  * <p>For example:</p>
@@ -2806,6 +2805,7 @@ export interface EnableKeyRequest {
2806
2805
  * </li>
2807
2806
  * </ul>
2808
2807
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
2808
+ * @public
2809
2809
  */
2810
2810
  KeyId: string | undefined;
2811
2811
  }
@@ -2814,7 +2814,6 @@ export interface EnableKeyRequest {
2814
2814
  */
2815
2815
  export interface EnableKeyRotationRequest {
2816
2816
  /**
2817
- * @public
2818
2817
  * <p>Identifies a symmetric encryption KMS key. You cannot enable automatic rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">asymmetric KMS keys</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html">HMAC KMS keys</a>, KMS keys with <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key material</a>, or KMS keys in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. To enable or disable automatic rotation of a set of related <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate">multi-Region keys</a>, set the property on the primary key.</p>
2819
2818
  * <p>Specify the key ID or key ARN of the KMS key.</p>
2820
2819
  * <p>For example:</p>
@@ -2829,6 +2828,7 @@ export interface EnableKeyRotationRequest {
2829
2828
  * </li>
2830
2829
  * </ul>
2831
2830
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
2831
+ * @public
2832
2832
  */
2833
2833
  KeyId: string | undefined;
2834
2834
  }
@@ -2837,7 +2837,6 @@ export interface EnableKeyRotationRequest {
2837
2837
  */
2838
2838
  export interface EncryptRequest {
2839
2839
  /**
2840
- * @public
2841
2840
  * <p>Identifies the KMS key to use in the encryption operation. The KMS key must have a
2842
2841
  * <code>KeyUsage</code> of <code>ENCRYPT_DECRYPT</code>. To find the <code>KeyUsage</code> of
2843
2842
  * a KMS key, use the <a>DescribeKey</a> operation.</p>
@@ -2862,15 +2861,15 @@ export interface EncryptRequest {
2862
2861
  * </li>
2863
2862
  * </ul>
2864
2863
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>
2864
+ * @public
2865
2865
  */
2866
2866
  KeyId: string | undefined;
2867
2867
  /**
2868
- * @public
2869
2868
  * <p>Data to be encrypted.</p>
2869
+ * @public
2870
2870
  */
2871
2871
  Plaintext: Uint8Array | undefined;
2872
2872
  /**
2873
- * @public
2874
2873
  * <p>Specifies the encryption context that will be used to encrypt the data.
2875
2874
  * An encryption context is valid only for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context. </p>
2876
2875
  * <important>
@@ -2881,29 +2880,30 @@ export interface EncryptRequest {
2881
2880
  * only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.</p>
2882
2881
  * <p>For more information, see
2883
2882
  * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption context</a> in the <i>Key Management Service Developer Guide</i>.</p>
2883
+ * @public
2884
2884
  */
2885
2885
  EncryptionContext?: Record<string, string>;
2886
2886
  /**
2887
- * @public
2888
2887
  * <p>A list of grant tokens.</p>
2889
2888
  * <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
2890
2889
  * <i>Key Management Service Developer Guide</i>.</p>
2890
+ * @public
2891
2891
  */
2892
2892
  GrantTokens?: string[];
2893
2893
  /**
2894
- * @public
2895
2894
  * <p>Specifies the encryption algorithm that KMS will use to encrypt the plaintext message.
2896
2895
  * The algorithm must be compatible with the KMS key that you specify.</p>
2897
2896
  * <p>This parameter is required only for asymmetric KMS keys. The default value,
2898
2897
  * <code>SYMMETRIC_DEFAULT</code>, is the algorithm used for symmetric encryption KMS keys. If
2899
2898
  * you are using an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256.</p>
2900
2899
  * <p>The SM2PKE algorithm is only available in China Regions.</p>
2900
+ * @public
2901
2901
  */
2902
2902
  EncryptionAlgorithm?: EncryptionAlgorithmSpec;
2903
2903
  /**
2904
- * @public
2905
2904
  * <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
2906
2905
  * <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
2906
+ * @public
2907
2907
  */
2908
2908
  DryRun?: boolean;
2909
2909
  }
@@ -2912,25 +2912,25 @@ export interface EncryptRequest {
2912
2912
  */
2913
2913
  export interface EncryptResponse {
2914
2914
  /**
2915
- * @public
2916
2915
  * <p>The encrypted plaintext. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
2916
+ * @public
2917
2917
  */
2918
2918
  CiphertextBlob?: Uint8Array;
2919
2919
  /**
2920
- * @public
2921
2920
  * <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the KMS key that was used to encrypt the plaintext.</p>
2921
+ * @public
2922
2922
  */
2923
2923
  KeyId?: string;
2924
2924
  /**
2925
- * @public
2926
2925
  * <p>The encryption algorithm that was used to encrypt the plaintext.</p>
2926
+ * @public
2927
2927
  */
2928
2928
  EncryptionAlgorithm?: EncryptionAlgorithmSpec;
2929
2929
  }
2930
2930
  /**
2931
- * @public
2932
2931
  * <p>The request was rejected because the specified import token is expired. Use <a>GetParametersForImport</a> to get a new import token and public key, use the new
2933
2932
  * public key to encrypt the key material, and then try the request again.</p>
2933
+ * @public
2934
2934
  */
2935
2935
  export declare class ExpiredImportTokenException extends __BaseException {
2936
2936
  readonly name: "ExpiredImportTokenException";
@@ -2945,7 +2945,6 @@ export declare class ExpiredImportTokenException extends __BaseException {
2945
2945
  */
2946
2946
  export interface GenerateDataKeyRequest {
2947
2947
  /**
2948
- * @public
2949
2948
  * <p>Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify
2950
2949
  * an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your
2951
2950
  * KMS key, use the <a>DescribeKey</a> operation.</p>
@@ -2970,10 +2969,10 @@ export interface GenerateDataKeyRequest {
2970
2969
  * </li>
2971
2970
  * </ul>
2972
2971
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>
2972
+ * @public
2973
2973
  */
2974
2974
  KeyId: string | undefined;
2975
2975
  /**
2976
- * @public
2977
2976
  * <p>Specifies the encryption context that will be used when encrypting the data key.</p>
2978
2977
  * <important>
2979
2978
  * <p>Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p>
@@ -2983,34 +2982,34 @@ export interface GenerateDataKeyRequest {
2983
2982
  * only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.</p>
2984
2983
  * <p>For more information, see
2985
2984
  * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption context</a> in the <i>Key Management Service Developer Guide</i>.</p>
2985
+ * @public
2986
2986
  */
2987
2987
  EncryptionContext?: Record<string, string>;
2988
2988
  /**
2989
- * @public
2990
2989
  * <p>Specifies the length of the data key in bytes. For example, use the value 64 to generate a
2991
2990
  * 512-bit data key (64 bytes is 512 bits). For 128-bit (16-byte) and 256-bit (32-byte) data
2992
2991
  * keys, use the <code>KeySpec</code> parameter.</p>
2993
2992
  * <p>You must specify either the <code>KeySpec</code> or the <code>NumberOfBytes</code>
2994
2993
  * parameter (but not both) in every <code>GenerateDataKey</code> request.</p>
2994
+ * @public
2995
2995
  */
2996
2996
  NumberOfBytes?: number;
2997
2997
  /**
2998
- * @public
2999
2998
  * <p>Specifies the length of the data key. Use <code>AES_128</code> to generate a 128-bit
3000
2999
  * symmetric key, or <code>AES_256</code> to generate a 256-bit symmetric key.</p>
3001
3000
  * <p>You must specify either the <code>KeySpec</code> or the <code>NumberOfBytes</code>
3002
3001
  * parameter (but not both) in every <code>GenerateDataKey</code> request.</p>
3002
+ * @public
3003
3003
  */
3004
3004
  KeySpec?: DataKeySpec;
3005
3005
  /**
3006
- * @public
3007
3006
  * <p>A list of grant tokens.</p>
3008
3007
  * <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
3009
3008
  * <i>Key Management Service Developer Guide</i>.</p>
3009
+ * @public
3010
3010
  */
3011
3011
  GrantTokens?: string[];
3012
3012
  /**
3013
- * @public
3014
3013
  * <p>A signed <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc">attestation document</a> from
3015
3014
  * an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The
3016
3015
  * only valid encryption algorithm is <code>RSAES_OAEP_SHA_256</code>. </p>
@@ -3024,12 +3023,13 @@ export interface GenerateDataKeyRequest {
3024
3023
  * under the KMS key specified by the <code>KeyId</code> parameter. The <code>Plaintext</code>
3025
3024
  * field in the response is null or empty.</p>
3026
3025
  * <p>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>
3026
+ * @public
3027
3027
  */
3028
3028
  Recipient?: RecipientInfo;
3029
3029
  /**
3030
- * @public
3031
3030
  * <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
3032
3031
  * <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
3032
+ * @public
3033
3033
  */
3034
3034
  DryRun?: boolean;
3035
3035
  }
@@ -3038,30 +3038,30 @@ export interface GenerateDataKeyRequest {
3038
3038
  */
3039
3039
  export interface GenerateDataKeyResponse {
3040
3040
  /**
3041
- * @public
3042
3041
  * <p>The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
3042
+ * @public
3043
3043
  */
3044
3044
  CiphertextBlob?: Uint8Array;
3045
3045
  /**
3046
- * @public
3047
3046
  * <p>The plaintext data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of
3048
3047
  * KMS. Then, remove it from memory as soon as possible.</p>
3049
3048
  * <p>If the response includes the <code>CiphertextForRecipient</code> field, the
3050
3049
  * <code>Plaintext</code> field is null or empty.</p>
3050
+ * @public
3051
3051
  */
3052
3052
  Plaintext?: Uint8Array;
3053
3053
  /**
3054
- * @public
3055
3054
  * <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the KMS key that encrypted the data key.</p>
3055
+ * @public
3056
3056
  */
3057
3057
  KeyId?: string;
3058
3058
  /**
3059
- * @public
3060
3059
  * <p>The plaintext data key encrypted with the public key from the Nitro enclave. This
3061
3060
  * ciphertext can be decrypted only by using a private key in the Nitro enclave. </p>
3062
3061
  * <p>This field is included in the response only when the <code>Recipient</code> parameter in
3063
3062
  * the request includes a valid attestation document from an Amazon Web Services Nitro enclave.
3064
3063
  * 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>
3064
+ * @public
3065
3065
  */
3066
3066
  CiphertextForRecipient?: Uint8Array;
3067
3067
  }
@@ -3070,7 +3070,6 @@ export interface GenerateDataKeyResponse {
3070
3070
  */
3071
3071
  export interface GenerateDataKeyPairRequest {
3072
3072
  /**
3073
- * @public
3074
3073
  * <p>Specifies the encryption context that will be used when encrypting the private key in the
3075
3074
  * data key pair.</p>
3076
3075
  * <important>
@@ -3081,10 +3080,10 @@ export interface GenerateDataKeyPairRequest {
3081
3080
  * only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.</p>
3082
3081
  * <p>For more information, see
3083
3082
  * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption context</a> in the <i>Key Management Service Developer Guide</i>.</p>
3083
+ * @public
3084
3084
  */
3085
3085
  EncryptionContext?: Record<string, string>;
3086
3086
  /**
3087
- * @public
3088
3087
  * <p>Specifies the symmetric encryption KMS key that encrypts the private key in the data key
3089
3088
  * pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the
3090
3089
  * type and origin of your KMS key, use the <a>DescribeKey</a> operation.</p>
@@ -3109,23 +3108,23 @@ export interface GenerateDataKeyPairRequest {
3109
3108
  * </li>
3110
3109
  * </ul>
3111
3110
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>
3111
+ * @public
3112
3112
  */
3113
3113
  KeyId: string | undefined;
3114
3114
  /**
3115
- * @public
3116
3115
  * <p>Determines the type of data key pair that is generated. </p>
3117
3116
  * <p>The KMS rule that restricts the use of asymmetric RSA and SM2 KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS. The SM2 key spec is only available in China Regions.</p>
3117
+ * @public
3118
3118
  */
3119
3119
  KeyPairSpec: DataKeyPairSpec | undefined;
3120
3120
  /**
3121
- * @public
3122
3121
  * <p>A list of grant tokens.</p>
3123
3122
  * <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
3124
3123
  * <i>Key Management Service Developer Guide</i>.</p>
3124
+ * @public
3125
3125
  */
3126
3126
  GrantTokens?: string[];
3127
3127
  /**
3128
- * @public
3129
3128
  * <p>A signed <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc">attestation document</a> from
3130
3129
  * an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The
3131
3130
  * only valid encryption algorithm is <code>RSAES_OAEP_SHA_256</code>. </p>
@@ -3139,12 +3138,13 @@ export interface GenerateDataKeyPairRequest {
3139
3138
  * data key encrypted under the KMS key specified by the <code>KeyId</code> parameter. The
3140
3139
  * <code>PrivateKeyPlaintext</code> field in the response is null or empty.</p>
3141
3140
  * <p>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>
3141
+ * @public
3142
3142
  */
3143
3143
  Recipient?: RecipientInfo;
3144
3144
  /**
3145
- * @public
3146
3145
  * <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
3147
3146
  * <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
3147
+ * @public
3148
3148
  */
3149
3149
  DryRun?: boolean;
3150
3150
  }
@@ -3153,39 +3153,39 @@ export interface GenerateDataKeyPairRequest {
3153
3153
  */
3154
3154
  export interface GenerateDataKeyPairResponse {
3155
3155
  /**
3156
- * @public
3157
3156
  * <p>The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
3157
+ * @public
3158
3158
  */
3159
3159
  PrivateKeyCiphertextBlob?: Uint8Array;
3160
3160
  /**
3161
- * @public
3162
3161
  * <p>The plaintext copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
3163
3162
  * <p>If the response includes the <code>CiphertextForRecipient</code> field, the
3164
3163
  * <code>PrivateKeyPlaintext</code> field is null or empty.</p>
3164
+ * @public
3165
3165
  */
3166
3166
  PrivateKeyPlaintext?: Uint8Array;
3167
3167
  /**
3168
- * @public
3169
3168
  * <p>The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
3169
+ * @public
3170
3170
  */
3171
3171
  PublicKey?: Uint8Array;
3172
3172
  /**
3173
- * @public
3174
3173
  * <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the KMS key that encrypted the private key.</p>
3174
+ * @public
3175
3175
  */
3176
3176
  KeyId?: string;
3177
3177
  /**
3178
- * @public
3179
3178
  * <p>The type of data key pair that was generated.</p>
3179
+ * @public
3180
3180
  */
3181
3181
  KeyPairSpec?: DataKeyPairSpec;
3182
3182
  /**
3183
- * @public
3184
3183
  * <p>The plaintext private data key encrypted with the public key from the Nitro enclave. This
3185
3184
  * ciphertext can be decrypted only by using a private key in the Nitro enclave. </p>
3186
3185
  * <p>This field is included in the response only when the <code>Recipient</code> parameter in
3187
3186
  * the request includes a valid attestation document from an Amazon Web Services Nitro enclave.
3188
3187
  * 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>
3188
+ * @public
3189
3189
  */
3190
3190
  CiphertextForRecipient?: Uint8Array;
3191
3191
  }
@@ -3194,7 +3194,6 @@ export interface GenerateDataKeyPairResponse {
3194
3194
  */
3195
3195
  export interface GenerateDataKeyPairWithoutPlaintextRequest {
3196
3196
  /**
3197
- * @public
3198
3197
  * <p>Specifies the encryption context that will be used when encrypting the private key in the
3199
3198
  * data key pair.</p>
3200
3199
  * <important>
@@ -3205,10 +3204,10 @@ export interface GenerateDataKeyPairWithoutPlaintextRequest {
3205
3204
  * only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.</p>
3206
3205
  * <p>For more information, see
3207
3206
  * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption context</a> in the <i>Key Management Service Developer Guide</i>.</p>
3207
+ * @public
3208
3208
  */
3209
3209
  EncryptionContext?: Record<string, string>;
3210
3210
  /**
3211
- * @public
3212
3211
  * <p>Specifies the symmetric encryption KMS key that encrypts the private key in the data key
3213
3212
  * pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the
3214
3213
  * type and origin of your KMS key, use the <a>DescribeKey</a> operation. </p>
@@ -3233,25 +3232,26 @@ export interface GenerateDataKeyPairWithoutPlaintextRequest {
3233
3232
  * </li>
3234
3233
  * </ul>
3235
3234
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>
3235
+ * @public
3236
3236
  */
3237
3237
  KeyId: string | undefined;
3238
3238
  /**
3239
- * @public
3240
3239
  * <p>Determines the type of data key pair that is generated.</p>
3241
3240
  * <p>The KMS rule that restricts the use of asymmetric RSA and SM2 KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS. The SM2 key spec is only available in China Regions.</p>
3241
+ * @public
3242
3242
  */
3243
3243
  KeyPairSpec: DataKeyPairSpec | undefined;
3244
3244
  /**
3245
- * @public
3246
3245
  * <p>A list of grant tokens.</p>
3247
3246
  * <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
3248
3247
  * <i>Key Management Service Developer Guide</i>.</p>
3248
+ * @public
3249
3249
  */
3250
3250
  GrantTokens?: string[];
3251
3251
  /**
3252
- * @public
3253
3252
  * <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
3254
3253
  * <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
3254
+ * @public
3255
3255
  */
3256
3256
  DryRun?: boolean;
3257
3257
  }
@@ -3260,23 +3260,23 @@ export interface GenerateDataKeyPairWithoutPlaintextRequest {
3260
3260
  */
3261
3261
  export interface GenerateDataKeyPairWithoutPlaintextResponse {
3262
3262
  /**
3263
- * @public
3264
3263
  * <p>The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
3264
+ * @public
3265
3265
  */
3266
3266
  PrivateKeyCiphertextBlob?: Uint8Array;
3267
3267
  /**
3268
- * @public
3269
3268
  * <p>The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
3269
+ * @public
3270
3270
  */
3271
3271
  PublicKey?: Uint8Array;
3272
3272
  /**
3273
- * @public
3274
3273
  * <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the KMS key that encrypted the private key.</p>
3274
+ * @public
3275
3275
  */
3276
3276
  KeyId?: string;
3277
3277
  /**
3278
- * @public
3279
3278
  * <p>The type of data key pair that was generated.</p>
3279
+ * @public
3280
3280
  */
3281
3281
  KeyPairSpec?: DataKeyPairSpec;
3282
3282
  }
@@ -3285,7 +3285,6 @@ export interface GenerateDataKeyPairWithoutPlaintextResponse {
3285
3285
  */
3286
3286
  export interface GenerateDataKeyWithoutPlaintextRequest {
3287
3287
  /**
3288
- * @public
3289
3288
  * <p>Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify
3290
3289
  * an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your
3291
3290
  * KMS key, use the <a>DescribeKey</a> operation.</p>
@@ -3310,10 +3309,10 @@ export interface GenerateDataKeyWithoutPlaintextRequest {
3310
3309
  * </li>
3311
3310
  * </ul>
3312
3311
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>
3312
+ * @public
3313
3313
  */
3314
3314
  KeyId: string | undefined;
3315
3315
  /**
3316
- * @public
3317
3316
  * <p>Specifies the encryption context that will be used when encrypting the data key.</p>
3318
3317
  * <important>
3319
3318
  * <p>Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p>
@@ -3323,32 +3322,33 @@ export interface GenerateDataKeyWithoutPlaintextRequest {
3323
3322
  * only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.</p>
3324
3323
  * <p>For more information, see
3325
3324
  * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption context</a> in the <i>Key Management Service Developer Guide</i>.</p>
3325
+ * @public
3326
3326
  */
3327
3327
  EncryptionContext?: Record<string, string>;
3328
3328
  /**
3329
- * @public
3330
3329
  * <p>The length of the data key. Use <code>AES_128</code> to generate a 128-bit symmetric key,
3331
3330
  * or <code>AES_256</code> to generate a 256-bit symmetric key.</p>
3331
+ * @public
3332
3332
  */
3333
3333
  KeySpec?: DataKeySpec;
3334
3334
  /**
3335
- * @public
3336
3335
  * <p>The length of the data key in bytes. For example, use the value 64 to generate a 512-bit
3337
3336
  * data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys),
3338
3337
  * we recommend that you use the <code>KeySpec</code> field instead of this one.</p>
3338
+ * @public
3339
3339
  */
3340
3340
  NumberOfBytes?: number;
3341
3341
  /**
3342
- * @public
3343
3342
  * <p>A list of grant tokens.</p>
3344
3343
  * <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
3345
3344
  * <i>Key Management Service Developer Guide</i>.</p>
3345
+ * @public
3346
3346
  */
3347
3347
  GrantTokens?: string[];
3348
3348
  /**
3349
- * @public
3350
3349
  * <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
3351
3350
  * <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
3351
+ * @public
3352
3352
  */
3353
3353
  DryRun?: boolean;
3354
3354
  }
@@ -3357,13 +3357,13 @@ export interface GenerateDataKeyWithoutPlaintextRequest {
3357
3357
  */
3358
3358
  export interface GenerateDataKeyWithoutPlaintextResponse {
3359
3359
  /**
3360
- * @public
3361
3360
  * <p>The encrypted data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
3361
+ * @public
3362
3362
  */
3363
3363
  CiphertextBlob?: Uint8Array;
3364
3364
  /**
3365
- * @public
3366
3365
  * <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the KMS key that encrypted the data key.</p>
3366
+ * @public
3367
3367
  */
3368
3368
  KeyId?: string;
3369
3369
  }
@@ -3372,41 +3372,41 @@ export interface GenerateDataKeyWithoutPlaintextResponse {
3372
3372
  */
3373
3373
  export interface GenerateMacRequest {
3374
3374
  /**
3375
- * @public
3376
3375
  * <p>The message to be hashed. Specify a message of up to 4,096 bytes. </p>
3377
3376
  * <p>
3378
3377
  * <code>GenerateMac</code> and <a>VerifyMac</a> do not provide special handling
3379
3378
  * for message digests. If you generate an HMAC for a hash digest of a message, you must verify
3380
3379
  * the HMAC of the same hash digest.</p>
3380
+ * @public
3381
3381
  */
3382
3382
  Message: Uint8Array | undefined;
3383
3383
  /**
3384
- * @public
3385
3384
  * <p>The HMAC KMS key to use in the operation. The MAC algorithm computes the HMAC for the
3386
3385
  * message and the key as described in <a href="https://datatracker.ietf.org/doc/html/rfc2104">RFC 2104</a>.</p>
3387
3386
  * <p>To identify an HMAC KMS key, use the <a>DescribeKey</a> operation and see the
3388
3387
  * <code>KeySpec</code> field in the response.</p>
3388
+ * @public
3389
3389
  */
3390
3390
  KeyId: string | undefined;
3391
3391
  /**
3392
- * @public
3393
3392
  * <p>The MAC algorithm used in the operation.</p>
3394
3393
  * <p> The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC
3395
3394
  * algorithms that your HMAC KMS key supports, use the <a>DescribeKey</a> operation
3396
3395
  * and see the <code>MacAlgorithms</code> field in the <code>DescribeKey</code> response.</p>
3396
+ * @public
3397
3397
  */
3398
3398
  MacAlgorithm: MacAlgorithmSpec | undefined;
3399
3399
  /**
3400
- * @public
3401
3400
  * <p>A list of grant tokens.</p>
3402
3401
  * <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
3403
3402
  * <i>Key Management Service Developer Guide</i>.</p>
3403
+ * @public
3404
3404
  */
3405
3405
  GrantTokens?: string[];
3406
3406
  /**
3407
- * @public
3408
3407
  * <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
3409
3408
  * <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
3409
+ * @public
3410
3410
  */
3411
3411
  DryRun?: boolean;
3412
3412
  }
@@ -3415,20 +3415,20 @@ export interface GenerateMacRequest {
3415
3415
  */
3416
3416
  export interface GenerateMacResponse {
3417
3417
  /**
3418
- * @public
3419
3418
  * <p>The hash-based message authentication code (HMAC) that was generated for the specified
3420
3419
  * message, HMAC KMS key, and MAC algorithm.</p>
3421
3420
  * <p>This is the standard, raw HMAC defined in <a href="https://datatracker.ietf.org/doc/html/rfc2104">RFC 2104</a>.</p>
3421
+ * @public
3422
3422
  */
3423
3423
  Mac?: Uint8Array;
3424
3424
  /**
3425
- * @public
3426
3425
  * <p>The MAC algorithm that was used to generate the HMAC.</p>
3426
+ * @public
3427
3427
  */
3428
3428
  MacAlgorithm?: MacAlgorithmSpec;
3429
3429
  /**
3430
- * @public
3431
3430
  * <p>The HMAC KMS key used in the operation.</p>
3431
+ * @public
3432
3432
  */
3433
3433
  KeyId?: string;
3434
3434
  }
@@ -3437,21 +3437,20 @@ export interface GenerateMacResponse {
3437
3437
  */
3438
3438
  export interface GenerateRandomRequest {
3439
3439
  /**
3440
- * @public
3441
3440
  * <p>The length of the random byte string. This parameter is required.</p>
3441
+ * @public
3442
3442
  */
3443
3443
  NumberOfBytes?: number;
3444
3444
  /**
3445
- * @public
3446
3445
  * <p>Generates the random byte string in the CloudHSM cluster that is associated with the
3447
3446
  * specified CloudHSM key store. To find the ID of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p>
3448
3447
  * <p>External key store IDs are not valid for this parameter. If you specify the ID of an
3449
3448
  * external key store, <code>GenerateRandom</code> throws an
3450
3449
  * <code>UnsupportedOperationException</code>.</p>
3450
+ * @public
3451
3451
  */
3452
3452
  CustomKeyStoreId?: string;
3453
3453
  /**
3454
- * @public
3455
3454
  * <p>A signed <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc">attestation document</a> from
3456
3455
  * an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The
3457
3456
  * only valid encryption algorithm is <code>RSAES_OAEP_SHA_256</code>. </p>
@@ -3463,6 +3462,7 @@ export interface GenerateRandomRequest {
3463
3462
  * can be decrypted only with the private key in the enclave. The <code>Plaintext</code> field in
3464
3463
  * the response is null or empty.</p>
3465
3464
  * <p>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>
3465
+ * @public
3466
3466
  */
3467
3467
  Recipient?: RecipientInfo;
3468
3468
  }
@@ -3471,19 +3471,19 @@ export interface GenerateRandomRequest {
3471
3471
  */
3472
3472
  export interface GenerateRandomResponse {
3473
3473
  /**
3474
- * @public
3475
3474
  * <p>The random byte string. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
3476
3475
  * <p>If the response includes the <code>CiphertextForRecipient</code> field, the
3477
3476
  * <code>Plaintext</code> field is null or empty.</p>
3477
+ * @public
3478
3478
  */
3479
3479
  Plaintext?: Uint8Array;
3480
3480
  /**
3481
- * @public
3482
3481
  * <p>The plaintext random bytes encrypted with the public key from the Nitro enclave. This
3483
3482
  * ciphertext can be decrypted only by using a private key in the Nitro enclave. </p>
3484
3483
  * <p>This field is included in the response only when the <code>Recipient</code> parameter in
3485
3484
  * the request includes a valid attestation document from an Amazon Web Services Nitro enclave.
3486
3485
  * 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>
3486
+ * @public
3487
3487
  */
3488
3488
  CiphertextForRecipient?: Uint8Array;
3489
3489
  }
@@ -3492,7 +3492,6 @@ export interface GenerateRandomResponse {
3492
3492
  */
3493
3493
  export interface GetKeyPolicyRequest {
3494
3494
  /**
3495
- * @public
3496
3495
  * <p>Gets the key policy for the specified KMS key.</p>
3497
3496
  * <p>Specify the key ID or key ARN of the KMS key.</p>
3498
3497
  * <p>For example:</p>
@@ -3507,12 +3506,13 @@ export interface GetKeyPolicyRequest {
3507
3506
  * </li>
3508
3507
  * </ul>
3509
3508
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
3509
+ * @public
3510
3510
  */
3511
3511
  KeyId: string | undefined;
3512
3512
  /**
3513
- * @public
3514
3513
  * <p>Specifies the name of the key policy. The only valid name is <code>default</code>. To get
3515
3514
  * the names of key policies, use <a>ListKeyPolicies</a>.</p>
3515
+ * @public
3516
3516
  */
3517
3517
  PolicyName: string | undefined;
3518
3518
  }
@@ -3521,8 +3521,8 @@ export interface GetKeyPolicyRequest {
3521
3521
  */
3522
3522
  export interface GetKeyPolicyResponse {
3523
3523
  /**
3524
- * @public
3525
3524
  * <p>A key policy document in JSON format.</p>
3525
+ * @public
3526
3526
  */
3527
3527
  Policy?: string;
3528
3528
  }
@@ -3531,7 +3531,6 @@ export interface GetKeyPolicyResponse {
3531
3531
  */
3532
3532
  export interface GetKeyRotationStatusRequest {
3533
3533
  /**
3534
- * @public
3535
3534
  * <p>Gets the rotation status for the specified KMS key.</p>
3536
3535
  * <p>Specify the key ID or key ARN of the KMS key. To specify a KMS key in a
3537
3536
  * different Amazon Web Services account, you must use the key ARN.</p>
@@ -3547,6 +3546,7 @@ export interface GetKeyRotationStatusRequest {
3547
3546
  * </li>
3548
3547
  * </ul>
3549
3548
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
3549
+ * @public
3550
3550
  */
3551
3551
  KeyId: string | undefined;
3552
3552
  }
@@ -3555,8 +3555,8 @@ export interface GetKeyRotationStatusRequest {
3555
3555
  */
3556
3556
  export interface GetKeyRotationStatusResponse {
3557
3557
  /**
3558
- * @public
3559
3558
  * <p>A Boolean value that specifies whether key rotation is enabled.</p>
3559
+ * @public
3560
3560
  */
3561
3561
  KeyRotationEnabled?: boolean;
3562
3562
  }
@@ -3578,7 +3578,6 @@ export type WrappingKeySpec = (typeof WrappingKeySpec)[keyof typeof WrappingKeyS
3578
3578
  */
3579
3579
  export interface GetParametersForImportRequest {
3580
3580
  /**
3581
- * @public
3582
3581
  * <p>The identifier of the KMS key that will be associated with the imported key material. The
3583
3582
  * <code>Origin</code> of the KMS key must be <code>EXTERNAL</code>.</p>
3584
3583
  * <p>All KMS key types are supported, including multi-Region keys. However, you cannot import
@@ -3596,10 +3595,10 @@ export interface GetParametersForImportRequest {
3596
3595
  * </li>
3597
3596
  * </ul>
3598
3597
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
3598
+ * @public
3599
3599
  */
3600
3600
  KeyId: string | undefined;
3601
3601
  /**
3602
- * @public
3603
3602
  * <p>The algorithm you will use with the RSA public key (<code>PublicKey</code>) in the
3604
3603
  * response to protect your key material during import. For more information, see <a href="kms/latest/developerguide/importing-keys-get-public-key-and-token.html#select-wrapping-algorithm">Select a wrapping algorithm</a> in the <i>Key Management Service Developer Guide</i>.</p>
3605
3604
  * <p>For RSA_AES wrapping algorithms, you encrypt your key material with an AES key that you
@@ -3638,15 +3637,16 @@ export interface GetParametersForImportRequest {
3638
3637
  * 10, 2023, KMS does not support the RSAES_PKCS1_V1_5 wrapping algorithm.</p>
3639
3638
  * </li>
3640
3639
  * </ul>
3640
+ * @public
3641
3641
  */
3642
3642
  WrappingAlgorithm: AlgorithmSpec | undefined;
3643
3643
  /**
3644
- * @public
3645
3644
  * <p>The type of RSA public key to return in the response. You will use this wrapping key with
3646
3645
  * the specified wrapping algorithm to protect your key material during import. </p>
3647
3646
  * <p>Use the longest RSA wrapping key that is practical. </p>
3648
3647
  * <p>You cannot use an RSA_2048 public key to directly wrap an ECC_NIST_P521 private key.
3649
3648
  * Instead, use an RSA_AES wrapping algorithm or choose a longer RSA public key.</p>
3649
+ * @public
3650
3650
  */
3651
3651
  WrappingKeySpec: WrappingKeySpec | undefined;
3652
3652
  }
@@ -3655,27 +3655,27 @@ export interface GetParametersForImportRequest {
3655
3655
  */
3656
3656
  export interface GetParametersForImportResponse {
3657
3657
  /**
3658
- * @public
3659
3658
  * <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the KMS key to use in a subsequent <a>ImportKeyMaterial</a> request. This is the same KMS key specified in the <code>GetParametersForImport</code>
3660
3659
  * request.</p>
3660
+ * @public
3661
3661
  */
3662
3662
  KeyId?: string;
3663
3663
  /**
3664
- * @public
3665
3664
  * <p>The import token to send in a subsequent <a>ImportKeyMaterial</a>
3666
3665
  * request.</p>
3666
+ * @public
3667
3667
  */
3668
3668
  ImportToken?: Uint8Array;
3669
3669
  /**
3670
- * @public
3671
3670
  * <p>The public key to use to encrypt the key material before importing it with <a>ImportKeyMaterial</a>.</p>
3671
+ * @public
3672
3672
  */
3673
3673
  PublicKey?: Uint8Array;
3674
3674
  /**
3675
- * @public
3676
3675
  * <p>The time at which the import token and public key are no longer valid. After this time,
3677
3676
  * you cannot use them to make an <a>ImportKeyMaterial</a> request and you must send
3678
3677
  * another <code>GetParametersForImport</code> request to get new ones.</p>
3678
+ * @public
3679
3679
  */
3680
3680
  ParametersValidTo?: Date;
3681
3681
  }
@@ -3684,7 +3684,6 @@ export interface GetParametersForImportResponse {
3684
3684
  */
3685
3685
  export interface GetPublicKeyRequest {
3686
3686
  /**
3687
- * @public
3688
3687
  * <p>Identifies the asymmetric KMS key that includes the public key.</p>
3689
3688
  * <p>To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.</p>
3690
3689
  * <p>For example:</p>
@@ -3707,13 +3706,14 @@ export interface GetPublicKeyRequest {
3707
3706
  * </li>
3708
3707
  * </ul>
3709
3708
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>
3709
+ * @public
3710
3710
  */
3711
3711
  KeyId: string | undefined;
3712
3712
  /**
3713
- * @public
3714
3713
  * <p>A list of grant tokens.</p>
3715
3714
  * <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
3716
3715
  * <i>Key Management Service Developer Guide</i>.</p>
3716
+ * @public
3717
3717
  */
3718
3718
  GrantTokens?: string[];
3719
3719
  }
@@ -3722,21 +3722,20 @@ export interface GetPublicKeyRequest {
3722
3722
  */
3723
3723
  export interface GetPublicKeyResponse {
3724
3724
  /**
3725
- * @public
3726
3725
  * <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the asymmetric KMS key from which the public key was
3727
3726
  * downloaded.</p>
3727
+ * @public
3728
3728
  */
3729
3729
  KeyId?: string;
3730
3730
  /**
3731
- * @public
3732
3731
  * <p>The exported public key. </p>
3733
3732
  * <p>The value is a DER-encoded X.509 public key, also known as
3734
3733
  * <code>SubjectPublicKeyInfo</code> (SPKI), as defined in <a href="https://tools.ietf.org/html/rfc5280">RFC 5280</a>. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
3735
3734
  * <p></p>
3735
+ * @public
3736
3736
  */
3737
3737
  PublicKey?: Uint8Array;
3738
3738
  /**
3739
- * @public
3740
3739
  * @deprecated
3741
3740
  *
3742
3741
  * <p>Instead, use the <code>KeySpec</code> field in the <code>GetPublicKey</code>
@@ -3744,92 +3743,93 @@ export interface GetPublicKeyResponse {
3744
3743
  * <p>The <code>KeySpec</code> and <code>CustomerMasterKeySpec</code> fields have the same
3745
3744
  * value. We recommend that you use the <code>KeySpec</code> field in your code. However, to
3746
3745
  * avoid breaking changes, KMS supports both fields.</p>
3746
+ * @public
3747
3747
  */
3748
3748
  CustomerMasterKeySpec?: CustomerMasterKeySpec;
3749
3749
  /**
3750
- * @public
3751
3750
  * <p>The type of the of the public key that was downloaded.</p>
3751
+ * @public
3752
3752
  */
3753
3753
  KeySpec?: KeySpec;
3754
3754
  /**
3755
- * @public
3756
3755
  * <p>The permitted use of the public key. Valid values are <code>ENCRYPT_DECRYPT</code> or
3757
3756
  * <code>SIGN_VERIFY</code>. </p>
3758
3757
  * <p>This information is critical. If a public key with <code>SIGN_VERIFY</code> key usage
3759
3758
  * encrypts data outside of KMS, the ciphertext cannot be decrypted. </p>
3759
+ * @public
3760
3760
  */
3761
3761
  KeyUsage?: KeyUsageType;
3762
3762
  /**
3763
- * @public
3764
3763
  * <p>The encryption algorithms that KMS supports for this key. </p>
3765
3764
  * <p>This information is critical. If a public key encrypts data outside of KMS by using an
3766
3765
  * unsupported encryption algorithm, the ciphertext cannot be decrypted. </p>
3767
3766
  * <p>This field appears in the response only when the <code>KeyUsage</code> of the public key
3768
3767
  * is <code>ENCRYPT_DECRYPT</code>.</p>
3768
+ * @public
3769
3769
  */
3770
3770
  EncryptionAlgorithms?: EncryptionAlgorithmSpec[];
3771
3771
  /**
3772
- * @public
3773
3772
  * <p>The signing algorithms that KMS supports for this key.</p>
3774
3773
  * <p>This field appears in the response only when the <code>KeyUsage</code> of the public key
3775
3774
  * is <code>SIGN_VERIFY</code>.</p>
3775
+ * @public
3776
3776
  */
3777
3777
  SigningAlgorithms?: SigningAlgorithmSpec[];
3778
3778
  }
3779
3779
  /**
3780
- * @public
3781
3780
  * <p>Contains information about a grant.</p>
3781
+ * @public
3782
3782
  */
3783
3783
  export interface GrantListEntry {
3784
3784
  /**
3785
- * @public
3786
3785
  * <p>The unique identifier for the KMS key to which the grant applies.</p>
3786
+ * @public
3787
3787
  */
3788
3788
  KeyId?: string;
3789
3789
  /**
3790
- * @public
3791
3790
  * <p>The unique identifier for the grant.</p>
3791
+ * @public
3792
3792
  */
3793
3793
  GrantId?: string;
3794
3794
  /**
3795
- * @public
3796
3795
  * <p>The friendly name that identifies the grant. If a name was provided in the <a>CreateGrant</a> request, that name is returned. Otherwise this value is null.</p>
3796
+ * @public
3797
3797
  */
3798
3798
  Name?: string;
3799
3799
  /**
3800
- * @public
3801
3800
  * <p>The date and time when the grant was created.</p>
3801
+ * @public
3802
3802
  */
3803
3803
  CreationDate?: Date;
3804
3804
  /**
3805
- * @public
3806
3805
  * <p>The identity that gets the permissions in the grant.</p>
3807
3806
  * <p>The <code>GranteePrincipal</code> field in the <code>ListGrants</code> response usually contains the
3808
3807
  * user or role designated as the grantee principal in the grant. However, when the grantee
3809
3808
  * principal in the grant is an Amazon Web Services service, the <code>GranteePrincipal</code> field contains
3810
3809
  * the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services">service
3811
3810
  * principal</a>, which might represent several different grantee principals.</p>
3811
+ * @public
3812
3812
  */
3813
3813
  GranteePrincipal?: string;
3814
3814
  /**
3815
- * @public
3816
3815
  * <p>The principal that can retire the grant.</p>
3816
+ * @public
3817
3817
  */
3818
3818
  RetiringPrincipal?: string;
3819
3819
  /**
3820
- * @public
3821
3820
  * <p>The Amazon Web Services account under which the grant was issued.</p>
3821
+ * @public
3822
3822
  */
3823
3823
  IssuingAccount?: string;
3824
3824
  /**
3825
- * @public
3826
3825
  * <p>The list of operations permitted by the grant.</p>
3826
+ * @public
3827
3827
  */
3828
3828
  Operations?: GrantOperation[];
3829
3829
  /**
3830
- * @public
3831
3830
  * <p>A list of key-value pairs that must be present in the encryption context of certain
3832
3831
  * subsequent operations that the grant allows.</p>
3832
+ * @public
3833
3833
  */
3834
3834
  Constraints?: GrantConstraints;
3835
3835
  }
@@ -3838,7 +3838,6 @@ export interface GrantListEntry {
3838
3838
  */
3839
3839
  export interface ImportKeyMaterialRequest {
3840
3840
  /**
3841
- * @public
3842
3841
  * <p>The identifier of the KMS key that will be associated with the imported key material. This
3843
3842
  * must be the same KMS key specified in the <code>KeyID</code> parameter of the corresponding
3844
3843
  * <a>GetParametersForImport</a> request. The <code>Origin</code> of the KMS key
@@ -3861,23 +3860,23 @@ export interface ImportKeyMaterialRequest {
3861
3860
  * </li>
3862
3861
  * </ul>
3863
3862
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
3863
+ * @public
3864
3864
  */
3865
3865
  KeyId: string | undefined;
3866
3866
  /**
3867
- * @public
3868
3867
  * <p>The import token that you received in the response to a previous <a>GetParametersForImport</a> request. It must be from the same response that contained
3869
3868
  * the public key that you used to encrypt the key material.</p>
3869
+ * @public
3870
3870
  */
3871
3871
  ImportToken: Uint8Array | undefined;
3872
3872
  /**
3873
- * @public
3874
3873
  * <p>The encrypted key material to import. The key material must be encrypted under the public
3875
3874
  * wrapping key that <a>GetParametersForImport</a> returned, using the wrapping
3876
3875
  * algorithm that you specified in the same <code>GetParametersForImport</code> request.</p>
3876
+ * @public
3877
3877
  */
3878
3878
  EncryptedKeyMaterial: Uint8Array | undefined;
3879
3879
  /**
3880
- * @public
3881
3880
  * <p>The date and time when the imported key material expires. This parameter is required when
3882
3881
  * the value of the <code>ExpirationModel</code> parameter is <code>KEY_MATERIAL_EXPIRES</code>.
3883
3882
  * Otherwise it is not valid.</p>
@@ -3888,10 +3887,10 @@ export interface ImportKeyMaterialRequest {
3888
3887
  * must reimport the same key material.</p>
3889
3888
  * <p>You cannot change the <code>ExpirationModel</code> or <code>ValidTo</code> values for the
3890
3889
  * current import after the request completes. To change either value, you must delete (<a>DeleteImportedKeyMaterial</a>) and reimport the key material.</p>
3890
+ * @public
3891
3891
  */
3892
3892
  ValidTo?: Date;
3893
3893
  /**
3894
- * @public
3895
3894
  * <p>Specifies whether the key material expires. The default is
3896
3895
  * <code>KEY_MATERIAL_EXPIRES</code>. For help with this choice, see <a href="https://docs.aws.amazon.com/en_us/kms/latest/developerguide/importing-keys.html#importing-keys-expiration">Setting an expiration time</a> in the <i>Key Management Service Developer Guide</i>.</p>
3897
3896
  * <p>When the value of <code>ExpirationModel</code> is <code>KEY_MATERIAL_EXPIRES</code>, you
@@ -3901,6 +3900,7 @@ export interface ImportKeyMaterialRequest {
3901
3900
  * <p>You cannot change the <code>ExpirationModel</code> or <code>ValidTo</code> values for the
3902
3901
  * current import after the request completes. To change either value, you must reimport the key
3903
3902
  * material.</p>
3903
+ * @public
3904
3904
  */
3905
3905
  ExpirationModel?: ExpirationModelType;
3906
3906
  }
@@ -3910,9 +3910,9 @@ export interface ImportKeyMaterialRequest {
3910
3910
  export interface ImportKeyMaterialResponse {
3911
3911
  }
3912
3912
  /**
3913
- * @public
3914
3913
  * <p>The request was rejected because the key material in the request is, expired, invalid, or
3915
3914
  * is not the same key material that was previously imported into this KMS key.</p>
3915
+ * @public
3916
3916
  */
3917
3917
  export declare class IncorrectKeyMaterialException extends __BaseException {
3918
3918
  readonly name: "IncorrectKeyMaterialException";
@@ -3923,9 +3923,9 @@ export declare class IncorrectKeyMaterialException extends __BaseException {
3923
3923
  constructor(opts: __ExceptionOptionType<IncorrectKeyMaterialException, __BaseException>);
3924
3924
  }
3925
3925
  /**
3926
- * @public
3927
3926
  * <p>The request was rejected because the provided import token is invalid or is associated
3928
3927
  * with a different KMS key.</p>
3928
+ * @public
3929
3929
  */
3930
3930
  export declare class InvalidImportTokenException extends __BaseException {
3931
3931
  readonly name: "InvalidImportTokenException";
@@ -3936,8 +3936,8 @@ export declare class InvalidImportTokenException extends __BaseException {
3936
3936
  constructor(opts: __ExceptionOptionType<InvalidImportTokenException, __BaseException>);
3937
3937
  }
3938
3938
  /**
3939
- * @public
3940
3939
  * <p>The request was rejected because the specified <code>GrantId</code> is not valid.</p>
3940
+ * @public
3941
3941
  */
3942
3942
  export declare class InvalidGrantIdException extends __BaseException {
3943
3943
  readonly name: "InvalidGrantIdException";
@@ -3948,26 +3948,26 @@ export declare class InvalidGrantIdException extends __BaseException {
3948
3948
  constructor(opts: __ExceptionOptionType<InvalidGrantIdException, __BaseException>);
3949
3949
  }
3950
3950
  /**
3951
- * @public
3952
3951
  * <p>Contains information about each entry in the key list.</p>
3952
+ * @public
3953
3953
  */
3954
3954
  export interface KeyListEntry {
3955
3955
  /**
3956
- * @public
3957
3956
  * <p>Unique identifier of the key.</p>
3957
+ * @public
3958
3958
  */
3959
3959
  KeyId?: string;
3960
3960
  /**
3961
- * @public
3962
3961
  * <p>ARN of the key.</p>
3962
+ * @public
3963
3963
  */
3964
3964
  KeyArn?: string;
3965
3965
  }
3966
3966
  /**
3967
- * @public
3968
3967
  * <p>The request was rejected because the HMAC verification failed. HMAC verification fails
3969
3968
  * when the HMAC computed by using the specified message, HMAC KMS key, and MAC algorithm does
3970
3969
  * not match the HMAC specified in the request.</p>
3970
+ * @public
3971
3971
  */
3972
3972
  export declare class KMSInvalidMacException extends __BaseException {
3973
3973
  readonly name: "KMSInvalidMacException";
@@ -3978,10 +3978,10 @@ export declare class KMSInvalidMacException extends __BaseException {
3978
3978
  constructor(opts: __ExceptionOptionType<KMSInvalidMacException, __BaseException>);
3979
3979
  }
3980
3980
  /**
3981
- * @public
3982
3981
  * <p>The request was rejected because the signature verification failed. Signature verification
3983
3982
  * fails when it cannot confirm that signature was produced by signing the specified message with
3984
3983
  * the specified KMS key and signing algorithm.</p>
3984
+ * @public
3985
3985
  */
3986
3986
  export declare class KMSInvalidSignatureException extends __BaseException {
3987
3987
  readonly name: "KMSInvalidSignatureException";
@@ -3996,7 +3996,6 @@ export declare class KMSInvalidSignatureException extends __BaseException {
3996
3996
  */
3997
3997
  export interface ListAliasesRequest {
3998
3998
  /**
3999
- * @public
4000
3999
  * <p>Lists only aliases that are associated with the specified KMS key. Enter a KMS key in your
4001
4000
  * Amazon Web Services account. </p>
4002
4001
  * <p>This parameter is optional. If you omit it, <code>ListAliases</code> returns all aliases
@@ -4014,22 +4013,23 @@ export interface ListAliasesRequest {
4014
4013
  * </li>
4015
4014
  * </ul>
4016
4015
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
4016
+ * @public
4017
4017
  */
4018
4018
  KeyId?: string;
4019
4019
  /**
4020
- * @public
4021
4020
  * <p>Use this parameter to specify the maximum number of items to return. When this
4022
4021
  * value is present, KMS does not return more than the specified number of items, but it might
4023
4022
  * return fewer.</p>
4024
4023
  * <p>This value is optional. If you include a value, it must be between 1
4025
4024
  * and 100, inclusive. If you do not include a value, it defaults to 50.</p>
4025
+ * @public
4026
4026
  */
4027
4027
  Limit?: number;
4028
4028
  /**
4029
- * @public
4030
4029
  * <p>Use this parameter in a subsequent request after you receive a response with
4031
4030
  * truncated results. Set it to the value of <code>NextMarker</code> from the truncated response
4032
4031
  * you just received.</p>
4032
+ * @public
4033
4033
  */
4034
4034
  Marker?: string;
4035
4035
  }
@@ -4038,22 +4038,22 @@ export interface ListAliasesRequest {
4038
4038
  */
4039
4039
  export interface ListAliasesResponse {
4040
4040
  /**
4041
- * @public
4042
4041
  * <p>A list of aliases.</p>
4042
+ * @public
4043
4043
  */
4044
4044
  Aliases?: AliasListEntry[];
4045
4045
  /**
4046
- * @public
4047
4046
  * <p>When <code>Truncated</code> is true, this element is present and contains the
4048
4047
  * value to use for the <code>Marker</code> parameter in a subsequent request.</p>
4048
+ * @public
4049
4049
  */
4050
4050
  NextMarker?: string;
4051
4051
  /**
4052
- * @public
4053
4052
  * <p>A flag that indicates whether there are more items in the list. When this
4054
4053
  * value is true, the list in this response is truncated. To get more items, pass the value of
4055
4054
  * the <code>NextMarker</code> element in thisresponse to the <code>Marker</code> parameter in a
4056
4055
  * subsequent request.</p>
4056
+ * @public
4057
4057
  */
4058
4058
  Truncated?: boolean;
4059
4059
  }
@@ -4062,23 +4062,22 @@ export interface ListAliasesResponse {
4062
4062
  */
4063
4063
  export interface ListGrantsRequest {
4064
4064
  /**
4065
- * @public
4066
4065
  * <p>Use this parameter to specify the maximum number of items to return. When this
4067
4066
  * value is present, KMS does not return more than the specified number of items, but it might
4068
4067
  * return fewer.</p>
4069
4068
  * <p>This value is optional. If you include a value, it must be between 1
4070
4069
  * and 100, inclusive. If you do not include a value, it defaults to 50.</p>
4070
+ * @public
4071
4071
  */
4072
4072
  Limit?: number;
4073
4073
  /**
4074
- * @public
4075
4074
  * <p>Use this parameter in a subsequent request after you receive a response with
4076
4075
  * truncated results. Set it to the value of <code>NextMarker</code> from the truncated response
4077
4076
  * you just received.</p>
4077
+ * @public
4078
4078
  */
4079
4079
  Marker?: string;
4080
4080
  /**
4081
- * @public
4082
4081
  * <p>Returns only grants for the specified KMS key. This parameter is required.</p>
4083
4082
  * <p>Specify the key ID or key ARN of the KMS key. To specify a KMS key in a
4084
4083
  * different Amazon Web Services account, you must use the key ARN.</p>
@@ -4094,18 +4093,19 @@ export interface ListGrantsRequest {
4094
4093
  * </li>
4095
4094
  * </ul>
4096
4095
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
4096
+ * @public
4097
4097
  */
4098
4098
  KeyId: string | undefined;
4099
4099
  /**
4100
- * @public
4101
4100
  * <p>Returns only the grant with the specified grant ID. The grant ID uniquely identifies the
4102
4101
  * grant. </p>
4102
+ * @public
4103
4103
  */
4104
4104
  GrantId?: string;
4105
4105
  /**
4106
- * @public
4107
4106
  * <p>Returns only grants where the specified principal is the grantee principal for the
4108
4107
  * grant.</p>
4108
+ * @public
4109
4109
  */
4110
4110
  GranteePrincipal?: string;
4111
4111
  }
@@ -4114,22 +4114,22 @@ export interface ListGrantsRequest {
4114
4114
  */
4115
4115
  export interface ListGrantsResponse {
4116
4116
  /**
4117
- * @public
4118
4117
  * <p>A list of grants.</p>
4118
+ * @public
4119
4119
  */
4120
4120
  Grants?: GrantListEntry[];
4121
4121
  /**
4122
- * @public
4123
4122
  * <p>When <code>Truncated</code> is true, this element is present and contains the
4124
4123
  * value to use for the <code>Marker</code> parameter in a subsequent request.</p>
4124
+ * @public
4125
4125
  */
4126
4126
  NextMarker?: string;
4127
4127
  /**
4128
- * @public
4129
4128
  * <p>A flag that indicates whether there are more items in the list. When this
4130
4129
  * value is true, the list in this response is truncated. To get more items, pass the value of
4131
4130
  * the <code>NextMarker</code> element in thisresponse to the <code>Marker</code> parameter in a
4132
4131
  * subsequent request.</p>
4132
+ * @public
4133
4133
  */
4134
4134
  Truncated?: boolean;
4135
4135
  }
@@ -4138,7 +4138,6 @@ export interface ListGrantsResponse {
4138
4138
  */
4139
4139
  export interface ListKeyPoliciesRequest {
4140
4140
  /**
4141
- * @public
4142
4141
  * <p>Gets the names of key policies for the specified KMS key.</p>
4143
4142
  * <p>Specify the key ID or key ARN of the KMS key.</p>
4144
4143
  * <p>For example:</p>
@@ -4153,23 +4152,24 @@ export interface ListKeyPoliciesRequest {
4153
4152
  * </li>
4154
4153
  * </ul>
4155
4154
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
4155
+ * @public
4156
4156
  */
4157
4157
  KeyId: string | undefined;
4158
4158
  /**
4159
- * @public
4160
4159
  * <p>Use this parameter to specify the maximum number of items to return. When this
4161
4160
  * value is present, KMS does not return more than the specified number of items, but it might
4162
4161
  * return fewer.</p>
4163
4162
  * <p>This value is optional. If you include a value, it must be between
4164
4163
  * 1 and 1000, inclusive. If you do not include a value, it defaults to 100.</p>
4165
4164
  * <p>Only one policy can be attached to a key.</p>
4165
+ * @public
4166
4166
  */
4167
4167
  Limit?: number;
4168
4168
  /**
4169
- * @public
4170
4169
  * <p>Use this parameter in a subsequent request after you receive a response with
4171
4170
  * truncated results. Set it to the value of <code>NextMarker</code> from the truncated response
4172
4171
  * you just received.</p>
4172
+ * @public
4173
4173
  */
4174
4174
  Marker?: string;
4175
4175
  }
@@ -4178,22 +4178,22 @@ export interface ListKeyPoliciesRequest {
4178
4178
  */
4179
4179
  export interface ListKeyPoliciesResponse {
4180
4180
  /**
4181
- * @public
4182
4181
  * <p>A list of key policy names. The only valid value is <code>default</code>.</p>
4182
+ * @public
4183
4183
  */
4184
4184
  PolicyNames?: string[];
4185
4185
  /**
4186
- * @public
4187
4186
  * <p>When <code>Truncated</code> is true, this element is present and contains the
4188
4187
  * value to use for the <code>Marker</code> parameter in a subsequent request.</p>
4188
+ * @public
4189
4189
  */
4190
4190
  NextMarker?: string;
4191
4191
  /**
4192
- * @public
4193
4192
  * <p>A flag that indicates whether there are more items in the list. When this
4194
4193
  * value is true, the list in this response is truncated. To get more items, pass the value of
4195
4194
  * the <code>NextMarker</code> element in thisresponse to the <code>Marker</code> parameter in a
4196
4195
  * subsequent request.</p>
4196
+ * @public
4197
4197
  */
4198
4198
  Truncated?: boolean;
4199
4199
  }
@@ -4202,19 +4202,19 @@ export interface ListKeyPoliciesResponse {
4202
4202
  */
4203
4203
  export interface ListKeysRequest {
4204
4204
  /**
4205
- * @public
4206
4205
  * <p>Use this parameter to specify the maximum number of items to return. When this
4207
4206
  * value is present, KMS does not return more than the specified number of items, but it might
4208
4207
  * return fewer.</p>
4209
4208
  * <p>This value is optional. If you include a value, it must be between
4210
4209
  * 1 and 1000, inclusive. If you do not include a value, it defaults to 100.</p>
4210
+ * @public
4211
4211
  */
4212
4212
  Limit?: number;
4213
4213
  /**
4214
- * @public
4215
4214
  * <p>Use this parameter in a subsequent request after you receive a response with
4216
4215
  * truncated results. Set it to the value of <code>NextMarker</code> from the truncated response
4217
4216
  * you just received.</p>
4217
+ * @public
4218
4218
  */
4219
4219
  Marker?: string;
4220
4220
  }
@@ -4223,22 +4223,22 @@ export interface ListKeysRequest {
4223
4223
  */
4224
4224
  export interface ListKeysResponse {
4225
4225
  /**
4226
- * @public
4227
4226
  * <p>A list of KMS keys.</p>
4227
+ * @public
4228
4228
  */
4229
4229
  Keys?: KeyListEntry[];
4230
4230
  /**
4231
- * @public
4232
4231
  * <p>When <code>Truncated</code> is true, this element is present and contains the
4233
4232
  * value to use for the <code>Marker</code> parameter in a subsequent request.</p>
4233
+ * @public
4234
4234
  */
4235
4235
  NextMarker?: string;
4236
4236
  /**
4237
- * @public
4238
4237
  * <p>A flag that indicates whether there are more items in the list. When this
4239
4238
  * value is true, the list in this response is truncated. To get more items, pass the value of
4240
4239
  * the <code>NextMarker</code> element in thisresponse to the <code>Marker</code> parameter in a
4241
4240
  * subsequent request.</p>
4241
+ * @public
4242
4242
  */
4243
4243
  Truncated?: boolean;
4244
4244
  }
@@ -4247,7 +4247,6 @@ export interface ListKeysResponse {
4247
4247
  */
4248
4248
  export interface ListResourceTagsRequest {
4249
4249
  /**
4250
- * @public
4251
4250
  * <p>Gets tags on the specified KMS key.</p>
4252
4251
  * <p>Specify the key ID or key ARN of the KMS key.</p>
4253
4252
  * <p>For example:</p>
@@ -4262,24 +4261,25 @@ export interface ListResourceTagsRequest {
4262
4261
  * </li>
4263
4262
  * </ul>
4264
4263
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
4264
+ * @public
4265
4265
  */
4266
4266
  KeyId: string | undefined;
4267
4267
  /**
4268
- * @public
4269
4268
  * <p>Use this parameter to specify the maximum number of items to return. When this
4270
4269
  * value is present, KMS does not return more than the specified number of items, but it might
4271
4270
  * return fewer.</p>
4272
4271
  * <p>This value is optional. If you include a value, it must be between 1 and 50, inclusive. If
4273
4272
  * you do not include a value, it defaults to 50.</p>
4273
+ * @public
4274
4274
  */
4275
4275
  Limit?: number;
4276
4276
  /**
4277
- * @public
4278
4277
  * <p>Use this parameter in a subsequent request after you receive a response with
4279
4278
  * truncated results. Set it to the value of <code>NextMarker</code> from the truncated response
4280
4279
  * you just received.</p>
4281
4280
  * <p>Do not attempt to construct this value. Use only the value of <code>NextMarker</code> from
4282
4281
  * the truncated response you just received.</p>
4282
+ * @public
4283
4283
  */
4284
4284
  Marker?: string;
4285
4285
  }
@@ -4288,26 +4288,26 @@ export interface ListResourceTagsRequest {
4288
4288
  */
4289
4289
  export interface ListResourceTagsResponse {
4290
4290
  /**
4291
- * @public
4292
4291
  * <p>A list of tags. Each tag consists of a tag key and a tag value.</p>
4293
4292
  * <note>
4294
4293
  * <p>Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">ABAC for KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
4295
4294
  * </note>
4295
+ * @public
4296
4296
  */
4297
4297
  Tags?: Tag[];
4298
4298
  /**
4299
- * @public
4300
4299
  * <p>When <code>Truncated</code> is true, this element is present and contains the
4301
4300
  * value to use for the <code>Marker</code> parameter in a subsequent request.</p>
4302
4301
  * <p>Do not assume or infer any information from this value.</p>
4302
+ * @public
4303
4303
  */
4304
4304
  NextMarker?: string;
4305
4305
  /**
4306
- * @public
4307
4306
  * <p>A flag that indicates whether there are more items in the list. When this
4308
4307
  * value is true, the list in this response is truncated. To get more items, pass the value of
4309
4308
  * the <code>NextMarker</code> element in thisresponse to the <code>Marker</code> parameter in a
4310
4309
  * subsequent request.</p>
4310
+ * @public
4311
4311
  */
4312
4312
  Truncated?: boolean;
4313
4313
  }
@@ -4316,23 +4316,22 @@ export interface ListResourceTagsResponse {
4316
4316
  */
4317
4317
  export interface ListRetirableGrantsRequest {
4318
4318
  /**
4319
- * @public
4320
4319
  * <p>Use this parameter to specify the maximum number of items to return. When this
4321
4320
  * value is present, KMS does not return more than the specified number of items, but it might
4322
4321
  * return fewer.</p>
4323
4322
  * <p>This value is optional. If you include a value, it must be between 1
4324
4323
  * and 100, inclusive. If you do not include a value, it defaults to 50.</p>
4324
+ * @public
4325
4325
  */
4326
4326
  Limit?: number;
4327
4327
  /**
4328
- * @public
4329
4328
  * <p>Use this parameter in a subsequent request after you receive a response with
4330
4329
  * truncated results. Set it to the value of <code>NextMarker</code> from the truncated response
4331
4330
  * you just received.</p>
4331
+ * @public
4332
4332
  */
4333
4333
  Marker?: string;
4334
4334
  /**
4335
- * @public
4336
4335
  * <p>The retiring principal for which to list grants. Enter a principal in your
4337
4336
  * Amazon Web Services account.</p>
4338
4337
  * <p>To specify the retiring principal, use the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of an
@@ -4341,6 +4340,7 @@ export interface ListRetirableGrantsRequest {
4341
4340
  * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM ARNs</a> in the <i>
4342
4341
  * <i>Identity and Access Management User Guide</i>
4343
4342
  * </i>.</p>
4343
+ * @public
4344
4344
  */
4345
4345
  RetiringPrincipal: string | undefined;
4346
4346
  }
@@ -4361,7 +4361,6 @@ export type MessageType = (typeof MessageType)[keyof typeof MessageType];
4361
4361
  */
4362
4362
  export interface PutKeyPolicyRequest {
4363
4363
  /**
4364
- * @public
4365
4364
  * <p>Sets the key policy on the specified KMS key.</p>
4366
4365
  * <p>Specify the key ID or key ARN of the KMS key.</p>
4367
4366
  * <p>For example:</p>
@@ -4376,15 +4375,15 @@ export interface PutKeyPolicyRequest {
4376
4375
  * </li>
4377
4376
  * </ul>
4378
4377
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
4378
+ * @public
4379
4379
  */
4380
4380
  KeyId: string | undefined;
4381
4381
  /**
4382
- * @public
4383
4382
  * <p>The name of the key policy. The only valid value is <code>default</code>.</p>
4383
+ * @public
4384
4384
  */
4385
4385
  PolicyName: string | undefined;
4386
4386
  /**
4387
- * @public
4388
4387
  * <p>The key policy to attach to the KMS key.</p>
4389
4388
  * <p>The key policy must meet the following criteria:</p>
4390
4389
  * <ul>
@@ -4419,10 +4418,10 @@ export interface PutKeyPolicyRequest {
4419
4418
  * <i>Key Management Service Developer Guide</i>.For help writing and formatting a JSON policy document, see the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html">IAM JSON Policy Reference</a> in the <i>
4420
4419
  * <i>Identity and Access Management User Guide</i>
4421
4420
  * </i>.</p>
4421
+ * @public
4422
4422
  */
4423
4423
  Policy: string | undefined;
4424
4424
  /**
4425
- * @public
4426
4425
  * <p>Skips ("bypasses") the key policy lockout safety check. The default value is false.</p>
4427
4426
  * <important>
4428
4427
  * <p>Setting this value to true increases the risk that the KMS key becomes unmanageable. Do
@@ -4432,6 +4431,7 @@ export interface PutKeyPolicyRequest {
4432
4431
  * <p>Use this parameter only when you intend to prevent the principal that is making the
4433
4432
  * request from making a subsequent <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html">PutKeyPolicy</a>
4434
4433
  * request on the KMS key.</p>
4434
+ * @public
4435
4435
  */
4436
4436
  BypassPolicyLockoutSafetyCheck?: boolean;
4437
4437
  }
@@ -4440,12 +4440,11 @@ export interface PutKeyPolicyRequest {
4440
4440
  */
4441
4441
  export interface ReEncryptRequest {
4442
4442
  /**
4443
- * @public
4444
4443
  * <p>Ciphertext of the data to reencrypt.</p>
4444
+ * @public
4445
4445
  */
4446
4446
  CiphertextBlob: Uint8Array | undefined;
4447
4447
  /**
4448
- * @public
4449
4448
  * <p>Specifies the encryption context to use to decrypt the ciphertext. Enter the same
4450
4449
  * encryption context that was used to encrypt the ciphertext.</p>
4451
4450
  * <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represent additional authenticated data.
@@ -4453,10 +4452,10 @@ export interface ReEncryptRequest {
4453
4452
  * only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.</p>
4454
4453
  * <p>For more information, see
4455
4454
  * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption context</a> in the <i>Key Management Service Developer Guide</i>.</p>
4455
+ * @public
4456
4456
  */
4457
4457
  SourceEncryptionContext?: Record<string, string>;
4458
4458
  /**
4459
- * @public
4460
4459
  * <p>Specifies the KMS key that KMS will use to decrypt the ciphertext before it is
4461
4460
  * re-encrypted.</p>
4462
4461
  * <p>Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a
@@ -4487,10 +4486,10 @@ export interface ReEncryptRequest {
4487
4486
  * </li>
4488
4487
  * </ul>
4489
4488
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>
4489
+ * @public
4490
4490
  */
4491
4491
  SourceKeyId?: string;
4492
4492
  /**
4493
- * @public
4494
4493
  * <p>A unique identifier for the KMS key that is used to reencrypt the data. Specify a
4495
4494
  * symmetric encryption KMS key or an asymmetric KMS key with a <code>KeyUsage</code> value of
4496
4495
  * <code>ENCRYPT_DECRYPT</code>. To find the <code>KeyUsage</code> value of a KMS key, use the
@@ -4516,10 +4515,10 @@ export interface ReEncryptRequest {
4516
4515
  * </li>
4517
4516
  * </ul>
4518
4517
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>
4518
+ * @public
4519
4519
  */
4520
4520
  DestinationKeyId: string | undefined;
4521
4521
  /**
4522
- * @public
4523
4522
  * <p>Specifies that encryption context to use when the reencrypting the data.</p>
4524
4523
  * <important>
4525
4524
  * <p>Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p>
@@ -4532,10 +4531,10 @@ export interface ReEncryptRequest {
4532
4531
  * only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.</p>
4533
4532
  * <p>For more information, see
4534
4533
  * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption context</a> in the <i>Key Management Service Developer Guide</i>.</p>
4534
+ * @public
4535
4535
  */
4536
4536
  DestinationEncryptionContext?: Record<string, string>;
4537
4537
  /**
4538
- * @public
4539
4538
  * <p>Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it
4540
4539
  * is reencrypted. The default value, <code>SYMMETRIC_DEFAULT</code>, represents the algorithm
4541
4540
  * used for symmetric encryption KMS keys.</p>
@@ -4543,28 +4542,29 @@ export interface ReEncryptRequest {
4543
4542
  * different algorithm, the decrypt attempt fails.</p>
4544
4543
  * <p>This parameter is required only when the ciphertext was encrypted under an asymmetric KMS
4545
4544
  * key.</p>
4545
+ * @public
4546
4546
  */
4547
4547
  SourceEncryptionAlgorithm?: EncryptionAlgorithmSpec;
4548
4548
  /**
4549
- * @public
4550
4549
  * <p>Specifies the encryption algorithm that KMS will use to reecrypt the data after it has
4551
4550
  * decrypted it. The default value, <code>SYMMETRIC_DEFAULT</code>, represents the encryption
4552
4551
  * algorithm used for symmetric encryption KMS keys.</p>
4553
4552
  * <p>This parameter is required only when the destination KMS key is an asymmetric KMS
4554
4553
  * key.</p>
4554
+ * @public
4555
4555
  */
4556
4556
  DestinationEncryptionAlgorithm?: EncryptionAlgorithmSpec;
4557
4557
  /**
4558
- * @public
4559
4558
  * <p>A list of grant tokens.</p>
4560
4559
  * <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
4561
4560
  * <i>Key Management Service Developer Guide</i>.</p>
4561
+ * @public
4562
4562
  */
4563
4563
  GrantTokens?: string[];
4564
4564
  /**
4565
- * @public
4566
4565
  * <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
4567
4566
  * <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
4567
+ * @public
4568
4568
  */
4569
4569
  DryRun?: boolean;
4570
4570
  }
@@ -4573,29 +4573,29 @@ export interface ReEncryptRequest {
4573
4573
  */
4574
4574
  export interface ReEncryptResponse {
4575
4575
  /**
4576
- * @public
4577
4576
  * <p>The reencrypted data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
4577
+ * @public
4578
4578
  */
4579
4579
  CiphertextBlob?: Uint8Array;
4580
4580
  /**
4581
- * @public
4582
4581
  * <p>Unique identifier of the KMS key used to originally encrypt the data.</p>
4582
+ * @public
4583
4583
  */
4584
4584
  SourceKeyId?: string;
4585
4585
  /**
4586
- * @public
4587
4586
  * <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the KMS key that was used to reencrypt the data.</p>
4587
+ * @public
4588
4588
  */
4589
4589
  KeyId?: string;
4590
4590
  /**
4591
- * @public
4592
4591
  * <p>The encryption algorithm that was used to decrypt the ciphertext before it was
4593
4592
  * reencrypted.</p>
4593
+ * @public
4594
4594
  */
4595
4595
  SourceEncryptionAlgorithm?: EncryptionAlgorithmSpec;
4596
4596
  /**
4597
- * @public
4598
4597
  * <p>The encryption algorithm that was used to reencrypt the data.</p>
4598
+ * @public
4599
4599
  */
4600
4600
  DestinationEncryptionAlgorithm?: EncryptionAlgorithmSpec;
4601
4601
  }
@@ -4604,7 +4604,6 @@ export interface ReEncryptResponse {
4604
4604
  */
4605
4605
  export interface ReplicateKeyRequest {
4606
4606
  /**
4607
- * @public
4608
4607
  * <p>Identifies the multi-Region primary key that is being replicated. To determine whether a
4609
4608
  * KMS key is a multi-Region primary key, use the <a>DescribeKey</a> operation to
4610
4609
  * check the value of the <code>MultiRegionKeyType</code> property.</p>
@@ -4621,10 +4620,10 @@ export interface ReplicateKeyRequest {
4621
4620
  * </li>
4622
4621
  * </ul>
4623
4622
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
4623
+ * @public
4624
4624
  */
4625
4625
  KeyId: string | undefined;
4626
4626
  /**
4627
- * @public
4628
4627
  * <p>The Region ID of the Amazon Web Services Region for this replica key. </p>
4629
4628
  * <p>Enter the Region ID, such as <code>us-east-1</code> or <code>ap-southeast-2</code>. For a
4630
4629
  * list of Amazon Web Services Regions in which KMS is supported, see <a href="https://docs.aws.amazon.com/general/latest/gr/kms.html#kms_region">KMS service endpoints</a> in the
@@ -4642,10 +4641,10 @@ export interface ReplicateKeyRequest {
4642
4641
  * <i>Amazon Web Services General Reference</i>. For information about enabling and disabling Regions, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable">Enabling a
4643
4642
  * Region</a> and <a href="https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-disable">Disabling a Region</a> in the
4644
4643
  * <i>Amazon Web Services General Reference</i>.</p>
4644
+ * @public
4645
4645
  */
4646
4646
  ReplicaRegion: string | undefined;
4647
4647
  /**
4648
- * @public
4649
4648
  * <p>The key policy to attach to the KMS key. This parameter is optional. If you do not provide
4650
4649
  * a key policy, KMS attaches the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default">default key policy</a> to the
4651
4650
  * KMS key.</p>
@@ -4685,10 +4684,10 @@ export interface ReplicateKeyRequest {
4685
4684
  * For help writing and formatting a JSON policy document, see the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html">IAM JSON Policy Reference</a> in the <i>
4686
4685
  * <i>Identity and Access Management User Guide</i>
4687
4686
  * </i>.</p>
4687
+ * @public
4688
4688
  */
4689
4689
  Policy?: string;
4690
4690
  /**
4691
- * @public
4692
4691
  * <p>Skips ("bypasses") the key policy lockout safety check. The default value is false.</p>
4693
4692
  * <important>
4694
4693
  * <p>Setting this value to true increases the risk that the KMS key becomes unmanageable. Do
@@ -4698,10 +4697,10 @@ export interface ReplicateKeyRequest {
4698
4697
  * <p>Use this parameter only when you intend to prevent the principal that is making the
4699
4698
  * request from making a subsequent <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html">PutKeyPolicy</a>
4700
4699
  * request on the KMS key.</p>
4700
+ * @public
4701
4701
  */
4702
4702
  BypassPolicyLockoutSafetyCheck?: boolean;
4703
4703
  /**
4704
- * @public
4705
4704
  * <p>A description of the KMS key. The default value is an empty string (no
4706
4705
  * description).</p>
4707
4706
  * <important>
@@ -4710,10 +4709,10 @@ export interface ReplicateKeyRequest {
4710
4709
  * <p>The description is not a shared property of multi-Region keys. You can specify the same
4711
4710
  * description or a different description for each key in a set of related multi-Region keys.
4712
4711
  * KMS does not synchronize this property.</p>
4712
+ * @public
4713
4713
  */
4714
4714
  Description?: string;
4715
4715
  /**
4716
- * @public
4717
4716
  * <p>Assigns one or more tags to the replica key. Use this parameter to tag the KMS key when it
4718
4717
  * is created. To tag an existing KMS key, use the <a>TagResource</a>
4719
4718
  * operation.</p>
@@ -4734,6 +4733,7 @@ export interface ReplicateKeyRequest {
4734
4733
  * <p>When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation
4735
4734
  * report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details,
4736
4735
  * see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">Tagging Keys</a>.</p>
4736
+ * @public
4737
4737
  */
4738
4738
  Tags?: Tag[];
4739
4739
  }
@@ -4742,22 +4742,22 @@ export interface ReplicateKeyRequest {
4742
4742
  */
4743
4743
  export interface ReplicateKeyResponse {
4744
4744
  /**
4745
- * @public
4746
4745
  * <p>Displays details about the new replica key, including its Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) and
4747
4746
  * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a>. It also includes the ARN and Amazon Web Services Region of its primary key and other
4748
4747
  * replica keys.</p>
4748
+ * @public
4749
4749
  */
4750
4750
  ReplicaKeyMetadata?: KeyMetadata;
4751
4751
  /**
4752
- * @public
4753
4752
  * <p>The key policy of the new replica key. The value is a key policy document in JSON
4754
4753
  * format.</p>
4754
+ * @public
4755
4755
  */
4756
4756
  ReplicaPolicy?: string;
4757
4757
  /**
4758
- * @public
4759
4758
  * <p>The tags on the new replica key. The value is a list of tag key and tag value
4760
4759
  * pairs.</p>
4760
+ * @public
4761
4761
  */
4762
4762
  ReplicaTags?: Tag[];
4763
4763
  }
@@ -4766,23 +4766,22 @@ export interface ReplicateKeyResponse {
4766
4766
  */
4767
4767
  export interface RetireGrantRequest {
4768
4768
  /**
4769
- * @public
4770
4769
  * <p>Identifies the grant to be retired. You can use a grant token to identify a new grant even
4771
4770
  * before it has achieved eventual consistency.</p>
4772
4771
  * <p>Only the <a>CreateGrant</a> operation returns a grant token. For details, see
4773
4772
  * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a>
4774
4773
  * and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-eventual-consistency">Eventual consistency</a> in the <i>Key Management Service Developer Guide</i>.</p>
4774
+ * @public
4775
4775
  */
4776
4776
  GrantToken?: string;
4777
4777
  /**
4778
- * @public
4779
4778
  * <p>The key ARN KMS key associated with the grant. To find the key ARN, use the <a>ListKeys</a> operation.</p>
4780
4779
  * <p>For example: <code>arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
4781
4780
  * </p>
4781
+ * @public
4782
4782
  */
4783
4783
  KeyId?: string;
4784
4784
  /**
4785
- * @public
4786
4785
  * <p>Identifies the grant to retire. To get the grant ID, use <a>CreateGrant</a>,
4787
4786
  * <a>ListGrants</a>, or <a>ListRetirableGrants</a>.</p>
4788
4787
  * <ul>
@@ -4791,12 +4790,13 @@ export interface RetireGrantRequest {
4791
4790
  * 0123456789012345678901234567890123456789012345678901234567890123</p>
4792
4791
  * </li>
4793
4792
  * </ul>
4793
+ * @public
4794
4794
  */
4795
4795
  GrantId?: string;
4796
4796
  /**
4797
- * @public
4798
4797
  * <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
4799
4798
  * <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
4799
+ * @public
4800
4800
  */
4801
4801
  DryRun?: boolean;
4802
4802
  }
@@ -4805,7 +4805,6 @@ export interface RetireGrantRequest {
4805
4805
  */
4806
4806
  export interface RevokeGrantRequest {
4807
4807
  /**
4808
- * @public
4809
4808
  * <p>A unique identifier for the KMS key associated with the grant. To get the key ID and key
4810
4809
  * ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
4811
4810
  * <p>Specify the key ID or key ARN of the KMS key. To specify a KMS key in a
@@ -4822,18 +4821,19 @@ export interface RevokeGrantRequest {
4822
4821
  * </li>
4823
4822
  * </ul>
4824
4823
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
4824
+ * @public
4825
4825
  */
4826
4826
  KeyId: string | undefined;
4827
4827
  /**
4828
- * @public
4829
4828
  * <p>Identifies the grant to revoke. To get the grant ID, use <a>CreateGrant</a>,
4830
4829
  * <a>ListGrants</a>, or <a>ListRetirableGrants</a>.</p>
4830
+ * @public
4831
4831
  */
4832
4832
  GrantId: string | undefined;
4833
4833
  /**
4834
- * @public
4835
4834
  * <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
4836
4835
  * <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
4836
+ * @public
4837
4837
  */
4838
4838
  DryRun?: boolean;
4839
4839
  }
@@ -4842,7 +4842,6 @@ export interface RevokeGrantRequest {
4842
4842
  */
4843
4843
  export interface ScheduleKeyDeletionRequest {
4844
4844
  /**
4845
- * @public
4846
4845
  * <p>The unique identifier of the KMS key to delete.</p>
4847
4846
  * <p>Specify the key ID or key ARN of the KMS key.</p>
4848
4847
  * <p>For example:</p>
@@ -4857,10 +4856,10 @@ export interface ScheduleKeyDeletionRequest {
4857
4856
  * </li>
4858
4857
  * </ul>
4859
4858
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
4859
+ * @public
4860
4860
  */
4861
4861
  KeyId: string | undefined;
4862
4862
  /**
4863
- * @public
4864
4863
  * <p>The waiting period, specified in number of days. After the waiting period ends, KMS
4865
4864
  * deletes the KMS key.</p>
4866
4865
  * <p>If the KMS key is a multi-Region primary key with replica keys, the waiting period begins
@@ -4872,6 +4871,7 @@ export interface ScheduleKeyDeletionRequest {
4872
4871
  * </a> condition key to further
4873
4872
  * constrain the values that principals can specify in the <code>PendingWindowInDays</code>
4874
4873
  * parameter.</p>
4874
+ * @public
4875
4875
  */
4876
4876
  PendingWindowInDays?: number;
4877
4877
  }
@@ -4880,31 +4880,31 @@ export interface ScheduleKeyDeletionRequest {
4880
4880
  */
4881
4881
  export interface ScheduleKeyDeletionResponse {
4882
4882
  /**
4883
- * @public
4884
4883
  * <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the KMS key whose deletion is scheduled.</p>
4884
+ * @public
4885
4885
  */
4886
4886
  KeyId?: string;
4887
4887
  /**
4888
- * @public
4889
4888
  * <p>The date and time after which KMS deletes the KMS key.</p>
4890
4889
  * <p>If the KMS key is a multi-Region primary key with replica keys, this field does not
4891
4890
  * appear. The deletion date for the primary key isn't known until its last replica key is
4892
4891
  * deleted.</p>
4892
+ * @public
4893
4893
  */
4894
4894
  DeletionDate?: Date;
4895
4895
  /**
4896
- * @public
4897
4896
  * <p>The current status of the KMS key.</p>
4898
4897
  * <p>For more information about how key state affects the use of a KMS key, see
4899
4898
  * <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>
4899
+ * @public
4900
4900
  */
4901
4901
  KeyState?: KeyState;
4902
4902
  /**
4903
- * @public
4904
4903
  * <p>The waiting period before the KMS key is deleted. </p>
4905
4904
  * <p>If the KMS key is a multi-Region primary key with replicas, the waiting period begins when
4906
4905
  * the last of its replica keys is deleted. Otherwise, the waiting period begins
4907
4906
  * immediately.</p>
4907
+ * @public
4908
4908
  */
4909
4909
  PendingWindowInDays?: number;
4910
4910
  }
@@ -4913,7 +4913,6 @@ export interface ScheduleKeyDeletionResponse {
4913
4913
  */
4914
4914
  export interface SignRequest {
4915
4915
  /**
4916
- * @public
4917
4916
  * <p>Identifies an asymmetric KMS key. KMS uses the private key in the asymmetric KMS key to
4918
4917
  * sign the message. The <code>KeyUsage</code> type of the KMS key must be
4919
4918
  * <code>SIGN_VERIFY</code>. To find the <code>KeyUsage</code> of a KMS key, use the <a>DescribeKey</a> operation.</p>
@@ -4938,18 +4937,18 @@ export interface SignRequest {
4938
4937
  * </li>
4939
4938
  * </ul>
4940
4939
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>
4940
+ * @public
4941
4941
  */
4942
4942
  KeyId: string | undefined;
4943
4943
  /**
4944
- * @public
4945
4944
  * <p>Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a
4946
4945
  * larger message, provide a message digest.</p>
4947
4946
  * <p>If you provide a message digest, use the <code>DIGEST</code> value of
4948
4947
  * <code>MessageType</code> to prevent the digest from being hashed again while signing.</p>
4948
+ * @public
4949
4949
  */
4950
4950
  Message: Uint8Array | undefined;
4951
4951
  /**
4952
- * @public
4953
4952
  * <p>Tells KMS whether the value of the <code>Message</code> parameter should be hashed as
4954
4953
  * part of the signing algorithm. Use <code>RAW</code> for unhashed messages; use
4955
4954
  * <code>DIGEST</code> for message digests, which are already hashed.</p>
@@ -4984,27 +4983,28 @@ export interface SignRequest {
4984
4983
  * verification with SM2 key pairs</a>.</p>
4985
4984
  * </li>
4986
4985
  * </ul>
4986
+ * @public
4987
4987
  */
4988
4988
  MessageType?: MessageType;
4989
4989
  /**
4990
- * @public
4991
4990
  * <p>A list of grant tokens.</p>
4992
4991
  * <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
4993
4992
  * <i>Key Management Service Developer Guide</i>.</p>
4993
+ * @public
4994
4994
  */
4995
4995
  GrantTokens?: string[];
4996
4996
  /**
4997
- * @public
4998
4997
  * <p>Specifies the signing algorithm to use when signing the message. </p>
4999
4998
  * <p>Choose an algorithm that is compatible with the type and size of the specified asymmetric
5000
4999
  * KMS key. When signing with RSA key pairs, RSASSA-PSS algorithms are preferred. We include
5001
5000
  * RSASSA-PKCS1-v1_5 algorithms for compatibility with existing applications.</p>
5001
+ * @public
5002
5002
  */
5003
5003
  SigningAlgorithm: SigningAlgorithmSpec | undefined;
5004
5004
  /**
5005
- * @public
5006
5005
  * <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
5007
5006
  * <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
5007
+ * @public
5008
5008
  */
5009
5009
  DryRun?: boolean;
5010
5010
  }
@@ -5013,12 +5013,11 @@ export interface SignRequest {
5013
5013
  */
5014
5014
  export interface SignResponse {
5015
5015
  /**
5016
- * @public
5017
5016
  * <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the asymmetric KMS key that was used to sign the message.</p>
5017
+ * @public
5018
5018
  */
5019
5019
  KeyId?: string;
5020
5020
  /**
5021
- * @public
5022
5021
  * <p>The cryptographic signature that was generated for the message. </p>
5023
5022
  * <ul>
5024
5023
  * <li>
@@ -5035,11 +5034,12 @@ export interface SignResponse {
5035
5034
  * </li>
5036
5035
  * </ul>
5037
5036
  * <p>When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
5037
+ * @public
5038
5038
  */
5039
5039
  Signature?: Uint8Array;
5040
5040
  /**
5041
- * @public
5042
5041
  * <p>The signing algorithm that was used to sign the message.</p>
5042
+ * @public
5043
5043
  */
5044
5044
  SigningAlgorithm?: SigningAlgorithmSpec;
5045
5045
  }
@@ -5048,7 +5048,6 @@ export interface SignResponse {
5048
5048
  */
5049
5049
  export interface TagResourceRequest {
5050
5050
  /**
5051
- * @public
5052
5051
  * <p>Identifies a customer managed key in the account and Region.</p>
5053
5052
  * <p>Specify the key ID or key ARN of the KMS key.</p>
5054
5053
  * <p>For example:</p>
@@ -5063,10 +5062,10 @@ export interface TagResourceRequest {
5063
5062
  * </li>
5064
5063
  * </ul>
5065
5064
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
5065
+ * @public
5066
5066
  */
5067
5067
  KeyId: string | undefined;
5068
5068
  /**
5069
- * @public
5070
5069
  * <p>One or more tags. Each tag consists of a tag key and a tag value. The tag value can be an
5071
5070
  * empty (null) string. </p>
5072
5071
  * <important>
@@ -5075,6 +5074,7 @@ export interface TagResourceRequest {
5075
5074
  * <p>You cannot have more than one tag on a KMS key with the same tag key. If you specify an
5076
5075
  * existing tag key with a different tag value, KMS replaces the current tag value with the
5077
5076
  * specified one.</p>
5077
+ * @public
5078
5078
  */
5079
5079
  Tags: Tag[] | undefined;
5080
5080
  }
@@ -5083,7 +5083,6 @@ export interface TagResourceRequest {
5083
5083
  */
5084
5084
  export interface UntagResourceRequest {
5085
5085
  /**
5086
- * @public
5087
5086
  * <p>Identifies the KMS key from which you are removing tags.</p>
5088
5087
  * <p>Specify the key ID or key ARN of the KMS key.</p>
5089
5088
  * <p>For example:</p>
@@ -5098,11 +5097,12 @@ export interface UntagResourceRequest {
5098
5097
  * </li>
5099
5098
  * </ul>
5100
5099
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
5100
+ * @public
5101
5101
  */
5102
5102
  KeyId: string | undefined;
5103
5103
  /**
5104
- * @public
5105
5104
  * <p>One or more tag keys. Specify only the tag keys, not the tag values.</p>
5105
+ * @public
5106
5106
  */
5107
5107
  TagKeys: string[] | undefined;
5108
5108
  }
@@ -5111,17 +5111,16 @@ export interface UntagResourceRequest {
5111
5111
  */
5112
5112
  export interface UpdateAliasRequest {
5113
5113
  /**
5114
- * @public
5115
5114
  * <p>Identifies the alias that is changing its KMS key. This value must begin with
5116
5115
  * <code>alias/</code> followed by the alias name, such as <code>alias/ExampleAlias</code>. You
5117
5116
  * cannot use <code>UpdateAlias</code> to change the alias name.</p>
5118
5117
  * <important>
5119
5118
  * <p>Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p>
5120
5119
  * </important>
5120
+ * @public
5121
5121
  */
5122
5122
  AliasName: string | undefined;
5123
5123
  /**
5124
- * @public
5125
5124
  * <p>Identifies the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a> to associate with the alias. You don't have permission to
5126
5125
  * associate an alias with an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed key</a>.</p>
5127
5126
  * <p>The KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the new
@@ -5141,6 +5140,7 @@ export interface UpdateAliasRequest {
5141
5140
  * </ul>
5142
5141
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
5143
5142
  * <p>To verify that the alias is mapped to the correct KMS key, use <a>ListAliases</a>.</p>
5143
+ * @public
5144
5144
  */
5145
5145
  TargetKeyId: string | undefined;
5146
5146
  }
@@ -5149,13 +5149,12 @@ export interface UpdateAliasRequest {
5149
5149
  */
5150
5150
  export interface UpdateCustomKeyStoreRequest {
5151
5151
  /**
5152
- * @public
5153
5152
  * <p>Identifies the custom key store that you want to update. Enter the ID of the custom key
5154
5153
  * store. To find the ID of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p>
5154
+ * @public
5155
5155
  */
5156
5156
  CustomKeyStoreId: string | undefined;
5157
5157
  /**
5158
- * @public
5159
5158
  * <p>Changes the friendly name of the custom key store to the value that you specify. The
5160
5159
  * custom key store name must be unique in the Amazon Web Services account.</p>
5161
5160
  * <important>
@@ -5163,20 +5162,20 @@ export interface UpdateCustomKeyStoreRequest {
5163
5162
  * </important>
5164
5163
  * <p>To change this value, an CloudHSM key store must be disconnected. An external key store can
5165
5164
  * be connected or disconnected.</p>
5165
+ * @public
5166
5166
  */
5167
5167
  NewCustomKeyStoreName?: string;
5168
5168
  /**
5169
- * @public
5170
5169
  * <p>Enter the current password of the <code>kmsuser</code> crypto user (CU) in the CloudHSM
5171
5170
  * cluster that is associated with the custom key store. This parameter is valid only for custom
5172
5171
  * key stores with a <code>CustomKeyStoreType</code> of <code>AWS_CLOUDHSM</code>.</p>
5173
5172
  * <p>This parameter tells KMS the current password of the <code>kmsuser</code> crypto user
5174
5173
  * (CU). It does not set or change the password of any users in the CloudHSM cluster.</p>
5175
5174
  * <p>To change this value, the CloudHSM key store must be disconnected.</p>
5175
+ * @public
5176
5176
  */
5177
5177
  KeyStorePassword?: string;
5178
5178
  /**
5179
- * @public
5180
5179
  * <p>Associates the custom key store with a related CloudHSM cluster. This parameter is valid only
5181
5180
  * for custom key stores with a <code>CustomKeyStoreType</code> of
5182
5181
  * <code>AWS_CLOUDHSM</code>.</p>
@@ -5187,10 +5186,10 @@ export interface UpdateCustomKeyStoreRequest {
5187
5186
  * a cluster associated with a custom key store. To view the cluster certificate of a cluster,
5188
5187
  * use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html">DescribeClusters</a> operation.</p>
5189
5188
  * <p>To change this value, the CloudHSM key store must be disconnected.</p>
5189
+ * @public
5190
5190
  */
5191
5191
  CloudHsmClusterId?: string;
5192
5192
  /**
5193
- * @public
5194
5193
  * <p>Changes the URI endpoint that KMS uses to connect to your external key store proxy (XKS
5195
5194
  * proxy). This parameter is valid only for custom key stores with a
5196
5195
  * <code>CustomKeyStoreType</code> of <code>EXTERNAL_KEY_STORE</code>.</p>
@@ -5203,10 +5202,10 @@ export interface UpdateCustomKeyStoreRequest {
5203
5202
  * <p>The combined <code>XksProxyUriEndpoint</code> and <code>XksProxyUriPath</code> values must
5204
5203
  * be unique in the Amazon Web Services account and Region.</p>
5205
5204
  * <p>To change this value, the external key store must be disconnected.</p>
5205
+ * @public
5206
5206
  */
5207
5207
  XksProxyUriEndpoint?: string;
5208
5208
  /**
5209
- * @public
5210
5209
  * <p>Changes the base path to the proxy APIs for this external key store. To find this value,
5211
5210
  * see the documentation for your external key manager and external key store proxy (XKS proxy).
5212
5211
  * This parameter is valid only for custom key stores with a <code>CustomKeyStoreType</code> of
@@ -5218,19 +5217,19 @@ export interface UpdateCustomKeyStoreRequest {
5218
5217
  * <p>The combined <code>XksProxyUriEndpoint</code> and <code>XksProxyUriPath</code> values must
5219
5218
  * be unique in the Amazon Web Services account and Region.</p>
5220
5219
  * <p>You can change this value when the external key store is connected or disconnected.</p>
5220
+ * @public
5221
5221
  */
5222
5222
  XksProxyUriPath?: string;
5223
5223
  /**
5224
- * @public
5225
5224
  * <p>Changes the name that KMS uses to identify the Amazon VPC endpoint service for your external
5226
5225
  * key store proxy (XKS proxy). This parameter is valid when the <code>CustomKeyStoreType</code>
5227
5226
  * is <code>EXTERNAL_KEY_STORE</code> and the <code>XksProxyConnectivity</code> is
5228
5227
  * <code>VPC_ENDPOINT_SERVICE</code>.</p>
5229
5228
  * <p>To change this value, the external key store must be disconnected.</p>
5229
+ * @public
5230
5230
  */
5231
5231
  XksProxyVpcEndpointServiceName?: string;
5232
5232
  /**
5233
- * @public
5234
5233
  * <p>Changes the credentials that KMS uses to sign requests to the external key store proxy
5235
5234
  * (XKS proxy). This parameter is valid only for custom key stores with a
5236
5235
  * <code>CustomKeyStoreType</code> of <code>EXTERNAL_KEY_STORE</code>.</p>
@@ -5241,10 +5240,10 @@ export interface UpdateCustomKeyStoreRequest {
5241
5240
  * For example, if you rotate the credential on your external key store proxy, you can use this
5242
5241
  * parameter to update the credential in KMS.</p>
5243
5242
  * <p>You can change this value when the external key store is connected or disconnected.</p>
5243
+ * @public
5244
5244
  */
5245
5245
  XksProxyAuthenticationCredential?: XksProxyAuthenticationCredentialType;
5246
5246
  /**
5247
- * @public
5248
5247
  * <p>Changes the connectivity setting for the external key store. To indicate that the external
5249
5248
  * key store proxy uses a Amazon VPC endpoint service to communicate with KMS, specify
5250
5249
  * <code>VPC_ENDPOINT_SERVICE</code>. Otherwise, specify <code>PUBLIC_ENDPOINT</code>.</p>
@@ -5255,6 +5254,7 @@ export interface UpdateCustomKeyStoreRequest {
5255
5254
  * must also change the <code>XksProxyUriEndpoint</code> and specify a null or empty string for
5256
5255
  * the <code>XksProxyVpcEndpointServiceName</code> value.</p>
5257
5256
  * <p>To change this value, the external key store must be disconnected.</p>
5257
+ * @public
5258
5258
  */
5259
5259
  XksProxyConnectivity?: XksProxyConnectivityType;
5260
5260
  }
@@ -5268,7 +5268,6 @@ export interface UpdateCustomKeyStoreResponse {
5268
5268
  */
5269
5269
  export interface UpdateKeyDescriptionRequest {
5270
5270
  /**
5271
- * @public
5272
5271
  * <p>Updates the description of the specified KMS key.</p>
5273
5272
  * <p>Specify the key ID or key ARN of the KMS key.</p>
5274
5273
  * <p>For example:</p>
@@ -5283,14 +5282,15 @@ export interface UpdateKeyDescriptionRequest {
5283
5282
  * </li>
5284
5283
  * </ul>
5285
5284
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
5285
+ * @public
5286
5286
  */
5287
5287
  KeyId: string | undefined;
5288
5288
  /**
5289
- * @public
5290
5289
  * <p>New description for the KMS key.</p>
5291
5290
  * <important>
5292
5291
  * <p>Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p>
5293
5292
  * </important>
5293
+ * @public
5294
5294
  */
5295
5295
  Description: string | undefined;
5296
5296
  }
@@ -5299,7 +5299,6 @@ export interface UpdateKeyDescriptionRequest {
5299
5299
  */
5300
5300
  export interface UpdatePrimaryRegionRequest {
5301
5301
  /**
5302
- * @public
5303
5302
  * <p>Identifies the current primary key. When the operation completes, this KMS key will be a
5304
5303
  * replica key.</p>
5305
5304
  * <p>Specify the key ID or key ARN of a multi-Region primary key.</p>
@@ -5315,15 +5314,16 @@ export interface UpdatePrimaryRegionRequest {
5315
5314
  * </li>
5316
5315
  * </ul>
5317
5316
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
5317
+ * @public
5318
5318
  */
5319
5319
  KeyId: string | undefined;
5320
5320
  /**
5321
- * @public
5322
5321
  * <p>The Amazon Web Services Region of the new primary key. Enter the Region ID, such as
5323
5322
  * <code>us-east-1</code> or <code>ap-southeast-2</code>. There must be an existing replica key
5324
5323
  * in this Region. </p>
5325
5324
  * <p>When the operation completes, the multi-Region key in this Region will be the primary
5326
5325
  * key.</p>
5326
+ * @public
5327
5327
  */
5328
5328
  PrimaryRegion: string | undefined;
5329
5329
  }
@@ -5332,7 +5332,6 @@ export interface UpdatePrimaryRegionRequest {
5332
5332
  */
5333
5333
  export interface VerifyRequest {
5334
5334
  /**
5335
- * @public
5336
5335
  * <p>Identifies the asymmetric KMS key that will be used to verify the signature. This must be
5337
5336
  * the same KMS key that was used to generate the signature. If you specify a different KMS key,
5338
5337
  * the signature verification fails.</p>
@@ -5357,20 +5356,20 @@ export interface VerifyRequest {
5357
5356
  * </li>
5358
5357
  * </ul>
5359
5358
  * <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>
5359
+ * @public
5360
5360
  */
5361
5361
  KeyId: string | undefined;
5362
5362
  /**
5363
- * @public
5364
5363
  * <p>Specifies the message that was signed. You can submit a raw message of up to 4096 bytes,
5365
5364
  * or a hash digest of the message. If you submit a digest, use the <code>MessageType</code>
5366
5365
  * parameter with a value of <code>DIGEST</code>.</p>
5367
5366
  * <p>If the message specified here is different from the message that was signed, the signature
5368
5367
  * verification fails. A message and its hash digest are considered to be the same
5369
5368
  * message.</p>
5369
+ * @public
5370
5370
  */
5371
5371
  Message: Uint8Array | undefined;
5372
5372
  /**
5373
- * @public
5374
5373
  * <p>Tells KMS whether the value of the <code>Message</code> parameter should be hashed as
5375
5374
  * part of the signing algorithm. Use <code>RAW</code> for unhashed messages; use
5376
5375
  * <code>DIGEST</code> for message digests, which are already hashed.</p>
@@ -5406,30 +5405,31 @@ export interface VerifyRequest {
5406
5405
  * verification with SM2 key pairs</a>.</p>
5407
5406
  * </li>
5408
5407
  * </ul>
5408
+ * @public
5409
5409
  */
5410
5410
  MessageType?: MessageType;
5411
5411
  /**
5412
- * @public
5413
5412
  * <p>The signature that the <code>Sign</code> operation generated.</p>
5413
+ * @public
5414
5414
  */
5415
5415
  Signature: Uint8Array | undefined;
5416
5416
  /**
5417
- * @public
5418
5417
  * <p>The signing algorithm that was used to sign the message. If you submit a different
5419
5418
  * algorithm, the signature verification fails.</p>
5419
+ * @public
5420
5420
  */
5421
5421
  SigningAlgorithm: SigningAlgorithmSpec | undefined;
5422
5422
  /**
5423
- * @public
5424
5423
  * <p>A list of grant tokens.</p>
5425
5424
  * <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
5426
5425
  * <i>Key Management Service Developer Guide</i>.</p>
5426
+ * @public
5427
5427
  */
5428
5428
  GrantTokens?: string[];
5429
5429
  /**
5430
- * @public
5431
5430
  * <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
5432
5431
  * <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
5432
+ * @public
5433
5433
  */
5434
5434
  DryRun?: boolean;
5435
5435
  }
@@ -5438,22 +5438,22 @@ export interface VerifyRequest {
5438
5438
  */
5439
5439
  export interface VerifyResponse {
5440
5440
  /**
5441
- * @public
5442
5441
  * <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the asymmetric KMS key that was used to verify the signature.</p>
5442
+ * @public
5443
5443
  */
5444
5444
  KeyId?: string;
5445
5445
  /**
5446
- * @public
5447
5446
  * <p>A Boolean value that indicates whether the signature was verified. A value of
5448
5447
  * <code>True</code> indicates that the <code>Signature</code> was produced by signing the
5449
5448
  * <code>Message</code> with the specified <code>KeyID</code> and
5450
5449
  * <code>SigningAlgorithm.</code> If the signature is not verified, the <code>Verify</code>
5451
5450
  * operation fails with a <code>KMSInvalidSignatureException</code> exception. </p>
5451
+ * @public
5452
5452
  */
5453
5453
  SignatureValid?: boolean;
5454
5454
  /**
5455
- * @public
5456
5455
  * <p>The signing algorithm that was used to verify the signature.</p>
5456
+ * @public
5457
5457
  */
5458
5458
  SigningAlgorithm?: SigningAlgorithmSpec;
5459
5459
  }
@@ -5462,47 +5462,47 @@ export interface VerifyResponse {
5462
5462
  */
5463
5463
  export interface VerifyMacRequest {
5464
5464
  /**
5465
- * @public
5466
5465
  * <p>The message that will be used in the verification. Enter the same message that was used to
5467
5466
  * generate the HMAC.</p>
5468
5467
  * <p>
5469
5468
  * <a>GenerateMac</a> and <code>VerifyMac</code> do not provide special handling
5470
5469
  * for message digests. If you generated an HMAC for a hash digest of a message, you must verify
5471
5470
  * the HMAC for the same hash digest.</p>
5471
+ * @public
5472
5472
  */
5473
5473
  Message: Uint8Array | undefined;
5474
5474
  /**
5475
- * @public
5476
5475
  * <p>The KMS key that will be used in the verification.</p>
5477
5476
  * <p>Enter a key ID of the KMS key that was used to generate the HMAC. If you identify a
5478
5477
  * different KMS key, the <code>VerifyMac</code> operation fails.</p>
5478
+ * @public
5479
5479
  */
5480
5480
  KeyId: string | undefined;
5481
5481
  /**
5482
- * @public
5483
5482
  * <p>The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that
5484
5483
  * was used to compute the HMAC. This algorithm must be supported by the HMAC KMS key identified
5485
5484
  * by the <code>KeyId</code> parameter.</p>
5485
+ * @public
5486
5486
  */
5487
5487
  MacAlgorithm: MacAlgorithmSpec | undefined;
5488
5488
  /**
5489
- * @public
5490
5489
  * <p>The HMAC to verify. Enter the HMAC that was generated by the <a>GenerateMac</a>
5491
5490
  * operation when you specified the same message, HMAC KMS key, and MAC algorithm as the values
5492
5491
  * specified in this request.</p>
5492
+ * @public
5493
5493
  */
5494
5494
  Mac: Uint8Array | undefined;
5495
5495
  /**
5496
- * @public
5497
5496
  * <p>A list of grant tokens.</p>
5498
5497
  * <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
5499
5498
  * <i>Key Management Service Developer Guide</i>.</p>
5499
+ * @public
5500
5500
  */
5501
5501
  GrantTokens?: string[];
5502
5502
  /**
5503
- * @public
5504
5503
  * <p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter. </p>
5505
5504
  * <p>To learn more about how to use this parameter, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html">Testing your KMS API calls</a> in the <i>Key Management Service Developer Guide</i>.</p>
5505
+ * @public
5506
5506
  */
5507
5507
  DryRun?: boolean;
5508
5508
  }
@@ -5511,12 +5511,11 @@ export interface VerifyMacRequest {
5511
5511
  */
5512
5512
  export interface VerifyMacResponse {
5513
5513
  /**
5514
- * @public
5515
5514
  * <p>The HMAC KMS key used in the verification.</p>
5515
+ * @public
5516
5516
  */
5517
5517
  KeyId?: string;
5518
5518
  /**
5519
- * @public
5520
5519
  * <p>A Boolean value that indicates whether the HMAC was verified. A value of <code>True</code>
5521
5520
  * indicates that the HMAC (<code>Mac</code>) was generated with the specified
5522
5521
  * <code>Message</code>, HMAC KMS key (<code>KeyID</code>) and
@@ -5524,11 +5523,12 @@ export interface VerifyMacResponse {
5524
5523
  * <p>If the HMAC is not verified, the <code>VerifyMac</code> operation fails with a
5525
5524
  * <code>KMSInvalidMacException</code> exception. This exception indicates that one or more of
5526
5525
  * the inputs changed since the HMAC was computed.</p>
5526
+ * @public
5527
5527
  */
5528
5528
  MacValid?: boolean;
5529
5529
  /**
5530
- * @public
5531
5530
  * <p>The MAC algorithm used in the verification.</p>
5531
+ * @public
5532
5532
  */
5533
5533
  MacAlgorithm?: MacAlgorithmSpec;
5534
5534
  }