@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
|
@@ -22,10 +22,10 @@ export interface GenerateDataKeyWithoutPlaintextCommandOutput extends GenerateDa
|
|
|
22
22
|
}
|
|
23
23
|
declare const GenerateDataKeyWithoutPlaintextCommand_base: {
|
|
24
24
|
new (input: GenerateDataKeyWithoutPlaintextCommandInput): import("@smithy/smithy-client").CommandImpl<GenerateDataKeyWithoutPlaintextCommandInput, GenerateDataKeyWithoutPlaintextCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: GenerateDataKeyWithoutPlaintextCommandInput): import("@smithy/smithy-client").CommandImpl<GenerateDataKeyWithoutPlaintextCommandInput, GenerateDataKeyWithoutPlaintextCommandOutput, 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
|
* data key that is encrypted under a symmetric encryption KMS key that you specify. The bytes in
|
|
31
31
|
* the key are random; they are not related to the caller or to the KMS key.</p>
|
|
@@ -123,7 +123,7 @@ declare const GenerateDataKeyWithoutPlaintextCommand_base: {
|
|
|
123
123
|
* const command = new GenerateDataKeyWithoutPlaintextCommand(input);
|
|
124
124
|
* const response = await client.send(command);
|
|
125
125
|
* // { // GenerateDataKeyWithoutPlaintextResponse
|
|
126
|
-
* // CiphertextBlob:
|
|
126
|
+
* // CiphertextBlob: new Uint8Array(),
|
|
127
127
|
* // KeyId: "STRING_VALUE",
|
|
128
128
|
* // };
|
|
129
129
|
*
|
|
@@ -204,6 +204,7 @@ declare const GenerateDataKeyWithoutPlaintextCommand_base: {
|
|
|
204
204
|
* @throws {@link KMSServiceException}
|
|
205
205
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
206
206
|
*
|
|
207
|
+
* @public
|
|
207
208
|
* @example To generate an encrypted data key
|
|
208
209
|
* ```javascript
|
|
209
210
|
* // The following example generates an encrypted copy of a 256-bit symmetric data encryption key (data key). The data key is encrypted with the specified KMS key.
|
|
@@ -22,10 +22,10 @@ export interface GenerateMacCommandOutput extends GenerateMacResponse, __Metadat
|
|
|
22
22
|
}
|
|
23
23
|
declare const GenerateMacCommand_base: {
|
|
24
24
|
new (input: GenerateMacCommandInput): import("@smithy/smithy-client").CommandImpl<GenerateMacCommandInput, GenerateMacCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: GenerateMacCommandInput): import("@smithy/smithy-client").CommandImpl<GenerateMacCommandInput, GenerateMacCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Generates a hash-based message authentication code (HMAC) for a message using an HMAC KMS
|
|
30
30
|
* key and a MAC algorithm that the key supports. HMAC KMS keys and the HMAC algorithms that
|
|
31
31
|
* KMS uses conform to industry standards defined in <a href="https://datatracker.ietf.org/doc/html/rfc2104">RFC 2104</a>.</p>
|
|
@@ -65,7 +65,7 @@ declare const GenerateMacCommand_base: {
|
|
|
65
65
|
* // const { KMSClient, GenerateMacCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
66
66
|
* const client = new KMSClient(config);
|
|
67
67
|
* const input = { // GenerateMacRequest
|
|
68
|
-
* Message: "
|
|
68
|
+
* Message: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") // required
|
|
69
69
|
* KeyId: "STRING_VALUE", // required
|
|
70
70
|
* MacAlgorithm: "HMAC_SHA_224" || "HMAC_SHA_256" || "HMAC_SHA_384" || "HMAC_SHA_512", // required
|
|
71
71
|
* GrantTokens: [ // GrantTokenList
|
|
@@ -76,7 +76,7 @@ declare const GenerateMacCommand_base: {
|
|
|
76
76
|
* const command = new GenerateMacCommand(input);
|
|
77
77
|
* const response = await client.send(command);
|
|
78
78
|
* // { // GenerateMacResponse
|
|
79
|
-
* // Mac:
|
|
79
|
+
* // Mac: new Uint8Array(),
|
|
80
80
|
* // MacAlgorithm: "HMAC_SHA_224" || "HMAC_SHA_256" || "HMAC_SHA_384" || "HMAC_SHA_512",
|
|
81
81
|
* // KeyId: "STRING_VALUE",
|
|
82
82
|
* // };
|
|
@@ -154,6 +154,7 @@ declare const GenerateMacCommand_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 generate an HMAC for a message
|
|
158
159
|
* ```javascript
|
|
159
160
|
* // This example generates an HMAC for a message, an HMAC KMS key, and a MAC algorithm. The algorithm must be supported by the specified HMAC KMS key.
|
|
@@ -22,10 +22,10 @@ export interface GenerateRandomCommandOutput extends GenerateRandomResponse, __M
|
|
|
22
22
|
}
|
|
23
23
|
declare const GenerateRandomCommand_base: {
|
|
24
24
|
new (input: GenerateRandomCommandInput): import("@smithy/smithy-client").CommandImpl<GenerateRandomCommandInput, GenerateRandomCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (...[input]: [] | [GenerateRandomCommandInput]): import("@smithy/smithy-client").CommandImpl<GenerateRandomCommandInput, GenerateRandomCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Returns a random byte string that is cryptographically secure.</p>
|
|
30
30
|
* <p>You must use the <code>NumberOfBytes</code> parameter to specify the length of the random
|
|
31
31
|
* byte string. There is no default value for string length.</p>
|
|
@@ -61,14 +61,14 @@ declare const GenerateRandomCommand_base: {
|
|
|
61
61
|
* CustomKeyStoreId: "STRING_VALUE",
|
|
62
62
|
* Recipient: { // RecipientInfo
|
|
63
63
|
* KeyEncryptionAlgorithm: "RSAES_OAEP_SHA_256",
|
|
64
|
-
* AttestationDocument: "
|
|
64
|
+
* AttestationDocument: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
|
|
65
65
|
* },
|
|
66
66
|
* };
|
|
67
67
|
* const command = new GenerateRandomCommand(input);
|
|
68
68
|
* const response = await client.send(command);
|
|
69
69
|
* // { // GenerateRandomResponse
|
|
70
|
-
* // Plaintext:
|
|
71
|
-
* // CiphertextForRecipient:
|
|
70
|
+
* // Plaintext: new Uint8Array(),
|
|
71
|
+
* // CiphertextForRecipient: new Uint8Array(),
|
|
72
72
|
* // };
|
|
73
73
|
*
|
|
74
74
|
* ```
|
|
@@ -134,6 +134,7 @@ declare const GenerateRandomCommand_base: {
|
|
|
134
134
|
* @throws {@link KMSServiceException}
|
|
135
135
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
136
136
|
*
|
|
137
|
+
* @public
|
|
137
138
|
* @example To generate random data
|
|
138
139
|
* ```javascript
|
|
139
140
|
* // The following example generates 32 bytes of random data.
|
|
@@ -22,10 +22,10 @@ export interface GetKeyPolicyCommandOutput extends GetKeyPolicyResponse, __Metad
|
|
|
22
22
|
}
|
|
23
23
|
declare const GetKeyPolicyCommand_base: {
|
|
24
24
|
new (input: GetKeyPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<GetKeyPolicyCommandInput, GetKeyPolicyCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: GetKeyPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<GetKeyPolicyCommandInput, GetKeyPolicyCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Gets a key policy attached to the specified KMS key.</p>
|
|
30
30
|
* <p>
|
|
31
31
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
@@ -100,6 +100,7 @@ declare const GetKeyPolicyCommand_base: {
|
|
|
100
100
|
* @throws {@link KMSServiceException}
|
|
101
101
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
102
102
|
*
|
|
103
|
+
* @public
|
|
103
104
|
* @example To retrieve a key policy
|
|
104
105
|
* ```javascript
|
|
105
106
|
* // The following example retrieves the key policy for the specified KMS key.
|
|
@@ -22,10 +22,10 @@ export interface GetKeyRotationStatusCommandOutput extends GetKeyRotationStatusR
|
|
|
22
22
|
}
|
|
23
23
|
declare const GetKeyRotationStatusCommand_base: {
|
|
24
24
|
new (input: GetKeyRotationStatusCommandInput): import("@smithy/smithy-client").CommandImpl<GetKeyRotationStatusCommandInput, GetKeyRotationStatusCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: GetKeyRotationStatusCommandInput): import("@smithy/smithy-client").CommandImpl<GetKeyRotationStatusCommandInput, GetKeyRotationStatusCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <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
|
|
30
30
|
* enabled for the specified KMS key.</p>
|
|
31
31
|
* <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
|
|
@@ -148,6 +148,7 @@ declare const GetKeyRotationStatusCommand_base: {
|
|
|
148
148
|
* @throws {@link KMSServiceException}
|
|
149
149
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
150
150
|
*
|
|
151
|
+
* @public
|
|
151
152
|
* @example To retrieve the rotation status for a KMS key
|
|
152
153
|
* ```javascript
|
|
153
154
|
* // The following example retrieves the status of automatic annual rotation of the key material for the specified KMS key.
|
|
@@ -22,10 +22,10 @@ export interface GetParametersForImportCommandOutput extends GetParametersForImp
|
|
|
22
22
|
}
|
|
23
23
|
declare const GetParametersForImportCommand_base: {
|
|
24
24
|
new (input: GetParametersForImportCommandInput): import("@smithy/smithy-client").CommandImpl<GetParametersForImportCommandInput, GetParametersForImportCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: GetParametersForImportCommandInput): import("@smithy/smithy-client").CommandImpl<GetParametersForImportCommandInput, GetParametersForImportCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Returns the public key and an import token you need to import or reimport key material for
|
|
30
30
|
* a KMS key. </p>
|
|
31
31
|
* <p>By default, KMS keys are created with key material that KMS generates. This operation
|
|
@@ -118,8 +118,8 @@ declare const GetParametersForImportCommand_base: {
|
|
|
118
118
|
* const response = await client.send(command);
|
|
119
119
|
* // { // GetParametersForImportResponse
|
|
120
120
|
* // KeyId: "STRING_VALUE",
|
|
121
|
-
* // ImportToken:
|
|
122
|
-
* // PublicKey:
|
|
121
|
+
* // ImportToken: new Uint8Array(),
|
|
122
|
+
* // PublicKey: new Uint8Array(),
|
|
123
123
|
* // ParametersValidTo: new Date("TIMESTAMP"),
|
|
124
124
|
* // };
|
|
125
125
|
*
|
|
@@ -174,6 +174,7 @@ declare const GetParametersForImportCommand_base: {
|
|
|
174
174
|
* @throws {@link KMSServiceException}
|
|
175
175
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
176
176
|
*
|
|
177
|
+
* @public
|
|
177
178
|
* @example To download the public key and import token for a symmetric encryption KMS key
|
|
178
179
|
* ```javascript
|
|
179
180
|
* // The following example downloads a public key and import token to import symmetric encryption key material. It uses the default wrapping key spec and the RSAES_OAEP_SHA_256 wrapping algorithm.
|
|
@@ -22,10 +22,10 @@ export interface GetPublicKeyCommandOutput extends GetPublicKeyResponse, __Metad
|
|
|
22
22
|
}
|
|
23
23
|
declare const GetPublicKeyCommand_base: {
|
|
24
24
|
new (input: GetPublicKeyCommandInput): import("@smithy/smithy-client").CommandImpl<GetPublicKeyCommandInput, GetPublicKeyCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: GetPublicKeyCommandInput): import("@smithy/smithy-client").CommandImpl<GetPublicKeyCommandInput, GetPublicKeyCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Returns the public key of an asymmetric KMS key. Unlike the private key of a asymmetric
|
|
30
30
|
* KMS key, which never leaves KMS unencrypted, callers with <code>kms:GetPublicKey</code>
|
|
31
31
|
* permission can download the public key of an asymmetric KMS key. You can share the public key
|
|
@@ -93,7 +93,7 @@ declare const GetPublicKeyCommand_base: {
|
|
|
93
93
|
* const response = await client.send(command);
|
|
94
94
|
* // { // GetPublicKeyResponse
|
|
95
95
|
* // KeyId: "STRING_VALUE",
|
|
96
|
-
* // PublicKey:
|
|
96
|
+
* // PublicKey: new Uint8Array(),
|
|
97
97
|
* // CustomerMasterKeySpec: "RSA_2048" || "RSA_3072" || "RSA_4096" || "ECC_NIST_P256" || "ECC_NIST_P384" || "ECC_NIST_P521" || "ECC_SECG_P256K1" || "SYMMETRIC_DEFAULT" || "HMAC_224" || "HMAC_256" || "HMAC_384" || "HMAC_512" || "SM2",
|
|
98
98
|
* // KeySpec: "RSA_2048" || "RSA_3072" || "RSA_4096" || "ECC_NIST_P256" || "ECC_NIST_P384" || "ECC_NIST_P521" || "ECC_SECG_P256K1" || "SYMMETRIC_DEFAULT" || "HMAC_224" || "HMAC_256" || "HMAC_384" || "HMAC_512" || "SM2",
|
|
99
99
|
* // KeyUsage: "SIGN_VERIFY" || "ENCRYPT_DECRYPT" || "GENERATE_VERIFY_MAC",
|
|
@@ -187,6 +187,7 @@ declare const GetPublicKeyCommand_base: {
|
|
|
187
187
|
* @throws {@link KMSServiceException}
|
|
188
188
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
189
189
|
*
|
|
190
|
+
* @public
|
|
190
191
|
* @example To download the public key of an asymmetric KMS key
|
|
191
192
|
* ```javascript
|
|
192
193
|
* // This example gets the public key of an asymmetric RSA KMS key used for encryption and decryption. The operation returns the key spec, key usage, and encryption or signing algorithms to help you use the public key correctly outside of AWS KMS.
|
|
@@ -22,10 +22,10 @@ export interface ImportKeyMaterialCommandOutput extends ImportKeyMaterialRespons
|
|
|
22
22
|
}
|
|
23
23
|
declare const ImportKeyMaterialCommand_base: {
|
|
24
24
|
new (input: ImportKeyMaterialCommandInput): import("@smithy/smithy-client").CommandImpl<ImportKeyMaterialCommandInput, ImportKeyMaterialCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: ImportKeyMaterialCommandInput): import("@smithy/smithy-client").CommandImpl<ImportKeyMaterialCommandInput, ImportKeyMaterialCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Imports or reimports key material into an existing KMS key that was created without key
|
|
30
30
|
* material. <code>ImportKeyMaterial</code> also sets the expiration model and expiration date of
|
|
31
31
|
* the imported key material.</p>
|
|
@@ -139,8 +139,8 @@ declare const ImportKeyMaterialCommand_base: {
|
|
|
139
139
|
* const client = new KMSClient(config);
|
|
140
140
|
* const input = { // ImportKeyMaterialRequest
|
|
141
141
|
* KeyId: "STRING_VALUE", // required
|
|
142
|
-
* ImportToken: "
|
|
143
|
-
* EncryptedKeyMaterial: "
|
|
142
|
+
* ImportToken: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") // required
|
|
143
|
+
* EncryptedKeyMaterial: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") // required
|
|
144
144
|
* ValidTo: new Date("TIMESTAMP"),
|
|
145
145
|
* ExpirationModel: "KEY_MATERIAL_EXPIRES" || "KEY_MATERIAL_DOES_NOT_EXPIRE",
|
|
146
146
|
* };
|
|
@@ -219,6 +219,7 @@ declare const ImportKeyMaterialCommand_base: {
|
|
|
219
219
|
* @throws {@link KMSServiceException}
|
|
220
220
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
221
221
|
*
|
|
222
|
+
* @public
|
|
222
223
|
* @example To import key material into a KMS key
|
|
223
224
|
* ```javascript
|
|
224
225
|
* // The following example imports key material into the specified KMS key.
|
|
@@ -22,10 +22,10 @@ export interface ListAliasesCommandOutput extends ListAliasesResponse, __Metadat
|
|
|
22
22
|
}
|
|
23
23
|
declare const ListAliasesCommand_base: {
|
|
24
24
|
new (input: ListAliasesCommandInput): import("@smithy/smithy-client").CommandImpl<ListAliasesCommandInput, ListAliasesCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (...[input]: [] | [ListAliasesCommandInput]): import("@smithy/smithy-client").CommandImpl<ListAliasesCommandInput, ListAliasesCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Gets a list of aliases in the caller's Amazon Web Services account and region. For more information
|
|
30
30
|
* about aliases, see <a>CreateAlias</a>.</p>
|
|
31
31
|
* <p>By default, the <code>ListAliases</code> operation returns all aliases in the account and
|
|
@@ -128,6 +128,7 @@ declare const ListAliasesCommand_base: {
|
|
|
128
128
|
* @throws {@link KMSServiceException}
|
|
129
129
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
130
130
|
*
|
|
131
|
+
* @public
|
|
131
132
|
* @example To list aliases
|
|
132
133
|
* ```javascript
|
|
133
134
|
* // The following example lists aliases.
|
|
@@ -22,10 +22,10 @@ export interface ListGrantsCommandOutput extends ListGrantsResponse, __MetadataB
|
|
|
22
22
|
}
|
|
23
23
|
declare const ListGrantsCommand_base: {
|
|
24
24
|
new (input: ListGrantsCommandInput): import("@smithy/smithy-client").CommandImpl<ListGrantsCommandInput, ListGrantsCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: ListGrantsCommandInput): import("@smithy/smithy-client").CommandImpl<ListGrantsCommandInput, ListGrantsCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Gets a list of all grants for the specified KMS key. </p>
|
|
30
30
|
* <p>You must specify the KMS key in all requests. You can filter the grant list by grant ID or
|
|
31
31
|
* grantee principal.</p>
|
|
@@ -170,6 +170,7 @@ declare const ListGrantsCommand_base: {
|
|
|
170
170
|
* @throws {@link KMSServiceException}
|
|
171
171
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
172
172
|
*
|
|
173
|
+
* @public
|
|
173
174
|
* @example To list grants for a KMS key
|
|
174
175
|
* ```javascript
|
|
175
176
|
* // The following example lists grants for the specified KMS key.
|
|
@@ -22,10 +22,10 @@ export interface ListKeyPoliciesCommandOutput extends ListKeyPoliciesResponse, _
|
|
|
22
22
|
}
|
|
23
23
|
declare const ListKeyPoliciesCommand_base: {
|
|
24
24
|
new (input: ListKeyPoliciesCommandInput): import("@smithy/smithy-client").CommandImpl<ListKeyPoliciesCommandInput, ListKeyPoliciesCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: ListKeyPoliciesCommandInput): import("@smithy/smithy-client").CommandImpl<ListKeyPoliciesCommandInput, ListKeyPoliciesCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Gets the names of the key policies that are attached to a KMS key. This operation is
|
|
30
30
|
* designed to get policy names that you can use in a <a>GetKeyPolicy</a> operation.
|
|
31
31
|
* However, the only valid policy name is <code>default</code>. </p>
|
|
@@ -119,6 +119,7 @@ declare const ListKeyPoliciesCommand_base: {
|
|
|
119
119
|
* @throws {@link KMSServiceException}
|
|
120
120
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
121
121
|
*
|
|
122
|
+
* @public
|
|
122
123
|
* @example To list key policies for a KMS key
|
|
123
124
|
* ```javascript
|
|
124
125
|
* // The following example lists key policies for the specified KMS key.
|
|
@@ -22,10 +22,10 @@ export interface ListKeysCommandOutput extends ListKeysResponse, __MetadataBeare
|
|
|
22
22
|
}
|
|
23
23
|
declare const ListKeysCommand_base: {
|
|
24
24
|
new (input: ListKeysCommandInput): import("@smithy/smithy-client").CommandImpl<ListKeysCommandInput, ListKeysCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (...[input]: [] | [ListKeysCommandInput]): import("@smithy/smithy-client").CommandImpl<ListKeysCommandInput, ListKeysCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Gets a list of all KMS keys in the caller's Amazon Web Services account and Region.</p>
|
|
30
30
|
* <p>
|
|
31
31
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
@@ -105,6 +105,7 @@ declare const ListKeysCommand_base: {
|
|
|
105
105
|
* @throws {@link KMSServiceException}
|
|
106
106
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
107
107
|
*
|
|
108
|
+
* @public
|
|
108
109
|
* @example To list KMS keys
|
|
109
110
|
* ```javascript
|
|
110
111
|
* // The following example lists KMS keys.
|
|
@@ -22,10 +22,10 @@ export interface ListResourceTagsCommandOutput extends ListResourceTagsResponse,
|
|
|
22
22
|
}
|
|
23
23
|
declare const ListResourceTagsCommand_base: {
|
|
24
24
|
new (input: ListResourceTagsCommandInput): import("@smithy/smithy-client").CommandImpl<ListResourceTagsCommandInput, ListResourceTagsCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: ListResourceTagsCommandInput): import("@smithy/smithy-client").CommandImpl<ListResourceTagsCommandInput, ListResourceTagsCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Returns all tags on the specified KMS key.</p>
|
|
30
30
|
* <p>For general information about tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in
|
|
31
31
|
* the <i>Amazon Web Services General Reference</i>. For information about using
|
|
@@ -114,6 +114,7 @@ declare const ListResourceTagsCommand_base: {
|
|
|
114
114
|
* @throws {@link KMSServiceException}
|
|
115
115
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
116
116
|
*
|
|
117
|
+
* @public
|
|
117
118
|
* @example To list tags for a KMS key
|
|
118
119
|
* ```javascript
|
|
119
120
|
* // The following example lists tags for a KMS key.
|
|
@@ -22,10 +22,10 @@ export interface ListRetirableGrantsCommandOutput extends ListGrantsResponse, __
|
|
|
22
22
|
}
|
|
23
23
|
declare const ListRetirableGrantsCommand_base: {
|
|
24
24
|
new (input: ListRetirableGrantsCommandInput): import("@smithy/smithy-client").CommandImpl<ListRetirableGrantsCommandInput, ListRetirableGrantsCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: ListRetirableGrantsCommandInput): import("@smithy/smithy-client").CommandImpl<ListRetirableGrantsCommandInput, ListRetirableGrantsCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Returns information about all grants in the Amazon Web Services account and Region that have the
|
|
30
30
|
* specified retiring principal. </p>
|
|
31
31
|
* <p>You can specify any principal in your Amazon Web Services account. The grants that are returned include
|
|
@@ -152,6 +152,7 @@ declare const ListRetirableGrantsCommand_base: {
|
|
|
152
152
|
* @throws {@link KMSServiceException}
|
|
153
153
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
154
154
|
*
|
|
155
|
+
* @public
|
|
155
156
|
* @example To list grants that the specified principal can retire
|
|
156
157
|
* ```javascript
|
|
157
158
|
* // The following example lists the grants that the specified principal (identity) can retire.
|
|
@@ -22,10 +22,10 @@ export interface PutKeyPolicyCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
}
|
|
23
23
|
declare const PutKeyPolicyCommand_base: {
|
|
24
24
|
new (input: PutKeyPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<PutKeyPolicyCommandInput, PutKeyPolicyCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: PutKeyPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<PutKeyPolicyCommandInput, PutKeyPolicyCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Attaches a key policy to the specified KMS key. </p>
|
|
30
30
|
* <p>For more information about key policies, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">Key Policies</a> in the <i>Key Management Service Developer Guide</i>.
|
|
31
31
|
* For help writing and formatting a JSON policy document, see the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html">IAM JSON Policy Reference</a> in the <i>
|
|
@@ -117,6 +117,7 @@ declare const PutKeyPolicyCommand_base: {
|
|
|
117
117
|
* @throws {@link KMSServiceException}
|
|
118
118
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
119
119
|
*
|
|
120
|
+
* @public
|
|
120
121
|
* @example To attach a key policy to a KMS key
|
|
121
122
|
* ```javascript
|
|
122
123
|
* // The following example attaches a key policy to the specified KMS key.
|
|
@@ -22,10 +22,10 @@ export interface ReEncryptCommandOutput extends ReEncryptResponse, __MetadataBea
|
|
|
22
22
|
}
|
|
23
23
|
declare const ReEncryptCommand_base: {
|
|
24
24
|
new (input: ReEncryptCommandInput): import("@smithy/smithy-client").CommandImpl<ReEncryptCommandInput, ReEncryptCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: ReEncryptCommandInput): import("@smithy/smithy-client").CommandImpl<ReEncryptCommandInput, ReEncryptCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Decrypts ciphertext and then reencrypts it entirely within KMS. You can use this
|
|
30
30
|
* operation to change the KMS key under which data is encrypted, such as when you <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-manually">manually
|
|
31
31
|
* rotate</a> a KMS key or change the KMS key that protects a ciphertext. You can also use
|
|
@@ -131,7 +131,7 @@ declare const ReEncryptCommand_base: {
|
|
|
131
131
|
* // const { KMSClient, ReEncryptCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
132
132
|
* const client = new KMSClient(config);
|
|
133
133
|
* const input = { // ReEncryptRequest
|
|
134
|
-
* CiphertextBlob: "
|
|
134
|
+
* CiphertextBlob: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") // required
|
|
135
135
|
* SourceEncryptionContext: { // EncryptionContextType
|
|
136
136
|
* "<keys>": "STRING_VALUE",
|
|
137
137
|
* },
|
|
@@ -150,7 +150,7 @@ declare const ReEncryptCommand_base: {
|
|
|
150
150
|
* const command = new ReEncryptCommand(input);
|
|
151
151
|
* const response = await client.send(command);
|
|
152
152
|
* // { // ReEncryptResponse
|
|
153
|
-
* // CiphertextBlob:
|
|
153
|
+
* // CiphertextBlob: new Uint8Array(),
|
|
154
154
|
* // SourceKeyId: "STRING_VALUE",
|
|
155
155
|
* // KeyId: "STRING_VALUE",
|
|
156
156
|
* // SourceEncryptionAlgorithm: "SYMMETRIC_DEFAULT" || "RSAES_OAEP_SHA_1" || "RSAES_OAEP_SHA_256" || "SM2PKE",
|
|
@@ -248,6 +248,7 @@ declare const ReEncryptCommand_base: {
|
|
|
248
248
|
* @throws {@link KMSServiceException}
|
|
249
249
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
250
250
|
*
|
|
251
|
+
* @public
|
|
251
252
|
* @example To reencrypt data
|
|
252
253
|
* ```javascript
|
|
253
254
|
* // The following example reencrypts data with the specified KMS key.
|
|
@@ -22,10 +22,10 @@ export interface ReplicateKeyCommandOutput extends ReplicateKeyResponse, __Metad
|
|
|
22
22
|
}
|
|
23
23
|
declare const ReplicateKeyCommand_base: {
|
|
24
24
|
new (input: ReplicateKeyCommandInput): import("@smithy/smithy-client").CommandImpl<ReplicateKeyCommandInput, ReplicateKeyCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: ReplicateKeyCommandInput): import("@smithy/smithy-client").CommandImpl<ReplicateKeyCommandInput, ReplicateKeyCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Replicates a multi-Region key into the specified Region. This operation creates a
|
|
30
30
|
* multi-Region replica key based on a multi-Region primary key in a different Region of the same
|
|
31
31
|
* Amazon Web Services partition. You can create multiple replicas of a primary key, but each must be in a
|
|
@@ -255,6 +255,7 @@ declare const ReplicateKeyCommand_base: {
|
|
|
255
255
|
* @throws {@link KMSServiceException}
|
|
256
256
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
257
257
|
*
|
|
258
|
+
* @public
|
|
258
259
|
* @example To replicate a multi-Region key in a different AWS Region
|
|
259
260
|
* ```javascript
|
|
260
261
|
* // This example creates a multi-Region replica key in us-west-2 of a multi-Region primary key in us-east-1.
|
|
@@ -22,10 +22,10 @@ export interface RetireGrantCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
}
|
|
23
23
|
declare const RetireGrantCommand_base: {
|
|
24
24
|
new (input: RetireGrantCommandInput): import("@smithy/smithy-client").CommandImpl<RetireGrantCommandInput, RetireGrantCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (...[input]: [] | [RetireGrantCommandInput]): import("@smithy/smithy-client").CommandImpl<RetireGrantCommandInput, RetireGrantCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Deletes a grant. Typically, you retire a grant when you no longer need its permissions. To
|
|
30
30
|
* identify the grant to retire, use a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">grant token</a>, or both the grant ID and a
|
|
31
31
|
* key identifier (key ID or key ARN) of the KMS key. The <a>CreateGrant</a> operation
|
|
@@ -147,6 +147,7 @@ declare const RetireGrantCommand_base: {
|
|
|
147
147
|
* @throws {@link KMSServiceException}
|
|
148
148
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
149
149
|
*
|
|
150
|
+
* @public
|
|
150
151
|
* @example To retire a grant
|
|
151
152
|
* ```javascript
|
|
152
153
|
* // The following example retires a grant.
|
|
@@ -22,10 +22,10 @@ export interface RevokeGrantCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
}
|
|
23
23
|
declare const RevokeGrantCommand_base: {
|
|
24
24
|
new (input: RevokeGrantCommandInput): import("@smithy/smithy-client").CommandImpl<RevokeGrantCommandInput, RevokeGrantCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: RevokeGrantCommandInput): import("@smithy/smithy-client").CommandImpl<RevokeGrantCommandInput, RevokeGrantCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Deletes the specified grant. You revoke a grant to terminate the permissions that the
|
|
30
30
|
* grant allows. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/managing-grants.html#grant-delete">Retiring and revoking grants</a> in
|
|
31
31
|
* the <i>
|
|
@@ -141,6 +141,7 @@ declare const RevokeGrantCommand_base: {
|
|
|
141
141
|
* @throws {@link KMSServiceException}
|
|
142
142
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
143
143
|
*
|
|
144
|
+
* @public
|
|
144
145
|
* @example To revoke a grant
|
|
145
146
|
* ```javascript
|
|
146
147
|
* // The following example revokes a grant.
|
|
@@ -22,10 +22,10 @@ export interface ScheduleKeyDeletionCommandOutput extends ScheduleKeyDeletionRes
|
|
|
22
22
|
}
|
|
23
23
|
declare const ScheduleKeyDeletionCommand_base: {
|
|
24
24
|
new (input: ScheduleKeyDeletionCommandInput): import("@smithy/smithy-client").CommandImpl<ScheduleKeyDeletionCommandInput, ScheduleKeyDeletionCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: ScheduleKeyDeletionCommandInput): import("@smithy/smithy-client").CommandImpl<ScheduleKeyDeletionCommandInput, ScheduleKeyDeletionCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Schedules the deletion of a KMS key. By default, KMS applies a waiting period of 30
|
|
30
30
|
* days, but you can specify a waiting period of 7-30 days. When this operation is successful,
|
|
31
31
|
* the key state of the KMS key changes to <code>PendingDeletion</code> and the key can't be used
|
|
@@ -152,6 +152,7 @@ declare const ScheduleKeyDeletionCommand_base: {
|
|
|
152
152
|
* @throws {@link KMSServiceException}
|
|
153
153
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
154
154
|
*
|
|
155
|
+
* @public
|
|
155
156
|
* @example To schedule a KMS key for deletion
|
|
156
157
|
* ```javascript
|
|
157
158
|
* // The following example schedules the specified KMS key for deletion.
|
|
@@ -22,10 +22,10 @@ export interface SignCommandOutput extends SignResponse, __MetadataBearer {
|
|
|
22
22
|
}
|
|
23
23
|
declare const SignCommand_base: {
|
|
24
24
|
new (input: SignCommandInput): import("@smithy/smithy-client").CommandImpl<SignCommandInput, SignCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: SignCommandInput): import("@smithy/smithy-client").CommandImpl<SignCommandInput, SignCommandOutput, 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://en.wikipedia.org/wiki/Digital_signature">digital
|
|
30
30
|
* signature</a> for a message or message digest by using the private key in an asymmetric
|
|
31
31
|
* signing KMS key. To verify the signature, use the <a>Verify</a> operation, or use
|
|
@@ -89,7 +89,7 @@ declare const SignCommand_base: {
|
|
|
89
89
|
* const client = new KMSClient(config);
|
|
90
90
|
* const input = { // SignRequest
|
|
91
91
|
* KeyId: "STRING_VALUE", // required
|
|
92
|
-
* Message: "
|
|
92
|
+
* Message: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") // required
|
|
93
93
|
* MessageType: "RAW" || "DIGEST",
|
|
94
94
|
* GrantTokens: [ // GrantTokenList
|
|
95
95
|
* "STRING_VALUE",
|
|
@@ -101,7 +101,7 @@ declare const SignCommand_base: {
|
|
|
101
101
|
* const response = await client.send(command);
|
|
102
102
|
* // { // SignResponse
|
|
103
103
|
* // KeyId: "STRING_VALUE",
|
|
104
|
-
* // Signature:
|
|
104
|
+
* // Signature: new Uint8Array(),
|
|
105
105
|
* // SigningAlgorithm: "RSASSA_PSS_SHA_256" || "RSASSA_PSS_SHA_384" || "RSASSA_PSS_SHA_512" || "RSASSA_PKCS1_V1_5_SHA_256" || "RSASSA_PKCS1_V1_5_SHA_384" || "RSASSA_PKCS1_V1_5_SHA_512" || "ECDSA_SHA_256" || "ECDSA_SHA_384" || "ECDSA_SHA_512" || "SM2DSA",
|
|
106
106
|
* // };
|
|
107
107
|
*
|
|
@@ -182,6 +182,7 @@ declare const SignCommand_base: {
|
|
|
182
182
|
* @throws {@link KMSServiceException}
|
|
183
183
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
184
184
|
*
|
|
185
|
+
* @public
|
|
185
186
|
* @example To digitally sign a message with an asymmetric KMS key.
|
|
186
187
|
* ```javascript
|
|
187
188
|
* // This operation uses the private key in an asymmetric elliptic curve (ECC) KMS key to generate a digital signature for a given message.
|
|
@@ -22,10 +22,10 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
}
|
|
23
23
|
declare const TagResourceCommand_base: {
|
|
24
24
|
new (input: TagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: TagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Adds or edits tags on a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>.</p>
|
|
30
30
|
* <note>
|
|
31
31
|
* <p>Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">ABAC for KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
@@ -145,6 +145,7 @@ declare const TagResourceCommand_base: {
|
|
|
145
145
|
* @throws {@link KMSServiceException}
|
|
146
146
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
147
147
|
*
|
|
148
|
+
* @public
|
|
148
149
|
* @example To tag a KMS key
|
|
149
150
|
* ```javascript
|
|
150
151
|
* // The following example tags a KMS key.
|
|
@@ -22,10 +22,10 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
}
|
|
23
23
|
declare const UntagResourceCommand_base: {
|
|
24
24
|
new (input: UntagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: UntagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Deletes tags from a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>. To delete a tag,
|
|
30
30
|
* specify the tag key and the KMS key.</p>
|
|
31
31
|
* <note>
|
|
@@ -133,6 +133,7 @@ declare const UntagResourceCommand_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 remove tags from a KMS key
|
|
137
138
|
* ```javascript
|
|
138
139
|
* // The following example removes tags from a KMS key.
|
|
@@ -22,10 +22,10 @@ export interface UpdateAliasCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
}
|
|
23
23
|
declare const UpdateAliasCommand_base: {
|
|
24
24
|
new (input: UpdateAliasCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateAliasCommandInput, UpdateAliasCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: UpdateAliasCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateAliasCommandInput, UpdateAliasCommandOutput, KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Associates an existing KMS alias with a different KMS key. Each alias is associated with
|
|
30
30
|
* only one KMS key at a time, although a KMS key can have multiple aliases. The alias and the
|
|
31
31
|
* KMS key must be in the same Amazon Web Services account and Region.</p>
|
|
@@ -153,6 +153,7 @@ declare const UpdateAliasCommand_base: {
|
|
|
153
153
|
* @throws {@link KMSServiceException}
|
|
154
154
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
155
155
|
*
|
|
156
|
+
* @public
|
|
156
157
|
* @example To update an alias
|
|
157
158
|
* ```javascript
|
|
158
159
|
* // The following example updates the specified alias to refer to the specified KMS key.
|