@aws-sdk/client-kms 3.295.0 → 3.297.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 (63) hide show
  1. package/dist-types/KMS.d.ts +51 -0
  2. package/dist-types/KMSClient.d.ts +24 -4
  3. package/dist-types/commands/CancelKeyDeletionCommand.d.ts +16 -0
  4. package/dist-types/commands/ConnectCustomKeyStoreCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateAliasCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateCustomKeyStoreCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateGrantCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateKeyCommand.d.ts +16 -0
  9. package/dist-types/commands/DecryptCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteAliasCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteCustomKeyStoreCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteImportedKeyMaterialCommand.d.ts +16 -0
  13. package/dist-types/commands/DescribeCustomKeyStoresCommand.d.ts +16 -0
  14. package/dist-types/commands/DescribeKeyCommand.d.ts +16 -0
  15. package/dist-types/commands/DisableKeyCommand.d.ts +16 -0
  16. package/dist-types/commands/DisableKeyRotationCommand.d.ts +16 -0
  17. package/dist-types/commands/DisconnectCustomKeyStoreCommand.d.ts +16 -0
  18. package/dist-types/commands/EnableKeyCommand.d.ts +16 -0
  19. package/dist-types/commands/EnableKeyRotationCommand.d.ts +16 -0
  20. package/dist-types/commands/EncryptCommand.d.ts +16 -0
  21. package/dist-types/commands/GenerateDataKeyCommand.d.ts +16 -0
  22. package/dist-types/commands/GenerateDataKeyPairCommand.d.ts +16 -0
  23. package/dist-types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +16 -0
  24. package/dist-types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +16 -0
  25. package/dist-types/commands/GenerateMacCommand.d.ts +16 -0
  26. package/dist-types/commands/GenerateRandomCommand.d.ts +16 -0
  27. package/dist-types/commands/GetKeyPolicyCommand.d.ts +16 -0
  28. package/dist-types/commands/GetKeyRotationStatusCommand.d.ts +16 -0
  29. package/dist-types/commands/GetParametersForImportCommand.d.ts +16 -0
  30. package/dist-types/commands/GetPublicKeyCommand.d.ts +16 -0
  31. package/dist-types/commands/ImportKeyMaterialCommand.d.ts +16 -0
  32. package/dist-types/commands/ListAliasesCommand.d.ts +16 -0
  33. package/dist-types/commands/ListGrantsCommand.d.ts +16 -0
  34. package/dist-types/commands/ListKeyPoliciesCommand.d.ts +16 -0
  35. package/dist-types/commands/ListKeysCommand.d.ts +16 -0
  36. package/dist-types/commands/ListResourceTagsCommand.d.ts +16 -0
  37. package/dist-types/commands/ListRetirableGrantsCommand.d.ts +16 -0
  38. package/dist-types/commands/PutKeyPolicyCommand.d.ts +16 -0
  39. package/dist-types/commands/ReEncryptCommand.d.ts +16 -0
  40. package/dist-types/commands/ReplicateKeyCommand.d.ts +16 -0
  41. package/dist-types/commands/RetireGrantCommand.d.ts +16 -0
  42. package/dist-types/commands/RevokeGrantCommand.d.ts +16 -0
  43. package/dist-types/commands/ScheduleKeyDeletionCommand.d.ts +16 -0
  44. package/dist-types/commands/SignCommand.d.ts +16 -0
  45. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  46. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  47. package/dist-types/commands/UpdateAliasCommand.d.ts +16 -0
  48. package/dist-types/commands/UpdateCustomKeyStoreCommand.d.ts +16 -0
  49. package/dist-types/commands/UpdateKeyDescriptionCommand.d.ts +16 -0
  50. package/dist-types/commands/UpdatePrimaryRegionCommand.d.ts +16 -0
  51. package/dist-types/commands/VerifyCommand.d.ts +16 -0
  52. package/dist-types/commands/VerifyMacCommand.d.ts +16 -0
  53. package/dist-types/models/KMSServiceException.d.ts +2 -0
  54. package/dist-types/models/models_0.d.ts +373 -0
  55. package/dist-types/pagination/DescribeCustomKeyStoresPaginator.d.ts +3 -0
  56. package/dist-types/pagination/Interfaces.d.ts +3 -0
  57. package/dist-types/pagination/ListAliasesPaginator.d.ts +3 -0
  58. package/dist-types/pagination/ListGrantsPaginator.d.ts +3 -0
  59. package/dist-types/pagination/ListKeyPoliciesPaginator.d.ts +3 -0
  60. package/dist-types/pagination/ListKeysPaginator.d.ts +3 -0
  61. package/dist-types/pagination/ListResourceTagsPaginator.d.ts +3 -0
  62. package/dist-types/pagination/ListRetirableGrantsPaginator.d.ts +3 -0
  63. package/package.json +29 -29
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { ScheduleKeyDeletionRequest, ScheduleKeyDeletionResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ScheduleKeyDeletionCommand}.
8
10
  */
9
11
  export interface ScheduleKeyDeletionCommandInput extends ScheduleKeyDeletionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ScheduleKeyDeletionCommand}.
13
17
  */
14
18
  export interface ScheduleKeyDeletionCommandOutput extends ScheduleKeyDeletionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Schedules the deletion of a KMS key. By default, KMS applies a waiting period of 30
18
23
  * days, but you can specify a waiting period of 7-30 days. When this operation is successful,
19
24
  * the key state of the KMS key changes to <code>PendingDeletion</code> and the key can't be used
@@ -80,6 +85,8 @@ export interface ScheduleKeyDeletionCommandOutput extends ScheduleKeyDeletionRes
80
85
  * const response = await client.send(command);
81
86
  * ```
82
87
  *
88
+ * @param ScheduleKeyDeletionCommandInput - {@link ScheduleKeyDeletionCommandInput}
89
+ * @returns {@link ScheduleKeyDeletionCommandOutput}
83
90
  * @see {@link ScheduleKeyDeletionCommandInput} for command's `input` shape.
84
91
  * @see {@link ScheduleKeyDeletionCommandOutput} for command's `response` shape.
85
92
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
@@ -141,11 +148,20 @@ export interface ScheduleKeyDeletionCommandOutput extends ScheduleKeyDeletionRes
141
148
  export declare class ScheduleKeyDeletionCommand extends $Command<ScheduleKeyDeletionCommandInput, ScheduleKeyDeletionCommandOutput, KMSClientResolvedConfig> {
142
149
  readonly input: ScheduleKeyDeletionCommandInput;
143
150
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
151
+ /**
152
+ * @public
153
+ */
144
154
  constructor(input: ScheduleKeyDeletionCommandInput);
145
155
  /**
146
156
  * @internal
147
157
  */
148
158
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ScheduleKeyDeletionCommandInput, ScheduleKeyDeletionCommandOutput>;
159
+ /**
160
+ * @internal
161
+ */
149
162
  private serialize;
163
+ /**
164
+ * @internal
165
+ */
150
166
  private deserialize;
151
167
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { SignRequest, SignResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SignCommand}.
8
10
  */
9
11
  export interface SignCommandInput extends SignRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SignCommand}.
13
17
  */
14
18
  export interface SignCommandOutput extends SignResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a <a href="https://en.wikipedia.org/wiki/Digital_signature">digital
18
23
  * signature</a> for a message or message digest by using the private key in an asymmetric
19
24
  * signing KMS key. To verify the signature, use the <a>Verify</a> operation, or use
@@ -76,6 +81,8 @@ export interface SignCommandOutput extends SignResponse, __MetadataBearer {
76
81
  * const response = await client.send(command);
77
82
  * ```
78
83
  *
84
+ * @param SignCommandInput - {@link SignCommandInput}
85
+ * @returns {@link SignCommandOutput}
79
86
  * @see {@link SignCommandInput} for command's `input` shape.
80
87
  * @see {@link SignCommandOutput} for command's `response` shape.
81
88
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
@@ -188,11 +195,20 @@ export interface SignCommandOutput extends SignResponse, __MetadataBearer {
188
195
  export declare class SignCommand extends $Command<SignCommandInput, SignCommandOutput, KMSClientResolvedConfig> {
189
196
  readonly input: SignCommandInput;
190
197
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
198
+ /**
199
+ * @public
200
+ */
191
201
  constructor(input: SignCommandInput);
192
202
  /**
193
203
  * @internal
194
204
  */
195
205
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SignCommandInput, SignCommandOutput>;
206
+ /**
207
+ * @internal
208
+ */
196
209
  private serialize;
210
+ /**
211
+ * @internal
212
+ */
197
213
  private deserialize;
198
214
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { TagResourceRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TagResourceCommand}.
8
10
  */
9
11
  export interface TagResourceCommandInput extends TagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TagResourceCommand}.
13
17
  */
14
18
  export interface TagResourceCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds or edits tags on a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>.</p>
18
23
  * <note>
19
24
  * <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>
@@ -71,6 +76,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
71
76
  * const response = await client.send(command);
72
77
  * ```
73
78
  *
79
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
80
+ * @returns {@link TagResourceCommandOutput}
74
81
  * @see {@link TagResourceCommandInput} for command's `input` shape.
75
82
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
76
83
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
@@ -134,11 +141,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
134
141
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, KMSClientResolvedConfig> {
135
142
  readonly input: TagResourceCommandInput;
136
143
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
144
+ /**
145
+ * @public
146
+ */
137
147
  constructor(input: TagResourceCommandInput);
138
148
  /**
139
149
  * @internal
140
150
  */
141
151
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
152
+ /**
153
+ * @internal
154
+ */
142
155
  private serialize;
156
+ /**
157
+ * @internal
158
+ */
143
159
  private deserialize;
144
160
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { UntagResourceRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UntagResourceCommand}.
8
10
  */
9
11
  export interface UntagResourceCommandInput extends UntagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UntagResourceCommand}.
13
17
  */
14
18
  export interface UntagResourceCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes tags from a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>. To delete a tag,
18
23
  * specify the tag key and the KMS key.</p>
19
24
  * <note>
@@ -66,6 +71,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
66
71
  * const response = await client.send(command);
67
72
  * ```
68
73
  *
74
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
75
+ * @returns {@link UntagResourceCommandOutput}
69
76
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
70
77
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
71
78
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
@@ -123,11 +130,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
123
130
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, KMSClientResolvedConfig> {
124
131
  readonly input: UntagResourceCommandInput;
125
132
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
133
+ /**
134
+ * @public
135
+ */
126
136
  constructor(input: UntagResourceCommandInput);
127
137
  /**
128
138
  * @internal
129
139
  */
130
140
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
141
+ /**
142
+ * @internal
143
+ */
131
144
  private serialize;
145
+ /**
146
+ * @internal
147
+ */
132
148
  private deserialize;
133
149
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { UpdateAliasRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateAliasCommand}.
8
10
  */
9
11
  export interface UpdateAliasCommandInput extends UpdateAliasRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateAliasCommand}.
13
17
  */
14
18
  export interface UpdateAliasCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Associates an existing KMS alias with a different KMS key. Each alias is associated with
18
23
  * only one KMS key at a time, although a KMS key can have multiple aliases. The alias and the
19
24
  * KMS key must be in the same Amazon Web Services account and Region.</p>
@@ -87,6 +92,8 @@ export interface UpdateAliasCommandOutput extends __MetadataBearer {
87
92
  * const response = await client.send(command);
88
93
  * ```
89
94
  *
95
+ * @param UpdateAliasCommandInput - {@link UpdateAliasCommandInput}
96
+ * @returns {@link UpdateAliasCommandOutput}
90
97
  * @see {@link UpdateAliasCommandInput} for command's `input` shape.
91
98
  * @see {@link UpdateAliasCommandOutput} for command's `response` shape.
92
99
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
@@ -142,11 +149,20 @@ export interface UpdateAliasCommandOutput extends __MetadataBearer {
142
149
  export declare class UpdateAliasCommand extends $Command<UpdateAliasCommandInput, UpdateAliasCommandOutput, KMSClientResolvedConfig> {
143
150
  readonly input: UpdateAliasCommandInput;
144
151
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
152
+ /**
153
+ * @public
154
+ */
145
155
  constructor(input: UpdateAliasCommandInput);
146
156
  /**
147
157
  * @internal
148
158
  */
149
159
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateAliasCommandInput, UpdateAliasCommandOutput>;
160
+ /**
161
+ * @internal
162
+ */
150
163
  private serialize;
164
+ /**
165
+ * @internal
166
+ */
151
167
  private deserialize;
152
168
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { UpdateCustomKeyStoreRequest, UpdateCustomKeyStoreResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateCustomKeyStoreCommand}.
8
10
  */
9
11
  export interface UpdateCustomKeyStoreCommandInput extends UpdateCustomKeyStoreRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateCustomKeyStoreCommand}.
13
17
  */
14
18
  export interface UpdateCustomKeyStoreCommandOutput extends UpdateCustomKeyStoreResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Changes the properties of a custom key store. You can use this operation to change the
18
23
  * properties of an CloudHSM key store or an external key store.</p>
19
24
  * <p>Use the required <code>CustomKeyStoreId</code> parameter to identify the custom key store.
@@ -117,6 +122,8 @@ export interface UpdateCustomKeyStoreCommandOutput extends UpdateCustomKeyStoreR
117
122
  * const response = await client.send(command);
118
123
  * ```
119
124
  *
125
+ * @param UpdateCustomKeyStoreCommandInput - {@link UpdateCustomKeyStoreCommandInput}
126
+ * @returns {@link UpdateCustomKeyStoreCommandOutput}
120
127
  * @see {@link UpdateCustomKeyStoreCommandInput} for command's `input` shape.
121
128
  * @see {@link UpdateCustomKeyStoreCommandOutput} for command's `response` shape.
122
129
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
@@ -359,11 +366,20 @@ export interface UpdateCustomKeyStoreCommandOutput extends UpdateCustomKeyStoreR
359
366
  export declare class UpdateCustomKeyStoreCommand extends $Command<UpdateCustomKeyStoreCommandInput, UpdateCustomKeyStoreCommandOutput, KMSClientResolvedConfig> {
360
367
  readonly input: UpdateCustomKeyStoreCommandInput;
361
368
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
369
+ /**
370
+ * @public
371
+ */
362
372
  constructor(input: UpdateCustomKeyStoreCommandInput);
363
373
  /**
364
374
  * @internal
365
375
  */
366
376
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateCustomKeyStoreCommandInput, UpdateCustomKeyStoreCommandOutput>;
377
+ /**
378
+ * @internal
379
+ */
367
380
  private serialize;
381
+ /**
382
+ * @internal
383
+ */
368
384
  private deserialize;
369
385
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { UpdateKeyDescriptionRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateKeyDescriptionCommand}.
8
10
  */
9
11
  export interface UpdateKeyDescriptionCommandInput extends UpdateKeyDescriptionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateKeyDescriptionCommand}.
13
17
  */
14
18
  export interface UpdateKeyDescriptionCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the description of a KMS key. To see the description of a KMS key, use <a>DescribeKey</a>. </p>
18
23
  * <p>The KMS key that you use for this operation must be in a compatible key state. For
19
24
  * details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
@@ -46,6 +51,8 @@ export interface UpdateKeyDescriptionCommandOutput extends __MetadataBearer {
46
51
  * const response = await client.send(command);
47
52
  * ```
48
53
  *
54
+ * @param UpdateKeyDescriptionCommandInput - {@link UpdateKeyDescriptionCommandInput}
55
+ * @returns {@link UpdateKeyDescriptionCommandOutput}
49
56
  * @see {@link UpdateKeyDescriptionCommandInput} for command's `input` shape.
50
57
  * @see {@link UpdateKeyDescriptionCommandOutput} for command's `response` shape.
51
58
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
@@ -101,11 +108,20 @@ export interface UpdateKeyDescriptionCommandOutput extends __MetadataBearer {
101
108
  export declare class UpdateKeyDescriptionCommand extends $Command<UpdateKeyDescriptionCommandInput, UpdateKeyDescriptionCommandOutput, KMSClientResolvedConfig> {
102
109
  readonly input: UpdateKeyDescriptionCommandInput;
103
110
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
111
+ /**
112
+ * @public
113
+ */
104
114
  constructor(input: UpdateKeyDescriptionCommandInput);
105
115
  /**
106
116
  * @internal
107
117
  */
108
118
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateKeyDescriptionCommandInput, UpdateKeyDescriptionCommandOutput>;
119
+ /**
120
+ * @internal
121
+ */
109
122
  private serialize;
123
+ /**
124
+ * @internal
125
+ */
110
126
  private deserialize;
111
127
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { UpdatePrimaryRegionRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdatePrimaryRegionCommand}.
8
10
  */
9
11
  export interface UpdatePrimaryRegionCommandInput extends UpdatePrimaryRegionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdatePrimaryRegionCommand}.
13
17
  */
14
18
  export interface UpdatePrimaryRegionCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Changes the primary key of a multi-Region key. </p>
18
23
  * <p>This operation changes the replica key in the specified Region to a primary key and
19
24
  * changes the former primary key to a replica key. For example, suppose you have a primary key
@@ -89,6 +94,8 @@ export interface UpdatePrimaryRegionCommandOutput extends __MetadataBearer {
89
94
  * const response = await client.send(command);
90
95
  * ```
91
96
  *
97
+ * @param UpdatePrimaryRegionCommandInput - {@link UpdatePrimaryRegionCommandInput}
98
+ * @returns {@link UpdatePrimaryRegionCommandOutput}
92
99
  * @see {@link UpdatePrimaryRegionCommandInput} for command's `input` shape.
93
100
  * @see {@link UpdatePrimaryRegionCommandOutput} for command's `response` shape.
94
101
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
@@ -151,11 +158,20 @@ export interface UpdatePrimaryRegionCommandOutput extends __MetadataBearer {
151
158
  export declare class UpdatePrimaryRegionCommand extends $Command<UpdatePrimaryRegionCommandInput, UpdatePrimaryRegionCommandOutput, KMSClientResolvedConfig> {
152
159
  readonly input: UpdatePrimaryRegionCommandInput;
153
160
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
161
+ /**
162
+ * @public
163
+ */
154
164
  constructor(input: UpdatePrimaryRegionCommandInput);
155
165
  /**
156
166
  * @internal
157
167
  */
158
168
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdatePrimaryRegionCommandInput, UpdatePrimaryRegionCommandOutput>;
169
+ /**
170
+ * @internal
171
+ */
159
172
  private serialize;
173
+ /**
174
+ * @internal
175
+ */
160
176
  private deserialize;
161
177
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { VerifyRequest, VerifyResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link VerifyCommand}.
8
10
  */
9
11
  export interface VerifyCommandInput extends VerifyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link VerifyCommand}.
13
17
  */
14
18
  export interface VerifyCommandOutput extends VerifyResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Verifies a digital signature that was generated by the <a>Sign</a> operation. </p>
18
23
  * <p></p>
19
24
  * <p>Verification confirms that an authorized user signed the message with the specified KMS
@@ -60,6 +65,8 @@ export interface VerifyCommandOutput extends VerifyResponse, __MetadataBearer {
60
65
  * const response = await client.send(command);
61
66
  * ```
62
67
  *
68
+ * @param VerifyCommandInput - {@link VerifyCommandInput}
69
+ * @returns {@link VerifyCommandOutput}
63
70
  * @see {@link VerifyCommandInput} for command's `input` shape.
64
71
  * @see {@link VerifyCommandOutput} for command's `response` shape.
65
72
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
@@ -179,11 +186,20 @@ export interface VerifyCommandOutput extends VerifyResponse, __MetadataBearer {
179
186
  export declare class VerifyCommand extends $Command<VerifyCommandInput, VerifyCommandOutput, KMSClientResolvedConfig> {
180
187
  readonly input: VerifyCommandInput;
181
188
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
189
+ /**
190
+ * @public
191
+ */
182
192
  constructor(input: VerifyCommandInput);
183
193
  /**
184
194
  * @internal
185
195
  */
186
196
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<VerifyCommandInput, VerifyCommandOutput>;
197
+ /**
198
+ * @internal
199
+ */
187
200
  private serialize;
201
+ /**
202
+ * @internal
203
+ */
188
204
  private deserialize;
189
205
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { VerifyMacRequest, VerifyMacResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link VerifyMacCommand}.
8
10
  */
9
11
  export interface VerifyMacCommandInput extends VerifyMacRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link VerifyMacCommand}.
13
17
  */
14
18
  export interface VerifyMacCommandOutput extends VerifyMacResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Verifies the hash-based message authentication code (HMAC) for a specified message, HMAC
18
23
  * KMS key, and MAC algorithm. To verify the HMAC, <code>VerifyMac</code> computes an HMAC using
19
24
  * the message, HMAC KMS key, and MAC algorithm that you specify, and compares the computed HMAC
@@ -45,6 +50,8 @@ export interface VerifyMacCommandOutput extends VerifyMacResponse, __MetadataBea
45
50
  * const response = await client.send(command);
46
51
  * ```
47
52
  *
53
+ * @param VerifyMacCommandInput - {@link VerifyMacCommandInput}
54
+ * @returns {@link VerifyMacCommandOutput}
48
55
  * @see {@link VerifyMacCommandInput} for command's `input` shape.
49
56
  * @see {@link VerifyMacCommandOutput} for command's `response` shape.
50
57
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
@@ -137,11 +144,20 @@ export interface VerifyMacCommandOutput extends VerifyMacResponse, __MetadataBea
137
144
  export declare class VerifyMacCommand extends $Command<VerifyMacCommandInput, VerifyMacCommandOutput, KMSClientResolvedConfig> {
138
145
  readonly input: VerifyMacCommandInput;
139
146
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
147
+ /**
148
+ * @public
149
+ */
140
150
  constructor(input: VerifyMacCommandInput);
141
151
  /**
142
152
  * @internal
143
153
  */
144
154
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<VerifyMacCommandInput, VerifyMacCommandOutput>;
155
+ /**
156
+ * @internal
157
+ */
145
158
  private serialize;
159
+ /**
160
+ * @internal
161
+ */
146
162
  private deserialize;
147
163
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from KMS service.
4
6
  */
5
7
  export declare class KMSServiceException extends __ServiceException {