@aws-sdk/client-kms 3.529.1 → 3.535.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/KMS.d.ts +7 -1
- package/dist-types/KMSClient.d.ts +1 -1
- package/dist-types/commands/CancelKeyDeletionCommand.d.ts +2 -1
- package/dist-types/commands/ConnectCustomKeyStoreCommand.d.ts +2 -1
- package/dist-types/commands/CreateAliasCommand.d.ts +2 -1
- package/dist-types/commands/CreateCustomKeyStoreCommand.d.ts +2 -1
- package/dist-types/commands/CreateGrantCommand.d.ts +2 -1
- package/dist-types/commands/CreateKeyCommand.d.ts +2 -1
- package/dist-types/commands/DecryptCommand.d.ts +6 -5
- package/dist-types/commands/DeleteAliasCommand.d.ts +2 -1
- package/dist-types/commands/DeleteCustomKeyStoreCommand.d.ts +2 -1
- package/dist-types/commands/DeleteImportedKeyMaterialCommand.d.ts +2 -1
- package/dist-types/commands/DescribeCustomKeyStoresCommand.d.ts +2 -1
- package/dist-types/commands/DescribeKeyCommand.d.ts +2 -1
- package/dist-types/commands/DisableKeyCommand.d.ts +2 -1
- package/dist-types/commands/DisableKeyRotationCommand.d.ts +2 -1
- package/dist-types/commands/DisconnectCustomKeyStoreCommand.d.ts +2 -1
- package/dist-types/commands/EnableKeyCommand.d.ts +2 -1
- package/dist-types/commands/EnableKeyRotationCommand.d.ts +2 -1
- package/dist-types/commands/EncryptCommand.d.ts +4 -3
- package/dist-types/commands/GenerateDataKeyCommand.d.ts +6 -5
- package/dist-types/commands/GenerateDataKeyPairCommand.d.ts +7 -6
- package/dist-types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +4 -3
- package/dist-types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +3 -2
- package/dist-types/commands/GenerateMacCommand.d.ts +4 -3
- package/dist-types/commands/GenerateRandomCommand.d.ts +5 -4
- package/dist-types/commands/GetKeyPolicyCommand.d.ts +2 -1
- package/dist-types/commands/GetKeyRotationStatusCommand.d.ts +2 -1
- package/dist-types/commands/GetParametersForImportCommand.d.ts +4 -3
- package/dist-types/commands/GetPublicKeyCommand.d.ts +3 -2
- package/dist-types/commands/ImportKeyMaterialCommand.d.ts +4 -3
- package/dist-types/commands/ListAliasesCommand.d.ts +2 -1
- package/dist-types/commands/ListGrantsCommand.d.ts +2 -1
- package/dist-types/commands/ListKeyPoliciesCommand.d.ts +2 -1
- package/dist-types/commands/ListKeysCommand.d.ts +2 -1
- package/dist-types/commands/ListResourceTagsCommand.d.ts +2 -1
- package/dist-types/commands/ListRetirableGrantsCommand.d.ts +2 -1
- package/dist-types/commands/PutKeyPolicyCommand.d.ts +2 -1
- package/dist-types/commands/ReEncryptCommand.d.ts +4 -3
- package/dist-types/commands/ReplicateKeyCommand.d.ts +2 -1
- package/dist-types/commands/RetireGrantCommand.d.ts +2 -1
- package/dist-types/commands/RevokeGrantCommand.d.ts +2 -1
- package/dist-types/commands/ScheduleKeyDeletionCommand.d.ts +2 -1
- package/dist-types/commands/SignCommand.d.ts +4 -3
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateAliasCommand.d.ts +2 -1
- package/dist-types/commands/UpdateCustomKeyStoreCommand.d.ts +2 -1
- package/dist-types/commands/UpdateKeyDescriptionCommand.d.ts +2 -1
- package/dist-types/commands/UpdatePrimaryRegionCommand.d.ts +2 -1
- package/dist-types/commands/VerifyCommand.d.ts +4 -3
- package/dist-types/commands/VerifyMacCommand.d.ts +4 -3
- package/dist-types/models/models_0.d.ts +404 -404
- package/dist-types/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/runtimeConfig.d.ts +2 -2
- package/dist-types/runtimeConfig.native.d.ts +2 -2
- package/dist-types/runtimeConfig.shared.d.ts +2 -2
- package/dist-types/ts3.4/KMS.d.ts +6 -0
- package/dist-types/ts3.4/commands/CancelKeyDeletionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ConnectCustomKeyStoreCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateAliasCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateCustomKeyStoreCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateGrantCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateKeyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DecryptCommand.d.ts +7 -0
- package/dist-types/ts3.4/commands/DeleteAliasCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteCustomKeyStoreCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteImportedKeyMaterialCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeCustomKeyStoresCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeKeyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisableKeyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisableKeyRotationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisconnectCustomKeyStoreCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/EnableKeyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/EnableKeyRotationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/EncryptCommand.d.ts +7 -0
- package/dist-types/ts3.4/commands/GenerateDataKeyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GenerateDataKeyPairCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GenerateMacCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GenerateRandomCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetKeyPolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetKeyRotationStatusCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetParametersForImportCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetPublicKeyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ImportKeyMaterialCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListAliasesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListGrantsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListKeyPoliciesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListKeysCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListResourceTagsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListRetirableGrantsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutKeyPolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ReEncryptCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ReplicateKeyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RetireGrantCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RevokeGrantCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ScheduleKeyDeletionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SignCommand.d.ts +7 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateAliasCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateCustomKeyStoreCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateKeyDescriptionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdatePrimaryRegionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/VerifyCommand.d.ts +7 -0
- package/dist-types/ts3.4/commands/VerifyMacCommand.d.ts +9 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
- package/package.json +40 -40
package/dist-types/KMS.d.ts
CHANGED
|
@@ -84,6 +84,7 @@ export interface KMS {
|
|
|
84
84
|
/**
|
|
85
85
|
* @see {@link CreateKeyCommand}
|
|
86
86
|
*/
|
|
87
|
+
createKey(): Promise<CreateKeyCommandOutput>;
|
|
87
88
|
createKey(args: CreateKeyCommandInput, options?: __HttpHandlerOptions): Promise<CreateKeyCommandOutput>;
|
|
88
89
|
createKey(args: CreateKeyCommandInput, cb: (err: any, data?: CreateKeyCommandOutput) => void): void;
|
|
89
90
|
createKey(args: CreateKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateKeyCommandOutput) => void): void;
|
|
@@ -114,6 +115,7 @@ export interface KMS {
|
|
|
114
115
|
/**
|
|
115
116
|
* @see {@link DescribeCustomKeyStoresCommand}
|
|
116
117
|
*/
|
|
118
|
+
describeCustomKeyStores(): Promise<DescribeCustomKeyStoresCommandOutput>;
|
|
117
119
|
describeCustomKeyStores(args: DescribeCustomKeyStoresCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCustomKeyStoresCommandOutput>;
|
|
118
120
|
describeCustomKeyStores(args: DescribeCustomKeyStoresCommandInput, cb: (err: any, data?: DescribeCustomKeyStoresCommandOutput) => void): void;
|
|
119
121
|
describeCustomKeyStores(args: DescribeCustomKeyStoresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCustomKeyStoresCommandOutput) => void): void;
|
|
@@ -192,6 +194,7 @@ export interface KMS {
|
|
|
192
194
|
/**
|
|
193
195
|
* @see {@link GenerateRandomCommand}
|
|
194
196
|
*/
|
|
197
|
+
generateRandom(): Promise<GenerateRandomCommandOutput>;
|
|
195
198
|
generateRandom(args: GenerateRandomCommandInput, options?: __HttpHandlerOptions): Promise<GenerateRandomCommandOutput>;
|
|
196
199
|
generateRandom(args: GenerateRandomCommandInput, cb: (err: any, data?: GenerateRandomCommandOutput) => void): void;
|
|
197
200
|
generateRandom(args: GenerateRandomCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateRandomCommandOutput) => void): void;
|
|
@@ -228,6 +231,7 @@ export interface KMS {
|
|
|
228
231
|
/**
|
|
229
232
|
* @see {@link ListAliasesCommand}
|
|
230
233
|
*/
|
|
234
|
+
listAliases(): Promise<ListAliasesCommandOutput>;
|
|
231
235
|
listAliases(args: ListAliasesCommandInput, options?: __HttpHandlerOptions): Promise<ListAliasesCommandOutput>;
|
|
232
236
|
listAliases(args: ListAliasesCommandInput, cb: (err: any, data?: ListAliasesCommandOutput) => void): void;
|
|
233
237
|
listAliases(args: ListAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAliasesCommandOutput) => void): void;
|
|
@@ -246,6 +250,7 @@ export interface KMS {
|
|
|
246
250
|
/**
|
|
247
251
|
* @see {@link ListKeysCommand}
|
|
248
252
|
*/
|
|
253
|
+
listKeys(): Promise<ListKeysCommandOutput>;
|
|
249
254
|
listKeys(args: ListKeysCommandInput, options?: __HttpHandlerOptions): Promise<ListKeysCommandOutput>;
|
|
250
255
|
listKeys(args: ListKeysCommandInput, cb: (err: any, data?: ListKeysCommandOutput) => void): void;
|
|
251
256
|
listKeys(args: ListKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListKeysCommandOutput) => void): void;
|
|
@@ -282,6 +287,7 @@ export interface KMS {
|
|
|
282
287
|
/**
|
|
283
288
|
* @see {@link RetireGrantCommand}
|
|
284
289
|
*/
|
|
290
|
+
retireGrant(): Promise<RetireGrantCommandOutput>;
|
|
285
291
|
retireGrant(args: RetireGrantCommandInput, options?: __HttpHandlerOptions): Promise<RetireGrantCommandOutput>;
|
|
286
292
|
retireGrant(args: RetireGrantCommandInput, cb: (err: any, data?: RetireGrantCommandOutput) => void): void;
|
|
287
293
|
retireGrant(args: RetireGrantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RetireGrantCommandOutput) => void): void;
|
|
@@ -353,7 +359,6 @@ export interface KMS {
|
|
|
353
359
|
verifyMac(args: VerifyMacCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifyMacCommandOutput) => void): void;
|
|
354
360
|
}
|
|
355
361
|
/**
|
|
356
|
-
* @public
|
|
357
362
|
* <fullname>Key Management Service</fullname>
|
|
358
363
|
* <p>Key Management Service (KMS) is an encryption and key management web service. This guide describes
|
|
359
364
|
* the KMS operations that you can call programmatically. For general information about KMS,
|
|
@@ -449,6 +454,7 @@ export interface KMS {
|
|
|
449
454
|
* </p>
|
|
450
455
|
* </li>
|
|
451
456
|
* </ul>
|
|
457
|
+
* @public
|
|
452
458
|
*/
|
|
453
459
|
export declare class KMS extends KMSClient implements KMS {
|
|
454
460
|
}
|
|
@@ -201,7 +201,6 @@ export type KMSClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHa
|
|
|
201
201
|
export interface KMSClientResolvedConfig extends KMSClientResolvedConfigType {
|
|
202
202
|
}
|
|
203
203
|
/**
|
|
204
|
-
* @public
|
|
205
204
|
* <fullname>Key Management Service</fullname>
|
|
206
205
|
* <p>Key Management Service (KMS) is an encryption and key management web service. This guide describes
|
|
207
206
|
* the KMS operations that you can call programmatically. For general information about KMS,
|
|
@@ -297,6 +296,7 @@ export interface KMSClientResolvedConfig extends KMSClientResolvedConfigType {
|
|
|
297
296
|
* </p>
|
|
298
297
|
* </li>
|
|
299
298
|
* </ul>
|
|
299
|
+
* @public
|
|
300
300
|
*/
|
|
301
301
|
export declare class KMSClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, KMSClientResolvedConfig> {
|
|
302
302
|
/**
|
|
@@ -22,10 +22,10 @@ export interface CancelKeyDeletionCommandOutput extends CancelKeyDeletionRespons
|
|
|
22
22
|
}
|
|
23
23
|
declare const CancelKeyDeletionCommand_base: {
|
|
24
24
|
new (input: CancelKeyDeletionCommandInput): import("@smithy/smithy-client").CommandImpl<CancelKeyDeletionCommandInput, CancelKeyDeletionCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: CancelKeyDeletionCommandInput): import("@smithy/smithy-client").CommandImpl<CancelKeyDeletionCommandInput, CancelKeyDeletionCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Cancels the deletion of a KMS key. When this operation succeeds, the key state of the KMS
|
|
30
30
|
* key is <code>Disabled</code>. To enable the KMS key, use <a>EnableKey</a>. </p>
|
|
31
31
|
* <p>For more information about scheduling and canceling deletion of a KMS key, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting KMS keys</a> in the
|
|
@@ -104,6 +104,7 @@ declare const CancelKeyDeletionCommand_base: {
|
|
|
104
104
|
* @throws {@link KMSServiceException}
|
|
105
105
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
106
106
|
*
|
|
107
|
+
* @public
|
|
107
108
|
* @example To cancel deletion of a KMS key
|
|
108
109
|
* ```javascript
|
|
109
110
|
* // The following example cancels deletion of the specified KMS key.
|
|
@@ -22,10 +22,10 @@ export interface ConnectCustomKeyStoreCommandOutput extends ConnectCustomKeyStor
|
|
|
22
22
|
}
|
|
23
23
|
declare const ConnectCustomKeyStoreCommand_base: {
|
|
24
24
|
new (input: ConnectCustomKeyStoreCommandInput): import("@smithy/smithy-client").CommandImpl<ConnectCustomKeyStoreCommandInput, ConnectCustomKeyStoreCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: ConnectCustomKeyStoreCommandInput): import("@smithy/smithy-client").CommandImpl<ConnectCustomKeyStoreCommandInput, ConnectCustomKeyStoreCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Connects or reconnects a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> to its backing key store. For an CloudHSM key
|
|
30
30
|
* store, <code>ConnectCustomKeyStore</code> connects the key store to its associated CloudHSM
|
|
31
31
|
* cluster. For an external key store, <code>ConnectCustomKeyStore</code> connects the key store
|
|
@@ -224,6 +224,7 @@ declare const ConnectCustomKeyStoreCommand_base: {
|
|
|
224
224
|
* @throws {@link KMSServiceException}
|
|
225
225
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
226
226
|
*
|
|
227
|
+
* @public
|
|
227
228
|
* @example To connect a custom key store
|
|
228
229
|
* ```javascript
|
|
229
230
|
* // This example connects an AWS KMS custom key store to its backing key store. For an AWS CloudHSM key store, it connects the key store to its AWS CloudHSM cluster. For an external key store, it connects the key store to the external key store proxy that communicates with your external key manager. This operation does not return any data. To verify that the custom key store is connected, use the <code>DescribeCustomKeyStores</code> operation.
|
|
@@ -22,10 +22,10 @@ export interface CreateAliasCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
}
|
|
23
23
|
declare const CreateAliasCommand_base: {
|
|
24
24
|
new (input: CreateAliasCommandInput): import("@smithy/smithy-client").CommandImpl<CreateAliasCommandInput, CreateAliasCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: CreateAliasCommandInput): import("@smithy/smithy-client").CommandImpl<CreateAliasCommandInput, CreateAliasCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Creates a friendly name for a KMS key. </p>
|
|
30
30
|
* <note>
|
|
31
31
|
* <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>
|
|
@@ -154,6 +154,7 @@ declare const CreateAliasCommand_base: {
|
|
|
154
154
|
* @throws {@link KMSServiceException}
|
|
155
155
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
156
156
|
*
|
|
157
|
+
* @public
|
|
157
158
|
* @example To create an alias
|
|
158
159
|
* ```javascript
|
|
159
160
|
* // The following example creates an alias for the specified KMS key.
|
|
@@ -22,10 +22,10 @@ export interface CreateCustomKeyStoreCommandOutput extends CreateCustomKeyStoreR
|
|
|
22
22
|
}
|
|
23
23
|
declare const CreateCustomKeyStoreCommand_base: {
|
|
24
24
|
new (input: CreateCustomKeyStoreCommandInput): import("@smithy/smithy-client").CommandImpl<CreateCustomKeyStoreCommandInput, CreateCustomKeyStoreCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: CreateCustomKeyStoreCommandInput): import("@smithy/smithy-client").CommandImpl<CreateCustomKeyStoreCommandInput, CreateCustomKeyStoreCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <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
|
|
30
30
|
* KMS key in a custom key store for a cryptographic operation, the cryptographic operation is
|
|
31
31
|
* 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>
|
|
@@ -280,6 +280,7 @@ declare const CreateCustomKeyStoreCommand_base: {
|
|
|
280
280
|
* @throws {@link KMSServiceException}
|
|
281
281
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
282
282
|
*
|
|
283
|
+
* @public
|
|
283
284
|
* @example To create an AWS CloudHSM key store
|
|
284
285
|
* ```javascript
|
|
285
286
|
* // This example creates a custom key store that is associated with an AWS CloudHSM cluster.
|
|
@@ -22,10 +22,10 @@ export interface CreateGrantCommandOutput extends CreateGrantResponse, __Metadat
|
|
|
22
22
|
}
|
|
23
23
|
declare const CreateGrantCommand_base: {
|
|
24
24
|
new (input: CreateGrantCommandInput): import("@smithy/smithy-client").CommandImpl<CreateGrantCommandInput, CreateGrantCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: CreateGrantCommandInput): import("@smithy/smithy-client").CommandImpl<CreateGrantCommandInput, CreateGrantCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Adds a grant to a KMS key. </p>
|
|
30
30
|
* <p>A <i>grant</i> is a policy instrument that allows Amazon Web Services principals to use
|
|
31
31
|
* 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,
|
|
@@ -185,6 +185,7 @@ declare const CreateGrantCommand_base: {
|
|
|
185
185
|
* @throws {@link KMSServiceException}
|
|
186
186
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
187
187
|
*
|
|
188
|
+
* @public
|
|
188
189
|
* @example To create a grant
|
|
189
190
|
* ```javascript
|
|
190
191
|
* // The following example creates a grant that allows the specified IAM role to encrypt data with the specified KMS key.
|
|
@@ -22,10 +22,10 @@ export interface CreateKeyCommandOutput extends CreateKeyResponse, __MetadataBea
|
|
|
22
22
|
}
|
|
23
23
|
declare const CreateKeyCommand_base: {
|
|
24
24
|
new (input: CreateKeyCommandInput): import("@smithy/smithy-client").CommandImpl<CreateKeyCommandInput, CreateKeyCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (...[input]: [] | [CreateKeyCommandInput]): import("@smithy/smithy-client").CommandImpl<CreateKeyCommandInput, CreateKeyCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <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.
|
|
30
30
|
* You can use a KMS key in cryptographic operations, such as encryption and signing. Some Amazon Web Services
|
|
31
31
|
* services let you use KMS keys that you create and manage to protect your service
|
|
@@ -400,6 +400,7 @@ declare const CreateKeyCommand_base: {
|
|
|
400
400
|
* @throws {@link KMSServiceException}
|
|
401
401
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
402
402
|
*
|
|
403
|
+
* @public
|
|
403
404
|
* @example To create a KMS key
|
|
404
405
|
* ```javascript
|
|
405
406
|
* // The following example creates a symmetric KMS key for encryption and decryption. No parameters are required for this operation.
|
|
@@ -22,10 +22,10 @@ export interface DecryptCommandOutput extends DecryptResponse, __MetadataBearer
|
|
|
22
22
|
}
|
|
23
23
|
declare const DecryptCommand_base: {
|
|
24
24
|
new (input: DecryptCommandInput): import("@smithy/smithy-client").CommandImpl<DecryptCommandInput, DecryptCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: DecryptCommandInput): import("@smithy/smithy-client").CommandImpl<DecryptCommandInput, DecryptCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Decrypts ciphertext that was encrypted by a KMS key using any of the following
|
|
30
30
|
* operations:</p>
|
|
31
31
|
* <ul>
|
|
@@ -130,7 +130,7 @@ declare const DecryptCommand_base: {
|
|
|
130
130
|
* // const { KMSClient, DecryptCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
131
131
|
* const client = new KMSClient(config);
|
|
132
132
|
* const input = { // DecryptRequest
|
|
133
|
-
* CiphertextBlob: "
|
|
133
|
+
* CiphertextBlob: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") // required
|
|
134
134
|
* EncryptionContext: { // EncryptionContextType
|
|
135
135
|
* "<keys>": "STRING_VALUE",
|
|
136
136
|
* },
|
|
@@ -141,7 +141,7 @@ declare const DecryptCommand_base: {
|
|
|
141
141
|
* EncryptionAlgorithm: "SYMMETRIC_DEFAULT" || "RSAES_OAEP_SHA_1" || "RSAES_OAEP_SHA_256" || "SM2PKE",
|
|
142
142
|
* Recipient: { // RecipientInfo
|
|
143
143
|
* KeyEncryptionAlgorithm: "RSAES_OAEP_SHA_256",
|
|
144
|
-
* AttestationDocument: "
|
|
144
|
+
* AttestationDocument: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
|
|
145
145
|
* },
|
|
146
146
|
* DryRun: true || false,
|
|
147
147
|
* };
|
|
@@ -149,9 +149,9 @@ declare const DecryptCommand_base: {
|
|
|
149
149
|
* const response = await client.send(command);
|
|
150
150
|
* // { // DecryptResponse
|
|
151
151
|
* // KeyId: "STRING_VALUE",
|
|
152
|
-
* // Plaintext:
|
|
152
|
+
* // Plaintext: new Uint8Array(),
|
|
153
153
|
* // EncryptionAlgorithm: "SYMMETRIC_DEFAULT" || "RSAES_OAEP_SHA_1" || "RSAES_OAEP_SHA_256" || "SM2PKE",
|
|
154
|
-
* // CiphertextForRecipient:
|
|
154
|
+
* // CiphertextForRecipient: new Uint8Array(),
|
|
155
155
|
* // };
|
|
156
156
|
*
|
|
157
157
|
* ```
|
|
@@ -245,6 +245,7 @@ declare const DecryptCommand_base: {
|
|
|
245
245
|
* @throws {@link KMSServiceException}
|
|
246
246
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
247
247
|
*
|
|
248
|
+
* @public
|
|
248
249
|
* @example To decrypt data with a symmetric encryption KMS key
|
|
249
250
|
* ```javascript
|
|
250
251
|
* // The following example decrypts data that was encrypted with a symmetric encryption KMS key. The KeyId is not required when decrypting with a symmetric encryption key, but it is a best practice.
|
|
@@ -22,10 +22,10 @@ export interface DeleteAliasCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
}
|
|
23
23
|
declare const DeleteAliasCommand_base: {
|
|
24
24
|
new (input: DeleteAliasCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteAliasCommandInput, DeleteAliasCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: DeleteAliasCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteAliasCommandInput, DeleteAliasCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Deletes the specified alias. </p>
|
|
30
30
|
* <note>
|
|
31
31
|
* <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>
|
|
@@ -133,6 +133,7 @@ declare const DeleteAliasCommand_base: {
|
|
|
133
133
|
* @throws {@link KMSServiceException}
|
|
134
134
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
135
135
|
*
|
|
136
|
+
* @public
|
|
136
137
|
* @example To delete an alias
|
|
137
138
|
* ```javascript
|
|
138
139
|
* // The following example deletes the specified alias.
|
|
@@ -22,10 +22,10 @@ export interface DeleteCustomKeyStoreCommandOutput extends DeleteCustomKeyStoreR
|
|
|
22
22
|
}
|
|
23
23
|
declare const DeleteCustomKeyStoreCommand_base: {
|
|
24
24
|
new (input: DeleteCustomKeyStoreCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteCustomKeyStoreCommandInput, DeleteCustomKeyStoreCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: DeleteCustomKeyStoreCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteCustomKeyStoreCommandInput, DeleteCustomKeyStoreCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <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
|
|
30
30
|
* custom key store. It does not delete the CloudHSM cluster that is associated with an CloudHSM key
|
|
31
31
|
* store, or affect any users or keys in the cluster. For an external key store, it does not
|
|
@@ -162,6 +162,7 @@ declare const DeleteCustomKeyStoreCommand_base: {
|
|
|
162
162
|
* @throws {@link KMSServiceException}
|
|
163
163
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
164
164
|
*
|
|
165
|
+
* @public
|
|
165
166
|
* @example To delete a custom key store from AWS KMS
|
|
166
167
|
* ```javascript
|
|
167
168
|
* // This example deletes a custom key store from AWS KMS. This operation does not affect the backing key store, such as a CloudHSM cluster, external key store proxy, or your external key manager. This operation doesn't return any data. To verify that the operation was successful, use the DescribeCustomKeyStores operation.
|
|
@@ -22,10 +22,10 @@ export interface DeleteImportedKeyMaterialCommandOutput extends __MetadataBearer
|
|
|
22
22
|
}
|
|
23
23
|
declare const DeleteImportedKeyMaterialCommand_base: {
|
|
24
24
|
new (input: DeleteImportedKeyMaterialCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteImportedKeyMaterialCommandInput, DeleteImportedKeyMaterialCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: DeleteImportedKeyMaterialCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteImportedKeyMaterialCommandInput, DeleteImportedKeyMaterialCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Deletes key material that was previously imported. This operation makes the specified KMS
|
|
30
30
|
* key temporarily unusable. To restore the usability of the KMS key, reimport the same key
|
|
31
31
|
* material. 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>
|
|
@@ -121,6 +121,7 @@ declare const DeleteImportedKeyMaterialCommand_base: {
|
|
|
121
121
|
* @throws {@link KMSServiceException}
|
|
122
122
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
123
123
|
*
|
|
124
|
+
* @public
|
|
124
125
|
* @example To delete imported key material
|
|
125
126
|
* ```javascript
|
|
126
127
|
* // The following example deletes the imported key material from the specified KMS key.
|
|
@@ -22,10 +22,10 @@ export interface DescribeCustomKeyStoresCommandOutput extends DescribeCustomKeyS
|
|
|
22
22
|
}
|
|
23
23
|
declare const DescribeCustomKeyStoresCommand_base: {
|
|
24
24
|
new (input: DescribeCustomKeyStoresCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeCustomKeyStoresCommandInput, DescribeCustomKeyStoresCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (...[input]: [] | [DescribeCustomKeyStoresCommandInput]): import("@smithy/smithy-client").CommandImpl<DescribeCustomKeyStoresCommandInput, DescribeCustomKeyStoresCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <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>
|
|
30
30
|
* <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
|
|
31
31
|
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
@@ -149,6 +149,7 @@ declare const DescribeCustomKeyStoresCommand_base: {
|
|
|
149
149
|
* @throws {@link KMSServiceException}
|
|
150
150
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
151
151
|
*
|
|
152
|
+
* @public
|
|
152
153
|
* @example To get detailed information about custom key stores in the account and Region
|
|
153
154
|
* ```javascript
|
|
154
155
|
* // This example gets detailed information about all AWS KMS custom key stores in an AWS account and Region. To get all key stores, do not enter a custom key store name or ID.
|
|
@@ -22,10 +22,10 @@ export interface DescribeKeyCommandOutput extends DescribeKeyResponse, __Metadat
|
|
|
22
22
|
}
|
|
23
23
|
declare const DescribeKeyCommand_base: {
|
|
24
24
|
new (input: DescribeKeyCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeKeyCommandInput, DescribeKeyCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: DescribeKeyCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeKeyCommandInput, DescribeKeyCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Provides detailed information about a KMS key. You can run <code>DescribeKey</code> on a
|
|
30
30
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed
|
|
31
31
|
* 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>
|
|
@@ -200,6 +200,7 @@ declare const DescribeKeyCommand_base: {
|
|
|
200
200
|
* @throws {@link KMSServiceException}
|
|
201
201
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
202
202
|
*
|
|
203
|
+
* @public
|
|
203
204
|
* @example To get details about a KMS key
|
|
204
205
|
* ```javascript
|
|
205
206
|
* // The following example gets metadata for a symmetric encryption KMS key.
|
|
@@ -22,10 +22,10 @@ export interface DisableKeyCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
}
|
|
23
23
|
declare const DisableKeyCommand_base: {
|
|
24
24
|
new (input: DisableKeyCommandInput): import("@smithy/smithy-client").CommandImpl<DisableKeyCommandInput, DisableKeyCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: DisableKeyCommandInput): import("@smithy/smithy-client").CommandImpl<DisableKeyCommandInput, DisableKeyCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Sets the state of a KMS key to disabled. This change temporarily prevents use of the KMS
|
|
30
30
|
* key for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. </p>
|
|
31
31
|
* <p>For more information about how key state affects the use of a KMS key, see
|
|
@@ -104,6 +104,7 @@ declare const DisableKeyCommand_base: {
|
|
|
104
104
|
* @throws {@link KMSServiceException}
|
|
105
105
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
106
106
|
*
|
|
107
|
+
* @public
|
|
107
108
|
* @example To disable a KMS key
|
|
108
109
|
* ```javascript
|
|
109
110
|
* // The following example disables the specified KMS key.
|
|
@@ -22,10 +22,10 @@ export interface DisableKeyRotationCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
}
|
|
23
23
|
declare const DisableKeyRotationCommand_base: {
|
|
24
24
|
new (input: DisableKeyRotationCommandInput): import("@smithy/smithy-client").CommandImpl<DisableKeyRotationCommandInput, DisableKeyRotationCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: DisableKeyRotationCommandInput): import("@smithy/smithy-client").CommandImpl<DisableKeyRotationCommandInput, DisableKeyRotationCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Disables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic
|
|
30
30
|
* rotation of the key material</a> of the specified symmetric encryption KMS key.</p>
|
|
31
31
|
* <p>Automatic key rotation is supported only on symmetric encryption KMS keys.
|
|
@@ -129,6 +129,7 @@ declare const DisableKeyRotationCommand_base: {
|
|
|
129
129
|
* @throws {@link KMSServiceException}
|
|
130
130
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
131
131
|
*
|
|
132
|
+
* @public
|
|
132
133
|
* @example To disable automatic rotation of key material
|
|
133
134
|
* ```javascript
|
|
134
135
|
* // The following example disables automatic annual rotation of the key material for the specified KMS key.
|
|
@@ -22,10 +22,10 @@ export interface DisconnectCustomKeyStoreCommandOutput extends DisconnectCustomK
|
|
|
22
22
|
}
|
|
23
23
|
declare const DisconnectCustomKeyStoreCommand_base: {
|
|
24
24
|
new (input: DisconnectCustomKeyStoreCommandInput): import("@smithy/smithy-client").CommandImpl<DisconnectCustomKeyStoreCommandInput, DisconnectCustomKeyStoreCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: DisconnectCustomKeyStoreCommandInput): import("@smithy/smithy-client").CommandImpl<DisconnectCustomKeyStoreCommandInput, DisconnectCustomKeyStoreCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <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
|
|
30
30
|
* CloudHSM key store from its associated CloudHSM cluster or disconnects an external key store from
|
|
31
31
|
* the external key store proxy that communicates with your external key manager.</p>
|
|
@@ -149,6 +149,7 @@ declare const DisconnectCustomKeyStoreCommand_base: {
|
|
|
149
149
|
* @throws {@link KMSServiceException}
|
|
150
150
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
151
151
|
*
|
|
152
|
+
* @public
|
|
152
153
|
* @example To disconnect a custom key store from its CloudHSM cluster
|
|
153
154
|
* ```javascript
|
|
154
155
|
* // This example disconnects an AWS KMS custom key store from its backing key store. For an AWS CloudHSM key store, it disconnects the key store from its AWS CloudHSM cluster. For an external key store, it disconnects the key store from the external key store proxy that communicates with your external key manager. This operation doesn't return any data. To verify that the custom key store is disconnected, use the <code>DescribeCustomKeyStores</code> operation.
|
|
@@ -22,10 +22,10 @@ export interface EnableKeyCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
}
|
|
23
23
|
declare const EnableKeyCommand_base: {
|
|
24
24
|
new (input: EnableKeyCommandInput): import("@smithy/smithy-client").CommandImpl<EnableKeyCommandInput, EnableKeyCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: EnableKeyCommandInput): import("@smithy/smithy-client").CommandImpl<EnableKeyCommandInput, EnableKeyCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Sets the key state of a KMS key to enabled. This allows you to use the KMS key for
|
|
30
30
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. </p>
|
|
31
31
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
@@ -104,6 +104,7 @@ declare const EnableKeyCommand_base: {
|
|
|
104
104
|
* @throws {@link KMSServiceException}
|
|
105
105
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
106
106
|
*
|
|
107
|
+
* @public
|
|
107
108
|
* @example To enable a KMS key
|
|
108
109
|
* ```javascript
|
|
109
110
|
* // The following example enables the specified KMS key.
|
|
@@ -22,10 +22,10 @@ export interface EnableKeyRotationCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
}
|
|
23
23
|
declare const EnableKeyRotationCommand_base: {
|
|
24
24
|
new (input: EnableKeyRotationCommandInput): import("@smithy/smithy-client").CommandImpl<EnableKeyRotationCommandInput, EnableKeyRotationCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: EnableKeyRotationCommandInput): import("@smithy/smithy-client").CommandImpl<EnableKeyRotationCommandInput, EnableKeyRotationCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Enables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic rotation
|
|
30
30
|
* of the key material</a> of the specified symmetric encryption KMS key. </p>
|
|
31
31
|
* <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
|
|
@@ -137,6 +137,7 @@ declare const EnableKeyRotationCommand_base: {
|
|
|
137
137
|
* @throws {@link KMSServiceException}
|
|
138
138
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
139
139
|
*
|
|
140
|
+
* @public
|
|
140
141
|
* @example To enable automatic rotation of key material
|
|
141
142
|
* ```javascript
|
|
142
143
|
* // The following example enables automatic annual rotation of the key material for the specified KMS key.
|
|
@@ -22,10 +22,10 @@ export interface EncryptCommandOutput extends EncryptResponse, __MetadataBearer
|
|
|
22
22
|
}
|
|
23
23
|
declare const EncryptCommand_base: {
|
|
24
24
|
new (input: EncryptCommandInput): import("@smithy/smithy-client").CommandImpl<EncryptCommandInput, EncryptCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: EncryptCommandInput): import("@smithy/smithy-client").CommandImpl<EncryptCommandInput, EncryptCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Encrypts plaintext of up to 4,096 bytes using a KMS key. You can use a symmetric or
|
|
30
30
|
* asymmetric KMS key with a <code>KeyUsage</code> of <code>ENCRYPT_DECRYPT</code>.</p>
|
|
31
31
|
* <p>You can use this operation to encrypt small amounts of arbitrary data, such as a personal
|
|
@@ -146,7 +146,7 @@ declare const EncryptCommand_base: {
|
|
|
146
146
|
* const client = new KMSClient(config);
|
|
147
147
|
* const input = { // EncryptRequest
|
|
148
148
|
* KeyId: "STRING_VALUE", // required
|
|
149
|
-
* Plaintext: "
|
|
149
|
+
* Plaintext: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") // required
|
|
150
150
|
* EncryptionContext: { // EncryptionContextType
|
|
151
151
|
* "<keys>": "STRING_VALUE",
|
|
152
152
|
* },
|
|
@@ -159,7 +159,7 @@ declare const EncryptCommand_base: {
|
|
|
159
159
|
* const command = new EncryptCommand(input);
|
|
160
160
|
* const response = await client.send(command);
|
|
161
161
|
* // { // EncryptResponse
|
|
162
|
-
* // CiphertextBlob:
|
|
162
|
+
* // CiphertextBlob: new Uint8Array(),
|
|
163
163
|
* // KeyId: "STRING_VALUE",
|
|
164
164
|
* // EncryptionAlgorithm: "SYMMETRIC_DEFAULT" || "RSAES_OAEP_SHA_1" || "RSAES_OAEP_SHA_256" || "SM2PKE",
|
|
165
165
|
* // };
|
|
@@ -241,6 +241,7 @@ declare const EncryptCommand_base: {
|
|
|
241
241
|
* @throws {@link KMSServiceException}
|
|
242
242
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
243
243
|
*
|
|
244
|
+
* @public
|
|
244
245
|
* @example To encrypt data with a symmetric encryption KMS key
|
|
245
246
|
* ```javascript
|
|
246
247
|
* // The following example encrypts data with the specified symmetric encryption KMS key.
|
|
@@ -22,10 +22,10 @@ export interface GenerateDataKeyCommandOutput extends GenerateDataKeyResponse, _
|
|
|
22
22
|
}
|
|
23
23
|
declare const GenerateDataKeyCommand_base: {
|
|
24
24
|
new (input: GenerateDataKeyCommandInput): import("@smithy/smithy-client").CommandImpl<GenerateDataKeyCommandInput, GenerateDataKeyCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: GenerateDataKeyCommandInput): import("@smithy/smithy-client").CommandImpl<GenerateDataKeyCommandInput, GenerateDataKeyCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Returns a unique symmetric data key for use outside of KMS. This operation returns a
|
|
30
30
|
* plaintext copy of the data key and a copy that is encrypted under a symmetric encryption KMS
|
|
31
31
|
* key that you specify. The bytes in the plaintext key are random; they are not related to the
|
|
@@ -150,17 +150,17 @@ declare const GenerateDataKeyCommand_base: {
|
|
|
150
150
|
* ],
|
|
151
151
|
* Recipient: { // RecipientInfo
|
|
152
152
|
* KeyEncryptionAlgorithm: "RSAES_OAEP_SHA_256",
|
|
153
|
-
* AttestationDocument: "
|
|
153
|
+
* AttestationDocument: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
|
|
154
154
|
* },
|
|
155
155
|
* DryRun: true || false,
|
|
156
156
|
* };
|
|
157
157
|
* const command = new GenerateDataKeyCommand(input);
|
|
158
158
|
* const response = await client.send(command);
|
|
159
159
|
* // { // GenerateDataKeyResponse
|
|
160
|
-
* // CiphertextBlob:
|
|
161
|
-
* // Plaintext:
|
|
160
|
+
* // CiphertextBlob: new Uint8Array(),
|
|
161
|
+
* // Plaintext: new Uint8Array(),
|
|
162
162
|
* // KeyId: "STRING_VALUE",
|
|
163
|
-
* // CiphertextForRecipient:
|
|
163
|
+
* // CiphertextForRecipient: new Uint8Array(),
|
|
164
164
|
* // };
|
|
165
165
|
*
|
|
166
166
|
* ```
|
|
@@ -240,6 +240,7 @@ declare const GenerateDataKeyCommand_base: {
|
|
|
240
240
|
* @throws {@link KMSServiceException}
|
|
241
241
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
242
242
|
*
|
|
243
|
+
* @public
|
|
243
244
|
* @example To generate a data key
|
|
244
245
|
* ```javascript
|
|
245
246
|
* // The following example generates a 256-bit symmetric data encryption key (data key) in two formats. One is the unencrypted (plainext) data key, and the other is the data key encrypted with the specified KMS key.
|
|
@@ -22,10 +22,10 @@ export interface GenerateDataKeyPairCommandOutput extends GenerateDataKeyPairRes
|
|
|
22
22
|
}
|
|
23
23
|
declare const GenerateDataKeyPairCommand_base: {
|
|
24
24
|
new (input: GenerateDataKeyPairCommandInput): import("@smithy/smithy-client").CommandImpl<GenerateDataKeyPairCommandInput, GenerateDataKeyPairCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: GenerateDataKeyPairCommandInput): import("@smithy/smithy-client").CommandImpl<GenerateDataKeyPairCommandInput, GenerateDataKeyPairCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Returns a unique asymmetric data key pair for use outside of KMS. This operation returns
|
|
30
30
|
* a plaintext public key, a plaintext private key, and a copy of the private key that is
|
|
31
31
|
* encrypted under the symmetric encryption KMS key you specify. You can use the data key pair to
|
|
@@ -128,19 +128,19 @@ declare const GenerateDataKeyPairCommand_base: {
|
|
|
128
128
|
* ],
|
|
129
129
|
* Recipient: { // RecipientInfo
|
|
130
130
|
* KeyEncryptionAlgorithm: "RSAES_OAEP_SHA_256",
|
|
131
|
-
* AttestationDocument: "
|
|
131
|
+
* AttestationDocument: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
|
|
132
132
|
* },
|
|
133
133
|
* DryRun: true || false,
|
|
134
134
|
* };
|
|
135
135
|
* const command = new GenerateDataKeyPairCommand(input);
|
|
136
136
|
* const response = await client.send(command);
|
|
137
137
|
* // { // GenerateDataKeyPairResponse
|
|
138
|
-
* // PrivateKeyCiphertextBlob:
|
|
139
|
-
* // PrivateKeyPlaintext:
|
|
140
|
-
* // PublicKey:
|
|
138
|
+
* // PrivateKeyCiphertextBlob: new Uint8Array(),
|
|
139
|
+
* // PrivateKeyPlaintext: new Uint8Array(),
|
|
140
|
+
* // PublicKey: new Uint8Array(),
|
|
141
141
|
* // KeyId: "STRING_VALUE",
|
|
142
142
|
* // KeyPairSpec: "RSA_2048" || "RSA_3072" || "RSA_4096" || "ECC_NIST_P256" || "ECC_NIST_P384" || "ECC_NIST_P521" || "ECC_SECG_P256K1" || "SM2",
|
|
143
|
-
* // CiphertextForRecipient:
|
|
143
|
+
* // CiphertextForRecipient: new Uint8Array(),
|
|
144
144
|
* // };
|
|
145
145
|
*
|
|
146
146
|
* ```
|
|
@@ -224,6 +224,7 @@ declare const GenerateDataKeyPairCommand_base: {
|
|
|
224
224
|
* @throws {@link KMSServiceException}
|
|
225
225
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
226
226
|
*
|
|
227
|
+
* @public
|
|
227
228
|
* @example To generate an RSA key pair for encryption and decryption
|
|
228
229
|
* ```javascript
|
|
229
230
|
* // This example generates an RSA data key pair for encryption and decryption. The operation returns a plaintext public key and private key, and a copy of the private key that is encrypted under a symmetric encryption KMS key that you specify.
|
|
@@ -22,10 +22,10 @@ export interface GenerateDataKeyPairWithoutPlaintextCommandOutput extends Genera
|
|
|
22
22
|
}
|
|
23
23
|
declare const GenerateDataKeyPairWithoutPlaintextCommand_base: {
|
|
24
24
|
new (input: GenerateDataKeyPairWithoutPlaintextCommandInput): import("@smithy/smithy-client").CommandImpl<GenerateDataKeyPairWithoutPlaintextCommandInput, GenerateDataKeyPairWithoutPlaintextCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: GenerateDataKeyPairWithoutPlaintextCommandInput): import("@smithy/smithy-client").CommandImpl<GenerateDataKeyPairWithoutPlaintextCommandInput, GenerateDataKeyPairWithoutPlaintextCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Returns a unique asymmetric data key pair for use outside of KMS. This operation returns
|
|
30
30
|
* a plaintext public key and a copy of the private key that is encrypted under the symmetric
|
|
31
31
|
* encryption KMS key you specify. Unlike <a>GenerateDataKeyPair</a>, this operation
|
|
@@ -113,8 +113,8 @@ declare const GenerateDataKeyPairWithoutPlaintextCommand_base: {
|
|
|
113
113
|
* const command = new GenerateDataKeyPairWithoutPlaintextCommand(input);
|
|
114
114
|
* const response = await client.send(command);
|
|
115
115
|
* // { // GenerateDataKeyPairWithoutPlaintextResponse
|
|
116
|
-
* // PrivateKeyCiphertextBlob:
|
|
117
|
-
* // PublicKey:
|
|
116
|
+
* // PrivateKeyCiphertextBlob: new Uint8Array(),
|
|
117
|
+
* // PublicKey: new Uint8Array(),
|
|
118
118
|
* // KeyId: "STRING_VALUE",
|
|
119
119
|
* // KeyPairSpec: "RSA_2048" || "RSA_3072" || "RSA_4096" || "ECC_NIST_P256" || "ECC_NIST_P384" || "ECC_NIST_P521" || "ECC_SECG_P256K1" || "SM2",
|
|
120
120
|
* // };
|
|
@@ -200,6 +200,7 @@ declare const GenerateDataKeyPairWithoutPlaintextCommand_base: {
|
|
|
200
200
|
* @throws {@link KMSServiceException}
|
|
201
201
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
202
202
|
*
|
|
203
|
+
* @public
|
|
203
204
|
* @example To generate an asymmetric data key pair without a plaintext key
|
|
204
205
|
* ```javascript
|
|
205
206
|
* // This example returns an asymmetric elliptic curve (ECC) data key pair. The private key is encrypted under the symmetric encryption KMS key that you specify. This operation doesn't return a plaintext (unencrypted) private key.
|