@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.
- package/dist-types/KMS.d.ts +51 -0
- package/dist-types/KMSClient.d.ts +24 -4
- package/dist-types/commands/CancelKeyDeletionCommand.d.ts +16 -0
- package/dist-types/commands/ConnectCustomKeyStoreCommand.d.ts +16 -0
- package/dist-types/commands/CreateAliasCommand.d.ts +16 -0
- package/dist-types/commands/CreateCustomKeyStoreCommand.d.ts +16 -0
- package/dist-types/commands/CreateGrantCommand.d.ts +16 -0
- package/dist-types/commands/CreateKeyCommand.d.ts +16 -0
- package/dist-types/commands/DecryptCommand.d.ts +16 -0
- package/dist-types/commands/DeleteAliasCommand.d.ts +16 -0
- package/dist-types/commands/DeleteCustomKeyStoreCommand.d.ts +16 -0
- package/dist-types/commands/DeleteImportedKeyMaterialCommand.d.ts +16 -0
- package/dist-types/commands/DescribeCustomKeyStoresCommand.d.ts +16 -0
- package/dist-types/commands/DescribeKeyCommand.d.ts +16 -0
- package/dist-types/commands/DisableKeyCommand.d.ts +16 -0
- package/dist-types/commands/DisableKeyRotationCommand.d.ts +16 -0
- package/dist-types/commands/DisconnectCustomKeyStoreCommand.d.ts +16 -0
- package/dist-types/commands/EnableKeyCommand.d.ts +16 -0
- package/dist-types/commands/EnableKeyRotationCommand.d.ts +16 -0
- package/dist-types/commands/EncryptCommand.d.ts +16 -0
- package/dist-types/commands/GenerateDataKeyCommand.d.ts +16 -0
- package/dist-types/commands/GenerateDataKeyPairCommand.d.ts +16 -0
- package/dist-types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +16 -0
- package/dist-types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +16 -0
- package/dist-types/commands/GenerateMacCommand.d.ts +16 -0
- package/dist-types/commands/GenerateRandomCommand.d.ts +16 -0
- package/dist-types/commands/GetKeyPolicyCommand.d.ts +16 -0
- package/dist-types/commands/GetKeyRotationStatusCommand.d.ts +16 -0
- package/dist-types/commands/GetParametersForImportCommand.d.ts +16 -0
- package/dist-types/commands/GetPublicKeyCommand.d.ts +16 -0
- package/dist-types/commands/ImportKeyMaterialCommand.d.ts +16 -0
- package/dist-types/commands/ListAliasesCommand.d.ts +16 -0
- package/dist-types/commands/ListGrantsCommand.d.ts +16 -0
- package/dist-types/commands/ListKeyPoliciesCommand.d.ts +16 -0
- package/dist-types/commands/ListKeysCommand.d.ts +16 -0
- package/dist-types/commands/ListResourceTagsCommand.d.ts +16 -0
- package/dist-types/commands/ListRetirableGrantsCommand.d.ts +16 -0
- package/dist-types/commands/PutKeyPolicyCommand.d.ts +16 -0
- package/dist-types/commands/ReEncryptCommand.d.ts +16 -0
- package/dist-types/commands/ReplicateKeyCommand.d.ts +16 -0
- package/dist-types/commands/RetireGrantCommand.d.ts +16 -0
- package/dist-types/commands/RevokeGrantCommand.d.ts +16 -0
- package/dist-types/commands/ScheduleKeyDeletionCommand.d.ts +16 -0
- package/dist-types/commands/SignCommand.d.ts +16 -0
- package/dist-types/commands/TagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UpdateAliasCommand.d.ts +16 -0
- package/dist-types/commands/UpdateCustomKeyStoreCommand.d.ts +16 -0
- package/dist-types/commands/UpdateKeyDescriptionCommand.d.ts +16 -0
- package/dist-types/commands/UpdatePrimaryRegionCommand.d.ts +16 -0
- package/dist-types/commands/VerifyCommand.d.ts +16 -0
- package/dist-types/commands/VerifyMacCommand.d.ts +16 -0
- package/dist-types/models/KMSServiceException.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +373 -0
- package/dist-types/pagination/DescribeCustomKeyStoresPaginator.d.ts +3 -0
- package/dist-types/pagination/Interfaces.d.ts +3 -0
- package/dist-types/pagination/ListAliasesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListGrantsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListKeyPoliciesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListKeysPaginator.d.ts +3 -0
- package/dist-types/pagination/ListResourceTagsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListRetirableGrantsPaginator.d.ts +3 -0
- 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 { EnableKeyRequest } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link EnableKeyCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface EnableKeyCommandInput extends EnableKeyRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link EnableKeyCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface EnableKeyCommandOutput extends __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Sets the key state of a KMS key to enabled. This allows you to use the KMS key for
|
|
18
23
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. </p>
|
|
19
24
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
@@ -35,6 +40,8 @@ export interface EnableKeyCommandOutput extends __MetadataBearer {
|
|
|
35
40
|
* const response = await client.send(command);
|
|
36
41
|
* ```
|
|
37
42
|
*
|
|
43
|
+
* @param EnableKeyCommandInput - {@link EnableKeyCommandInput}
|
|
44
|
+
* @returns {@link EnableKeyCommandOutput}
|
|
38
45
|
* @see {@link EnableKeyCommandInput} for command's `input` shape.
|
|
39
46
|
* @see {@link EnableKeyCommandOutput} for command's `response` shape.
|
|
40
47
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -93,11 +100,20 @@ export interface EnableKeyCommandOutput extends __MetadataBearer {
|
|
|
93
100
|
export declare class EnableKeyCommand extends $Command<EnableKeyCommandInput, EnableKeyCommandOutput, KMSClientResolvedConfig> {
|
|
94
101
|
readonly input: EnableKeyCommandInput;
|
|
95
102
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
103
|
+
/**
|
|
104
|
+
* @public
|
|
105
|
+
*/
|
|
96
106
|
constructor(input: EnableKeyCommandInput);
|
|
97
107
|
/**
|
|
98
108
|
* @internal
|
|
99
109
|
*/
|
|
100
110
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<EnableKeyCommandInput, EnableKeyCommandOutput>;
|
|
111
|
+
/**
|
|
112
|
+
* @internal
|
|
113
|
+
*/
|
|
101
114
|
private serialize;
|
|
115
|
+
/**
|
|
116
|
+
* @internal
|
|
117
|
+
*/
|
|
102
118
|
private deserialize;
|
|
103
119
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { EnableKeyRotationRequest } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link EnableKeyRotationCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface EnableKeyRotationCommandInput extends EnableKeyRotationRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link EnableKeyRotationCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface EnableKeyRotationCommandOutput extends __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Enables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic rotation
|
|
18
23
|
* of the key material</a> of the specified symmetric encryption KMS key. </p>
|
|
19
24
|
* <p>When you enable automatic rotation of a<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed KMS key</a>, KMS
|
|
@@ -65,6 +70,8 @@ export interface EnableKeyRotationCommandOutput extends __MetadataBearer {
|
|
|
65
70
|
* const response = await client.send(command);
|
|
66
71
|
* ```
|
|
67
72
|
*
|
|
73
|
+
* @param EnableKeyRotationCommandInput - {@link EnableKeyRotationCommandInput}
|
|
74
|
+
* @returns {@link EnableKeyRotationCommandOutput}
|
|
68
75
|
* @see {@link EnableKeyRotationCommandInput} for command's `input` shape.
|
|
69
76
|
* @see {@link EnableKeyRotationCommandOutput} for command's `response` shape.
|
|
70
77
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -126,11 +133,20 @@ export interface EnableKeyRotationCommandOutput extends __MetadataBearer {
|
|
|
126
133
|
export declare class EnableKeyRotationCommand extends $Command<EnableKeyRotationCommandInput, EnableKeyRotationCommandOutput, KMSClientResolvedConfig> {
|
|
127
134
|
readonly input: EnableKeyRotationCommandInput;
|
|
128
135
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
136
|
+
/**
|
|
137
|
+
* @public
|
|
138
|
+
*/
|
|
129
139
|
constructor(input: EnableKeyRotationCommandInput);
|
|
130
140
|
/**
|
|
131
141
|
* @internal
|
|
132
142
|
*/
|
|
133
143
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<EnableKeyRotationCommandInput, EnableKeyRotationCommandOutput>;
|
|
144
|
+
/**
|
|
145
|
+
* @internal
|
|
146
|
+
*/
|
|
134
147
|
private serialize;
|
|
148
|
+
/**
|
|
149
|
+
* @internal
|
|
150
|
+
*/
|
|
135
151
|
private deserialize;
|
|
136
152
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { EncryptRequest, EncryptResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link EncryptCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface EncryptCommandInput extends EncryptRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link EncryptCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface EncryptCommandOutput extends EncryptResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Encrypts plaintext of up to 4,096 bytes using a KMS key. You can use a symmetric or
|
|
18
23
|
* asymmetric KMS key with a <code>KeyUsage</code> of <code>ENCRYPT_DECRYPT</code>.</p>
|
|
19
24
|
* <p>You can use this operation to encrypt small amounts of arbitrary data, such as a personal
|
|
@@ -134,6 +139,8 @@ export interface EncryptCommandOutput extends EncryptResponse, __MetadataBearer
|
|
|
134
139
|
* const response = await client.send(command);
|
|
135
140
|
* ```
|
|
136
141
|
*
|
|
142
|
+
* @param EncryptCommandInput - {@link EncryptCommandInput}
|
|
143
|
+
* @returns {@link EncryptCommandOutput}
|
|
137
144
|
* @see {@link EncryptCommandInput} for command's `input` shape.
|
|
138
145
|
* @see {@link EncryptCommandOutput} for command's `response` shape.
|
|
139
146
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -222,11 +229,20 @@ export interface EncryptCommandOutput extends EncryptResponse, __MetadataBearer
|
|
|
222
229
|
export declare class EncryptCommand extends $Command<EncryptCommandInput, EncryptCommandOutput, KMSClientResolvedConfig> {
|
|
223
230
|
readonly input: EncryptCommandInput;
|
|
224
231
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
232
|
+
/**
|
|
233
|
+
* @public
|
|
234
|
+
*/
|
|
225
235
|
constructor(input: EncryptCommandInput);
|
|
226
236
|
/**
|
|
227
237
|
* @internal
|
|
228
238
|
*/
|
|
229
239
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<EncryptCommandInput, EncryptCommandOutput>;
|
|
240
|
+
/**
|
|
241
|
+
* @internal
|
|
242
|
+
*/
|
|
230
243
|
private serialize;
|
|
244
|
+
/**
|
|
245
|
+
* @internal
|
|
246
|
+
*/
|
|
231
247
|
private deserialize;
|
|
232
248
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { GenerateDataKeyRequest, GenerateDataKeyResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link GenerateDataKeyCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface GenerateDataKeyCommandInput extends GenerateDataKeyRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link GenerateDataKeyCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface GenerateDataKeyCommandOutput extends GenerateDataKeyResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Returns a unique symmetric data key for use outside of KMS. This operation returns a
|
|
18
23
|
* plaintext copy of the data key and a copy that is encrypted under a symmetric encryption KMS
|
|
19
24
|
* key that you specify. The bytes in the plaintext key are random; they are not related
|
|
@@ -118,6 +123,8 @@ export interface GenerateDataKeyCommandOutput extends GenerateDataKeyResponse, _
|
|
|
118
123
|
* const response = await client.send(command);
|
|
119
124
|
* ```
|
|
120
125
|
*
|
|
126
|
+
* @param GenerateDataKeyCommandInput - {@link GenerateDataKeyCommandInput}
|
|
127
|
+
* @returns {@link GenerateDataKeyCommandOutput}
|
|
121
128
|
* @see {@link GenerateDataKeyCommandInput} for command's `input` shape.
|
|
122
129
|
* @see {@link GenerateDataKeyCommandOutput} for command's `response` shape.
|
|
123
130
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -207,11 +214,20 @@ export interface GenerateDataKeyCommandOutput extends GenerateDataKeyResponse, _
|
|
|
207
214
|
export declare class GenerateDataKeyCommand extends $Command<GenerateDataKeyCommandInput, GenerateDataKeyCommandOutput, KMSClientResolvedConfig> {
|
|
208
215
|
readonly input: GenerateDataKeyCommandInput;
|
|
209
216
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
217
|
+
/**
|
|
218
|
+
* @public
|
|
219
|
+
*/
|
|
210
220
|
constructor(input: GenerateDataKeyCommandInput);
|
|
211
221
|
/**
|
|
212
222
|
* @internal
|
|
213
223
|
*/
|
|
214
224
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GenerateDataKeyCommandInput, GenerateDataKeyCommandOutput>;
|
|
225
|
+
/**
|
|
226
|
+
* @internal
|
|
227
|
+
*/
|
|
215
228
|
private serialize;
|
|
229
|
+
/**
|
|
230
|
+
* @internal
|
|
231
|
+
*/
|
|
216
232
|
private deserialize;
|
|
217
233
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { GenerateDataKeyPairRequest, GenerateDataKeyPairResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link GenerateDataKeyPairCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface GenerateDataKeyPairCommandInput extends GenerateDataKeyPairRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link GenerateDataKeyPairCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface GenerateDataKeyPairCommandOutput extends GenerateDataKeyPairResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Returns a unique asymmetric data key pair for use outside of KMS. This operation returns
|
|
18
23
|
* a plaintext public key, a plaintext private key, and a copy of the private key that is
|
|
19
24
|
* encrypted under the symmetric encryption KMS key you specify. You can use the data key pair to
|
|
@@ -95,6 +100,8 @@ export interface GenerateDataKeyPairCommandOutput extends GenerateDataKeyPairRes
|
|
|
95
100
|
* const response = await client.send(command);
|
|
96
101
|
* ```
|
|
97
102
|
*
|
|
103
|
+
* @param GenerateDataKeyPairCommandInput - {@link GenerateDataKeyPairCommandInput}
|
|
104
|
+
* @returns {@link GenerateDataKeyPairCommandOutput}
|
|
98
105
|
* @see {@link GenerateDataKeyPairCommandInput} for command's `input` shape.
|
|
99
106
|
* @see {@link GenerateDataKeyPairCommandOutput} for command's `response` shape.
|
|
100
107
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -190,11 +197,20 @@ export interface GenerateDataKeyPairCommandOutput extends GenerateDataKeyPairRes
|
|
|
190
197
|
export declare class GenerateDataKeyPairCommand extends $Command<GenerateDataKeyPairCommandInput, GenerateDataKeyPairCommandOutput, KMSClientResolvedConfig> {
|
|
191
198
|
readonly input: GenerateDataKeyPairCommandInput;
|
|
192
199
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
200
|
+
/**
|
|
201
|
+
* @public
|
|
202
|
+
*/
|
|
193
203
|
constructor(input: GenerateDataKeyPairCommandInput);
|
|
194
204
|
/**
|
|
195
205
|
* @internal
|
|
196
206
|
*/
|
|
197
207
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GenerateDataKeyPairCommandInput, GenerateDataKeyPairCommandOutput>;
|
|
208
|
+
/**
|
|
209
|
+
* @internal
|
|
210
|
+
*/
|
|
198
211
|
private serialize;
|
|
212
|
+
/**
|
|
213
|
+
* @internal
|
|
214
|
+
*/
|
|
199
215
|
private deserialize;
|
|
200
216
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { GenerateDataKeyPairWithoutPlaintextRequest, GenerateDataKeyPairWithoutPlaintextResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link GenerateDataKeyPairWithoutPlaintextCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface GenerateDataKeyPairWithoutPlaintextCommandInput extends GenerateDataKeyPairWithoutPlaintextRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link GenerateDataKeyPairWithoutPlaintextCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface GenerateDataKeyPairWithoutPlaintextCommandOutput extends GenerateDataKeyPairWithoutPlaintextResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Returns a unique asymmetric data key pair for use outside of KMS. This operation returns
|
|
18
23
|
* a plaintext public key and a copy of the private key that is encrypted under the symmetric
|
|
19
24
|
* encryption KMS key you specify. Unlike <a>GenerateDataKeyPair</a>, this operation
|
|
@@ -87,6 +92,8 @@ export interface GenerateDataKeyPairWithoutPlaintextCommandOutput extends Genera
|
|
|
87
92
|
* const response = await client.send(command);
|
|
88
93
|
* ```
|
|
89
94
|
*
|
|
95
|
+
* @param GenerateDataKeyPairWithoutPlaintextCommandInput - {@link GenerateDataKeyPairWithoutPlaintextCommandInput}
|
|
96
|
+
* @returns {@link GenerateDataKeyPairWithoutPlaintextCommandOutput}
|
|
90
97
|
* @see {@link GenerateDataKeyPairWithoutPlaintextCommandInput} for command's `input` shape.
|
|
91
98
|
* @see {@link GenerateDataKeyPairWithoutPlaintextCommandOutput} for command's `response` shape.
|
|
92
99
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -181,11 +188,20 @@ export interface GenerateDataKeyPairWithoutPlaintextCommandOutput extends Genera
|
|
|
181
188
|
export declare class GenerateDataKeyPairWithoutPlaintextCommand extends $Command<GenerateDataKeyPairWithoutPlaintextCommandInput, GenerateDataKeyPairWithoutPlaintextCommandOutput, KMSClientResolvedConfig> {
|
|
182
189
|
readonly input: GenerateDataKeyPairWithoutPlaintextCommandInput;
|
|
183
190
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
191
|
+
/**
|
|
192
|
+
* @public
|
|
193
|
+
*/
|
|
184
194
|
constructor(input: GenerateDataKeyPairWithoutPlaintextCommandInput);
|
|
185
195
|
/**
|
|
186
196
|
* @internal
|
|
187
197
|
*/
|
|
188
198
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GenerateDataKeyPairWithoutPlaintextCommandInput, GenerateDataKeyPairWithoutPlaintextCommandOutput>;
|
|
199
|
+
/**
|
|
200
|
+
* @internal
|
|
201
|
+
*/
|
|
189
202
|
private serialize;
|
|
203
|
+
/**
|
|
204
|
+
* @internal
|
|
205
|
+
*/
|
|
190
206
|
private deserialize;
|
|
191
207
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { GenerateDataKeyWithoutPlaintextRequest, GenerateDataKeyWithoutPlaintextResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link GenerateDataKeyWithoutPlaintextCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface GenerateDataKeyWithoutPlaintextCommandInput extends GenerateDataKeyWithoutPlaintextRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link GenerateDataKeyWithoutPlaintextCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface GenerateDataKeyWithoutPlaintextCommandOutput extends GenerateDataKeyWithoutPlaintextResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Returns a unique symmetric data key for use outside of KMS. This operation returns a
|
|
18
23
|
* data key that is encrypted under a symmetric encryption KMS key that you specify. The bytes in
|
|
19
24
|
* the key are random; they are not related to the caller or to the KMS key.</p>
|
|
@@ -96,6 +101,8 @@ export interface GenerateDataKeyWithoutPlaintextCommandOutput extends GenerateDa
|
|
|
96
101
|
* const response = await client.send(command);
|
|
97
102
|
* ```
|
|
98
103
|
*
|
|
104
|
+
* @param GenerateDataKeyWithoutPlaintextCommandInput - {@link GenerateDataKeyWithoutPlaintextCommandInput}
|
|
105
|
+
* @returns {@link GenerateDataKeyWithoutPlaintextCommandOutput}
|
|
99
106
|
* @see {@link GenerateDataKeyWithoutPlaintextCommandInput} for command's `input` shape.
|
|
100
107
|
* @see {@link GenerateDataKeyWithoutPlaintextCommandOutput} for command's `response` shape.
|
|
101
108
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -184,11 +191,20 @@ export interface GenerateDataKeyWithoutPlaintextCommandOutput extends GenerateDa
|
|
|
184
191
|
export declare class GenerateDataKeyWithoutPlaintextCommand extends $Command<GenerateDataKeyWithoutPlaintextCommandInput, GenerateDataKeyWithoutPlaintextCommandOutput, KMSClientResolvedConfig> {
|
|
185
192
|
readonly input: GenerateDataKeyWithoutPlaintextCommandInput;
|
|
186
193
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
194
|
+
/**
|
|
195
|
+
* @public
|
|
196
|
+
*/
|
|
187
197
|
constructor(input: GenerateDataKeyWithoutPlaintextCommandInput);
|
|
188
198
|
/**
|
|
189
199
|
* @internal
|
|
190
200
|
*/
|
|
191
201
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GenerateDataKeyWithoutPlaintextCommandInput, GenerateDataKeyWithoutPlaintextCommandOutput>;
|
|
202
|
+
/**
|
|
203
|
+
* @internal
|
|
204
|
+
*/
|
|
192
205
|
private serialize;
|
|
206
|
+
/**
|
|
207
|
+
* @internal
|
|
208
|
+
*/
|
|
193
209
|
private deserialize;
|
|
194
210
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { GenerateMacRequest, GenerateMacResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link GenerateMacCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface GenerateMacCommandInput extends GenerateMacRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link GenerateMacCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface GenerateMacCommandOutput extends GenerateMacResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Generates a hash-based message authentication code (HMAC) for a message using an HMAC KMS key and a MAC algorithm that the key supports.
|
|
18
23
|
* HMAC KMS keys and the HMAC algorithms that KMS uses conform to industry standards defined in <a href="https://datatracker.ietf.org/doc/html/rfc2104">RFC 2104</a>.</p>
|
|
19
24
|
* <p>You can use value that GenerateMac returns in the <a>VerifyMac</a> operation to
|
|
@@ -52,6 +57,8 @@ export interface GenerateMacCommandOutput extends GenerateMacResponse, __Metadat
|
|
|
52
57
|
* const response = await client.send(command);
|
|
53
58
|
* ```
|
|
54
59
|
*
|
|
60
|
+
* @param GenerateMacCommandInput - {@link GenerateMacCommandInput}
|
|
61
|
+
* @returns {@link GenerateMacCommandOutput}
|
|
55
62
|
* @see {@link GenerateMacCommandInput} for command's `input` shape.
|
|
56
63
|
* @see {@link GenerateMacCommandOutput} for command's `response` shape.
|
|
57
64
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -138,11 +145,20 @@ export interface GenerateMacCommandOutput extends GenerateMacResponse, __Metadat
|
|
|
138
145
|
export declare class GenerateMacCommand extends $Command<GenerateMacCommandInput, GenerateMacCommandOutput, KMSClientResolvedConfig> {
|
|
139
146
|
readonly input: GenerateMacCommandInput;
|
|
140
147
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
148
|
+
/**
|
|
149
|
+
* @public
|
|
150
|
+
*/
|
|
141
151
|
constructor(input: GenerateMacCommandInput);
|
|
142
152
|
/**
|
|
143
153
|
* @internal
|
|
144
154
|
*/
|
|
145
155
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GenerateMacCommandInput, GenerateMacCommandOutput>;
|
|
156
|
+
/**
|
|
157
|
+
* @internal
|
|
158
|
+
*/
|
|
146
159
|
private serialize;
|
|
160
|
+
/**
|
|
161
|
+
* @internal
|
|
162
|
+
*/
|
|
147
163
|
private deserialize;
|
|
148
164
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { GenerateRandomRequest, GenerateRandomResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link GenerateRandomCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface GenerateRandomCommandInput extends GenerateRandomRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link GenerateRandomCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface GenerateRandomCommandOutput extends GenerateRandomResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Returns a random byte string that is cryptographically secure.</p>
|
|
18
23
|
* <p>You must use the <code>NumberOfBytes</code> parameter to specify the length of the random
|
|
19
24
|
* byte string. There is no default value for string length.</p>
|
|
@@ -39,6 +44,8 @@ export interface GenerateRandomCommandOutput extends GenerateRandomResponse, __M
|
|
|
39
44
|
* const response = await client.send(command);
|
|
40
45
|
* ```
|
|
41
46
|
*
|
|
47
|
+
* @param GenerateRandomCommandInput - {@link GenerateRandomCommandInput}
|
|
48
|
+
* @returns {@link GenerateRandomCommandOutput}
|
|
42
49
|
* @see {@link GenerateRandomCommandInput} for command's `input` shape.
|
|
43
50
|
* @see {@link GenerateRandomCommandOutput} for command's `response` shape.
|
|
44
51
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -116,11 +123,20 @@ export interface GenerateRandomCommandOutput extends GenerateRandomResponse, __M
|
|
|
116
123
|
export declare class GenerateRandomCommand extends $Command<GenerateRandomCommandInput, GenerateRandomCommandOutput, KMSClientResolvedConfig> {
|
|
117
124
|
readonly input: GenerateRandomCommandInput;
|
|
118
125
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
126
|
+
/**
|
|
127
|
+
* @public
|
|
128
|
+
*/
|
|
119
129
|
constructor(input: GenerateRandomCommandInput);
|
|
120
130
|
/**
|
|
121
131
|
* @internal
|
|
122
132
|
*/
|
|
123
133
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GenerateRandomCommandInput, GenerateRandomCommandOutput>;
|
|
134
|
+
/**
|
|
135
|
+
* @internal
|
|
136
|
+
*/
|
|
124
137
|
private serialize;
|
|
138
|
+
/**
|
|
139
|
+
* @internal
|
|
140
|
+
*/
|
|
125
141
|
private deserialize;
|
|
126
142
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { GetKeyPolicyRequest, GetKeyPolicyResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link GetKeyPolicyCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface GetKeyPolicyCommandInput extends GetKeyPolicyRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link GetKeyPolicyCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface GetKeyPolicyCommandOutput extends GetKeyPolicyResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Gets a key policy attached to the specified KMS key.</p>
|
|
18
23
|
* <p>
|
|
19
24
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
@@ -32,6 +37,8 @@ export interface GetKeyPolicyCommandOutput extends GetKeyPolicyResponse, __Metad
|
|
|
32
37
|
* const response = await client.send(command);
|
|
33
38
|
* ```
|
|
34
39
|
*
|
|
40
|
+
* @param GetKeyPolicyCommandInput - {@link GetKeyPolicyCommandInput}
|
|
41
|
+
* @returns {@link GetKeyPolicyCommandOutput}
|
|
35
42
|
* @see {@link GetKeyPolicyCommandInput} for command's `input` shape.
|
|
36
43
|
* @see {@link GetKeyPolicyCommandOutput} for command's `response` shape.
|
|
37
44
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -92,11 +99,20 @@ export interface GetKeyPolicyCommandOutput extends GetKeyPolicyResponse, __Metad
|
|
|
92
99
|
export declare class GetKeyPolicyCommand extends $Command<GetKeyPolicyCommandInput, GetKeyPolicyCommandOutput, KMSClientResolvedConfig> {
|
|
93
100
|
readonly input: GetKeyPolicyCommandInput;
|
|
94
101
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
102
|
+
/**
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
95
105
|
constructor(input: GetKeyPolicyCommandInput);
|
|
96
106
|
/**
|
|
97
107
|
* @internal
|
|
98
108
|
*/
|
|
99
109
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetKeyPolicyCommandInput, GetKeyPolicyCommandOutput>;
|
|
110
|
+
/**
|
|
111
|
+
* @internal
|
|
112
|
+
*/
|
|
100
113
|
private serialize;
|
|
114
|
+
/**
|
|
115
|
+
* @internal
|
|
116
|
+
*/
|
|
101
117
|
private deserialize;
|
|
102
118
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { GetKeyRotationStatusRequest, GetKeyRotationStatusResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link GetKeyRotationStatusCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface GetKeyRotationStatusCommandInput extends GetKeyRotationStatusRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link GetKeyRotationStatusCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface GetKeyRotationStatusCommandOutput extends GetKeyRotationStatusResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Gets a Boolean value that indicates whether <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic rotation of the key material</a> is
|
|
18
23
|
* enabled for the specified KMS key.</p>
|
|
19
24
|
* <p>When you enable automatic rotation for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed KMS keys</a>, KMS
|
|
@@ -77,6 +82,8 @@ export interface GetKeyRotationStatusCommandOutput extends GetKeyRotationStatusR
|
|
|
77
82
|
* const response = await client.send(command);
|
|
78
83
|
* ```
|
|
79
84
|
*
|
|
85
|
+
* @param GetKeyRotationStatusCommandInput - {@link GetKeyRotationStatusCommandInput}
|
|
86
|
+
* @returns {@link GetKeyRotationStatusCommandOutput}
|
|
80
87
|
* @see {@link GetKeyRotationStatusCommandInput} for command's `input` shape.
|
|
81
88
|
* @see {@link GetKeyRotationStatusCommandOutput} for command's `response` shape.
|
|
82
89
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -140,11 +147,20 @@ export interface GetKeyRotationStatusCommandOutput extends GetKeyRotationStatusR
|
|
|
140
147
|
export declare class GetKeyRotationStatusCommand extends $Command<GetKeyRotationStatusCommandInput, GetKeyRotationStatusCommandOutput, KMSClientResolvedConfig> {
|
|
141
148
|
readonly input: GetKeyRotationStatusCommandInput;
|
|
142
149
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
150
|
+
/**
|
|
151
|
+
* @public
|
|
152
|
+
*/
|
|
143
153
|
constructor(input: GetKeyRotationStatusCommandInput);
|
|
144
154
|
/**
|
|
145
155
|
* @internal
|
|
146
156
|
*/
|
|
147
157
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetKeyRotationStatusCommandInput, GetKeyRotationStatusCommandOutput>;
|
|
158
|
+
/**
|
|
159
|
+
* @internal
|
|
160
|
+
*/
|
|
148
161
|
private serialize;
|
|
162
|
+
/**
|
|
163
|
+
* @internal
|
|
164
|
+
*/
|
|
149
165
|
private deserialize;
|
|
150
166
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { GetParametersForImportRequest, GetParametersForImportResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link GetParametersForImportCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface GetParametersForImportCommandInput extends GetParametersForImportRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link GetParametersForImportCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface GetParametersForImportCommandOutput extends GetParametersForImportResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Returns the items you need to import key material into a symmetric encryption KMS key. For
|
|
18
23
|
* more information about importing key material into KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing key material</a> in the
|
|
19
24
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
@@ -58,6 +63,8 @@ export interface GetParametersForImportCommandOutput extends GetParametersForImp
|
|
|
58
63
|
* const response = await client.send(command);
|
|
59
64
|
* ```
|
|
60
65
|
*
|
|
66
|
+
* @param GetParametersForImportCommandInput - {@link GetParametersForImportCommandInput}
|
|
67
|
+
* @returns {@link GetParametersForImportCommandOutput}
|
|
61
68
|
* @see {@link GetParametersForImportCommandInput} for command's `input` shape.
|
|
62
69
|
* @see {@link GetParametersForImportCommandOutput} for command's `response` shape.
|
|
63
70
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -126,11 +133,20 @@ export interface GetParametersForImportCommandOutput extends GetParametersForImp
|
|
|
126
133
|
export declare class GetParametersForImportCommand extends $Command<GetParametersForImportCommandInput, GetParametersForImportCommandOutput, KMSClientResolvedConfig> {
|
|
127
134
|
readonly input: GetParametersForImportCommandInput;
|
|
128
135
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
136
|
+
/**
|
|
137
|
+
* @public
|
|
138
|
+
*/
|
|
129
139
|
constructor(input: GetParametersForImportCommandInput);
|
|
130
140
|
/**
|
|
131
141
|
* @internal
|
|
132
142
|
*/
|
|
133
143
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetParametersForImportCommandInput, GetParametersForImportCommandOutput>;
|
|
144
|
+
/**
|
|
145
|
+
* @internal
|
|
146
|
+
*/
|
|
134
147
|
private serialize;
|
|
148
|
+
/**
|
|
149
|
+
* @internal
|
|
150
|
+
*/
|
|
135
151
|
private deserialize;
|
|
136
152
|
}
|