@aws-sdk/client-kms 3.36.0 → 3.39.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/CHANGELOG.md +42 -0
- package/dist-cjs/KMS.js +0 -92
- package/dist-cjs/KMSClient.js +0 -97
- package/dist-cjs/commands/CancelKeyDeletionCommand.js +0 -37
- package/dist-cjs/commands/ConnectCustomKeyStoreCommand.js +0 -85
- package/dist-cjs/commands/CreateAliasCommand.js +0 -81
- package/dist-cjs/commands/CreateCustomKeyStoreCommand.js +0 -73
- package/dist-cjs/commands/CreateGrantCommand.js +0 -86
- package/dist-cjs/commands/CreateKeyCommand.js +0 -148
- package/dist-cjs/commands/DecryptCommand.js +0 -112
- package/dist-cjs/commands/DeleteAliasCommand.js +0 -71
- package/dist-cjs/commands/DeleteCustomKeyStoreCommand.js +0 -78
- package/dist-cjs/commands/DeleteImportedKeyMaterialCommand.js +0 -53
- package/dist-cjs/commands/DescribeCustomKeyStoresCommand.js +0 -77
- package/dist-cjs/commands/DescribeKeyCommand.js +0 -103
- package/dist-cjs/commands/DisableKeyCommand.js +0 -39
- package/dist-cjs/commands/DisableKeyRotationCommand.js +0 -49
- package/dist-cjs/commands/DisconnectCustomKeyStoreCommand.js +0 -76
- package/dist-cjs/commands/EnableKeyCommand.js +0 -36
- package/dist-cjs/commands/EnableKeyRotationCommand.js +0 -49
- package/dist-cjs/commands/EncryptCommand.js +0 -148
- package/dist-cjs/commands/GenerateDataKeyCommand.js +0 -121
- package/dist-cjs/commands/GenerateDataKeyPairCommand.js +0 -100
- package/dist-cjs/commands/GenerateDataKeyPairWithoutPlaintextCommand.js +0 -90
- package/dist-cjs/commands/GenerateDataKeyWithoutPlaintextCommand.js +0 -95
- package/dist-cjs/commands/GenerateRandomCommand.js +0 -33
- package/dist-cjs/commands/GetKeyPolicyCommand.js +0 -32
- package/dist-cjs/commands/GetKeyRotationStatusCommand.js +0 -61
- package/dist-cjs/commands/GetParametersForImportCommand.js +0 -58
- package/dist-cjs/commands/GetPublicKeyCommand.js +0 -70
- package/dist-cjs/commands/ImportKeyMaterialCommand.js +0 -87
- package/dist-cjs/commands/ListAliasesCommand.js +0 -66
- package/dist-cjs/commands/ListGrantsCommand.js +0 -69
- package/dist-cjs/commands/ListKeyPoliciesCommand.js +0 -46
- package/dist-cjs/commands/ListKeysCommand.js +0 -54
- package/dist-cjs/commands/ListResourceTagsCommand.js +0 -58
- package/dist-cjs/commands/ListRetirableGrantsCommand.js +0 -67
- package/dist-cjs/commands/PutKeyPolicyCommand.js +0 -37
- package/dist-cjs/commands/ReEncryptCommand.js +0 -122
- package/dist-cjs/commands/ReplicateKeyCommand.js +0 -101
- package/dist-cjs/commands/RetireGrantCommand.js +0 -70
- package/dist-cjs/commands/RevokeGrantCommand.js +0 -67
- package/dist-cjs/commands/ScheduleKeyDeletionCommand.js +0 -78
- package/dist-cjs/commands/SignCommand.js +0 -69
- package/dist-cjs/commands/TagResourceCommand.js +0 -71
- package/dist-cjs/commands/UntagResourceCommand.js +0 -67
- package/dist-cjs/commands/UpdateAliasCommand.js +0 -86
- package/dist-cjs/commands/UpdateCustomKeyStoreCommand.js +0 -96
- package/dist-cjs/commands/UpdateKeyDescriptionCommand.js +0 -47
- package/dist-cjs/commands/UpdatePrimaryRegionCommand.js +0 -89
- package/dist-cjs/commands/VerifyCommand.js +0 -54
- package/dist-cjs/commands/index.js +51 -0
- package/dist-cjs/endpoints.js +6 -1
- package/dist-cjs/index.js +4 -55
- package/dist-cjs/models/models_0.js +0 -366
- package/dist-cjs/pagination/ListAliasesPaginator.js +0 -10
- package/dist-cjs/pagination/ListGrantsPaginator.js +0 -10
- package/dist-cjs/pagination/ListKeyPoliciesPaginator.js +0 -10
- package/dist-cjs/pagination/ListKeysPaginator.js +0 -10
- package/dist-cjs/pagination/index.js +8 -0
- package/dist-cjs/protocols/Aws_json1_1.js +0 -5
- package/dist-cjs/runtimeConfig.browser.js +1 -5
- package/dist-cjs/runtimeConfig.js +1 -5
- package/dist-cjs/runtimeConfig.native.js +0 -3
- package/dist-cjs/runtimeConfig.shared.js +0 -3
- package/dist-es/commands/index.js +48 -0
- package/dist-es/endpoints.js +6 -1
- package/dist-es/index.js +4 -55
- package/dist-es/pagination/index.js +5 -0
- package/dist-types/commands/index.d.ts +48 -0
- package/dist-types/index.d.ts +4 -55
- package/dist-types/pagination/index.d.ts +5 -0
- package/dist-types/ts3.4/KMS.d.ts +49 -2646
- package/dist-types/ts3.4/KMSClient.d.ts +24 -178
- package/dist-types/ts3.4/commands/CancelKeyDeletionCommand.d.ts +2 -33
- package/dist-types/ts3.4/commands/ConnectCustomKeyStoreCommand.d.ts +2 -81
- package/dist-types/ts3.4/commands/CreateAliasCommand.d.ts +2 -77
- package/dist-types/ts3.4/commands/CreateCustomKeyStoreCommand.d.ts +2 -69
- package/dist-types/ts3.4/commands/CreateGrantCommand.d.ts +2 -82
- package/dist-types/ts3.4/commands/CreateKeyCommand.d.ts +2 -144
- package/dist-types/ts3.4/commands/DecryptCommand.d.ts +2 -108
- package/dist-types/ts3.4/commands/DeleteAliasCommand.d.ts +2 -67
- package/dist-types/ts3.4/commands/DeleteCustomKeyStoreCommand.d.ts +2 -74
- package/dist-types/ts3.4/commands/DeleteImportedKeyMaterialCommand.d.ts +2 -49
- package/dist-types/ts3.4/commands/DescribeCustomKeyStoresCommand.d.ts +2 -73
- package/dist-types/ts3.4/commands/DescribeKeyCommand.d.ts +2 -99
- package/dist-types/ts3.4/commands/DisableKeyCommand.d.ts +2 -35
- package/dist-types/ts3.4/commands/DisableKeyRotationCommand.d.ts +2 -45
- package/dist-types/ts3.4/commands/DisconnectCustomKeyStoreCommand.d.ts +2 -72
- package/dist-types/ts3.4/commands/EnableKeyCommand.d.ts +2 -32
- package/dist-types/ts3.4/commands/EnableKeyRotationCommand.d.ts +2 -45
- package/dist-types/ts3.4/commands/EncryptCommand.d.ts +2 -144
- package/dist-types/ts3.4/commands/GenerateDataKeyCommand.d.ts +2 -117
- package/dist-types/ts3.4/commands/GenerateDataKeyPairCommand.d.ts +2 -96
- package/dist-types/ts3.4/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +2 -86
- package/dist-types/ts3.4/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +2 -91
- package/dist-types/ts3.4/commands/GenerateRandomCommand.d.ts +2 -29
- package/dist-types/ts3.4/commands/GetKeyPolicyCommand.d.ts +2 -28
- package/dist-types/ts3.4/commands/GetKeyRotationStatusCommand.d.ts +2 -57
- package/dist-types/ts3.4/commands/GetParametersForImportCommand.d.ts +2 -54
- package/dist-types/ts3.4/commands/GetPublicKeyCommand.d.ts +2 -66
- package/dist-types/ts3.4/commands/ImportKeyMaterialCommand.d.ts +2 -83
- package/dist-types/ts3.4/commands/ListAliasesCommand.d.ts +2 -62
- package/dist-types/ts3.4/commands/ListGrantsCommand.d.ts +2 -65
- package/dist-types/ts3.4/commands/ListKeyPoliciesCommand.d.ts +2 -42
- package/dist-types/ts3.4/commands/ListKeysCommand.d.ts +2 -50
- package/dist-types/ts3.4/commands/ListResourceTagsCommand.d.ts +2 -54
- package/dist-types/ts3.4/commands/ListRetirableGrantsCommand.d.ts +2 -63
- package/dist-types/ts3.4/commands/PutKeyPolicyCommand.d.ts +2 -33
- package/dist-types/ts3.4/commands/ReEncryptCommand.d.ts +2 -118
- package/dist-types/ts3.4/commands/ReplicateKeyCommand.d.ts +2 -97
- package/dist-types/ts3.4/commands/RetireGrantCommand.d.ts +2 -66
- package/dist-types/ts3.4/commands/RevokeGrantCommand.d.ts +2 -63
- package/dist-types/ts3.4/commands/ScheduleKeyDeletionCommand.d.ts +2 -74
- package/dist-types/ts3.4/commands/SignCommand.d.ts +2 -65
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -67
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -63
- package/dist-types/ts3.4/commands/UpdateAliasCommand.d.ts +2 -82
- package/dist-types/ts3.4/commands/UpdateCustomKeyStoreCommand.d.ts +2 -92
- package/dist-types/ts3.4/commands/UpdateKeyDescriptionCommand.d.ts +2 -43
- package/dist-types/ts3.4/commands/UpdatePrimaryRegionCommand.d.ts +2 -85
- package/dist-types/ts3.4/commands/VerifyCommand.d.ts +2 -50
- package/dist-types/ts3.4/commands/index.d.ts +48 -0
- package/dist-types/ts3.4/index.d.ts +4 -55
- package/dist-types/ts3.4/models/models_0.d.ts +445 -2963
- package/dist-types/ts3.4/pagination/index.d.ts +5 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
- package/package.json +32 -32
|
@@ -57,213 +57,59 @@ import { VerifyCommandInput, VerifyCommandOutput } from "./commands/VerifyComman
|
|
|
57
57
|
export declare type ServiceInputTypes = CancelKeyDeletionCommandInput | ConnectCustomKeyStoreCommandInput | CreateAliasCommandInput | CreateCustomKeyStoreCommandInput | CreateGrantCommandInput | CreateKeyCommandInput | DecryptCommandInput | DeleteAliasCommandInput | DeleteCustomKeyStoreCommandInput | DeleteImportedKeyMaterialCommandInput | DescribeCustomKeyStoresCommandInput | DescribeKeyCommandInput | DisableKeyCommandInput | DisableKeyRotationCommandInput | DisconnectCustomKeyStoreCommandInput | EnableKeyCommandInput | EnableKeyRotationCommandInput | EncryptCommandInput | GenerateDataKeyCommandInput | GenerateDataKeyPairCommandInput | GenerateDataKeyPairWithoutPlaintextCommandInput | GenerateDataKeyWithoutPlaintextCommandInput | GenerateRandomCommandInput | GetKeyPolicyCommandInput | GetKeyRotationStatusCommandInput | GetParametersForImportCommandInput | GetPublicKeyCommandInput | ImportKeyMaterialCommandInput | ListAliasesCommandInput | ListGrantsCommandInput | ListKeyPoliciesCommandInput | ListKeysCommandInput | ListResourceTagsCommandInput | ListRetirableGrantsCommandInput | PutKeyPolicyCommandInput | ReEncryptCommandInput | ReplicateKeyCommandInput | RetireGrantCommandInput | RevokeGrantCommandInput | ScheduleKeyDeletionCommandInput | SignCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAliasCommandInput | UpdateCustomKeyStoreCommandInput | UpdateKeyDescriptionCommandInput | UpdatePrimaryRegionCommandInput | VerifyCommandInput;
|
|
58
58
|
export declare type ServiceOutputTypes = CancelKeyDeletionCommandOutput | ConnectCustomKeyStoreCommandOutput | CreateAliasCommandOutput | CreateCustomKeyStoreCommandOutput | CreateGrantCommandOutput | CreateKeyCommandOutput | DecryptCommandOutput | DeleteAliasCommandOutput | DeleteCustomKeyStoreCommandOutput | DeleteImportedKeyMaterialCommandOutput | DescribeCustomKeyStoresCommandOutput | DescribeKeyCommandOutput | DisableKeyCommandOutput | DisableKeyRotationCommandOutput | DisconnectCustomKeyStoreCommandOutput | EnableKeyCommandOutput | EnableKeyRotationCommandOutput | EncryptCommandOutput | GenerateDataKeyCommandOutput | GenerateDataKeyPairCommandOutput | GenerateDataKeyPairWithoutPlaintextCommandOutput | GenerateDataKeyWithoutPlaintextCommandOutput | GenerateRandomCommandOutput | GetKeyPolicyCommandOutput | GetKeyRotationStatusCommandOutput | GetParametersForImportCommandOutput | GetPublicKeyCommandOutput | ImportKeyMaterialCommandOutput | ListAliasesCommandOutput | ListGrantsCommandOutput | ListKeyPoliciesCommandOutput | ListKeysCommandOutput | ListResourceTagsCommandOutput | ListRetirableGrantsCommandOutput | PutKeyPolicyCommandOutput | ReEncryptCommandOutput | ReplicateKeyCommandOutput | RetireGrantCommandOutput | RevokeGrantCommandOutput | ScheduleKeyDeletionCommandOutput | SignCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAliasCommandOutput | UpdateCustomKeyStoreCommandOutput | UpdateKeyDescriptionCommandOutput | UpdatePrimaryRegionCommandOutput | VerifyCommandOutput;
|
|
59
59
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
60
|
-
|
|
61
|
-
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
62
|
-
*/
|
|
60
|
+
|
|
63
61
|
requestHandler?: __HttpHandler;
|
|
64
|
-
|
|
65
|
-
* A constructor for a class implementing the {@link __Hash} interface
|
|
66
|
-
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
|
|
67
|
-
* @internal
|
|
68
|
-
*/
|
|
62
|
+
|
|
69
63
|
sha256?: __HashConstructor;
|
|
70
|
-
|
|
71
|
-
* The function that will be used to convert strings into HTTP endpoints.
|
|
72
|
-
* @internal
|
|
73
|
-
*/
|
|
64
|
+
|
|
74
65
|
urlParser?: __UrlParser;
|
|
75
|
-
|
|
76
|
-
* A function that can calculate the length of a request body.
|
|
77
|
-
* @internal
|
|
78
|
-
*/
|
|
66
|
+
|
|
79
67
|
bodyLengthChecker?: (body: any) => number | undefined;
|
|
80
|
-
|
|
81
|
-
* A function that converts a stream into an array of bytes.
|
|
82
|
-
* @internal
|
|
83
|
-
*/
|
|
68
|
+
|
|
84
69
|
streamCollector?: __StreamCollector;
|
|
85
|
-
|
|
86
|
-
* The function that will be used to convert a base64-encoded string to a byte array.
|
|
87
|
-
* @internal
|
|
88
|
-
*/
|
|
70
|
+
|
|
89
71
|
base64Decoder?: __Decoder;
|
|
90
|
-
|
|
91
|
-
* The function that will be used to convert binary data to a base64-encoded string.
|
|
92
|
-
* @internal
|
|
93
|
-
*/
|
|
72
|
+
|
|
94
73
|
base64Encoder?: __Encoder;
|
|
95
|
-
|
|
96
|
-
* The function that will be used to convert a UTF8-encoded string to a byte array.
|
|
97
|
-
* @internal
|
|
98
|
-
*/
|
|
74
|
+
|
|
99
75
|
utf8Decoder?: __Decoder;
|
|
100
|
-
|
|
101
|
-
* The function that will be used to convert binary data to a UTF-8 encoded string.
|
|
102
|
-
* @internal
|
|
103
|
-
*/
|
|
76
|
+
|
|
104
77
|
utf8Encoder?: __Encoder;
|
|
105
|
-
|
|
106
|
-
* The runtime environment.
|
|
107
|
-
* @internal
|
|
108
|
-
*/
|
|
78
|
+
|
|
109
79
|
runtime?: string;
|
|
110
|
-
|
|
111
|
-
* Disable dyanamically changing the endpoint of the client based on the hostPrefix
|
|
112
|
-
* trait of an operation.
|
|
113
|
-
*/
|
|
80
|
+
|
|
114
81
|
disableHostPrefix?: boolean;
|
|
115
|
-
|
|
116
|
-
* Value for how many times a request will be made at most in case of retry.
|
|
117
|
-
*/
|
|
82
|
+
|
|
118
83
|
maxAttempts?: number | __Provider<number>;
|
|
119
|
-
|
|
120
|
-
* Specifies which retry algorithm to use.
|
|
121
|
-
*/
|
|
84
|
+
|
|
122
85
|
retryMode?: string | __Provider<string>;
|
|
123
|
-
|
|
124
|
-
* Optional logger for logging debug/info/warn/error.
|
|
125
|
-
*/
|
|
86
|
+
|
|
126
87
|
logger?: __Logger;
|
|
127
|
-
|
|
128
|
-
* Unique service identifier.
|
|
129
|
-
* @internal
|
|
130
|
-
*/
|
|
88
|
+
|
|
131
89
|
serviceId?: string;
|
|
132
|
-
|
|
133
|
-
* The AWS region to which this client will send requests
|
|
134
|
-
*/
|
|
90
|
+
|
|
135
91
|
region?: string | __Provider<string>;
|
|
136
|
-
|
|
137
|
-
* Default credentials provider; Not available in browser runtime.
|
|
138
|
-
* @internal
|
|
139
|
-
*/
|
|
92
|
+
|
|
140
93
|
credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
|
|
141
|
-
|
|
142
|
-
* Fetch related hostname, signing name or signing region with given region.
|
|
143
|
-
* @internal
|
|
144
|
-
*/
|
|
94
|
+
|
|
145
95
|
regionInfoProvider?: RegionInfoProvider;
|
|
146
|
-
|
|
147
|
-
* The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
|
|
148
|
-
* @internal
|
|
149
|
-
*/
|
|
96
|
+
|
|
150
97
|
defaultUserAgentProvider?: Provider<__UserAgent>;
|
|
151
98
|
}
|
|
152
99
|
declare type KMSClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointsInputConfig & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig;
|
|
153
|
-
|
|
154
|
-
* The configuration interface of KMSClient class constructor that set the region, credentials and other options.
|
|
155
|
-
*/
|
|
100
|
+
|
|
156
101
|
export interface KMSClientConfig extends KMSClientConfigType {
|
|
157
102
|
}
|
|
158
103
|
declare type KMSClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointsResolvedConfig & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig;
|
|
159
|
-
|
|
160
|
-
* The resolved configuration interface of KMSClient class. This is resolved and normalized from the {@link KMSClientConfig | constructor configuration interface}.
|
|
161
|
-
*/
|
|
104
|
+
|
|
162
105
|
export interface KMSClientResolvedConfig extends KMSClientResolvedConfigType {
|
|
163
106
|
}
|
|
164
|
-
|
|
165
|
-
* <fullname>Key Management Service</fullname>
|
|
166
|
-
* <p>Key Management Service (KMS) is an encryption and key management web service. This guide describes
|
|
167
|
-
* the KMS operations that you can call programmatically. For general information about KMS,
|
|
168
|
-
* see the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/">
|
|
169
|
-
* <i>Key Management Service Developer Guide</i>
|
|
170
|
-
* </a>.</p>
|
|
171
|
-
* <note>
|
|
172
|
-
* <p>KMS is replacing the term <i>customer master key (CMK)</i> with <i>KMS key</i> and <i>KMS key</i>. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.</p>
|
|
173
|
-
* <p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming
|
|
174
|
-
* languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a
|
|
175
|
-
* convenient way to create programmatic access to KMS and other Amazon Web Services services. For example,
|
|
176
|
-
* the SDKs take care of tasks such as signing requests (see below), managing errors, and
|
|
177
|
-
* retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to
|
|
178
|
-
* download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web
|
|
179
|
-
* Services</a>.</p>
|
|
180
|
-
* </note>
|
|
181
|
-
* <p>We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.</p>
|
|
182
|
-
* <p>Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients
|
|
183
|
-
* must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral
|
|
184
|
-
* Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems
|
|
185
|
-
* such as Java 7 and later support these modes.</p>
|
|
186
|
-
* <p>
|
|
187
|
-
* <b>Signing Requests</b>
|
|
188
|
-
* </p>
|
|
189
|
-
* <p>Requests must be signed by using an access key ID and a secret access key. We strongly
|
|
190
|
-
* recommend that you <i>do not</i> use your Amazon Web Services account (root) access key ID and
|
|
191
|
-
* secret key for everyday work with KMS. Instead, use the access key ID and secret access key
|
|
192
|
-
* for an IAM user. You can also use the Amazon Web Services Security Token Service to generate temporary
|
|
193
|
-
* security credentials that you can use to sign requests.</p>
|
|
194
|
-
* <p>All KMS operations require <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p>
|
|
195
|
-
* <p>
|
|
196
|
-
* <b>Logging API Requests</b>
|
|
197
|
-
* </p>
|
|
198
|
-
* <p>KMS supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your
|
|
199
|
-
* Amazon Web Services account and delivers them to an Amazon S3 bucket that you specify. By using the
|
|
200
|
-
* information collected by CloudTrail, you can determine what requests were made to KMS, who made
|
|
201
|
-
* the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it
|
|
202
|
-
* on and find your log files, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/">CloudTrail User Guide</a>.</p>
|
|
203
|
-
* <p>
|
|
204
|
-
* <b>Additional Resources</b>
|
|
205
|
-
* </p>
|
|
206
|
-
* <p>For more information about credentials and request signing, see the following:</p>
|
|
207
|
-
* <ul>
|
|
208
|
-
* <li>
|
|
209
|
-
* <p>
|
|
210
|
-
* <a href="https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html">Amazon Web Services
|
|
211
|
-
* Security Credentials</a> - This topic provides general information about the types
|
|
212
|
-
* of credentials used to access Amazon Web Services.</p>
|
|
213
|
-
* </li>
|
|
214
|
-
* <li>
|
|
215
|
-
* <p>
|
|
216
|
-
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html">Temporary
|
|
217
|
-
* Security Credentials</a> - This section of the <i>IAM User Guide</i>
|
|
218
|
-
* describes how to create and use temporary security credentials.</p>
|
|
219
|
-
* </li>
|
|
220
|
-
* <li>
|
|
221
|
-
* <p>
|
|
222
|
-
* <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version
|
|
223
|
-
* 4 Signing Process</a> - This set of topics walks you through the process of signing
|
|
224
|
-
* a request using an access key ID and a secret access key.</p>
|
|
225
|
-
* </li>
|
|
226
|
-
* </ul>
|
|
227
|
-
* <p>
|
|
228
|
-
* <b>Commonly Used API Operations</b>
|
|
229
|
-
* </p>
|
|
230
|
-
* <p>Of the API operations discussed in this guide, the following will prove the most useful
|
|
231
|
-
* for most applications. You will likely perform operations other than these, such as creating
|
|
232
|
-
* keys and assigning policies, by using the console.</p>
|
|
233
|
-
* <ul>
|
|
234
|
-
* <li>
|
|
235
|
-
* <p>
|
|
236
|
-
* <a>Encrypt</a>
|
|
237
|
-
* </p>
|
|
238
|
-
* </li>
|
|
239
|
-
* <li>
|
|
240
|
-
* <p>
|
|
241
|
-
* <a>Decrypt</a>
|
|
242
|
-
* </p>
|
|
243
|
-
* </li>
|
|
244
|
-
* <li>
|
|
245
|
-
* <p>
|
|
246
|
-
* <a>GenerateDataKey</a>
|
|
247
|
-
* </p>
|
|
248
|
-
* </li>
|
|
249
|
-
* <li>
|
|
250
|
-
* <p>
|
|
251
|
-
* <a>GenerateDataKeyWithoutPlaintext</a>
|
|
252
|
-
* </p>
|
|
253
|
-
* </li>
|
|
254
|
-
* </ul>
|
|
255
|
-
*/
|
|
107
|
+
|
|
256
108
|
export declare class KMSClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, KMSClientResolvedConfig> {
|
|
257
|
-
|
|
258
|
-
* The resolved configuration of KMSClient class. This is resolved and normalized from the {@link KMSClientConfig | constructor configuration interface}.
|
|
259
|
-
*/
|
|
109
|
+
|
|
260
110
|
readonly config: KMSClientResolvedConfig;
|
|
261
111
|
constructor(configuration: KMSClientConfig);
|
|
262
|
-
|
|
263
|
-
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
|
|
264
|
-
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
|
|
265
|
-
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
|
|
266
|
-
*/
|
|
112
|
+
|
|
267
113
|
destroy(): void;
|
|
268
114
|
}
|
|
269
115
|
export {};
|
|
@@ -6,42 +6,11 @@ export interface CancelKeyDeletionCommandInput extends CancelKeyDeletionRequest
|
|
|
6
6
|
}
|
|
7
7
|
export interface CancelKeyDeletionCommandOutput extends CancelKeyDeletionResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Cancels the deletion of a KMS key. When this operation succeeds, the key state of the KMS
|
|
11
|
-
* key is <code>Disabled</code>. To enable the KMS key, use <a>EnableKey</a>. </p>
|
|
12
|
-
* <p>For more information about scheduling and canceling deletion of a KMS key, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting KMS keys</a> in the
|
|
13
|
-
* <i>Key Management Service Developer Guide</i>.</p>
|
|
14
|
-
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
15
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
16
|
-
* <p>
|
|
17
|
-
* <b>Cross-account
|
|
18
|
-
* use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
19
|
-
* <p>
|
|
20
|
-
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CancelKeyDeletion</a> (key policy)</p>
|
|
21
|
-
* <p>
|
|
22
|
-
* <b>Related operations</b>: <a>ScheduleKeyDeletion</a>
|
|
23
|
-
* </p>
|
|
24
|
-
* @example
|
|
25
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
26
|
-
* ```javascript
|
|
27
|
-
* import { KMSClient, CancelKeyDeletionCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
28
|
-
* // const { KMSClient, CancelKeyDeletionCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
29
|
-
* const client = new KMSClient(config);
|
|
30
|
-
* const command = new CancelKeyDeletionCommand(input);
|
|
31
|
-
* const response = await client.send(command);
|
|
32
|
-
* ```
|
|
33
|
-
*
|
|
34
|
-
* @see {@link CancelKeyDeletionCommandInput} for command's `input` shape.
|
|
35
|
-
* @see {@link CancelKeyDeletionCommandOutput} for command's `response` shape.
|
|
36
|
-
* @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
|
|
37
|
-
*
|
|
38
|
-
*/
|
|
9
|
+
|
|
39
10
|
export declare class CancelKeyDeletionCommand extends $Command<CancelKeyDeletionCommandInput, CancelKeyDeletionCommandOutput, KMSClientResolvedConfig> {
|
|
40
11
|
readonly input: CancelKeyDeletionCommandInput;
|
|
41
12
|
constructor(input: CancelKeyDeletionCommandInput);
|
|
42
|
-
|
|
43
|
-
* @internal
|
|
44
|
-
*/
|
|
13
|
+
|
|
45
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CancelKeyDeletionCommandInput, CancelKeyDeletionCommandOutput>;
|
|
46
15
|
private serialize;
|
|
47
16
|
private deserialize;
|
|
@@ -6,90 +6,11 @@ export interface ConnectCustomKeyStoreCommandInput extends ConnectCustomKeyStore
|
|
|
6
6
|
}
|
|
7
7
|
export interface ConnectCustomKeyStoreCommandOutput extends ConnectCustomKeyStoreResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Connects or reconnects a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> to its associated CloudHSM cluster.</p>
|
|
11
|
-
* <p>The custom key store must be connected before you can create KMS keys in the key store or
|
|
12
|
-
* use the KMS keys it contains. You can disconnect and reconnect a custom key store at any
|
|
13
|
-
* time.</p>
|
|
14
|
-
* <p>To connect a custom key store, its associated CloudHSM cluster must have at least one active
|
|
15
|
-
* HSM. To get the number of active HSMs in a cluster, use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html">DescribeClusters</a> operation. To add HSMs
|
|
16
|
-
* to the cluster, use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html">CreateHsm</a> operation. Also, the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser">
|
|
17
|
-
* <code>kmsuser</code> crypto
|
|
18
|
-
* user</a> (CU) must not be logged into the cluster. This prevents KMS from using this
|
|
19
|
-
* account to log in.</p>
|
|
20
|
-
* <p>The connection process can take an extended amount of time to complete; up to 20 minutes.
|
|
21
|
-
* This operation starts the connection process, but it does not wait for it to complete. When it
|
|
22
|
-
* succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no
|
|
23
|
-
* properties. However, this response does not indicate that the custom key store is connected.
|
|
24
|
-
* To get the connection state of the custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p>
|
|
25
|
-
* <p>During the connection process, KMS finds the CloudHSM cluster that is associated with the
|
|
26
|
-
* custom key store, creates the connection infrastructure, connects to the cluster, logs into
|
|
27
|
-
* the CloudHSM client as the <code>kmsuser</code> CU, and rotates its password.</p>
|
|
28
|
-
* <p>The <code>ConnectCustomKeyStore</code> operation might fail for various reasons. To find
|
|
29
|
-
* the reason, use the <a>DescribeCustomKeyStores</a> operation and see the
|
|
30
|
-
* <code>ConnectionErrorCode</code> in the response. For help interpreting the
|
|
31
|
-
* <code>ConnectionErrorCode</code>, see <a>CustomKeyStoresListEntry</a>.</p>
|
|
32
|
-
* <p>To fix the failure, use the <a>DisconnectCustomKeyStore</a> operation to
|
|
33
|
-
* disconnect the custom key store, correct the error, use the <a>UpdateCustomKeyStore</a> operation if necessary, and then use
|
|
34
|
-
* <code>ConnectCustomKeyStore</code> again.</p>
|
|
35
|
-
* <p>If you are having trouble connecting or disconnecting a custom key store, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html">Troubleshooting a Custom Key
|
|
36
|
-
* Store</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
37
|
-
* <p>
|
|
38
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
39
|
-
*
|
|
40
|
-
* <p>
|
|
41
|
-
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ConnectCustomKeyStore</a> (IAM policy)</p>
|
|
42
|
-
* <p>
|
|
43
|
-
* <b>Related operations</b>
|
|
44
|
-
* </p>
|
|
45
|
-
* <ul>
|
|
46
|
-
* <li>
|
|
47
|
-
* <p>
|
|
48
|
-
* <a>CreateCustomKeyStore</a>
|
|
49
|
-
* </p>
|
|
50
|
-
* </li>
|
|
51
|
-
* <li>
|
|
52
|
-
* <p>
|
|
53
|
-
* <a>DeleteCustomKeyStore</a>
|
|
54
|
-
* </p>
|
|
55
|
-
* </li>
|
|
56
|
-
* <li>
|
|
57
|
-
* <p>
|
|
58
|
-
* <a>DescribeCustomKeyStores</a>
|
|
59
|
-
* </p>
|
|
60
|
-
* </li>
|
|
61
|
-
* <li>
|
|
62
|
-
* <p>
|
|
63
|
-
* <a>DisconnectCustomKeyStore</a>
|
|
64
|
-
* </p>
|
|
65
|
-
* </li>
|
|
66
|
-
* <li>
|
|
67
|
-
* <p>
|
|
68
|
-
* <a>UpdateCustomKeyStore</a>
|
|
69
|
-
* </p>
|
|
70
|
-
* </li>
|
|
71
|
-
* </ul>
|
|
72
|
-
* @example
|
|
73
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
74
|
-
* ```javascript
|
|
75
|
-
* import { KMSClient, ConnectCustomKeyStoreCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
76
|
-
* // const { KMSClient, ConnectCustomKeyStoreCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
77
|
-
* const client = new KMSClient(config);
|
|
78
|
-
* const command = new ConnectCustomKeyStoreCommand(input);
|
|
79
|
-
* const response = await client.send(command);
|
|
80
|
-
* ```
|
|
81
|
-
*
|
|
82
|
-
* @see {@link ConnectCustomKeyStoreCommandInput} for command's `input` shape.
|
|
83
|
-
* @see {@link ConnectCustomKeyStoreCommandOutput} for command's `response` shape.
|
|
84
|
-
* @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
|
|
85
|
-
*
|
|
86
|
-
*/
|
|
9
|
+
|
|
87
10
|
export declare class ConnectCustomKeyStoreCommand extends $Command<ConnectCustomKeyStoreCommandInput, ConnectCustomKeyStoreCommandOutput, KMSClientResolvedConfig> {
|
|
88
11
|
readonly input: ConnectCustomKeyStoreCommandInput;
|
|
89
12
|
constructor(input: ConnectCustomKeyStoreCommandInput);
|
|
90
|
-
|
|
91
|
-
* @internal
|
|
92
|
-
*/
|
|
13
|
+
|
|
93
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ConnectCustomKeyStoreCommandInput, ConnectCustomKeyStoreCommandOutput>;
|
|
94
15
|
private serialize;
|
|
95
16
|
private deserialize;
|
|
@@ -6,86 +6,11 @@ export interface CreateAliasCommandInput extends CreateAliasRequest {
|
|
|
6
6
|
}
|
|
7
7
|
export interface CreateAliasCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Creates a friendly name for a KMS key. </p>
|
|
11
|
-
* <note>
|
|
12
|
-
* <p>Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">Using ABAC in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
13
|
-
* </note>
|
|
14
|
-
* <p>You can use an alias to identify a KMS key in the KMS console, in the <a>DescribeKey</a> operation and in <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>, such as <a>Encrypt</a> and
|
|
15
|
-
* <a>GenerateDataKey</a>. You can also change the KMS key that's associated with
|
|
16
|
-
* the alias (<a>UpdateAlias</a>) or delete the alias (<a>DeleteAlias</a>)
|
|
17
|
-
* at any time. These operations don't affect the underlying KMS key. </p>
|
|
18
|
-
* <p>You can associate the alias with any customer managed key in the same Amazon Web Services Region. Each
|
|
19
|
-
* alias is associated with only one KMS key at a time, but a KMS key can have multiple aliases.
|
|
20
|
-
* A valid KMS key is required. You can't create an alias without a KMS key.</p>
|
|
21
|
-
* <p>The alias must be unique in the account and Region, but you can have aliases with the same
|
|
22
|
-
* name in different Regions. For detailed information about aliases, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html">Using aliases</a> in the
|
|
23
|
-
* <i>Key Management Service Developer Guide</i>.</p>
|
|
24
|
-
* <p>This operation does not return a response. To get the alias that you created, use the
|
|
25
|
-
* <a>ListAliases</a> operation.</p>
|
|
26
|
-
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
27
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
28
|
-
* <p>
|
|
29
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on an alias in a different Amazon Web Services account.</p>
|
|
30
|
-
*
|
|
31
|
-
* <p>
|
|
32
|
-
* <b>Required permissions</b>
|
|
33
|
-
* </p>
|
|
34
|
-
* <ul>
|
|
35
|
-
* <li>
|
|
36
|
-
* <p>
|
|
37
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateAlias</a> on
|
|
38
|
-
* the alias (IAM policy).</p>
|
|
39
|
-
* </li>
|
|
40
|
-
* <li>
|
|
41
|
-
* <p>
|
|
42
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateAlias</a> on
|
|
43
|
-
* the KMS key (key policy).</p>
|
|
44
|
-
* </li>
|
|
45
|
-
* </ul>
|
|
46
|
-
* <p>For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access">Controlling access to aliases</a> in the
|
|
47
|
-
* <i>Key Management Service Developer Guide</i>.</p>
|
|
48
|
-
* <p>
|
|
49
|
-
* <b>Related operations:</b>
|
|
50
|
-
* </p>
|
|
51
|
-
* <ul>
|
|
52
|
-
* <li>
|
|
53
|
-
* <p>
|
|
54
|
-
* <a>DeleteAlias</a>
|
|
55
|
-
* </p>
|
|
56
|
-
* </li>
|
|
57
|
-
* <li>
|
|
58
|
-
* <p>
|
|
59
|
-
* <a>ListAliases</a>
|
|
60
|
-
* </p>
|
|
61
|
-
* </li>
|
|
62
|
-
* <li>
|
|
63
|
-
* <p>
|
|
64
|
-
* <a>UpdateAlias</a>
|
|
65
|
-
* </p>
|
|
66
|
-
* </li>
|
|
67
|
-
* </ul>
|
|
68
|
-
* @example
|
|
69
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
70
|
-
* ```javascript
|
|
71
|
-
* import { KMSClient, CreateAliasCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
72
|
-
* // const { KMSClient, CreateAliasCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
73
|
-
* const client = new KMSClient(config);
|
|
74
|
-
* const command = new CreateAliasCommand(input);
|
|
75
|
-
* const response = await client.send(command);
|
|
76
|
-
* ```
|
|
77
|
-
*
|
|
78
|
-
* @see {@link CreateAliasCommandInput} for command's `input` shape.
|
|
79
|
-
* @see {@link CreateAliasCommandOutput} for command's `response` shape.
|
|
80
|
-
* @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
|
|
81
|
-
*
|
|
82
|
-
*/
|
|
9
|
+
|
|
83
10
|
export declare class CreateAliasCommand extends $Command<CreateAliasCommandInput, CreateAliasCommandOutput, KMSClientResolvedConfig> {
|
|
84
11
|
readonly input: CreateAliasCommandInput;
|
|
85
12
|
constructor(input: CreateAliasCommandInput);
|
|
86
|
-
|
|
87
|
-
* @internal
|
|
88
|
-
*/
|
|
13
|
+
|
|
89
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAliasCommandInput, CreateAliasCommandOutput>;
|
|
90
15
|
private serialize;
|
|
91
16
|
private deserialize;
|
|
@@ -6,78 +6,11 @@ export interface CreateCustomKeyStoreCommandInput extends CreateCustomKeyStoreRe
|
|
|
6
6
|
}
|
|
7
7
|
export interface CreateCustomKeyStoreCommandOutput extends CreateCustomKeyStoreResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Creates a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> that is associated with an <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/clusters.html">CloudHSM cluster</a> that you own and
|
|
11
|
-
* manage.</p>
|
|
12
|
-
* <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Custom Key Store feature</a> feature in KMS, which
|
|
13
|
-
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
14
|
-
* single-tenant key store.</p>
|
|
15
|
-
* <p>Before you create the custom key store, you must assemble
|
|
16
|
-
* the required elements, including an CloudHSM cluster that fulfills the requirements for a custom
|
|
17
|
-
* key store. For details about the required elements, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore">Assemble the Prerequisites</a>
|
|
18
|
-
* in the <i>Key Management Service Developer Guide</i>.</p>
|
|
19
|
-
* <p>When the operation completes successfully, it returns the ID of the new custom key store.
|
|
20
|
-
* Before you can use your new custom key store, you need to use the <a>ConnectCustomKeyStore</a> operation to connect the new key store to its CloudHSM
|
|
21
|
-
* cluster. Even if you are not going to use your custom key store immediately, you might want to
|
|
22
|
-
* connect it to verify that all settings are correct and then disconnect it until you are ready
|
|
23
|
-
* to use it.</p>
|
|
24
|
-
* <p>For help with failures, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html">Troubleshooting a Custom Key Store</a> in the
|
|
25
|
-
* <i>Key Management Service Developer Guide</i>.</p>
|
|
26
|
-
* <p>
|
|
27
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
28
|
-
* <p>
|
|
29
|
-
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateCustomKeyStore</a> (IAM policy).</p>
|
|
30
|
-
* <p>
|
|
31
|
-
* <b>Related operations:</b>
|
|
32
|
-
* </p>
|
|
33
|
-
* <ul>
|
|
34
|
-
* <li>
|
|
35
|
-
* <p>
|
|
36
|
-
* <a>ConnectCustomKeyStore</a>
|
|
37
|
-
* </p>
|
|
38
|
-
* </li>
|
|
39
|
-
* <li>
|
|
40
|
-
* <p>
|
|
41
|
-
* <a>DeleteCustomKeyStore</a>
|
|
42
|
-
* </p>
|
|
43
|
-
* </li>
|
|
44
|
-
* <li>
|
|
45
|
-
* <p>
|
|
46
|
-
* <a>DescribeCustomKeyStores</a>
|
|
47
|
-
* </p>
|
|
48
|
-
* </li>
|
|
49
|
-
* <li>
|
|
50
|
-
* <p>
|
|
51
|
-
* <a>DisconnectCustomKeyStore</a>
|
|
52
|
-
* </p>
|
|
53
|
-
* </li>
|
|
54
|
-
* <li>
|
|
55
|
-
* <p>
|
|
56
|
-
* <a>UpdateCustomKeyStore</a>
|
|
57
|
-
* </p>
|
|
58
|
-
* </li>
|
|
59
|
-
* </ul>
|
|
60
|
-
* @example
|
|
61
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
62
|
-
* ```javascript
|
|
63
|
-
* import { KMSClient, CreateCustomKeyStoreCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
64
|
-
* // const { KMSClient, CreateCustomKeyStoreCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
65
|
-
* const client = new KMSClient(config);
|
|
66
|
-
* const command = new CreateCustomKeyStoreCommand(input);
|
|
67
|
-
* const response = await client.send(command);
|
|
68
|
-
* ```
|
|
69
|
-
*
|
|
70
|
-
* @see {@link CreateCustomKeyStoreCommandInput} for command's `input` shape.
|
|
71
|
-
* @see {@link CreateCustomKeyStoreCommandOutput} for command's `response` shape.
|
|
72
|
-
* @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
|
|
73
|
-
*
|
|
74
|
-
*/
|
|
9
|
+
|
|
75
10
|
export declare class CreateCustomKeyStoreCommand extends $Command<CreateCustomKeyStoreCommandInput, CreateCustomKeyStoreCommandOutput, KMSClientResolvedConfig> {
|
|
76
11
|
readonly input: CreateCustomKeyStoreCommandInput;
|
|
77
12
|
constructor(input: CreateCustomKeyStoreCommandInput);
|
|
78
|
-
|
|
79
|
-
* @internal
|
|
80
|
-
*/
|
|
13
|
+
|
|
81
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateCustomKeyStoreCommandInput, CreateCustomKeyStoreCommandOutput>;
|
|
82
15
|
private serialize;
|
|
83
16
|
private deserialize;
|
|
@@ -6,91 +6,11 @@ export interface CreateGrantCommandInput extends CreateGrantRequest {
|
|
|
6
6
|
}
|
|
7
7
|
export interface CreateGrantCommandOutput extends CreateGrantResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Adds a grant to a KMS key. </p>
|
|
11
|
-
* <p>A <i>grant</i> is a policy instrument that allows Amazon Web Services principals to use
|
|
12
|
-
* KMS keys in cryptographic operations. It also can allow them to view a KMS key (<a>DescribeKey</a>) and create and manage grants. When authorizing access to a KMS key,
|
|
13
|
-
* grants are considered along with key policies and IAM policies. Grants are often used for
|
|
14
|
-
* temporary permissions because you can create one, use its permissions, and delete it without
|
|
15
|
-
* changing your key policies or IAM policies. </p>
|
|
16
|
-
* <p>For detailed information about grants, including grant terminology, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Using grants</a> in the
|
|
17
|
-
* <i>
|
|
18
|
-
* <i>Key Management Service Developer Guide</i>
|
|
19
|
-
* </i>. For examples of working with grants in several
|
|
20
|
-
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a>. </p>
|
|
21
|
-
* <p>The <code>CreateGrant</code> operation returns a <code>GrantToken</code> and a
|
|
22
|
-
* <code>GrantId</code>.</p>
|
|
23
|
-
* <ul>
|
|
24
|
-
* <li>
|
|
25
|
-
* <p>When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as <i>eventual consistency</i>. Once the grant has achieved eventual consistency, the grantee
|
|
26
|
-
* principal can use the permissions in the grant without identifying the grant. </p>
|
|
27
|
-
* <p>However, to use the permissions in the grant immediately, use the
|
|
28
|
-
* <code>GrantToken</code> that <code>CreateGrant</code> returns. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a
|
|
29
|
-
* grant token</a> in the <i>
|
|
30
|
-
* <i>Key Management Service Developer Guide</i>
|
|
31
|
-
* </i>.</p>
|
|
32
|
-
* </li>
|
|
33
|
-
* <li>
|
|
34
|
-
* <p>The <code>CreateGrant</code> operation also returns a <code>GrantId</code>. You can
|
|
35
|
-
* use the <code>GrantId</code> and a key identifier to identify the grant in the <a>RetireGrant</a> and <a>RevokeGrant</a> operations. To find the grant
|
|
36
|
-
* ID, use the <a>ListGrants</a> or <a>ListRetirableGrants</a>
|
|
37
|
-
* operations.</p>
|
|
38
|
-
* </li>
|
|
39
|
-
* </ul>
|
|
40
|
-
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
41
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
42
|
-
* <p>
|
|
43
|
-
* <b>Cross-account use</b>: Yes.
|
|
44
|
-
* To perform this operation on a KMS key in a different Amazon Web Services account, specify the key
|
|
45
|
-
* ARN in the value of the <code>KeyId</code> parameter. </p>
|
|
46
|
-
* <p>
|
|
47
|
-
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateGrant</a> (key policy)</p>
|
|
48
|
-
* <p>
|
|
49
|
-
* <b>Related operations:</b>
|
|
50
|
-
* </p>
|
|
51
|
-
* <ul>
|
|
52
|
-
* <li>
|
|
53
|
-
* <p>
|
|
54
|
-
* <a>ListGrants</a>
|
|
55
|
-
* </p>
|
|
56
|
-
* </li>
|
|
57
|
-
* <li>
|
|
58
|
-
* <p>
|
|
59
|
-
* <a>ListRetirableGrants</a>
|
|
60
|
-
* </p>
|
|
61
|
-
* </li>
|
|
62
|
-
* <li>
|
|
63
|
-
* <p>
|
|
64
|
-
* <a>RetireGrant</a>
|
|
65
|
-
* </p>
|
|
66
|
-
* </li>
|
|
67
|
-
* <li>
|
|
68
|
-
* <p>
|
|
69
|
-
* <a>RevokeGrant</a>
|
|
70
|
-
* </p>
|
|
71
|
-
* </li>
|
|
72
|
-
* </ul>
|
|
73
|
-
* @example
|
|
74
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
75
|
-
* ```javascript
|
|
76
|
-
* import { KMSClient, CreateGrantCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
77
|
-
* // const { KMSClient, CreateGrantCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
78
|
-
* const client = new KMSClient(config);
|
|
79
|
-
* const command = new CreateGrantCommand(input);
|
|
80
|
-
* const response = await client.send(command);
|
|
81
|
-
* ```
|
|
82
|
-
*
|
|
83
|
-
* @see {@link CreateGrantCommandInput} for command's `input` shape.
|
|
84
|
-
* @see {@link CreateGrantCommandOutput} for command's `response` shape.
|
|
85
|
-
* @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
|
|
86
|
-
*
|
|
87
|
-
*/
|
|
9
|
+
|
|
88
10
|
export declare class CreateGrantCommand extends $Command<CreateGrantCommandInput, CreateGrantCommandOutput, KMSClientResolvedConfig> {
|
|
89
11
|
readonly input: CreateGrantCommandInput;
|
|
90
12
|
constructor(input: CreateGrantCommandInput);
|
|
91
|
-
|
|
92
|
-
* @internal
|
|
93
|
-
*/
|
|
13
|
+
|
|
94
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateGrantCommandInput, CreateGrantCommandOutput>;
|
|
95
15
|
private serialize;
|
|
96
16
|
private deserialize;
|