@aws-sdk/client-kms 3.299.0 → 3.301.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/commands/CancelKeyDeletionCommand.d.ts +3 -0
- package/dist-types/commands/ConnectCustomKeyStoreCommand.d.ts +3 -0
- package/dist-types/commands/CreateAliasCommand.d.ts +4 -0
- package/dist-types/commands/CreateCustomKeyStoreCommand.d.ts +15 -0
- package/dist-types/commands/CreateGrantCommand.d.ts +20 -0
- package/dist-types/commands/CreateKeyCommand.d.ts +18 -0
- package/dist-types/commands/DecryptCommand.d.ts +11 -0
- package/dist-types/commands/DeleteAliasCommand.d.ts +3 -0
- package/dist-types/commands/DeleteCustomKeyStoreCommand.d.ts +3 -0
- package/dist-types/commands/DeleteImportedKeyMaterialCommand.d.ts +3 -0
- package/dist-types/commands/DescribeCustomKeyStoresCommand.d.ts +6 -0
- package/dist-types/commands/DescribeKeyCommand.d.ts +6 -0
- package/dist-types/commands/DisableKeyCommand.d.ts +3 -0
- package/dist-types/commands/DisableKeyRotationCommand.d.ts +3 -0
- package/dist-types/commands/DisconnectCustomKeyStoreCommand.d.ts +3 -0
- package/dist-types/commands/EnableKeyCommand.d.ts +3 -0
- package/dist-types/commands/EnableKeyRotationCommand.d.ts +3 -0
- package/dist-types/commands/EncryptCommand.d.ts +11 -0
- package/dist-types/commands/GenerateDataKeyCommand.d.ts +11 -0
- package/dist-types/commands/GenerateDataKeyPairCommand.d.ts +10 -0
- package/dist-types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +10 -0
- package/dist-types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +11 -0
- package/dist-types/commands/GenerateMacCommand.d.ts +8 -0
- package/dist-types/commands/GenerateRandomCommand.d.ts +4 -0
- package/dist-types/commands/GetKeyPolicyCommand.d.ts +4 -0
- package/dist-types/commands/GetKeyRotationStatusCommand.d.ts +3 -0
- package/dist-types/commands/GetParametersForImportCommand.d.ts +5 -0
- package/dist-types/commands/GetPublicKeyCommand.d.ts +6 -0
- package/dist-types/commands/ImportKeyMaterialCommand.d.ts +7 -0
- package/dist-types/commands/ListAliasesCommand.d.ts +5 -0
- package/dist-types/commands/ListGrantsCommand.d.ts +7 -0
- package/dist-types/commands/ListKeyPoliciesCommand.d.ts +5 -0
- package/dist-types/commands/ListKeysCommand.d.ts +4 -0
- package/dist-types/commands/ListResourceTagsCommand.d.ts +5 -0
- package/dist-types/commands/ListRetirableGrantsCommand.d.ts +5 -0
- package/dist-types/commands/PutKeyPolicyCommand.d.ts +6 -0
- package/dist-types/commands/ReEncryptCommand.d.ts +16 -0
- package/dist-types/commands/ReplicateKeyCommand.d.ts +13 -0
- package/dist-types/commands/RetireGrantCommand.d.ts +5 -0
- package/dist-types/commands/RevokeGrantCommand.d.ts +4 -0
- package/dist-types/commands/ScheduleKeyDeletionCommand.d.ts +4 -0
- package/dist-types/commands/SignCommand.d.ts +9 -0
- package/dist-types/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +6 -0
- package/dist-types/commands/UpdateAliasCommand.d.ts +4 -0
- package/dist-types/commands/UpdateCustomKeyStoreCommand.d.ts +14 -0
- package/dist-types/commands/UpdateKeyDescriptionCommand.d.ts +4 -0
- package/dist-types/commands/UpdatePrimaryRegionCommand.d.ts +4 -0
- package/dist-types/commands/VerifyCommand.d.ts +10 -0
- package/dist-types/commands/VerifyMacCommand.d.ts +9 -0
- package/package.json +8 -8
|
@@ -38,6 +38,9 @@ export interface CancelKeyDeletionCommandOutput extends CancelKeyDeletionRespons
|
|
|
38
38
|
* import { KMSClient, CancelKeyDeletionCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
39
39
|
* // const { KMSClient, CancelKeyDeletionCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
40
40
|
* const client = new KMSClient(config);
|
|
41
|
+
* const input = { // CancelKeyDeletionRequest
|
|
42
|
+
* KeyId: "STRING_VALUE", // required
|
|
43
|
+
* };
|
|
41
44
|
* const command = new CancelKeyDeletionCommand(input);
|
|
42
45
|
* const response = await client.send(command);
|
|
43
46
|
* ```
|
|
@@ -112,6 +112,9 @@ export interface ConnectCustomKeyStoreCommandOutput extends ConnectCustomKeyStor
|
|
|
112
112
|
* import { KMSClient, ConnectCustomKeyStoreCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
113
113
|
* // const { KMSClient, ConnectCustomKeyStoreCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
114
114
|
* const client = new KMSClient(config);
|
|
115
|
+
* const input = { // ConnectCustomKeyStoreRequest
|
|
116
|
+
* CustomKeyStoreId: "STRING_VALUE", // required
|
|
117
|
+
* };
|
|
115
118
|
* const command = new ConnectCustomKeyStoreCommand(input);
|
|
116
119
|
* const response = await client.send(command);
|
|
117
120
|
* ```
|
|
@@ -82,6 +82,10 @@ export interface CreateAliasCommandOutput extends __MetadataBearer {
|
|
|
82
82
|
* import { KMSClient, CreateAliasCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
83
83
|
* // const { KMSClient, CreateAliasCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
84
84
|
* const client = new KMSClient(config);
|
|
85
|
+
* const input = { // CreateAliasRequest
|
|
86
|
+
* AliasName: "STRING_VALUE", // required
|
|
87
|
+
* TargetKeyId: "STRING_VALUE", // required
|
|
88
|
+
* };
|
|
85
89
|
* const command = new CreateAliasCommand(input);
|
|
86
90
|
* const response = await client.send(command);
|
|
87
91
|
* ```
|
|
@@ -113,6 +113,21 @@ export interface CreateCustomKeyStoreCommandOutput extends CreateCustomKeyStoreR
|
|
|
113
113
|
* import { KMSClient, CreateCustomKeyStoreCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
114
114
|
* // const { KMSClient, CreateCustomKeyStoreCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
115
115
|
* const client = new KMSClient(config);
|
|
116
|
+
* const input = { // CreateCustomKeyStoreRequest
|
|
117
|
+
* CustomKeyStoreName: "STRING_VALUE", // required
|
|
118
|
+
* CloudHsmClusterId: "STRING_VALUE",
|
|
119
|
+
* TrustAnchorCertificate: "STRING_VALUE",
|
|
120
|
+
* KeyStorePassword: "STRING_VALUE",
|
|
121
|
+
* CustomKeyStoreType: "AWS_CLOUDHSM" || "EXTERNAL_KEY_STORE",
|
|
122
|
+
* XksProxyUriEndpoint: "STRING_VALUE",
|
|
123
|
+
* XksProxyUriPath: "STRING_VALUE",
|
|
124
|
+
* XksProxyVpcEndpointServiceName: "STRING_VALUE",
|
|
125
|
+
* XksProxyAuthenticationCredential: { // XksProxyAuthenticationCredentialType
|
|
126
|
+
* AccessKeyId: "STRING_VALUE", // required
|
|
127
|
+
* RawSecretAccessKey: "STRING_VALUE", // required
|
|
128
|
+
* },
|
|
129
|
+
* XksProxyConnectivity: "PUBLIC_ENDPOINT" || "VPC_ENDPOINT_SERVICE",
|
|
130
|
+
* };
|
|
116
131
|
* const command = new CreateCustomKeyStoreCommand(input);
|
|
117
132
|
* const response = await client.send(command);
|
|
118
133
|
* ```
|
|
@@ -87,6 +87,26 @@ export interface CreateGrantCommandOutput extends CreateGrantResponse, __Metadat
|
|
|
87
87
|
* import { KMSClient, CreateGrantCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
88
88
|
* // const { KMSClient, CreateGrantCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
89
89
|
* const client = new KMSClient(config);
|
|
90
|
+
* const input = { // CreateGrantRequest
|
|
91
|
+
* KeyId: "STRING_VALUE", // required
|
|
92
|
+
* GranteePrincipal: "STRING_VALUE", // required
|
|
93
|
+
* RetiringPrincipal: "STRING_VALUE",
|
|
94
|
+
* Operations: [ // GrantOperationList // required
|
|
95
|
+
* "Decrypt" || "Encrypt" || "GenerateDataKey" || "GenerateDataKeyWithoutPlaintext" || "ReEncryptFrom" || "ReEncryptTo" || "Sign" || "Verify" || "GetPublicKey" || "CreateGrant" || "RetireGrant" || "DescribeKey" || "GenerateDataKeyPair" || "GenerateDataKeyPairWithoutPlaintext" || "GenerateMac" || "VerifyMac",
|
|
96
|
+
* ],
|
|
97
|
+
* Constraints: { // GrantConstraints
|
|
98
|
+
* EncryptionContextSubset: { // EncryptionContextType
|
|
99
|
+
* "<keys>": "STRING_VALUE",
|
|
100
|
+
* },
|
|
101
|
+
* EncryptionContextEquals: {
|
|
102
|
+
* "<keys>": "STRING_VALUE",
|
|
103
|
+
* },
|
|
104
|
+
* },
|
|
105
|
+
* GrantTokens: [ // GrantTokenList
|
|
106
|
+
* "STRING_VALUE",
|
|
107
|
+
* ],
|
|
108
|
+
* Name: "STRING_VALUE",
|
|
109
|
+
* };
|
|
90
110
|
* const command = new CreateGrantCommand(input);
|
|
91
111
|
* const response = await client.send(command);
|
|
92
112
|
* ```
|
|
@@ -192,6 +192,24 @@ export interface CreateKeyCommandOutput extends CreateKeyResponse, __MetadataBea
|
|
|
192
192
|
* import { KMSClient, CreateKeyCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
193
193
|
* // const { KMSClient, CreateKeyCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
194
194
|
* const client = new KMSClient(config);
|
|
195
|
+
* const input = { // CreateKeyRequest
|
|
196
|
+
* Policy: "STRING_VALUE",
|
|
197
|
+
* Description: "STRING_VALUE",
|
|
198
|
+
* KeyUsage: "SIGN_VERIFY" || "ENCRYPT_DECRYPT" || "GENERATE_VERIFY_MAC",
|
|
199
|
+
* 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",
|
|
200
|
+
* 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",
|
|
201
|
+
* Origin: "AWS_KMS" || "EXTERNAL" || "AWS_CLOUDHSM" || "EXTERNAL_KEY_STORE",
|
|
202
|
+
* CustomKeyStoreId: "STRING_VALUE",
|
|
203
|
+
* BypassPolicyLockoutSafetyCheck: true || false,
|
|
204
|
+
* Tags: [ // TagList
|
|
205
|
+
* { // Tag
|
|
206
|
+
* TagKey: "STRING_VALUE", // required
|
|
207
|
+
* TagValue: "STRING_VALUE", // required
|
|
208
|
+
* },
|
|
209
|
+
* ],
|
|
210
|
+
* MultiRegion: true || false,
|
|
211
|
+
* XksKeyId: "STRING_VALUE",
|
|
212
|
+
* };
|
|
195
213
|
* const command = new CreateKeyCommand(input);
|
|
196
214
|
* const response = await client.send(command);
|
|
197
215
|
* ```
|
|
@@ -113,6 +113,17 @@ export interface DecryptCommandOutput extends DecryptResponse, __MetadataBearer
|
|
|
113
113
|
* import { KMSClient, DecryptCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
114
114
|
* // const { KMSClient, DecryptCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
115
115
|
* const client = new KMSClient(config);
|
|
116
|
+
* const input = { // DecryptRequest
|
|
117
|
+
* CiphertextBlob: "BLOB_VALUE", // required
|
|
118
|
+
* EncryptionContext: { // EncryptionContextType
|
|
119
|
+
* "<keys>": "STRING_VALUE",
|
|
120
|
+
* },
|
|
121
|
+
* GrantTokens: [ // GrantTokenList
|
|
122
|
+
* "STRING_VALUE",
|
|
123
|
+
* ],
|
|
124
|
+
* KeyId: "STRING_VALUE",
|
|
125
|
+
* EncryptionAlgorithm: "SYMMETRIC_DEFAULT" || "RSAES_OAEP_SHA_1" || "RSAES_OAEP_SHA_256" || "SM2PKE",
|
|
126
|
+
* };
|
|
116
127
|
* const command = new DecryptCommand(input);
|
|
117
128
|
* const response = await client.send(command);
|
|
118
129
|
* ```
|
|
@@ -73,6 +73,9 @@ export interface DeleteAliasCommandOutput extends __MetadataBearer {
|
|
|
73
73
|
* import { KMSClient, DeleteAliasCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
74
74
|
* // const { KMSClient, DeleteAliasCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
75
75
|
* const client = new KMSClient(config);
|
|
76
|
+
* const input = { // DeleteAliasRequest
|
|
77
|
+
* AliasName: "STRING_VALUE", // required
|
|
78
|
+
* };
|
|
76
79
|
* const command = new DeleteAliasCommand(input);
|
|
77
80
|
* const response = await client.send(command);
|
|
78
81
|
* ```
|
|
@@ -84,6 +84,9 @@ export interface DeleteCustomKeyStoreCommandOutput extends DeleteCustomKeyStoreR
|
|
|
84
84
|
* import { KMSClient, DeleteCustomKeyStoreCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
85
85
|
* // const { KMSClient, DeleteCustomKeyStoreCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
86
86
|
* const client = new KMSClient(config);
|
|
87
|
+
* const input = { // DeleteCustomKeyStoreRequest
|
|
88
|
+
* CustomKeyStoreId: "STRING_VALUE", // required
|
|
89
|
+
* };
|
|
87
90
|
* const command = new DeleteCustomKeyStoreCommand(input);
|
|
88
91
|
* const response = await client.send(command);
|
|
89
92
|
* ```
|
|
@@ -54,6 +54,9 @@ export interface DeleteImportedKeyMaterialCommandOutput extends __MetadataBearer
|
|
|
54
54
|
* import { KMSClient, DeleteImportedKeyMaterialCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
55
55
|
* // const { KMSClient, DeleteImportedKeyMaterialCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
56
56
|
* const client = new KMSClient(config);
|
|
57
|
+
* const input = { // DeleteImportedKeyMaterialRequest
|
|
58
|
+
* KeyId: "STRING_VALUE", // required
|
|
59
|
+
* };
|
|
57
60
|
* const command = new DeleteImportedKeyMaterialCommand(input);
|
|
58
61
|
* const response = await client.send(command);
|
|
59
62
|
* ```
|
|
@@ -84,6 +84,12 @@ export interface DescribeCustomKeyStoresCommandOutput extends DescribeCustomKeyS
|
|
|
84
84
|
* import { KMSClient, DescribeCustomKeyStoresCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
85
85
|
* // const { KMSClient, DescribeCustomKeyStoresCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
86
86
|
* const client = new KMSClient(config);
|
|
87
|
+
* const input = { // DescribeCustomKeyStoresRequest
|
|
88
|
+
* CustomKeyStoreId: "STRING_VALUE",
|
|
89
|
+
* CustomKeyStoreName: "STRING_VALUE",
|
|
90
|
+
* Limit: Number("int"),
|
|
91
|
+
* Marker: "STRING_VALUE",
|
|
92
|
+
* };
|
|
87
93
|
* const command = new DescribeCustomKeyStoresCommand(input);
|
|
88
94
|
* const response = await client.send(command);
|
|
89
95
|
* ```
|
|
@@ -108,6 +108,12 @@ export interface DescribeKeyCommandOutput extends DescribeKeyResponse, __Metadat
|
|
|
108
108
|
* import { KMSClient, DescribeKeyCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
109
109
|
* // const { KMSClient, DescribeKeyCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
110
110
|
* const client = new KMSClient(config);
|
|
111
|
+
* const input = { // DescribeKeyRequest
|
|
112
|
+
* KeyId: "STRING_VALUE", // required
|
|
113
|
+
* GrantTokens: [ // GrantTokenList
|
|
114
|
+
* "STRING_VALUE",
|
|
115
|
+
* ],
|
|
116
|
+
* };
|
|
111
117
|
* const command = new DescribeKeyCommand(input);
|
|
112
118
|
* const response = await client.send(command);
|
|
113
119
|
* ```
|
|
@@ -40,6 +40,9 @@ export interface DisableKeyCommandOutput extends __MetadataBearer {
|
|
|
40
40
|
* import { KMSClient, DisableKeyCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
41
41
|
* // const { KMSClient, DisableKeyCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
42
42
|
* const client = new KMSClient(config);
|
|
43
|
+
* const input = { // DisableKeyRequest
|
|
44
|
+
* KeyId: "STRING_VALUE", // required
|
|
45
|
+
* };
|
|
43
46
|
* const command = new DisableKeyCommand(input);
|
|
44
47
|
* const response = await client.send(command);
|
|
45
48
|
* ```
|
|
@@ -58,6 +58,9 @@ export interface DisableKeyRotationCommandOutput extends __MetadataBearer {
|
|
|
58
58
|
* import { KMSClient, DisableKeyRotationCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
59
59
|
* // const { KMSClient, DisableKeyRotationCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
60
60
|
* const client = new KMSClient(config);
|
|
61
|
+
* const input = { // DisableKeyRotationRequest
|
|
62
|
+
* KeyId: "STRING_VALUE", // required
|
|
63
|
+
* };
|
|
61
64
|
* const command = new DisableKeyRotationCommand(input);
|
|
62
65
|
* const response = await client.send(command);
|
|
63
66
|
* ```
|
|
@@ -77,6 +77,9 @@ export interface DisconnectCustomKeyStoreCommandOutput extends DisconnectCustomK
|
|
|
77
77
|
* import { KMSClient, DisconnectCustomKeyStoreCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
78
78
|
* // const { KMSClient, DisconnectCustomKeyStoreCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
79
79
|
* const client = new KMSClient(config);
|
|
80
|
+
* const input = { // DisconnectCustomKeyStoreRequest
|
|
81
|
+
* CustomKeyStoreId: "STRING_VALUE", // required
|
|
82
|
+
* };
|
|
80
83
|
* const command = new DisconnectCustomKeyStoreCommand(input);
|
|
81
84
|
* const response = await client.send(command);
|
|
82
85
|
* ```
|
|
@@ -36,6 +36,9 @@ export interface EnableKeyCommandOutput extends __MetadataBearer {
|
|
|
36
36
|
* import { KMSClient, EnableKeyCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
37
37
|
* // const { KMSClient, EnableKeyCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
38
38
|
* const client = new KMSClient(config);
|
|
39
|
+
* const input = { // EnableKeyRequest
|
|
40
|
+
* KeyId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
39
42
|
* const command = new EnableKeyCommand(input);
|
|
40
43
|
* const response = await client.send(command);
|
|
41
44
|
* ```
|
|
@@ -66,6 +66,9 @@ export interface EnableKeyRotationCommandOutput extends __MetadataBearer {
|
|
|
66
66
|
* import { KMSClient, EnableKeyRotationCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
67
67
|
* // const { KMSClient, EnableKeyRotationCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
68
68
|
* const client = new KMSClient(config);
|
|
69
|
+
* const input = { // EnableKeyRotationRequest
|
|
70
|
+
* KeyId: "STRING_VALUE", // required
|
|
71
|
+
* };
|
|
69
72
|
* const command = new EnableKeyRotationCommand(input);
|
|
70
73
|
* const response = await client.send(command);
|
|
71
74
|
* ```
|
|
@@ -135,6 +135,17 @@ export interface EncryptCommandOutput extends EncryptResponse, __MetadataBearer
|
|
|
135
135
|
* import { KMSClient, EncryptCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
136
136
|
* // const { KMSClient, EncryptCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
137
137
|
* const client = new KMSClient(config);
|
|
138
|
+
* const input = { // EncryptRequest
|
|
139
|
+
* KeyId: "STRING_VALUE", // required
|
|
140
|
+
* Plaintext: "BLOB_VALUE", // required
|
|
141
|
+
* EncryptionContext: { // EncryptionContextType
|
|
142
|
+
* "<keys>": "STRING_VALUE",
|
|
143
|
+
* },
|
|
144
|
+
* GrantTokens: [ // GrantTokenList
|
|
145
|
+
* "STRING_VALUE",
|
|
146
|
+
* ],
|
|
147
|
+
* EncryptionAlgorithm: "SYMMETRIC_DEFAULT" || "RSAES_OAEP_SHA_1" || "RSAES_OAEP_SHA_256" || "SM2PKE",
|
|
148
|
+
* };
|
|
138
149
|
* const command = new EncryptCommand(input);
|
|
139
150
|
* const response = await client.send(command);
|
|
140
151
|
* ```
|
|
@@ -119,6 +119,17 @@ export interface GenerateDataKeyCommandOutput extends GenerateDataKeyResponse, _
|
|
|
119
119
|
* import { KMSClient, GenerateDataKeyCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
120
120
|
* // const { KMSClient, GenerateDataKeyCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
121
121
|
* const client = new KMSClient(config);
|
|
122
|
+
* const input = { // GenerateDataKeyRequest
|
|
123
|
+
* KeyId: "STRING_VALUE", // required
|
|
124
|
+
* EncryptionContext: { // EncryptionContextType
|
|
125
|
+
* "<keys>": "STRING_VALUE",
|
|
126
|
+
* },
|
|
127
|
+
* NumberOfBytes: Number("int"),
|
|
128
|
+
* KeySpec: "AES_256" || "AES_128",
|
|
129
|
+
* GrantTokens: [ // GrantTokenList
|
|
130
|
+
* "STRING_VALUE",
|
|
131
|
+
* ],
|
|
132
|
+
* };
|
|
122
133
|
* const command = new GenerateDataKeyCommand(input);
|
|
123
134
|
* const response = await client.send(command);
|
|
124
135
|
* ```
|
|
@@ -96,6 +96,16 @@ export interface GenerateDataKeyPairCommandOutput extends GenerateDataKeyPairRes
|
|
|
96
96
|
* import { KMSClient, GenerateDataKeyPairCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
97
97
|
* // const { KMSClient, GenerateDataKeyPairCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
98
98
|
* const client = new KMSClient(config);
|
|
99
|
+
* const input = { // GenerateDataKeyPairRequest
|
|
100
|
+
* EncryptionContext: { // EncryptionContextType
|
|
101
|
+
* "<keys>": "STRING_VALUE",
|
|
102
|
+
* },
|
|
103
|
+
* KeyId: "STRING_VALUE", // required
|
|
104
|
+
* KeyPairSpec: "RSA_2048" || "RSA_3072" || "RSA_4096" || "ECC_NIST_P256" || "ECC_NIST_P384" || "ECC_NIST_P521" || "ECC_SECG_P256K1" || "SM2", // required
|
|
105
|
+
* GrantTokens: [ // GrantTokenList
|
|
106
|
+
* "STRING_VALUE",
|
|
107
|
+
* ],
|
|
108
|
+
* };
|
|
99
109
|
* const command = new GenerateDataKeyPairCommand(input);
|
|
100
110
|
* const response = await client.send(command);
|
|
101
111
|
* ```
|
|
@@ -88,6 +88,16 @@ export interface GenerateDataKeyPairWithoutPlaintextCommandOutput extends Genera
|
|
|
88
88
|
* import { KMSClient, GenerateDataKeyPairWithoutPlaintextCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
89
89
|
* // const { KMSClient, GenerateDataKeyPairWithoutPlaintextCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
90
90
|
* const client = new KMSClient(config);
|
|
91
|
+
* const input = { // GenerateDataKeyPairWithoutPlaintextRequest
|
|
92
|
+
* EncryptionContext: { // EncryptionContextType
|
|
93
|
+
* "<keys>": "STRING_VALUE",
|
|
94
|
+
* },
|
|
95
|
+
* KeyId: "STRING_VALUE", // required
|
|
96
|
+
* KeyPairSpec: "RSA_2048" || "RSA_3072" || "RSA_4096" || "ECC_NIST_P256" || "ECC_NIST_P384" || "ECC_NIST_P521" || "ECC_SECG_P256K1" || "SM2", // required
|
|
97
|
+
* GrantTokens: [ // GrantTokenList
|
|
98
|
+
* "STRING_VALUE",
|
|
99
|
+
* ],
|
|
100
|
+
* };
|
|
91
101
|
* const command = new GenerateDataKeyPairWithoutPlaintextCommand(input);
|
|
92
102
|
* const response = await client.send(command);
|
|
93
103
|
* ```
|
|
@@ -97,6 +97,17 @@ export interface GenerateDataKeyWithoutPlaintextCommandOutput extends GenerateDa
|
|
|
97
97
|
* import { KMSClient, GenerateDataKeyWithoutPlaintextCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
98
98
|
* // const { KMSClient, GenerateDataKeyWithoutPlaintextCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
99
99
|
* const client = new KMSClient(config);
|
|
100
|
+
* const input = { // GenerateDataKeyWithoutPlaintextRequest
|
|
101
|
+
* KeyId: "STRING_VALUE", // required
|
|
102
|
+
* EncryptionContext: { // EncryptionContextType
|
|
103
|
+
* "<keys>": "STRING_VALUE",
|
|
104
|
+
* },
|
|
105
|
+
* KeySpec: "AES_256" || "AES_128",
|
|
106
|
+
* NumberOfBytes: Number("int"),
|
|
107
|
+
* GrantTokens: [ // GrantTokenList
|
|
108
|
+
* "STRING_VALUE",
|
|
109
|
+
* ],
|
|
110
|
+
* };
|
|
100
111
|
* const command = new GenerateDataKeyWithoutPlaintextCommand(input);
|
|
101
112
|
* const response = await client.send(command);
|
|
102
113
|
* ```
|
|
@@ -53,6 +53,14 @@ export interface GenerateMacCommandOutput extends GenerateMacResponse, __Metadat
|
|
|
53
53
|
* import { KMSClient, GenerateMacCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
54
54
|
* // const { KMSClient, GenerateMacCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
55
55
|
* const client = new KMSClient(config);
|
|
56
|
+
* const input = { // GenerateMacRequest
|
|
57
|
+
* Message: "BLOB_VALUE", // required
|
|
58
|
+
* KeyId: "STRING_VALUE", // required
|
|
59
|
+
* MacAlgorithm: "HMAC_SHA_224" || "HMAC_SHA_256" || "HMAC_SHA_384" || "HMAC_SHA_512", // required
|
|
60
|
+
* GrantTokens: [ // GrantTokenList
|
|
61
|
+
* "STRING_VALUE",
|
|
62
|
+
* ],
|
|
63
|
+
* };
|
|
56
64
|
* const command = new GenerateMacCommand(input);
|
|
57
65
|
* const response = await client.send(command);
|
|
58
66
|
* ```
|
|
@@ -40,6 +40,10 @@ export interface GenerateRandomCommandOutput extends GenerateRandomResponse, __M
|
|
|
40
40
|
* import { KMSClient, GenerateRandomCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
41
41
|
* // const { KMSClient, GenerateRandomCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
42
42
|
* const client = new KMSClient(config);
|
|
43
|
+
* const input = { // GenerateRandomRequest
|
|
44
|
+
* NumberOfBytes: Number("int"),
|
|
45
|
+
* CustomKeyStoreId: "STRING_VALUE",
|
|
46
|
+
* };
|
|
43
47
|
* const command = new GenerateRandomCommand(input);
|
|
44
48
|
* const response = await client.send(command);
|
|
45
49
|
* ```
|
|
@@ -33,6 +33,10 @@ export interface GetKeyPolicyCommandOutput extends GetKeyPolicyResponse, __Metad
|
|
|
33
33
|
* import { KMSClient, GetKeyPolicyCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
34
34
|
* // const { KMSClient, GetKeyPolicyCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
35
35
|
* const client = new KMSClient(config);
|
|
36
|
+
* const input = { // GetKeyPolicyRequest
|
|
37
|
+
* KeyId: "STRING_VALUE", // required
|
|
38
|
+
* PolicyName: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
36
40
|
* const command = new GetKeyPolicyCommand(input);
|
|
37
41
|
* const response = await client.send(command);
|
|
38
42
|
* ```
|
|
@@ -78,6 +78,9 @@ export interface GetKeyRotationStatusCommandOutput extends GetKeyRotationStatusR
|
|
|
78
78
|
* import { KMSClient, GetKeyRotationStatusCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
79
79
|
* // const { KMSClient, GetKeyRotationStatusCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
80
80
|
* const client = new KMSClient(config);
|
|
81
|
+
* const input = { // GetKeyRotationStatusRequest
|
|
82
|
+
* KeyId: "STRING_VALUE", // required
|
|
83
|
+
* };
|
|
81
84
|
* const command = new GetKeyRotationStatusCommand(input);
|
|
82
85
|
* const response = await client.send(command);
|
|
83
86
|
* ```
|
|
@@ -59,6 +59,11 @@ export interface GetParametersForImportCommandOutput extends GetParametersForImp
|
|
|
59
59
|
* import { KMSClient, GetParametersForImportCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
60
60
|
* // const { KMSClient, GetParametersForImportCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
61
61
|
* const client = new KMSClient(config);
|
|
62
|
+
* const input = { // GetParametersForImportRequest
|
|
63
|
+
* KeyId: "STRING_VALUE", // required
|
|
64
|
+
* WrappingAlgorithm: "RSAES_PKCS1_V1_5" || "RSAES_OAEP_SHA_1" || "RSAES_OAEP_SHA_256", // required
|
|
65
|
+
* WrappingKeySpec: "RSA_2048", // required
|
|
66
|
+
* };
|
|
62
67
|
* const command = new GetParametersForImportCommand(input);
|
|
63
68
|
* const response = await client.send(command);
|
|
64
69
|
* ```
|
|
@@ -74,6 +74,12 @@ export interface GetPublicKeyCommandOutput extends GetPublicKeyResponse, __Metad
|
|
|
74
74
|
* import { KMSClient, GetPublicKeyCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
75
75
|
* // const { KMSClient, GetPublicKeyCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
76
76
|
* const client = new KMSClient(config);
|
|
77
|
+
* const input = { // GetPublicKeyRequest
|
|
78
|
+
* KeyId: "STRING_VALUE", // required
|
|
79
|
+
* GrantTokens: [ // GrantTokenList
|
|
80
|
+
* "STRING_VALUE",
|
|
81
|
+
* ],
|
|
82
|
+
* };
|
|
77
83
|
* const command = new GetPublicKeyCommand(input);
|
|
78
84
|
* const response = await client.send(command);
|
|
79
85
|
* ```
|
|
@@ -89,6 +89,13 @@ export interface ImportKeyMaterialCommandOutput extends ImportKeyMaterialRespons
|
|
|
89
89
|
* import { KMSClient, ImportKeyMaterialCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
90
90
|
* // const { KMSClient, ImportKeyMaterialCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
91
91
|
* const client = new KMSClient(config);
|
|
92
|
+
* const input = { // ImportKeyMaterialRequest
|
|
93
|
+
* KeyId: "STRING_VALUE", // required
|
|
94
|
+
* ImportToken: "BLOB_VALUE", // required
|
|
95
|
+
* EncryptedKeyMaterial: "BLOB_VALUE", // required
|
|
96
|
+
* ValidTo: new Date("TIMESTAMP"),
|
|
97
|
+
* ExpirationModel: "KEY_MATERIAL_EXPIRES" || "KEY_MATERIAL_DOES_NOT_EXPIRE",
|
|
98
|
+
* };
|
|
92
99
|
* const command = new ImportKeyMaterialCommand(input);
|
|
93
100
|
* const response = await client.send(command);
|
|
94
101
|
* ```
|
|
@@ -66,6 +66,11 @@ export interface ListAliasesCommandOutput extends ListAliasesResponse, __Metadat
|
|
|
66
66
|
* import { KMSClient, ListAliasesCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
67
67
|
* // const { KMSClient, ListAliasesCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
68
68
|
* const client = new KMSClient(config);
|
|
69
|
+
* const input = { // ListAliasesRequest
|
|
70
|
+
* KeyId: "STRING_VALUE",
|
|
71
|
+
* Limit: Number("int"),
|
|
72
|
+
* Marker: "STRING_VALUE",
|
|
73
|
+
* };
|
|
69
74
|
* const command = new ListAliasesCommand(input);
|
|
70
75
|
* const response = await client.send(command);
|
|
71
76
|
* ```
|
|
@@ -70,6 +70,13 @@ export interface ListGrantsCommandOutput extends ListGrantsResponse, __MetadataB
|
|
|
70
70
|
* import { KMSClient, ListGrantsCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
71
71
|
* // const { KMSClient, ListGrantsCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
72
72
|
* const client = new KMSClient(config);
|
|
73
|
+
* const input = { // ListGrantsRequest
|
|
74
|
+
* Limit: Number("int"),
|
|
75
|
+
* Marker: "STRING_VALUE",
|
|
76
|
+
* KeyId: "STRING_VALUE", // required
|
|
77
|
+
* GrantId: "STRING_VALUE",
|
|
78
|
+
* GranteePrincipal: "STRING_VALUE",
|
|
79
|
+
* };
|
|
73
80
|
* const command = new ListGrantsCommand(input);
|
|
74
81
|
* const response = await client.send(command);
|
|
75
82
|
* ```
|
|
@@ -47,6 +47,11 @@ export interface ListKeyPoliciesCommandOutput extends ListKeyPoliciesResponse, _
|
|
|
47
47
|
* import { KMSClient, ListKeyPoliciesCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
48
48
|
* // const { KMSClient, ListKeyPoliciesCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
49
49
|
* const client = new KMSClient(config);
|
|
50
|
+
* const input = { // ListKeyPoliciesRequest
|
|
51
|
+
* KeyId: "STRING_VALUE", // required
|
|
52
|
+
* Limit: Number("int"),
|
|
53
|
+
* Marker: "STRING_VALUE",
|
|
54
|
+
* };
|
|
50
55
|
* const command = new ListKeyPoliciesCommand(input);
|
|
51
56
|
* const response = await client.send(command);
|
|
52
57
|
* ```
|
|
@@ -55,6 +55,10 @@ export interface ListKeysCommandOutput extends ListKeysResponse, __MetadataBeare
|
|
|
55
55
|
* import { KMSClient, ListKeysCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
56
56
|
* // const { KMSClient, ListKeysCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
57
57
|
* const client = new KMSClient(config);
|
|
58
|
+
* const input = { // ListKeysRequest
|
|
59
|
+
* Limit: Number("int"),
|
|
60
|
+
* Marker: "STRING_VALUE",
|
|
61
|
+
* };
|
|
58
62
|
* const command = new ListKeysCommand(input);
|
|
59
63
|
* const response = await client.send(command);
|
|
60
64
|
* ```
|
|
@@ -59,6 +59,11 @@ export interface ListResourceTagsCommandOutput extends ListResourceTagsResponse,
|
|
|
59
59
|
* import { KMSClient, ListResourceTagsCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
60
60
|
* // const { KMSClient, ListResourceTagsCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
61
61
|
* const client = new KMSClient(config);
|
|
62
|
+
* const input = { // ListResourceTagsRequest
|
|
63
|
+
* KeyId: "STRING_VALUE", // required
|
|
64
|
+
* Limit: Number("int"),
|
|
65
|
+
* Marker: "STRING_VALUE",
|
|
66
|
+
* };
|
|
62
67
|
* const command = new ListResourceTagsCommand(input);
|
|
63
68
|
* const response = await client.send(command);
|
|
64
69
|
* ```
|
|
@@ -68,6 +68,11 @@ export interface ListRetirableGrantsCommandOutput extends ListGrantsResponse, __
|
|
|
68
68
|
* import { KMSClient, ListRetirableGrantsCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
69
69
|
* // const { KMSClient, ListRetirableGrantsCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
70
70
|
* const client = new KMSClient(config);
|
|
71
|
+
* const input = { // ListRetirableGrantsRequest
|
|
72
|
+
* Limit: Number("int"),
|
|
73
|
+
* Marker: "STRING_VALUE",
|
|
74
|
+
* RetiringPrincipal: "STRING_VALUE", // required
|
|
75
|
+
* };
|
|
71
76
|
* const command = new ListRetirableGrantsCommand(input);
|
|
72
77
|
* const response = await client.send(command);
|
|
73
78
|
* ```
|
|
@@ -38,6 +38,12 @@ export interface PutKeyPolicyCommandOutput extends __MetadataBearer {
|
|
|
38
38
|
* import { KMSClient, PutKeyPolicyCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
39
39
|
* // const { KMSClient, PutKeyPolicyCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
40
40
|
* const client = new KMSClient(config);
|
|
41
|
+
* const input = { // PutKeyPolicyRequest
|
|
42
|
+
* KeyId: "STRING_VALUE", // required
|
|
43
|
+
* PolicyName: "STRING_VALUE", // required
|
|
44
|
+
* Policy: "STRING_VALUE", // required
|
|
45
|
+
* BypassPolicyLockoutSafetyCheck: true || false,
|
|
46
|
+
* };
|
|
41
47
|
* const command = new PutKeyPolicyCommand(input);
|
|
42
48
|
* const response = await client.send(command);
|
|
43
49
|
* ```
|
|
@@ -120,6 +120,22 @@ export interface ReEncryptCommandOutput extends ReEncryptResponse, __MetadataBea
|
|
|
120
120
|
* import { KMSClient, ReEncryptCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
121
121
|
* // const { KMSClient, ReEncryptCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
122
122
|
* const client = new KMSClient(config);
|
|
123
|
+
* const input = { // ReEncryptRequest
|
|
124
|
+
* CiphertextBlob: "BLOB_VALUE", // required
|
|
125
|
+
* SourceEncryptionContext: { // EncryptionContextType
|
|
126
|
+
* "<keys>": "STRING_VALUE",
|
|
127
|
+
* },
|
|
128
|
+
* SourceKeyId: "STRING_VALUE",
|
|
129
|
+
* DestinationKeyId: "STRING_VALUE", // required
|
|
130
|
+
* DestinationEncryptionContext: {
|
|
131
|
+
* "<keys>": "STRING_VALUE",
|
|
132
|
+
* },
|
|
133
|
+
* SourceEncryptionAlgorithm: "SYMMETRIC_DEFAULT" || "RSAES_OAEP_SHA_1" || "RSAES_OAEP_SHA_256" || "SM2PKE",
|
|
134
|
+
* DestinationEncryptionAlgorithm: "SYMMETRIC_DEFAULT" || "RSAES_OAEP_SHA_1" || "RSAES_OAEP_SHA_256" || "SM2PKE",
|
|
135
|
+
* GrantTokens: [ // GrantTokenList
|
|
136
|
+
* "STRING_VALUE",
|
|
137
|
+
* ],
|
|
138
|
+
* };
|
|
123
139
|
* const command = new ReEncryptCommand(input);
|
|
124
140
|
* const response = await client.send(command);
|
|
125
141
|
* ```
|
|
@@ -108,6 +108,19 @@ export interface ReplicateKeyCommandOutput extends ReplicateKeyResponse, __Metad
|
|
|
108
108
|
* import { KMSClient, ReplicateKeyCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
109
109
|
* // const { KMSClient, ReplicateKeyCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
110
110
|
* const client = new KMSClient(config);
|
|
111
|
+
* const input = { // ReplicateKeyRequest
|
|
112
|
+
* KeyId: "STRING_VALUE", // required
|
|
113
|
+
* ReplicaRegion: "STRING_VALUE", // required
|
|
114
|
+
* Policy: "STRING_VALUE",
|
|
115
|
+
* BypassPolicyLockoutSafetyCheck: true || false,
|
|
116
|
+
* Description: "STRING_VALUE",
|
|
117
|
+
* Tags: [ // TagList
|
|
118
|
+
* { // Tag
|
|
119
|
+
* TagKey: "STRING_VALUE", // required
|
|
120
|
+
* TagValue: "STRING_VALUE", // required
|
|
121
|
+
* },
|
|
122
|
+
* ],
|
|
123
|
+
* };
|
|
111
124
|
* const command = new ReplicateKeyCommand(input);
|
|
112
125
|
* const response = await client.send(command);
|
|
113
126
|
* ```
|
|
@@ -71,6 +71,11 @@ export interface RetireGrantCommandOutput extends __MetadataBearer {
|
|
|
71
71
|
* import { KMSClient, RetireGrantCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
72
72
|
* // const { KMSClient, RetireGrantCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
73
73
|
* const client = new KMSClient(config);
|
|
74
|
+
* const input = { // RetireGrantRequest
|
|
75
|
+
* GrantToken: "STRING_VALUE",
|
|
76
|
+
* KeyId: "STRING_VALUE",
|
|
77
|
+
* GrantId: "STRING_VALUE",
|
|
78
|
+
* };
|
|
74
79
|
* const command = new RetireGrantCommand(input);
|
|
75
80
|
* const response = await client.send(command);
|
|
76
81
|
* ```
|
|
@@ -69,6 +69,10 @@ export interface RevokeGrantCommandOutput extends __MetadataBearer {
|
|
|
69
69
|
* import { KMSClient, RevokeGrantCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
70
70
|
* // const { KMSClient, RevokeGrantCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
71
71
|
* const client = new KMSClient(config);
|
|
72
|
+
* const input = { // RevokeGrantRequest
|
|
73
|
+
* KeyId: "STRING_VALUE", // required
|
|
74
|
+
* GrantId: "STRING_VALUE", // required
|
|
75
|
+
* };
|
|
72
76
|
* const command = new RevokeGrantCommand(input);
|
|
73
77
|
* const response = await client.send(command);
|
|
74
78
|
* ```
|
|
@@ -81,6 +81,10 @@ export interface ScheduleKeyDeletionCommandOutput extends ScheduleKeyDeletionRes
|
|
|
81
81
|
* import { KMSClient, ScheduleKeyDeletionCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
82
82
|
* // const { KMSClient, ScheduleKeyDeletionCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
83
83
|
* const client = new KMSClient(config);
|
|
84
|
+
* const input = { // ScheduleKeyDeletionRequest
|
|
85
|
+
* KeyId: "STRING_VALUE", // required
|
|
86
|
+
* PendingWindowInDays: Number("int"),
|
|
87
|
+
* };
|
|
84
88
|
* const command = new ScheduleKeyDeletionCommand(input);
|
|
85
89
|
* const response = await client.send(command);
|
|
86
90
|
* ```
|
|
@@ -77,6 +77,15 @@ export interface SignCommandOutput extends SignResponse, __MetadataBearer {
|
|
|
77
77
|
* import { KMSClient, SignCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
78
78
|
* // const { KMSClient, SignCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
79
79
|
* const client = new KMSClient(config);
|
|
80
|
+
* const input = { // SignRequest
|
|
81
|
+
* KeyId: "STRING_VALUE", // required
|
|
82
|
+
* Message: "BLOB_VALUE", // required
|
|
83
|
+
* MessageType: "RAW" || "DIGEST",
|
|
84
|
+
* GrantTokens: [ // GrantTokenList
|
|
85
|
+
* "STRING_VALUE",
|
|
86
|
+
* ],
|
|
87
|
+
* 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", // required
|
|
88
|
+
* };
|
|
80
89
|
* const command = new SignCommand(input);
|
|
81
90
|
* const response = await client.send(command);
|
|
82
91
|
* ```
|
|
@@ -72,6 +72,15 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
|
|
|
72
72
|
* import { KMSClient, TagResourceCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
73
73
|
* // const { KMSClient, TagResourceCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
74
74
|
* const client = new KMSClient(config);
|
|
75
|
+
* const input = { // TagResourceRequest
|
|
76
|
+
* KeyId: "STRING_VALUE", // required
|
|
77
|
+
* Tags: [ // TagList // required
|
|
78
|
+
* { // Tag
|
|
79
|
+
* TagKey: "STRING_VALUE", // required
|
|
80
|
+
* TagValue: "STRING_VALUE", // required
|
|
81
|
+
* },
|
|
82
|
+
* ],
|
|
83
|
+
* };
|
|
75
84
|
* const command = new TagResourceCommand(input);
|
|
76
85
|
* const response = await client.send(command);
|
|
77
86
|
* ```
|
|
@@ -67,6 +67,12 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
|
|
|
67
67
|
* import { KMSClient, UntagResourceCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
68
68
|
* // const { KMSClient, UntagResourceCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
69
69
|
* const client = new KMSClient(config);
|
|
70
|
+
* const input = { // UntagResourceRequest
|
|
71
|
+
* KeyId: "STRING_VALUE", // required
|
|
72
|
+
* TagKeys: [ // TagKeyList // required
|
|
73
|
+
* "STRING_VALUE",
|
|
74
|
+
* ],
|
|
75
|
+
* };
|
|
70
76
|
* const command = new UntagResourceCommand(input);
|
|
71
77
|
* const response = await client.send(command);
|
|
72
78
|
* ```
|
|
@@ -88,6 +88,10 @@ export interface UpdateAliasCommandOutput extends __MetadataBearer {
|
|
|
88
88
|
* import { KMSClient, UpdateAliasCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
89
89
|
* // const { KMSClient, UpdateAliasCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
90
90
|
* const client = new KMSClient(config);
|
|
91
|
+
* const input = { // UpdateAliasRequest
|
|
92
|
+
* AliasName: "STRING_VALUE", // required
|
|
93
|
+
* TargetKeyId: "STRING_VALUE", // required
|
|
94
|
+
* };
|
|
91
95
|
* const command = new UpdateAliasCommand(input);
|
|
92
96
|
* const response = await client.send(command);
|
|
93
97
|
* ```
|
|
@@ -118,6 +118,20 @@ export interface UpdateCustomKeyStoreCommandOutput extends UpdateCustomKeyStoreR
|
|
|
118
118
|
* import { KMSClient, UpdateCustomKeyStoreCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
119
119
|
* // const { KMSClient, UpdateCustomKeyStoreCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
120
120
|
* const client = new KMSClient(config);
|
|
121
|
+
* const input = { // UpdateCustomKeyStoreRequest
|
|
122
|
+
* CustomKeyStoreId: "STRING_VALUE", // required
|
|
123
|
+
* NewCustomKeyStoreName: "STRING_VALUE",
|
|
124
|
+
* KeyStorePassword: "STRING_VALUE",
|
|
125
|
+
* CloudHsmClusterId: "STRING_VALUE",
|
|
126
|
+
* XksProxyUriEndpoint: "STRING_VALUE",
|
|
127
|
+
* XksProxyUriPath: "STRING_VALUE",
|
|
128
|
+
* XksProxyVpcEndpointServiceName: "STRING_VALUE",
|
|
129
|
+
* XksProxyAuthenticationCredential: { // XksProxyAuthenticationCredentialType
|
|
130
|
+
* AccessKeyId: "STRING_VALUE", // required
|
|
131
|
+
* RawSecretAccessKey: "STRING_VALUE", // required
|
|
132
|
+
* },
|
|
133
|
+
* XksProxyConnectivity: "PUBLIC_ENDPOINT" || "VPC_ENDPOINT_SERVICE",
|
|
134
|
+
* };
|
|
121
135
|
* const command = new UpdateCustomKeyStoreCommand(input);
|
|
122
136
|
* const response = await client.send(command);
|
|
123
137
|
* ```
|
|
@@ -47,6 +47,10 @@ export interface UpdateKeyDescriptionCommandOutput extends __MetadataBearer {
|
|
|
47
47
|
* import { KMSClient, UpdateKeyDescriptionCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
48
48
|
* // const { KMSClient, UpdateKeyDescriptionCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
49
49
|
* const client = new KMSClient(config);
|
|
50
|
+
* const input = { // UpdateKeyDescriptionRequest
|
|
51
|
+
* KeyId: "STRING_VALUE", // required
|
|
52
|
+
* Description: "STRING_VALUE", // required
|
|
53
|
+
* };
|
|
50
54
|
* const command = new UpdateKeyDescriptionCommand(input);
|
|
51
55
|
* const response = await client.send(command);
|
|
52
56
|
* ```
|
|
@@ -90,6 +90,10 @@ export interface UpdatePrimaryRegionCommandOutput extends __MetadataBearer {
|
|
|
90
90
|
* import { KMSClient, UpdatePrimaryRegionCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
91
91
|
* // const { KMSClient, UpdatePrimaryRegionCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
92
92
|
* const client = new KMSClient(config);
|
|
93
|
+
* const input = { // UpdatePrimaryRegionRequest
|
|
94
|
+
* KeyId: "STRING_VALUE", // required
|
|
95
|
+
* PrimaryRegion: "STRING_VALUE", // required
|
|
96
|
+
* };
|
|
93
97
|
* const command = new UpdatePrimaryRegionCommand(input);
|
|
94
98
|
* const response = await client.send(command);
|
|
95
99
|
* ```
|
|
@@ -61,6 +61,16 @@ export interface VerifyCommandOutput extends VerifyResponse, __MetadataBearer {
|
|
|
61
61
|
* import { KMSClient, VerifyCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
62
62
|
* // const { KMSClient, VerifyCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
63
63
|
* const client = new KMSClient(config);
|
|
64
|
+
* const input = { // VerifyRequest
|
|
65
|
+
* KeyId: "STRING_VALUE", // required
|
|
66
|
+
* Message: "BLOB_VALUE", // required
|
|
67
|
+
* MessageType: "RAW" || "DIGEST",
|
|
68
|
+
* Signature: "BLOB_VALUE", // required
|
|
69
|
+
* 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", // required
|
|
70
|
+
* GrantTokens: [ // GrantTokenList
|
|
71
|
+
* "STRING_VALUE",
|
|
72
|
+
* ],
|
|
73
|
+
* };
|
|
64
74
|
* const command = new VerifyCommand(input);
|
|
65
75
|
* const response = await client.send(command);
|
|
66
76
|
* ```
|
|
@@ -46,6 +46,15 @@ export interface VerifyMacCommandOutput extends VerifyMacResponse, __MetadataBea
|
|
|
46
46
|
* import { KMSClient, VerifyMacCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
47
47
|
* // const { KMSClient, VerifyMacCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
48
48
|
* const client = new KMSClient(config);
|
|
49
|
+
* const input = { // VerifyMacRequest
|
|
50
|
+
* Message: "BLOB_VALUE", // required
|
|
51
|
+
* KeyId: "STRING_VALUE", // required
|
|
52
|
+
* MacAlgorithm: "HMAC_SHA_224" || "HMAC_SHA_256" || "HMAC_SHA_384" || "HMAC_SHA_512", // required
|
|
53
|
+
* Mac: "BLOB_VALUE", // required
|
|
54
|
+
* GrantTokens: [ // GrantTokenList
|
|
55
|
+
* "STRING_VALUE",
|
|
56
|
+
* ],
|
|
57
|
+
* };
|
|
49
58
|
* const command = new VerifyMacCommand(input);
|
|
50
59
|
* const response = await client.send(command);
|
|
51
60
|
* ```
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-kms",
|
|
3
3
|
"description": "AWS SDK for JavaScript Kms Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.301.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,9 +21,9 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/config-resolver": "3.
|
|
26
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.301.0",
|
|
25
|
+
"@aws-sdk/config-resolver": "3.300.0",
|
|
26
|
+
"@aws-sdk/credential-provider-node": "3.301.0",
|
|
27
27
|
"@aws-sdk/fetch-http-handler": "3.296.0",
|
|
28
28
|
"@aws-sdk/hash-node": "3.296.0",
|
|
29
29
|
"@aws-sdk/invalid-dependency": "3.296.0",
|
|
@@ -32,12 +32,12 @@
|
|
|
32
32
|
"@aws-sdk/middleware-host-header": "3.296.0",
|
|
33
33
|
"@aws-sdk/middleware-logger": "3.296.0",
|
|
34
34
|
"@aws-sdk/middleware-recursion-detection": "3.296.0",
|
|
35
|
-
"@aws-sdk/middleware-retry": "3.
|
|
35
|
+
"@aws-sdk/middleware-retry": "3.300.0",
|
|
36
36
|
"@aws-sdk/middleware-serde": "3.296.0",
|
|
37
37
|
"@aws-sdk/middleware-signing": "3.299.0",
|
|
38
38
|
"@aws-sdk/middleware-stack": "3.296.0",
|
|
39
39
|
"@aws-sdk/middleware-user-agent": "3.299.0",
|
|
40
|
-
"@aws-sdk/node-config-provider": "3.
|
|
40
|
+
"@aws-sdk/node-config-provider": "3.300.0",
|
|
41
41
|
"@aws-sdk/node-http-handler": "3.296.0",
|
|
42
42
|
"@aws-sdk/protocol-http": "3.296.0",
|
|
43
43
|
"@aws-sdk/smithy-client": "3.296.0",
|
|
@@ -47,11 +47,11 @@
|
|
|
47
47
|
"@aws-sdk/util-body-length-browser": "3.295.0",
|
|
48
48
|
"@aws-sdk/util-body-length-node": "3.295.0",
|
|
49
49
|
"@aws-sdk/util-defaults-mode-browser": "3.296.0",
|
|
50
|
-
"@aws-sdk/util-defaults-mode-node": "3.
|
|
50
|
+
"@aws-sdk/util-defaults-mode-node": "3.300.0",
|
|
51
51
|
"@aws-sdk/util-endpoints": "3.296.0",
|
|
52
52
|
"@aws-sdk/util-retry": "3.296.0",
|
|
53
53
|
"@aws-sdk/util-user-agent-browser": "3.299.0",
|
|
54
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
54
|
+
"@aws-sdk/util-user-agent-node": "3.300.0",
|
|
55
55
|
"@aws-sdk/util-utf8": "3.295.0",
|
|
56
56
|
"tslib": "^2.5.0"
|
|
57
57
|
},
|