@aws-sdk/client-kms 3.296.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 +3 -3
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { CreateCustomKeyStoreRequest, CreateCustomKeyStoreResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link CreateCustomKeyStoreCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface CreateCustomKeyStoreCommandInput extends CreateCustomKeyStoreRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link CreateCustomKeyStoreCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface CreateCustomKeyStoreCommandOutput extends CreateCustomKeyStoreResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Creates a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> backed by a key store that you own and manage. When you use a
|
|
18
23
|
* KMS key in a custom key store for a cryptographic operation, the cryptographic operation is
|
|
19
24
|
* actually performed in your key store using your keys. KMS supports <a href="https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html">CloudHSM key stores</a>
|
|
@@ -112,6 +117,8 @@ export interface CreateCustomKeyStoreCommandOutput extends CreateCustomKeyStoreR
|
|
|
112
117
|
* const response = await client.send(command);
|
|
113
118
|
* ```
|
|
114
119
|
*
|
|
120
|
+
* @param CreateCustomKeyStoreCommandInput - {@link CreateCustomKeyStoreCommandInput}
|
|
121
|
+
* @returns {@link CreateCustomKeyStoreCommandOutput}
|
|
115
122
|
* @see {@link CreateCustomKeyStoreCommandInput} for command's `input` shape.
|
|
116
123
|
* @see {@link CreateCustomKeyStoreCommandOutput} for command's `response` shape.
|
|
117
124
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -313,11 +320,20 @@ export interface CreateCustomKeyStoreCommandOutput extends CreateCustomKeyStoreR
|
|
|
313
320
|
export declare class CreateCustomKeyStoreCommand extends $Command<CreateCustomKeyStoreCommandInput, CreateCustomKeyStoreCommandOutput, KMSClientResolvedConfig> {
|
|
314
321
|
readonly input: CreateCustomKeyStoreCommandInput;
|
|
315
322
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
323
|
+
/**
|
|
324
|
+
* @public
|
|
325
|
+
*/
|
|
316
326
|
constructor(input: CreateCustomKeyStoreCommandInput);
|
|
317
327
|
/**
|
|
318
328
|
* @internal
|
|
319
329
|
*/
|
|
320
330
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateCustomKeyStoreCommandInput, CreateCustomKeyStoreCommandOutput>;
|
|
331
|
+
/**
|
|
332
|
+
* @internal
|
|
333
|
+
*/
|
|
321
334
|
private serialize;
|
|
335
|
+
/**
|
|
336
|
+
* @internal
|
|
337
|
+
*/
|
|
322
338
|
private deserialize;
|
|
323
339
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { CreateGrantRequest, CreateGrantResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link CreateGrantCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface CreateGrantCommandInput extends CreateGrantRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link CreateGrantCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface CreateGrantCommandOutput extends CreateGrantResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Adds a grant to a KMS key. </p>
|
|
18
23
|
* <p>A <i>grant</i> is a policy instrument that allows Amazon Web Services principals to use
|
|
19
24
|
* KMS keys in cryptographic operations. It also can allow them to view a KMS key (<a>DescribeKey</a>) and create and manage grants. When authorizing access to a KMS key,
|
|
@@ -86,6 +91,8 @@ export interface CreateGrantCommandOutput extends CreateGrantResponse, __Metadat
|
|
|
86
91
|
* const response = await client.send(command);
|
|
87
92
|
* ```
|
|
88
93
|
*
|
|
94
|
+
* @param CreateGrantCommandInput - {@link CreateGrantCommandInput}
|
|
95
|
+
* @returns {@link CreateGrantCommandOutput}
|
|
89
96
|
* @see {@link CreateGrantCommandInput} for command's `input` shape.
|
|
90
97
|
* @see {@link CreateGrantCommandOutput} for command's `response` shape.
|
|
91
98
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -161,11 +168,20 @@ export interface CreateGrantCommandOutput extends CreateGrantResponse, __Metadat
|
|
|
161
168
|
export declare class CreateGrantCommand extends $Command<CreateGrantCommandInput, CreateGrantCommandOutput, KMSClientResolvedConfig> {
|
|
162
169
|
readonly input: CreateGrantCommandInput;
|
|
163
170
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
171
|
+
/**
|
|
172
|
+
* @public
|
|
173
|
+
*/
|
|
164
174
|
constructor(input: CreateGrantCommandInput);
|
|
165
175
|
/**
|
|
166
176
|
* @internal
|
|
167
177
|
*/
|
|
168
178
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateGrantCommandInput, CreateGrantCommandOutput>;
|
|
179
|
+
/**
|
|
180
|
+
* @internal
|
|
181
|
+
*/
|
|
169
182
|
private serialize;
|
|
183
|
+
/**
|
|
184
|
+
* @internal
|
|
185
|
+
*/
|
|
170
186
|
private deserialize;
|
|
171
187
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { CreateKeyRequest, CreateKeyResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link CreateKeyCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface CreateKeyCommandInput extends CreateKeyRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link CreateKeyCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface CreateKeyCommandOutput extends CreateKeyResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Creates a unique customer managed <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms-keys">KMS key</a> in your Amazon Web Services account and Region.
|
|
18
23
|
* You can use a KMS key in cryptographic operations, such as encryption and signing. Some Amazon Web Services
|
|
19
24
|
* services let you use KMS keys that you create and manage to protect your service
|
|
@@ -191,6 +196,8 @@ export interface CreateKeyCommandOutput extends CreateKeyResponse, __MetadataBea
|
|
|
191
196
|
* const response = await client.send(command);
|
|
192
197
|
* ```
|
|
193
198
|
*
|
|
199
|
+
* @param CreateKeyCommandInput - {@link CreateKeyCommandInput}
|
|
200
|
+
* @returns {@link CreateKeyCommandOutput}
|
|
194
201
|
* @see {@link CreateKeyCommandInput} for command's `input` shape.
|
|
195
202
|
* @see {@link CreateKeyCommandOutput} for command's `response` shape.
|
|
196
203
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -604,11 +611,20 @@ export interface CreateKeyCommandOutput extends CreateKeyResponse, __MetadataBea
|
|
|
604
611
|
export declare class CreateKeyCommand extends $Command<CreateKeyCommandInput, CreateKeyCommandOutput, KMSClientResolvedConfig> {
|
|
605
612
|
readonly input: CreateKeyCommandInput;
|
|
606
613
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
614
|
+
/**
|
|
615
|
+
* @public
|
|
616
|
+
*/
|
|
607
617
|
constructor(input: CreateKeyCommandInput);
|
|
608
618
|
/**
|
|
609
619
|
* @internal
|
|
610
620
|
*/
|
|
611
621
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateKeyCommandInput, CreateKeyCommandOutput>;
|
|
622
|
+
/**
|
|
623
|
+
* @internal
|
|
624
|
+
*/
|
|
612
625
|
private serialize;
|
|
626
|
+
/**
|
|
627
|
+
* @internal
|
|
628
|
+
*/
|
|
613
629
|
private deserialize;
|
|
614
630
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { DecryptRequest, DecryptResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link DecryptCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface DecryptCommandInput extends DecryptRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link DecryptCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface DecryptCommandOutput extends DecryptResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Decrypts ciphertext that was encrypted by a KMS key using any of the following
|
|
18
23
|
* operations:</p>
|
|
19
24
|
* <ul>
|
|
@@ -112,6 +117,8 @@ export interface DecryptCommandOutput extends DecryptResponse, __MetadataBearer
|
|
|
112
117
|
* const response = await client.send(command);
|
|
113
118
|
* ```
|
|
114
119
|
*
|
|
120
|
+
* @param DecryptCommandInput - {@link DecryptCommandInput}
|
|
121
|
+
* @returns {@link DecryptCommandOutput}
|
|
115
122
|
* @see {@link DecryptCommandInput} for command's `input` shape.
|
|
116
123
|
* @see {@link DecryptCommandOutput} for command's `response` shape.
|
|
117
124
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -214,11 +221,20 @@ export interface DecryptCommandOutput extends DecryptResponse, __MetadataBearer
|
|
|
214
221
|
export declare class DecryptCommand extends $Command<DecryptCommandInput, DecryptCommandOutput, KMSClientResolvedConfig> {
|
|
215
222
|
readonly input: DecryptCommandInput;
|
|
216
223
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
224
|
+
/**
|
|
225
|
+
* @public
|
|
226
|
+
*/
|
|
217
227
|
constructor(input: DecryptCommandInput);
|
|
218
228
|
/**
|
|
219
229
|
* @internal
|
|
220
230
|
*/
|
|
221
231
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DecryptCommandInput, DecryptCommandOutput>;
|
|
232
|
+
/**
|
|
233
|
+
* @internal
|
|
234
|
+
*/
|
|
222
235
|
private serialize;
|
|
236
|
+
/**
|
|
237
|
+
* @internal
|
|
238
|
+
*/
|
|
223
239
|
private deserialize;
|
|
224
240
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { DeleteAliasRequest } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link DeleteAliasCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface DeleteAliasCommandInput extends DeleteAliasRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link DeleteAliasCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface DeleteAliasCommandOutput extends __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Deletes the specified alias. </p>
|
|
18
23
|
* <note>
|
|
19
24
|
* <p>Adding, deleting, or updating an alias 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>
|
|
@@ -72,6 +77,8 @@ export interface DeleteAliasCommandOutput extends __MetadataBearer {
|
|
|
72
77
|
* const response = await client.send(command);
|
|
73
78
|
* ```
|
|
74
79
|
*
|
|
80
|
+
* @param DeleteAliasCommandInput - {@link DeleteAliasCommandInput}
|
|
81
|
+
* @returns {@link DeleteAliasCommandOutput}
|
|
75
82
|
* @see {@link DeleteAliasCommandInput} for command's `input` shape.
|
|
76
83
|
* @see {@link DeleteAliasCommandOutput} for command's `response` shape.
|
|
77
84
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -122,11 +129,20 @@ export interface DeleteAliasCommandOutput extends __MetadataBearer {
|
|
|
122
129
|
export declare class DeleteAliasCommand extends $Command<DeleteAliasCommandInput, DeleteAliasCommandOutput, KMSClientResolvedConfig> {
|
|
123
130
|
readonly input: DeleteAliasCommandInput;
|
|
124
131
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
132
|
+
/**
|
|
133
|
+
* @public
|
|
134
|
+
*/
|
|
125
135
|
constructor(input: DeleteAliasCommandInput);
|
|
126
136
|
/**
|
|
127
137
|
* @internal
|
|
128
138
|
*/
|
|
129
139
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteAliasCommandInput, DeleteAliasCommandOutput>;
|
|
140
|
+
/**
|
|
141
|
+
* @internal
|
|
142
|
+
*/
|
|
130
143
|
private serialize;
|
|
144
|
+
/**
|
|
145
|
+
* @internal
|
|
146
|
+
*/
|
|
131
147
|
private deserialize;
|
|
132
148
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { DeleteCustomKeyStoreRequest, DeleteCustomKeyStoreResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link DeleteCustomKeyStoreCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface DeleteCustomKeyStoreCommandInput extends DeleteCustomKeyStoreRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link DeleteCustomKeyStoreCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface DeleteCustomKeyStoreCommandOutput extends DeleteCustomKeyStoreResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Deletes a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. This operation does not affect any backing elements of the
|
|
18
23
|
* custom key store. It does not delete the CloudHSM cluster that is associated with an CloudHSM key
|
|
19
24
|
* store, or affect any users or keys in the cluster. For an external key store, it does not
|
|
@@ -83,6 +88,8 @@ export interface DeleteCustomKeyStoreCommandOutput extends DeleteCustomKeyStoreR
|
|
|
83
88
|
* const response = await client.send(command);
|
|
84
89
|
* ```
|
|
85
90
|
*
|
|
91
|
+
* @param DeleteCustomKeyStoreCommandInput - {@link DeleteCustomKeyStoreCommandInput}
|
|
92
|
+
* @returns {@link DeleteCustomKeyStoreCommandOutput}
|
|
86
93
|
* @see {@link DeleteCustomKeyStoreCommandInput} for command's `input` shape.
|
|
87
94
|
* @see {@link DeleteCustomKeyStoreCommandOutput} for command's `response` shape.
|
|
88
95
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -153,11 +160,20 @@ export interface DeleteCustomKeyStoreCommandOutput extends DeleteCustomKeyStoreR
|
|
|
153
160
|
export declare class DeleteCustomKeyStoreCommand extends $Command<DeleteCustomKeyStoreCommandInput, DeleteCustomKeyStoreCommandOutput, KMSClientResolvedConfig> {
|
|
154
161
|
readonly input: DeleteCustomKeyStoreCommandInput;
|
|
155
162
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
163
|
+
/**
|
|
164
|
+
* @public
|
|
165
|
+
*/
|
|
156
166
|
constructor(input: DeleteCustomKeyStoreCommandInput);
|
|
157
167
|
/**
|
|
158
168
|
* @internal
|
|
159
169
|
*/
|
|
160
170
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteCustomKeyStoreCommandInput, DeleteCustomKeyStoreCommandOutput>;
|
|
171
|
+
/**
|
|
172
|
+
* @internal
|
|
173
|
+
*/
|
|
161
174
|
private serialize;
|
|
175
|
+
/**
|
|
176
|
+
* @internal
|
|
177
|
+
*/
|
|
162
178
|
private deserialize;
|
|
163
179
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { DeleteImportedKeyMaterialRequest } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link DeleteImportedKeyMaterialCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface DeleteImportedKeyMaterialCommandInput extends DeleteImportedKeyMaterialRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link DeleteImportedKeyMaterialCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface DeleteImportedKeyMaterialCommandOutput extends __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Deletes key material that you previously imported. This operation makes the specified KMS
|
|
18
23
|
* key unusable. For 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>
|
|
19
24
|
* in the <i>Key Management Service Developer Guide</i>. </p>
|
|
@@ -53,6 +58,8 @@ export interface DeleteImportedKeyMaterialCommandOutput extends __MetadataBearer
|
|
|
53
58
|
* const response = await client.send(command);
|
|
54
59
|
* ```
|
|
55
60
|
*
|
|
61
|
+
* @param DeleteImportedKeyMaterialCommandInput - {@link DeleteImportedKeyMaterialCommandInput}
|
|
62
|
+
* @returns {@link DeleteImportedKeyMaterialCommandOutput}
|
|
56
63
|
* @see {@link DeleteImportedKeyMaterialCommandInput} for command's `input` shape.
|
|
57
64
|
* @see {@link DeleteImportedKeyMaterialCommandOutput} for command's `response` shape.
|
|
58
65
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -111,11 +118,20 @@ export interface DeleteImportedKeyMaterialCommandOutput extends __MetadataBearer
|
|
|
111
118
|
export declare class DeleteImportedKeyMaterialCommand extends $Command<DeleteImportedKeyMaterialCommandInput, DeleteImportedKeyMaterialCommandOutput, KMSClientResolvedConfig> {
|
|
112
119
|
readonly input: DeleteImportedKeyMaterialCommandInput;
|
|
113
120
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
121
|
+
/**
|
|
122
|
+
* @public
|
|
123
|
+
*/
|
|
114
124
|
constructor(input: DeleteImportedKeyMaterialCommandInput);
|
|
115
125
|
/**
|
|
116
126
|
* @internal
|
|
117
127
|
*/
|
|
118
128
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteImportedKeyMaterialCommandInput, DeleteImportedKeyMaterialCommandOutput>;
|
|
129
|
+
/**
|
|
130
|
+
* @internal
|
|
131
|
+
*/
|
|
119
132
|
private serialize;
|
|
133
|
+
/**
|
|
134
|
+
* @internal
|
|
135
|
+
*/
|
|
120
136
|
private deserialize;
|
|
121
137
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { DescribeCustomKeyStoresRequest, DescribeCustomKeyStoresResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link DescribeCustomKeyStoresCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface DescribeCustomKeyStoresCommandInput extends DescribeCustomKeyStoresRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link DescribeCustomKeyStoresCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface DescribeCustomKeyStoresCommandOutput extends DescribeCustomKeyStoresResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Gets information about <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key stores</a> in the account and Region.</p>
|
|
18
23
|
* <p> This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key stores</a> feature in KMS, which
|
|
19
24
|
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
@@ -83,6 +88,8 @@ export interface DescribeCustomKeyStoresCommandOutput extends DescribeCustomKeyS
|
|
|
83
88
|
* const response = await client.send(command);
|
|
84
89
|
* ```
|
|
85
90
|
*
|
|
91
|
+
* @param DescribeCustomKeyStoresCommandInput - {@link DescribeCustomKeyStoresCommandInput}
|
|
92
|
+
* @returns {@link DescribeCustomKeyStoresCommandOutput}
|
|
86
93
|
* @see {@link DescribeCustomKeyStoresCommandInput} for command's `input` shape.
|
|
87
94
|
* @see {@link DescribeCustomKeyStoresCommandOutput} for command's `response` shape.
|
|
88
95
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -205,11 +212,20 @@ export interface DescribeCustomKeyStoresCommandOutput extends DescribeCustomKeyS
|
|
|
205
212
|
export declare class DescribeCustomKeyStoresCommand extends $Command<DescribeCustomKeyStoresCommandInput, DescribeCustomKeyStoresCommandOutput, KMSClientResolvedConfig> {
|
|
206
213
|
readonly input: DescribeCustomKeyStoresCommandInput;
|
|
207
214
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
215
|
+
/**
|
|
216
|
+
* @public
|
|
217
|
+
*/
|
|
208
218
|
constructor(input: DescribeCustomKeyStoresCommandInput);
|
|
209
219
|
/**
|
|
210
220
|
* @internal
|
|
211
221
|
*/
|
|
212
222
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeCustomKeyStoresCommandInput, DescribeCustomKeyStoresCommandOutput>;
|
|
223
|
+
/**
|
|
224
|
+
* @internal
|
|
225
|
+
*/
|
|
213
226
|
private serialize;
|
|
227
|
+
/**
|
|
228
|
+
* @internal
|
|
229
|
+
*/
|
|
214
230
|
private deserialize;
|
|
215
231
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { DescribeKeyRequest, DescribeKeyResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link DescribeKeyCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface DescribeKeyCommandInput extends DescribeKeyRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link DescribeKeyCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface DescribeKeyCommandOutput extends DescribeKeyResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Provides detailed information about a KMS key. You can run <code>DescribeKey</code> on a
|
|
18
23
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed
|
|
19
24
|
* key</a> or an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed key</a>.</p>
|
|
@@ -107,6 +112,8 @@ export interface DescribeKeyCommandOutput extends DescribeKeyResponse, __Metadat
|
|
|
107
112
|
* const response = await client.send(command);
|
|
108
113
|
* ```
|
|
109
114
|
*
|
|
115
|
+
* @param DescribeKeyCommandInput - {@link DescribeKeyCommandInput}
|
|
116
|
+
* @returns {@link DescribeKeyCommandOutput}
|
|
110
117
|
* @see {@link DescribeKeyCommandInput} for command's `input` shape.
|
|
111
118
|
* @see {@link DescribeKeyCommandOutput} for command's `response` shape.
|
|
112
119
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -360,11 +367,20 @@ export interface DescribeKeyCommandOutput extends DescribeKeyResponse, __Metadat
|
|
|
360
367
|
export declare class DescribeKeyCommand extends $Command<DescribeKeyCommandInput, DescribeKeyCommandOutput, KMSClientResolvedConfig> {
|
|
361
368
|
readonly input: DescribeKeyCommandInput;
|
|
362
369
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
370
|
+
/**
|
|
371
|
+
* @public
|
|
372
|
+
*/
|
|
363
373
|
constructor(input: DescribeKeyCommandInput);
|
|
364
374
|
/**
|
|
365
375
|
* @internal
|
|
366
376
|
*/
|
|
367
377
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeKeyCommandInput, DescribeKeyCommandOutput>;
|
|
378
|
+
/**
|
|
379
|
+
* @internal
|
|
380
|
+
*/
|
|
368
381
|
private serialize;
|
|
382
|
+
/**
|
|
383
|
+
* @internal
|
|
384
|
+
*/
|
|
369
385
|
private deserialize;
|
|
370
386
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { DisableKeyRequest } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link DisableKeyCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface DisableKeyCommandInput extends DisableKeyRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link DisableKeyCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface DisableKeyCommandOutput extends __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Sets the state of a KMS key to disabled. This change temporarily prevents use of the KMS
|
|
18
23
|
* key for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. </p>
|
|
19
24
|
* <p>For more information about how key state affects the use of a KMS key, see
|
|
@@ -39,6 +44,8 @@ export interface DisableKeyCommandOutput extends __MetadataBearer {
|
|
|
39
44
|
* const response = await client.send(command);
|
|
40
45
|
* ```
|
|
41
46
|
*
|
|
47
|
+
* @param DisableKeyCommandInput - {@link DisableKeyCommandInput}
|
|
48
|
+
* @returns {@link DisableKeyCommandOutput}
|
|
42
49
|
* @see {@link DisableKeyCommandInput} for command's `input` shape.
|
|
43
50
|
* @see {@link DisableKeyCommandOutput} for command's `response` shape.
|
|
44
51
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -93,11 +100,20 @@ export interface DisableKeyCommandOutput extends __MetadataBearer {
|
|
|
93
100
|
export declare class DisableKeyCommand extends $Command<DisableKeyCommandInput, DisableKeyCommandOutput, KMSClientResolvedConfig> {
|
|
94
101
|
readonly input: DisableKeyCommandInput;
|
|
95
102
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
103
|
+
/**
|
|
104
|
+
* @public
|
|
105
|
+
*/
|
|
96
106
|
constructor(input: DisableKeyCommandInput);
|
|
97
107
|
/**
|
|
98
108
|
* @internal
|
|
99
109
|
*/
|
|
100
110
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisableKeyCommandInput, DisableKeyCommandOutput>;
|
|
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 { DisableKeyRotationRequest } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link DisableKeyRotationCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface DisableKeyRotationCommandInput extends DisableKeyRotationRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link DisableKeyRotationCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface DisableKeyRotationCommandOutput extends __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Disables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic
|
|
18
23
|
* rotation of the key material</a> of the specified symmetric encryption KMS key.</p>
|
|
19
24
|
* <p>Automatic key rotation is supported only on symmetric encryption KMS keys.
|
|
@@ -57,6 +62,8 @@ export interface DisableKeyRotationCommandOutput extends __MetadataBearer {
|
|
|
57
62
|
* const response = await client.send(command);
|
|
58
63
|
* ```
|
|
59
64
|
*
|
|
65
|
+
* @param DisableKeyRotationCommandInput - {@link DisableKeyRotationCommandInput}
|
|
66
|
+
* @returns {@link DisableKeyRotationCommandOutput}
|
|
60
67
|
* @see {@link DisableKeyRotationCommandInput} for command's `input` shape.
|
|
61
68
|
* @see {@link DisableKeyRotationCommandOutput} for command's `response` shape.
|
|
62
69
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -118,11 +125,20 @@ export interface DisableKeyRotationCommandOutput extends __MetadataBearer {
|
|
|
118
125
|
export declare class DisableKeyRotationCommand extends $Command<DisableKeyRotationCommandInput, DisableKeyRotationCommandOutput, KMSClientResolvedConfig> {
|
|
119
126
|
readonly input: DisableKeyRotationCommandInput;
|
|
120
127
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
128
|
+
/**
|
|
129
|
+
* @public
|
|
130
|
+
*/
|
|
121
131
|
constructor(input: DisableKeyRotationCommandInput);
|
|
122
132
|
/**
|
|
123
133
|
* @internal
|
|
124
134
|
*/
|
|
125
135
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisableKeyRotationCommandInput, DisableKeyRotationCommandOutput>;
|
|
136
|
+
/**
|
|
137
|
+
* @internal
|
|
138
|
+
*/
|
|
126
139
|
private serialize;
|
|
140
|
+
/**
|
|
141
|
+
* @internal
|
|
142
|
+
*/
|
|
127
143
|
private deserialize;
|
|
128
144
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { DisconnectCustomKeyStoreRequest, DisconnectCustomKeyStoreResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link DisconnectCustomKeyStoreCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface DisconnectCustomKeyStoreCommandInput extends DisconnectCustomKeyStoreRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link DisconnectCustomKeyStoreCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface DisconnectCustomKeyStoreCommandOutput extends DisconnectCustomKeyStoreResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Disconnects the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> from its backing key store. This operation disconnects an
|
|
18
23
|
* CloudHSM key store from its associated CloudHSM cluster or disconnects an external key store from
|
|
19
24
|
* the external key store proxy that communicates with your external key manager.</p>
|
|
@@ -76,6 +81,8 @@ export interface DisconnectCustomKeyStoreCommandOutput extends DisconnectCustomK
|
|
|
76
81
|
* const response = await client.send(command);
|
|
77
82
|
* ```
|
|
78
83
|
*
|
|
84
|
+
* @param DisconnectCustomKeyStoreCommandInput - {@link DisconnectCustomKeyStoreCommandInput}
|
|
85
|
+
* @returns {@link DisconnectCustomKeyStoreCommandOutput}
|
|
79
86
|
* @see {@link DisconnectCustomKeyStoreCommandInput} for command's `input` shape.
|
|
80
87
|
* @see {@link DisconnectCustomKeyStoreCommandOutput} for command's `response` shape.
|
|
81
88
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -140,11 +147,20 @@ export interface DisconnectCustomKeyStoreCommandOutput extends DisconnectCustomK
|
|
|
140
147
|
export declare class DisconnectCustomKeyStoreCommand extends $Command<DisconnectCustomKeyStoreCommandInput, DisconnectCustomKeyStoreCommandOutput, KMSClientResolvedConfig> {
|
|
141
148
|
readonly input: DisconnectCustomKeyStoreCommandInput;
|
|
142
149
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
150
|
+
/**
|
|
151
|
+
* @public
|
|
152
|
+
*/
|
|
143
153
|
constructor(input: DisconnectCustomKeyStoreCommandInput);
|
|
144
154
|
/**
|
|
145
155
|
* @internal
|
|
146
156
|
*/
|
|
147
157
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisconnectCustomKeyStoreCommandInput, DisconnectCustomKeyStoreCommandOutput>;
|
|
158
|
+
/**
|
|
159
|
+
* @internal
|
|
160
|
+
*/
|
|
148
161
|
private serialize;
|
|
162
|
+
/**
|
|
163
|
+
* @internal
|
|
164
|
+
*/
|
|
149
165
|
private deserialize;
|
|
150
166
|
}
|