@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.
Files changed (131) hide show
  1. package/CHANGELOG.md +42 -0
  2. package/dist-cjs/KMS.js +0 -92
  3. package/dist-cjs/KMSClient.js +0 -97
  4. package/dist-cjs/commands/CancelKeyDeletionCommand.js +0 -37
  5. package/dist-cjs/commands/ConnectCustomKeyStoreCommand.js +0 -85
  6. package/dist-cjs/commands/CreateAliasCommand.js +0 -81
  7. package/dist-cjs/commands/CreateCustomKeyStoreCommand.js +0 -73
  8. package/dist-cjs/commands/CreateGrantCommand.js +0 -86
  9. package/dist-cjs/commands/CreateKeyCommand.js +0 -148
  10. package/dist-cjs/commands/DecryptCommand.js +0 -112
  11. package/dist-cjs/commands/DeleteAliasCommand.js +0 -71
  12. package/dist-cjs/commands/DeleteCustomKeyStoreCommand.js +0 -78
  13. package/dist-cjs/commands/DeleteImportedKeyMaterialCommand.js +0 -53
  14. package/dist-cjs/commands/DescribeCustomKeyStoresCommand.js +0 -77
  15. package/dist-cjs/commands/DescribeKeyCommand.js +0 -103
  16. package/dist-cjs/commands/DisableKeyCommand.js +0 -39
  17. package/dist-cjs/commands/DisableKeyRotationCommand.js +0 -49
  18. package/dist-cjs/commands/DisconnectCustomKeyStoreCommand.js +0 -76
  19. package/dist-cjs/commands/EnableKeyCommand.js +0 -36
  20. package/dist-cjs/commands/EnableKeyRotationCommand.js +0 -49
  21. package/dist-cjs/commands/EncryptCommand.js +0 -148
  22. package/dist-cjs/commands/GenerateDataKeyCommand.js +0 -121
  23. package/dist-cjs/commands/GenerateDataKeyPairCommand.js +0 -100
  24. package/dist-cjs/commands/GenerateDataKeyPairWithoutPlaintextCommand.js +0 -90
  25. package/dist-cjs/commands/GenerateDataKeyWithoutPlaintextCommand.js +0 -95
  26. package/dist-cjs/commands/GenerateRandomCommand.js +0 -33
  27. package/dist-cjs/commands/GetKeyPolicyCommand.js +0 -32
  28. package/dist-cjs/commands/GetKeyRotationStatusCommand.js +0 -61
  29. package/dist-cjs/commands/GetParametersForImportCommand.js +0 -58
  30. package/dist-cjs/commands/GetPublicKeyCommand.js +0 -70
  31. package/dist-cjs/commands/ImportKeyMaterialCommand.js +0 -87
  32. package/dist-cjs/commands/ListAliasesCommand.js +0 -66
  33. package/dist-cjs/commands/ListGrantsCommand.js +0 -69
  34. package/dist-cjs/commands/ListKeyPoliciesCommand.js +0 -46
  35. package/dist-cjs/commands/ListKeysCommand.js +0 -54
  36. package/dist-cjs/commands/ListResourceTagsCommand.js +0 -58
  37. package/dist-cjs/commands/ListRetirableGrantsCommand.js +0 -67
  38. package/dist-cjs/commands/PutKeyPolicyCommand.js +0 -37
  39. package/dist-cjs/commands/ReEncryptCommand.js +0 -122
  40. package/dist-cjs/commands/ReplicateKeyCommand.js +0 -101
  41. package/dist-cjs/commands/RetireGrantCommand.js +0 -70
  42. package/dist-cjs/commands/RevokeGrantCommand.js +0 -67
  43. package/dist-cjs/commands/ScheduleKeyDeletionCommand.js +0 -78
  44. package/dist-cjs/commands/SignCommand.js +0 -69
  45. package/dist-cjs/commands/TagResourceCommand.js +0 -71
  46. package/dist-cjs/commands/UntagResourceCommand.js +0 -67
  47. package/dist-cjs/commands/UpdateAliasCommand.js +0 -86
  48. package/dist-cjs/commands/UpdateCustomKeyStoreCommand.js +0 -96
  49. package/dist-cjs/commands/UpdateKeyDescriptionCommand.js +0 -47
  50. package/dist-cjs/commands/UpdatePrimaryRegionCommand.js +0 -89
  51. package/dist-cjs/commands/VerifyCommand.js +0 -54
  52. package/dist-cjs/commands/index.js +51 -0
  53. package/dist-cjs/endpoints.js +6 -1
  54. package/dist-cjs/index.js +4 -55
  55. package/dist-cjs/models/models_0.js +0 -366
  56. package/dist-cjs/pagination/ListAliasesPaginator.js +0 -10
  57. package/dist-cjs/pagination/ListGrantsPaginator.js +0 -10
  58. package/dist-cjs/pagination/ListKeyPoliciesPaginator.js +0 -10
  59. package/dist-cjs/pagination/ListKeysPaginator.js +0 -10
  60. package/dist-cjs/pagination/index.js +8 -0
  61. package/dist-cjs/protocols/Aws_json1_1.js +0 -5
  62. package/dist-cjs/runtimeConfig.browser.js +1 -5
  63. package/dist-cjs/runtimeConfig.js +1 -5
  64. package/dist-cjs/runtimeConfig.native.js +0 -3
  65. package/dist-cjs/runtimeConfig.shared.js +0 -3
  66. package/dist-es/commands/index.js +48 -0
  67. package/dist-es/endpoints.js +6 -1
  68. package/dist-es/index.js +4 -55
  69. package/dist-es/pagination/index.js +5 -0
  70. package/dist-types/commands/index.d.ts +48 -0
  71. package/dist-types/index.d.ts +4 -55
  72. package/dist-types/pagination/index.d.ts +5 -0
  73. package/dist-types/ts3.4/KMS.d.ts +49 -2646
  74. package/dist-types/ts3.4/KMSClient.d.ts +24 -178
  75. package/dist-types/ts3.4/commands/CancelKeyDeletionCommand.d.ts +2 -33
  76. package/dist-types/ts3.4/commands/ConnectCustomKeyStoreCommand.d.ts +2 -81
  77. package/dist-types/ts3.4/commands/CreateAliasCommand.d.ts +2 -77
  78. package/dist-types/ts3.4/commands/CreateCustomKeyStoreCommand.d.ts +2 -69
  79. package/dist-types/ts3.4/commands/CreateGrantCommand.d.ts +2 -82
  80. package/dist-types/ts3.4/commands/CreateKeyCommand.d.ts +2 -144
  81. package/dist-types/ts3.4/commands/DecryptCommand.d.ts +2 -108
  82. package/dist-types/ts3.4/commands/DeleteAliasCommand.d.ts +2 -67
  83. package/dist-types/ts3.4/commands/DeleteCustomKeyStoreCommand.d.ts +2 -74
  84. package/dist-types/ts3.4/commands/DeleteImportedKeyMaterialCommand.d.ts +2 -49
  85. package/dist-types/ts3.4/commands/DescribeCustomKeyStoresCommand.d.ts +2 -73
  86. package/dist-types/ts3.4/commands/DescribeKeyCommand.d.ts +2 -99
  87. package/dist-types/ts3.4/commands/DisableKeyCommand.d.ts +2 -35
  88. package/dist-types/ts3.4/commands/DisableKeyRotationCommand.d.ts +2 -45
  89. package/dist-types/ts3.4/commands/DisconnectCustomKeyStoreCommand.d.ts +2 -72
  90. package/dist-types/ts3.4/commands/EnableKeyCommand.d.ts +2 -32
  91. package/dist-types/ts3.4/commands/EnableKeyRotationCommand.d.ts +2 -45
  92. package/dist-types/ts3.4/commands/EncryptCommand.d.ts +2 -144
  93. package/dist-types/ts3.4/commands/GenerateDataKeyCommand.d.ts +2 -117
  94. package/dist-types/ts3.4/commands/GenerateDataKeyPairCommand.d.ts +2 -96
  95. package/dist-types/ts3.4/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +2 -86
  96. package/dist-types/ts3.4/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +2 -91
  97. package/dist-types/ts3.4/commands/GenerateRandomCommand.d.ts +2 -29
  98. package/dist-types/ts3.4/commands/GetKeyPolicyCommand.d.ts +2 -28
  99. package/dist-types/ts3.4/commands/GetKeyRotationStatusCommand.d.ts +2 -57
  100. package/dist-types/ts3.4/commands/GetParametersForImportCommand.d.ts +2 -54
  101. package/dist-types/ts3.4/commands/GetPublicKeyCommand.d.ts +2 -66
  102. package/dist-types/ts3.4/commands/ImportKeyMaterialCommand.d.ts +2 -83
  103. package/dist-types/ts3.4/commands/ListAliasesCommand.d.ts +2 -62
  104. package/dist-types/ts3.4/commands/ListGrantsCommand.d.ts +2 -65
  105. package/dist-types/ts3.4/commands/ListKeyPoliciesCommand.d.ts +2 -42
  106. package/dist-types/ts3.4/commands/ListKeysCommand.d.ts +2 -50
  107. package/dist-types/ts3.4/commands/ListResourceTagsCommand.d.ts +2 -54
  108. package/dist-types/ts3.4/commands/ListRetirableGrantsCommand.d.ts +2 -63
  109. package/dist-types/ts3.4/commands/PutKeyPolicyCommand.d.ts +2 -33
  110. package/dist-types/ts3.4/commands/ReEncryptCommand.d.ts +2 -118
  111. package/dist-types/ts3.4/commands/ReplicateKeyCommand.d.ts +2 -97
  112. package/dist-types/ts3.4/commands/RetireGrantCommand.d.ts +2 -66
  113. package/dist-types/ts3.4/commands/RevokeGrantCommand.d.ts +2 -63
  114. package/dist-types/ts3.4/commands/ScheduleKeyDeletionCommand.d.ts +2 -74
  115. package/dist-types/ts3.4/commands/SignCommand.d.ts +2 -65
  116. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -67
  117. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -63
  118. package/dist-types/ts3.4/commands/UpdateAliasCommand.d.ts +2 -82
  119. package/dist-types/ts3.4/commands/UpdateCustomKeyStoreCommand.d.ts +2 -92
  120. package/dist-types/ts3.4/commands/UpdateKeyDescriptionCommand.d.ts +2 -43
  121. package/dist-types/ts3.4/commands/UpdatePrimaryRegionCommand.d.ts +2 -85
  122. package/dist-types/ts3.4/commands/VerifyCommand.d.ts +2 -50
  123. package/dist-types/ts3.4/commands/index.d.ts +48 -0
  124. package/dist-types/ts3.4/index.d.ts +4 -55
  125. package/dist-types/ts3.4/models/models_0.d.ts +445 -2963
  126. package/dist-types/ts3.4/pagination/index.d.ts +5 -0
  127. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  128. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  129. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  130. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  131. package/package.json +32 -32
@@ -48,2794 +48,197 @@ import { UpdateKeyDescriptionCommandInput, UpdateKeyDescriptionCommandOutput } f
48
48
  import { UpdatePrimaryRegionCommandInput, UpdatePrimaryRegionCommandOutput } from "./commands/UpdatePrimaryRegionCommand";
49
49
  import { VerifyCommandInput, VerifyCommandOutput } from "./commands/VerifyCommand";
50
50
  import { KMSClient } from "./KMSClient";
51
- /**
52
- * <fullname>Key Management Service</fullname>
53
- * <p>Key Management Service (KMS) is an encryption and key management web service. This guide describes
54
- * the KMS operations that you can call programmatically. For general information about KMS,
55
- * see the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/">
56
- * <i>Key Management Service Developer Guide</i>
57
- * </a>.</p>
58
- * <note>
59
- * <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>
60
- * <p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming
61
- * languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a
62
- * convenient way to create programmatic access to KMS and other Amazon Web Services services. For example,
63
- * the SDKs take care of tasks such as signing requests (see below), managing errors, and
64
- * retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to
65
- * download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web
66
- * Services</a>.</p>
67
- * </note>
68
- * <p>We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.</p>
69
- * <p>Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients
70
- * must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral
71
- * Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems
72
- * such as Java 7 and later support these modes.</p>
73
- * <p>
74
- * <b>Signing Requests</b>
75
- * </p>
76
- * <p>Requests must be signed by using an access key ID and a secret access key. We strongly
77
- * recommend that you <i>do not</i> use your Amazon Web Services account (root) access key ID and
78
- * secret key for everyday work with KMS. Instead, use the access key ID and secret access key
79
- * for an IAM user. You can also use the Amazon Web Services Security Token Service to generate temporary
80
- * security credentials that you can use to sign requests.</p>
81
- * <p>All KMS operations require <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p>
82
- * <p>
83
- * <b>Logging API Requests</b>
84
- * </p>
85
- * <p>KMS supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your
86
- * Amazon Web Services account and delivers them to an Amazon S3 bucket that you specify. By using the
87
- * information collected by CloudTrail, you can determine what requests were made to KMS, who made
88
- * the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it
89
- * on and find your log files, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/">CloudTrail User Guide</a>.</p>
90
- * <p>
91
- * <b>Additional Resources</b>
92
- * </p>
93
- * <p>For more information about credentials and request signing, see the following:</p>
94
- * <ul>
95
- * <li>
96
- * <p>
97
- * <a href="https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html">Amazon Web Services
98
- * Security Credentials</a> - This topic provides general information about the types
99
- * of credentials used to access Amazon Web Services.</p>
100
- * </li>
101
- * <li>
102
- * <p>
103
- * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html">Temporary
104
- * Security Credentials</a> - This section of the <i>IAM User Guide</i>
105
- * describes how to create and use temporary security credentials.</p>
106
- * </li>
107
- * <li>
108
- * <p>
109
- * <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version
110
- * 4 Signing Process</a> - This set of topics walks you through the process of signing
111
- * a request using an access key ID and a secret access key.</p>
112
- * </li>
113
- * </ul>
114
- * <p>
115
- * <b>Commonly Used API Operations</b>
116
- * </p>
117
- * <p>Of the API operations discussed in this guide, the following will prove the most useful
118
- * for most applications. You will likely perform operations other than these, such as creating
119
- * keys and assigning policies, by using the console.</p>
120
- * <ul>
121
- * <li>
122
- * <p>
123
- * <a>Encrypt</a>
124
- * </p>
125
- * </li>
126
- * <li>
127
- * <p>
128
- * <a>Decrypt</a>
129
- * </p>
130
- * </li>
131
- * <li>
132
- * <p>
133
- * <a>GenerateDataKey</a>
134
- * </p>
135
- * </li>
136
- * <li>
137
- * <p>
138
- * <a>GenerateDataKeyWithoutPlaintext</a>
139
- * </p>
140
- * </li>
141
- * </ul>
142
- */
51
+
143
52
  export declare class KMS extends KMSClient {
144
- /**
145
- * <p>Cancels the deletion of a KMS key. When this operation succeeds, the key state of the KMS
146
- * key is <code>Disabled</code>. To enable the KMS key, use <a>EnableKey</a>. </p>
147
- * <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
148
- * <i>Key Management Service Developer Guide</i>.</p>
149
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
150
- * 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>
151
- * <p>
152
- * <b>Cross-account
153
- * use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
154
- * <p>
155
- * <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>
156
- * <p>
157
- * <b>Related operations</b>: <a>ScheduleKeyDeletion</a>
158
- * </p>
159
- */
53
+
160
54
  cancelKeyDeletion(args: CancelKeyDeletionCommandInput, options?: __HttpHandlerOptions): Promise<CancelKeyDeletionCommandOutput>;
161
55
  cancelKeyDeletion(args: CancelKeyDeletionCommandInput, cb: (err: any, data?: CancelKeyDeletionCommandOutput) => void): void;
162
56
  cancelKeyDeletion(args: CancelKeyDeletionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelKeyDeletionCommandOutput) => void): void;
163
- /**
164
- * <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>
165
- * <p>The custom key store must be connected before you can create KMS keys in the key store or
166
- * use the KMS keys it contains. You can disconnect and reconnect a custom key store at any
167
- * time.</p>
168
- * <p>To connect a custom key store, its associated CloudHSM cluster must have at least one active
169
- * 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
170
- * 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">
171
- * <code>kmsuser</code> crypto
172
- * user</a> (CU) must not be logged into the cluster. This prevents KMS from using this
173
- * account to log in.</p>
174
- * <p>The connection process can take an extended amount of time to complete; up to 20 minutes.
175
- * This operation starts the connection process, but it does not wait for it to complete. When it
176
- * succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no
177
- * properties. However, this response does not indicate that the custom key store is connected.
178
- * To get the connection state of the custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p>
179
- * <p>During the connection process, KMS finds the CloudHSM cluster that is associated with the
180
- * custom key store, creates the connection infrastructure, connects to the cluster, logs into
181
- * the CloudHSM client as the <code>kmsuser</code> CU, and rotates its password.</p>
182
- * <p>The <code>ConnectCustomKeyStore</code> operation might fail for various reasons. To find
183
- * the reason, use the <a>DescribeCustomKeyStores</a> operation and see the
184
- * <code>ConnectionErrorCode</code> in the response. For help interpreting the
185
- * <code>ConnectionErrorCode</code>, see <a>CustomKeyStoresListEntry</a>.</p>
186
- * <p>To fix the failure, use the <a>DisconnectCustomKeyStore</a> operation to
187
- * disconnect the custom key store, correct the error, use the <a>UpdateCustomKeyStore</a> operation if necessary, and then use
188
- * <code>ConnectCustomKeyStore</code> again.</p>
189
- * <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
190
- * Store</a> in the <i>Key Management Service Developer Guide</i>.</p>
191
- * <p>
192
- * <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
193
- *
194
- * <p>
195
- * <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>
196
- * <p>
197
- * <b>Related operations</b>
198
- * </p>
199
- * <ul>
200
- * <li>
201
- * <p>
202
- * <a>CreateCustomKeyStore</a>
203
- * </p>
204
- * </li>
205
- * <li>
206
- * <p>
207
- * <a>DeleteCustomKeyStore</a>
208
- * </p>
209
- * </li>
210
- * <li>
211
- * <p>
212
- * <a>DescribeCustomKeyStores</a>
213
- * </p>
214
- * </li>
215
- * <li>
216
- * <p>
217
- * <a>DisconnectCustomKeyStore</a>
218
- * </p>
219
- * </li>
220
- * <li>
221
- * <p>
222
- * <a>UpdateCustomKeyStore</a>
223
- * </p>
224
- * </li>
225
- * </ul>
226
- */
57
+
227
58
  connectCustomKeyStore(args: ConnectCustomKeyStoreCommandInput, options?: __HttpHandlerOptions): Promise<ConnectCustomKeyStoreCommandOutput>;
228
59
  connectCustomKeyStore(args: ConnectCustomKeyStoreCommandInput, cb: (err: any, data?: ConnectCustomKeyStoreCommandOutput) => void): void;
229
60
  connectCustomKeyStore(args: ConnectCustomKeyStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConnectCustomKeyStoreCommandOutput) => void): void;
230
- /**
231
- * <p>Creates a friendly name for a KMS key. </p>
232
- * <note>
233
- * <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>
234
- * </note>
235
- * <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
236
- * <a>GenerateDataKey</a>. You can also change the KMS key that's associated with
237
- * the alias (<a>UpdateAlias</a>) or delete the alias (<a>DeleteAlias</a>)
238
- * at any time. These operations don't affect the underlying KMS key. </p>
239
- * <p>You can associate the alias with any customer managed key in the same Amazon Web Services Region. Each
240
- * alias is associated with only one KMS key at a time, but a KMS key can have multiple aliases.
241
- * A valid KMS key is required. You can't create an alias without a KMS key.</p>
242
- * <p>The alias must be unique in the account and Region, but you can have aliases with the same
243
- * 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
244
- * <i>Key Management Service Developer Guide</i>.</p>
245
- * <p>This operation does not return a response. To get the alias that you created, use the
246
- * <a>ListAliases</a> operation.</p>
247
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
248
- * 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>
249
- * <p>
250
- * <b>Cross-account use</b>: No. You cannot perform this operation on an alias in a different Amazon Web Services account.</p>
251
- *
252
- * <p>
253
- * <b>Required permissions</b>
254
- * </p>
255
- * <ul>
256
- * <li>
257
- * <p>
258
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateAlias</a> on
259
- * the alias (IAM policy).</p>
260
- * </li>
261
- * <li>
262
- * <p>
263
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateAlias</a> on
264
- * the KMS key (key policy).</p>
265
- * </li>
266
- * </ul>
267
- * <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
268
- * <i>Key Management Service Developer Guide</i>.</p>
269
- * <p>
270
- * <b>Related operations:</b>
271
- * </p>
272
- * <ul>
273
- * <li>
274
- * <p>
275
- * <a>DeleteAlias</a>
276
- * </p>
277
- * </li>
278
- * <li>
279
- * <p>
280
- * <a>ListAliases</a>
281
- * </p>
282
- * </li>
283
- * <li>
284
- * <p>
285
- * <a>UpdateAlias</a>
286
- * </p>
287
- * </li>
288
- * </ul>
289
- */
61
+
290
62
  createAlias(args: CreateAliasCommandInput, options?: __HttpHandlerOptions): Promise<CreateAliasCommandOutput>;
291
63
  createAlias(args: CreateAliasCommandInput, cb: (err: any, data?: CreateAliasCommandOutput) => void): void;
292
64
  createAlias(args: CreateAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAliasCommandOutput) => void): void;
293
- /**
294
- * <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
295
- * manage.</p>
296
- * <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
297
- * combines the convenience and extensive integration of KMS with the isolation and control of a
298
- * single-tenant key store.</p>
299
- * <p>Before you create the custom key store, you must assemble
300
- * the required elements, including an CloudHSM cluster that fulfills the requirements for a custom
301
- * 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>
302
- * in the <i>Key Management Service Developer Guide</i>.</p>
303
- * <p>When the operation completes successfully, it returns the ID of the new custom key store.
304
- * 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
305
- * cluster. Even if you are not going to use your custom key store immediately, you might want to
306
- * connect it to verify that all settings are correct and then disconnect it until you are ready
307
- * to use it.</p>
308
- * <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
309
- * <i>Key Management Service Developer Guide</i>.</p>
310
- * <p>
311
- * <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
312
- * <p>
313
- * <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>
314
- * <p>
315
- * <b>Related operations:</b>
316
- * </p>
317
- * <ul>
318
- * <li>
319
- * <p>
320
- * <a>ConnectCustomKeyStore</a>
321
- * </p>
322
- * </li>
323
- * <li>
324
- * <p>
325
- * <a>DeleteCustomKeyStore</a>
326
- * </p>
327
- * </li>
328
- * <li>
329
- * <p>
330
- * <a>DescribeCustomKeyStores</a>
331
- * </p>
332
- * </li>
333
- * <li>
334
- * <p>
335
- * <a>DisconnectCustomKeyStore</a>
336
- * </p>
337
- * </li>
338
- * <li>
339
- * <p>
340
- * <a>UpdateCustomKeyStore</a>
341
- * </p>
342
- * </li>
343
- * </ul>
344
- */
65
+
345
66
  createCustomKeyStore(args: CreateCustomKeyStoreCommandInput, options?: __HttpHandlerOptions): Promise<CreateCustomKeyStoreCommandOutput>;
346
67
  createCustomKeyStore(args: CreateCustomKeyStoreCommandInput, cb: (err: any, data?: CreateCustomKeyStoreCommandOutput) => void): void;
347
68
  createCustomKeyStore(args: CreateCustomKeyStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCustomKeyStoreCommandOutput) => void): void;
348
- /**
349
- * <p>Adds a grant to a KMS key. </p>
350
- * <p>A <i>grant</i> is a policy instrument that allows Amazon Web Services principals to use
351
- * 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,
352
- * grants are considered along with key policies and IAM policies. Grants are often used for
353
- * temporary permissions because you can create one, use its permissions, and delete it without
354
- * changing your key policies or IAM policies. </p>
355
- * <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
356
- * <i>
357
- * <i>Key Management Service Developer Guide</i>
358
- * </i>. For examples of working with grants in several
359
- * programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a>. </p>
360
- * <p>The <code>CreateGrant</code> operation returns a <code>GrantToken</code> and a
361
- * <code>GrantId</code>.</p>
362
- * <ul>
363
- * <li>
364
- * <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
365
- * principal can use the permissions in the grant without identifying the grant. </p>
366
- * <p>However, to use the permissions in the grant immediately, use the
367
- * <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
368
- * grant token</a> in the <i>
369
- * <i>Key Management Service Developer Guide</i>
370
- * </i>.</p>
371
- * </li>
372
- * <li>
373
- * <p>The <code>CreateGrant</code> operation also returns a <code>GrantId</code>. You can
374
- * 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
375
- * ID, use the <a>ListGrants</a> or <a>ListRetirableGrants</a>
376
- * operations.</p>
377
- * </li>
378
- * </ul>
379
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
380
- * 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>
381
- * <p>
382
- * <b>Cross-account use</b>: Yes.
383
- * To perform this operation on a KMS key in a different Amazon Web Services account, specify the key
384
- * ARN in the value of the <code>KeyId</code> parameter. </p>
385
- * <p>
386
- * <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>
387
- * <p>
388
- * <b>Related operations:</b>
389
- * </p>
390
- * <ul>
391
- * <li>
392
- * <p>
393
- * <a>ListGrants</a>
394
- * </p>
395
- * </li>
396
- * <li>
397
- * <p>
398
- * <a>ListRetirableGrants</a>
399
- * </p>
400
- * </li>
401
- * <li>
402
- * <p>
403
- * <a>RetireGrant</a>
404
- * </p>
405
- * </li>
406
- * <li>
407
- * <p>
408
- * <a>RevokeGrant</a>
409
- * </p>
410
- * </li>
411
- * </ul>
412
- */
69
+
413
70
  createGrant(args: CreateGrantCommandInput, options?: __HttpHandlerOptions): Promise<CreateGrantCommandOutput>;
414
71
  createGrant(args: CreateGrantCommandInput, cb: (err: any, data?: CreateGrantCommandOutput) => void): void;
415
72
  createGrant(args: CreateGrantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGrantCommandOutput) => void): void;
416
- /**
417
- * <p>Creates a unique customer managed <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms-keys">KMS key</a> in your Amazon Web Services account and
418
- * Region.</p>
419
- * <note>
420
- * <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>
421
- * </note>
422
- *
423
- * <p>You can use the <code>CreateKey</code> operation to create symmetric or asymmetric KMS
424
- * keys.</p>
425
- * <ul>
426
- * <li>
427
- * <p>
428
- * <b>Symmetric KMS keys</b> contain a 256-bit symmetric key
429
- * that never leaves KMS unencrypted. To use the KMS key, you must call KMS. You can use
430
- * a symmetric KMS key to encrypt and decrypt small amounts of data, but they are typically
431
- * used to generate <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data keys</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-key-pairs">data keys pairs</a>. For details,
432
- * see <a>GenerateDataKey</a> and <a>GenerateDataKeyPair</a>.</p>
433
- * </li>
434
- * <li>
435
- * <p>
436
- * <b>Asymmetric KMS keys</b> can contain an RSA key pair or an
437
- * Elliptic Curve (ECC) key pair. The private key in an asymmetric KMS key never leaves KMS
438
- * unencrypted. However, you can use the <a>GetPublicKey</a> operation to download
439
- * the public key so it can be used outside of KMS. KMS keys with RSA key pairs can be used
440
- * to encrypt or decrypt data or sign and verify messages (but not both). KMS keys with ECC
441
- * key pairs can be used only to sign and verify messages.</p>
442
- * </li>
443
- * </ul>
444
- * <p>For information about symmetric and asymmetric KMS keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
445
- *
446
- *
447
- * <p>To create different types of KMS keys, use the following guidance:</p>
448
- *
449
- * <dl>
450
- * <dt>Asymmetric KMS keys</dt>
451
- * <dd>
452
- * <p>To create an asymmetric KMS key, use the <code>KeySpec</code> parameter to specify
453
- * the type of key material in the KMS key. Then, use the <code>KeyUsage</code> parameter
454
- * to determine whether the KMS key will be used to encrypt and decrypt or sign and verify.
455
- * You can't change these properties after the KMS key is created.</p>
456
- * <p> </p>
457
- * </dd>
458
- * <dt>Symmetric KMS keys</dt>
459
- * <dd>
460
- * <p>When creating a symmetric KMS key, you don't need to specify the
461
- * <code>KeySpec</code> or <code>KeyUsage</code> parameters. The default value for
462
- * <code>KeySpec</code>, <code>SYMMETRIC_DEFAULT</code>, and the default value for
463
- * <code>KeyUsage</code>, <code>ENCRYPT_DECRYPT</code>, are the only valid values for
464
- * symmetric KMS keys. </p>
465
- * <p> </p>
466
- * </dd>
467
- * <dt>Multi-Region primary keys</dt>
468
- * <dt>Imported key material</dt>
469
- * <dd>
470
- * <p>To create a multi-Region <i>primary key</i> in the local Amazon Web Services Region,
471
- * use the <code>MultiRegion</code> parameter with a value of <code>True</code>. To create
472
- * a multi-Region <i>replica key</i>, that is, a KMS key with the same key ID
473
- * and key material as a primary key, but in a different Amazon Web Services Region, use the <a>ReplicateKey</a> operation. To change a replica key to a primary key, and its
474
- * primary key to a replica key, use the <a>UpdatePrimaryRegion</a>
475
- * operation.</p>
476
- * <p>This operation supports <i>multi-Region keys</i>, an KMS feature that lets you create multiple
477
- * interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key
478
- * material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt
479
- * it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
480
- * <p>You can create symmetric and asymmetric multi-Region keys and multi-Region keys with
481
- * imported key material. You cannot create multi-Region keys in a custom key store.</p>
482
- * <p> </p>
483
- * </dd>
484
- * <dd>
485
- * <p>To import your own key material, begin by creating a symmetric KMS key with no key
486
- * material. To do this, use the <code>Origin</code> parameter of <code>CreateKey</code>
487
- * with a value of <code>EXTERNAL</code>. Next, use <a>GetParametersForImport</a> operation to get a public key and import token, and use the public key to encrypt
488
- * your key material. Then, use <a>ImportKeyMaterial</a> with your import token
489
- * to import the key material. For step-by-step instructions, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a> in the <i>
490
- * <i>Key Management Service Developer Guide</i>
491
- * </i>. You
492
- * cannot import the key material into an asymmetric KMS key.</p>
493
- * <p>To create a multi-Region primary key with imported key material, use the
494
- * <code>Origin</code> parameter of <code>CreateKey</code> with a value of
495
- * <code>EXTERNAL</code> and the <code>MultiRegion</code> parameter with a value of
496
- * <code>True</code>. To create replicas of the multi-Region primary key, use the <a>ReplicateKey</a> operation. For more information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
497
- * <p> </p>
498
- * </dd>
499
- * <dt>Custom key store</dt>
500
- * <dd>
501
- * <p>To create a symmetric KMS key in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>, use the
502
- * <code>CustomKeyStoreId</code> parameter to specify the custom key store. You must also
503
- * use the <code>Origin</code> parameter with a value of <code>AWS_CLOUDHSM</code>. The
504
- * CloudHSM cluster that is associated with the custom key store must have at least two active
505
- * HSMs in different Availability Zones in the Amazon Web Services Region. </p>
506
- * <p>You cannot create an asymmetric KMS key in a custom key store. For information about
507
- * custom key stores in KMS see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Using Custom Key Stores</a> in
508
- * the <i>
509
- * <i>Key Management Service Developer Guide</i>
510
- * </i>.</p>
511
- * </dd>
512
- * </dl>
513
- * <p>
514
- * <b>Cross-account use</b>: No. You cannot use this operation to
515
- * create a KMS key in a different Amazon Web Services account.</p>
516
- *
517
- * <p>
518
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateKey</a> (IAM policy). To use the
519
- * <code>Tags</code> parameter, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:TagResource</a> (IAM policy). For examples and information about related
520
- * permissions, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policy-example-create-key">Allow a user to create
521
- * KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
522
- * <p>
523
- * <b>Related operations:</b>
524
- * </p>
525
- * <ul>
526
- * <li>
527
- * <p>
528
- * <a>DescribeKey</a>
529
- * </p>
530
- * </li>
531
- * <li>
532
- * <p>
533
- * <a>ListKeys</a>
534
- * </p>
535
- * </li>
536
- * <li>
537
- * <p>
538
- * <a>ScheduleKeyDeletion</a>
539
- * </p>
540
- * </li>
541
- * </ul>
542
- */
73
+
543
74
  createKey(args: CreateKeyCommandInput, options?: __HttpHandlerOptions): Promise<CreateKeyCommandOutput>;
544
75
  createKey(args: CreateKeyCommandInput, cb: (err: any, data?: CreateKeyCommandOutput) => void): void;
545
76
  createKey(args: CreateKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateKeyCommandOutput) => void): void;
546
- /**
547
- * <p>Decrypts ciphertext that was encrypted by a KMS key using any of the following
548
- * operations:</p>
549
- * <ul>
550
- * <li>
551
- * <p>
552
- * <a>Encrypt</a>
553
- * </p>
554
- * </li>
555
- * <li>
556
- * <p>
557
- * <a>GenerateDataKey</a>
558
- * </p>
559
- * </li>
560
- * <li>
561
- * <p>
562
- * <a>GenerateDataKeyPair</a>
563
- * </p>
564
- * </li>
565
- * <li>
566
- * <p>
567
- * <a>GenerateDataKeyWithoutPlaintext</a>
568
- * </p>
569
- * </li>
570
- * <li>
571
- * <p>
572
- * <a>GenerateDataKeyPairWithoutPlaintext</a>
573
- * </p>
574
- * </li>
575
- * </ul>
576
- * <p>You can use this operation to decrypt ciphertext that was encrypted under a symmetric or
577
- * asymmetric KMS key. When the KMS key is asymmetric, you must specify the KMS key and the
578
- * encryption algorithm that was used to encrypt the ciphertext. For information about symmetric and asymmetric KMS keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
579
- * <p>The Decrypt operation also decrypts ciphertext that was encrypted outside of KMS by the
580
- * public key in an KMS asymmetric KMS key. However, it cannot decrypt ciphertext produced by
581
- * other libraries, such as the <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">Amazon Web Services
582
- * Encryption SDK</a> or <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3 client-side encryption</a>.
583
- * These libraries return a ciphertext format that is incompatible with KMS.</p>
584
- * <p>If the ciphertext was encrypted under a symmetric KMS key, the <code>KeyId</code>
585
- * parameter is optional. KMS can get this information from metadata that it adds to the
586
- * symmetric ciphertext blob. This feature adds durability to your implementation by ensuring
587
- * that authorized users can decrypt ciphertext decades after it was encrypted, even if they've
588
- * lost track of the key ID. However, specifying the KMS key is always recommended as a best
589
- * practice. When you use the <code>KeyId</code> parameter to specify a KMS key, KMS only uses
590
- * the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the
591
- * <code>Decrypt</code> operation fails. This practice ensures that you use the KMS key that
592
- * you intend.</p>
593
- * <p>Whenever possible, use key policies to give users permission to call the
594
- * <code>Decrypt</code> operation on a particular KMS key, instead of using IAM policies.
595
- * Otherwise, you might create an IAM user policy that gives the user <code>Decrypt</code>
596
- * permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys
597
- * in other accounts if the key policy for the cross-account KMS key permits it. If you must use
598
- * an IAM policy for <code>Decrypt</code> permissions, limit the user to particular KMS keys or
599
- * particular trusted accounts. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policies-best-practices">Best practices for IAM
600
- * policies</a> in the <i>Key Management Service Developer Guide</i>.</p>
601
- * <p>Applications in Amazon Web Services Nitro Enclaves can call this operation by using the <a href="https://github.com/aws/aws-nitro-enclaves-sdk-c">Amazon Web Services Nitro Enclaves Development Kit</a>. For information about the supporting parameters, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves use KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
602
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
603
- * 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>
604
- * <p>
605
- * <b>Cross-account
606
- * use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
607
- * the key ARN or alias ARN in the value of the <code>KeyId</code> parameter. </p>
608
- *
609
- * <p>
610
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:Decrypt</a> (key policy)</p>
611
- * <p>
612
- * <b>Related operations:</b>
613
- * </p>
614
- * <ul>
615
- * <li>
616
- * <p>
617
- * <a>Encrypt</a>
618
- * </p>
619
- * </li>
620
- * <li>
621
- * <p>
622
- * <a>GenerateDataKey</a>
623
- * </p>
624
- * </li>
625
- * <li>
626
- * <p>
627
- * <a>GenerateDataKeyPair</a>
628
- * </p>
629
- * </li>
630
- * <li>
631
- * <p>
632
- * <a>ReEncrypt</a>
633
- * </p>
634
- * </li>
635
- * </ul>
636
- */
77
+
637
78
  decrypt(args: DecryptCommandInput, options?: __HttpHandlerOptions): Promise<DecryptCommandOutput>;
638
79
  decrypt(args: DecryptCommandInput, cb: (err: any, data?: DecryptCommandOutput) => void): void;
639
80
  decrypt(args: DecryptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DecryptCommandOutput) => void): void;
640
- /**
641
- * <p>Deletes the specified alias. </p>
642
- * <note>
643
- * <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>
644
- * </note>
645
- * <p>Because an alias is not a property of a KMS key, you can delete and change the aliases of
646
- * a KMS key without affecting the KMS key. Also, aliases do not appear in the response from the
647
- * <a>DescribeKey</a> operation. To get the aliases of all KMS keys, use the <a>ListAliases</a> operation. </p>
648
- * <p>Each KMS key can have multiple aliases. To change the alias of a KMS key, use <a>DeleteAlias</a> to delete the current alias and <a>CreateAlias</a> to
649
- * create a new alias. To associate an existing alias with a different KMS key, call <a>UpdateAlias</a>.</p>
650
- * <p>
651
- * <b>Cross-account use</b>: No. You cannot perform this operation on an alias in a different Amazon Web Services account.</p>
652
- * <p>
653
- * <b>Required permissions</b>
654
- * </p>
655
- * <ul>
656
- * <li>
657
- * <p>
658
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteAlias</a> on
659
- * the alias (IAM policy).</p>
660
- * </li>
661
- * <li>
662
- * <p>
663
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteAlias</a> on
664
- * the KMS key (key policy).</p>
665
- * </li>
666
- * </ul>
667
- * <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
668
- * <i>Key Management Service Developer Guide</i>.</p>
669
- * <p>
670
- * <b>Related operations:</b>
671
- * </p>
672
- * <ul>
673
- * <li>
674
- * <p>
675
- * <a>CreateAlias</a>
676
- * </p>
677
- * </li>
678
- * <li>
679
- * <p>
680
- * <a>ListAliases</a>
681
- * </p>
682
- * </li>
683
- * <li>
684
- * <p>
685
- * <a>UpdateAlias</a>
686
- * </p>
687
- * </li>
688
- * </ul>
689
- */
81
+
690
82
  deleteAlias(args: DeleteAliasCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAliasCommandOutput>;
691
83
  deleteAlias(args: DeleteAliasCommandInput, cb: (err: any, data?: DeleteAliasCommandOutput) => void): void;
692
84
  deleteAlias(args: DeleteAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAliasCommandOutput) => void): void;
693
- /**
694
- * <p>Deletes a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. This operation does not delete the CloudHSM cluster that is
695
- * associated with the custom key store, or affect any users or keys in the cluster.</p>
696
- * <p>The custom key store that you delete cannot contain any KMS <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys">KMS keys</a>. Before deleting the key store,
697
- * verify that you will never need to use any of the KMS keys in the key store for any
698
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. Then, use <a>ScheduleKeyDeletion</a> to delete the KMS keys from the
699
- * key store. When the scheduled waiting period expires, the <code>ScheduleKeyDeletion</code>
700
- * operation deletes the KMS keys. Then it makes a best effort to delete the key material from
701
- * the associated cluster. However, you might need to manually <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key">delete the orphaned key
702
- * material</a> from the cluster and its backups.</p>
703
- * <p>After all KMS keys are deleted from KMS, use <a>DisconnectCustomKeyStore</a>
704
- * to disconnect the key store from KMS. Then, you can delete the custom key store.</p>
705
- * <p>Instead of deleting the custom key store, consider using <a>DisconnectCustomKeyStore</a> to disconnect it from KMS. While the key store is
706
- * disconnected, you cannot create or use the KMS keys in the key store. But, you do not need to
707
- * delete KMS keys and you can reconnect a disconnected custom key store at any time.</p>
708
- * <p>If the operation succeeds, it returns a JSON object with no
709
- * properties.</p>
710
- * <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
711
- * combines the convenience and extensive integration of KMS with the isolation and control of a
712
- * single-tenant key store.</p>
713
- * <p>
714
- * <b>Cross-account use</b>: No.
715
- * You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
716
- *
717
- * <p>
718
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteCustomKeyStore</a> (IAM policy)</p>
719
- * <p>
720
- * <b>Related operations:</b>
721
- * </p>
722
- * <ul>
723
- * <li>
724
- * <p>
725
- * <a>ConnectCustomKeyStore</a>
726
- * </p>
727
- * </li>
728
- * <li>
729
- * <p>
730
- * <a>CreateCustomKeyStore</a>
731
- * </p>
732
- * </li>
733
- * <li>
734
- * <p>
735
- * <a>DescribeCustomKeyStores</a>
736
- * </p>
737
- * </li>
738
- * <li>
739
- * <p>
740
- * <a>DisconnectCustomKeyStore</a>
741
- * </p>
742
- * </li>
743
- * <li>
744
- * <p>
745
- * <a>UpdateCustomKeyStore</a>
746
- * </p>
747
- * </li>
748
- * </ul>
749
- */
85
+
750
86
  deleteCustomKeyStore(args: DeleteCustomKeyStoreCommandInput, options?: __HttpHandlerOptions): Promise<DeleteCustomKeyStoreCommandOutput>;
751
87
  deleteCustomKeyStore(args: DeleteCustomKeyStoreCommandInput, cb: (err: any, data?: DeleteCustomKeyStoreCommandOutput) => void): void;
752
88
  deleteCustomKeyStore(args: DeleteCustomKeyStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCustomKeyStoreCommandOutput) => void): void;
753
- /**
754
- * <p>Deletes key material that you previously imported. This operation makes the specified KMS
755
- * key unusable. For more information about importing key material into KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a>
756
- * in the <i>Key Management Service Developer Guide</i>. </p>
757
- * <p>When the specified KMS key is in the <code>PendingDeletion</code> state, this operation
758
- * does not change the KMS key's state. Otherwise, it changes the KMS key's state to
759
- * <code>PendingImport</code>.</p>
760
- * <p>After you delete key material, you can use <a>ImportKeyMaterial</a> to reimport
761
- * the same key material into the KMS key.</p>
762
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
763
- * 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>
764
- * <p>
765
- * <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
766
- *
767
- * <p>
768
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteImportedKeyMaterial</a> (key policy)</p>
769
- * <p>
770
- * <b>Related operations:</b>
771
- * </p>
772
- * <ul>
773
- * <li>
774
- * <p>
775
- * <a>GetParametersForImport</a>
776
- * </p>
777
- * </li>
778
- * <li>
779
- * <p>
780
- * <a>ImportKeyMaterial</a>
781
- * </p>
782
- * </li>
783
- * </ul>
784
- */
89
+
785
90
  deleteImportedKeyMaterial(args: DeleteImportedKeyMaterialCommandInput, options?: __HttpHandlerOptions): Promise<DeleteImportedKeyMaterialCommandOutput>;
786
91
  deleteImportedKeyMaterial(args: DeleteImportedKeyMaterialCommandInput, cb: (err: any, data?: DeleteImportedKeyMaterialCommandOutput) => void): void;
787
92
  deleteImportedKeyMaterial(args: DeleteImportedKeyMaterialCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteImportedKeyMaterialCommandOutput) => void): void;
788
- /**
789
- * <p>Gets information about <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key stores</a> in the account and Region.</p>
790
- * <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
791
- * combines the convenience and extensive integration of KMS with the isolation and control of a
792
- * single-tenant key store.</p>
793
- * <p>By default, this operation returns information about all custom key
794
- * stores in the account and Region. To get only information about a particular custom key store,
795
- * use either the <code>CustomKeyStoreName</code> or <code>CustomKeyStoreId</code> parameter (but
796
- * not both).</p>
797
- * <p>To determine whether the custom key store is connected to its CloudHSM cluster, use the
798
- * <code>ConnectionState</code> element in the response. If an attempt to connect the custom
799
- * key store failed, the <code>ConnectionState</code> value is <code>FAILED</code> and the
800
- * <code>ConnectionErrorCode</code> element in the response indicates the cause of the failure.
801
- * For help interpreting the <code>ConnectionErrorCode</code>, see <a>CustomKeyStoresListEntry</a>.</p>
802
- * <p>Custom key stores have a <code>DISCONNECTED</code> connection state if the key store has
803
- * never been connected or you use the <a>DisconnectCustomKeyStore</a> operation to
804
- * disconnect it. If your custom key store state is <code>CONNECTED</code> but you are having
805
- * trouble using it, make sure that its associated CloudHSM cluster is active and contains the
806
- * minimum number of HSMs required for the operation, if any.</p>
807
- * <p> For help repairing your custom key store, see the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html">Troubleshooting Custom Key Stores</a> topic in the
808
- * <i>Key Management Service Developer Guide</i>.</p>
809
- * <p>
810
- * <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
811
- * <p>
812
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DescribeCustomKeyStores</a> (IAM policy)</p>
813
- * <p>
814
- * <b>Related operations:</b>
815
- * </p>
816
- * <ul>
817
- * <li>
818
- * <p>
819
- * <a>ConnectCustomKeyStore</a>
820
- * </p>
821
- * </li>
822
- * <li>
823
- * <p>
824
- * <a>CreateCustomKeyStore</a>
825
- * </p>
826
- * </li>
827
- * <li>
828
- * <p>
829
- * <a>DeleteCustomKeyStore</a>
830
- * </p>
831
- * </li>
832
- * <li>
833
- * <p>
834
- * <a>DisconnectCustomKeyStore</a>
835
- * </p>
836
- * </li>
837
- * <li>
838
- * <p>
839
- * <a>UpdateCustomKeyStore</a>
840
- * </p>
841
- * </li>
842
- * </ul>
843
- */
93
+
844
94
  describeCustomKeyStores(args: DescribeCustomKeyStoresCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCustomKeyStoresCommandOutput>;
845
95
  describeCustomKeyStores(args: DescribeCustomKeyStoresCommandInput, cb: (err: any, data?: DescribeCustomKeyStoresCommandOutput) => void): void;
846
96
  describeCustomKeyStores(args: DescribeCustomKeyStoresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCustomKeyStoresCommandOutput) => void): void;
847
- /**
848
- * <p>Provides detailed information about a KMS key. You can run <code>DescribeKey</code> on a
849
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed
850
- * key</a> or an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed key</a>.</p>
851
- * <p>This detailed information includes the key ARN, creation date (and deletion date, if
852
- * applicable), the key state, and the origin and expiration date (if any) of the key material.
853
- * It includes fields, like <code>KeySpec</code>, that help you distinguish symmetric from
854
- * asymmetric KMS keys. It also provides information that is particularly important to asymmetric
855
- * keys, such as the key usage (encryption or signing) and the encryption algorithms or signing
856
- * algorithms that the KMS key supports. For KMS keys in custom key stores, it includes
857
- * information about the custom key store, such as the key store ID and the CloudHSM cluster ID. For
858
- * multi-Region keys, it displays the primary key and all related replica keys. </p>
859
- * <p>
860
- * <code>DescribeKey</code> does not return the following information:</p>
861
- * <ul>
862
- * <li>
863
- * <p>Aliases associated with the KMS key. To get this information, use <a>ListAliases</a>.</p>
864
- * </li>
865
- * <li>
866
- * <p>Whether automatic key rotation is enabled on the KMS key. To get this information, use
867
- * <a>GetKeyRotationStatus</a>. Also, some key states prevent a KMS key from
868
- * being automatically rotated. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-how-it-works">How Automatic Key Rotation
869
- * Works</a> in <i>Key Management Service Developer Guide</i>.</p>
870
- * </li>
871
- * <li>
872
- * <p>Tags on the KMS key. To get this information, use <a>ListResourceTags</a>.</p>
873
- * </li>
874
- * <li>
875
- * <p>Key policies and grants on the KMS key. To get this information, use <a>GetKeyPolicy</a> and <a>ListGrants</a>.</p>
876
- * </li>
877
- * </ul>
878
- * <p>If you call the <code>DescribeKey</code> operation on a <i>predefined Amazon Web Services
879
- * alias</i>, that is, an Amazon Web Services alias with no key ID, KMS creates an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed
880
- * key</a>. Then, it associates the alias with the new KMS key, and returns the
881
- * <code>KeyId</code> and <code>Arn</code> of the new KMS key in the response.</p>
882
- * <p>
883
- * <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
884
- * the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
885
- *
886
- * <p>
887
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DescribeKey</a> (key policy)</p>
888
- * <p>
889
- * <b>Related operations:</b>
890
- * </p>
891
- * <ul>
892
- * <li>
893
- * <p>
894
- * <a>GetKeyPolicy</a>
895
- * </p>
896
- * </li>
897
- * <li>
898
- * <p>
899
- * <a>GetKeyRotationStatus</a>
900
- * </p>
901
- * </li>
902
- * <li>
903
- * <p>
904
- * <a>ListAliases</a>
905
- * </p>
906
- * </li>
907
- * <li>
908
- * <p>
909
- * <a>ListGrants</a>
910
- * </p>
911
- * </li>
912
- * <li>
913
- * <p>
914
- * <a>ListKeys</a>
915
- * </p>
916
- * </li>
917
- * <li>
918
- * <p>
919
- * <a>ListResourceTags</a>
920
- * </p>
921
- * </li>
922
- * <li>
923
- * <p>
924
- * <a>ListRetirableGrants</a>
925
- * </p>
926
- * </li>
927
- * </ul>
928
- */
97
+
929
98
  describeKey(args: DescribeKeyCommandInput, options?: __HttpHandlerOptions): Promise<DescribeKeyCommandOutput>;
930
99
  describeKey(args: DescribeKeyCommandInput, cb: (err: any, data?: DescribeKeyCommandOutput) => void): void;
931
100
  describeKey(args: DescribeKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeKeyCommandOutput) => void): void;
932
- /**
933
- * <p>Sets the state of a KMS key to disabled. This change temporarily prevents use of the KMS
934
- * key for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. </p>
935
- * <p>For more information about how key state affects the use of a KMS key, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS
936
- * key</a> in the <i>
937
- * <i>Key Management Service Developer Guide</i>
938
- * </i>.</p>
939
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
940
- * 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>
941
- * <p>
942
- * <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
943
- *
944
- * <p>
945
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DisableKey</a> (key policy)</p>
946
- * <p>
947
- * <b>Related operations</b>: <a>EnableKey</a>
948
- * </p>
949
- */
101
+
950
102
  disableKey(args: DisableKeyCommandInput, options?: __HttpHandlerOptions): Promise<DisableKeyCommandOutput>;
951
103
  disableKey(args: DisableKeyCommandInput, cb: (err: any, data?: DisableKeyCommandOutput) => void): void;
952
104
  disableKey(args: DisableKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableKeyCommandOutput) => void): void;
953
- /**
954
- * <p>Disables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic
955
- * rotation of the key material</a> for the specified symmetric KMS key.</p>
956
- * <p> You cannot enable automatic rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks">asymmetric KMS keys</a>, KMS keys with <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key material</a>, or KMS keys in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. To enable or disable automatic rotation of a set of related <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-replica-key">multi-Region keys</a>, set the property on the primary key. </p>
957
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
958
- * 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>
959
- * <p>
960
- * <b>Cross-account
961
- * use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
962
- *
963
- * <p>
964
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DisableKeyRotation</a> (key policy)</p>
965
- * <p>
966
- * <b>Related operations:</b>
967
- * </p>
968
- * <ul>
969
- * <li>
970
- * <p>
971
- * <a>EnableKeyRotation</a>
972
- * </p>
973
- * </li>
974
- * <li>
975
- * <p>
976
- * <a>GetKeyRotationStatus</a>
977
- * </p>
978
- * </li>
979
- * </ul>
980
- */
105
+
981
106
  disableKeyRotation(args: DisableKeyRotationCommandInput, options?: __HttpHandlerOptions): Promise<DisableKeyRotationCommandOutput>;
982
107
  disableKeyRotation(args: DisableKeyRotationCommandInput, cb: (err: any, data?: DisableKeyRotationCommandOutput) => void): void;
983
108
  disableKeyRotation(args: DisableKeyRotationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableKeyRotationCommandOutput) => void): void;
984
- /**
985
- * <p>Disconnects the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> from its associated CloudHSM cluster. While a custom key
986
- * store is disconnected, you can manage the custom key store and its KMS keys, but you cannot
987
- * create or use KMS keys in the custom key store. You can reconnect the custom key store at any
988
- * time.</p>
989
- * <note>
990
- * <p>While a custom key store is disconnected, all attempts to create KMS keys in the custom key store or to use existing KMS keys in <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> will
991
- * fail. This action can prevent users from storing and accessing sensitive data.</p>
992
- * </note>
993
- * <p></p>
994
- * <p>To find the connection state of a custom key store, use the <a>DescribeCustomKeyStores</a> operation. To reconnect a custom key store, use the
995
- * <a>ConnectCustomKeyStore</a> operation.</p>
996
- * <p>If the operation succeeds, it returns a JSON object with no
997
- * properties.</p>
998
- * <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
999
- * combines the convenience and extensive integration of KMS with the isolation and control of a
1000
- * single-tenant key store.</p>
1001
- *
1002
- * <p>
1003
- * <b>Cross-account use</b>: No.
1004
- * You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
1005
- *
1006
- * <p>
1007
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DisconnectCustomKeyStore</a> (IAM policy)</p>
1008
- * <p>
1009
- * <b>Related operations:</b>
1010
- * </p>
1011
- * <ul>
1012
- * <li>
1013
- * <p>
1014
- * <a>ConnectCustomKeyStore</a>
1015
- * </p>
1016
- * </li>
1017
- * <li>
1018
- * <p>
1019
- * <a>CreateCustomKeyStore</a>
1020
- * </p>
1021
- * </li>
1022
- * <li>
1023
- * <p>
1024
- * <a>DeleteCustomKeyStore</a>
1025
- * </p>
1026
- * </li>
1027
- * <li>
1028
- * <p>
1029
- * <a>DescribeCustomKeyStores</a>
1030
- * </p>
1031
- * </li>
1032
- * <li>
1033
- * <p>
1034
- * <a>UpdateCustomKeyStore</a>
1035
- * </p>
1036
- * </li>
1037
- * </ul>
1038
- */
109
+
1039
110
  disconnectCustomKeyStore(args: DisconnectCustomKeyStoreCommandInput, options?: __HttpHandlerOptions): Promise<DisconnectCustomKeyStoreCommandOutput>;
1040
111
  disconnectCustomKeyStore(args: DisconnectCustomKeyStoreCommandInput, cb: (err: any, data?: DisconnectCustomKeyStoreCommandOutput) => void): void;
1041
112
  disconnectCustomKeyStore(args: DisconnectCustomKeyStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisconnectCustomKeyStoreCommandOutput) => void): void;
1042
- /**
1043
- * <p>Sets the key state of a KMS key to enabled. This allows you to use the KMS key for
1044
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. </p>
1045
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
1046
- * 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>
1047
- * <p>
1048
- * <b>Cross-account
1049
- * use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
1050
- *
1051
- * <p>
1052
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:EnableKey</a> (key policy)</p>
1053
- * <p>
1054
- * <b>Related operations</b>: <a>DisableKey</a>
1055
- * </p>
1056
- */
113
+
1057
114
  enableKey(args: EnableKeyCommandInput, options?: __HttpHandlerOptions): Promise<EnableKeyCommandOutput>;
1058
115
  enableKey(args: EnableKeyCommandInput, cb: (err: any, data?: EnableKeyCommandOutput) => void): void;
1059
116
  enableKey(args: EnableKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableKeyCommandOutput) => void): void;
1060
- /**
1061
- * <p>Enables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic rotation
1062
- * of the key material</a> for the specified symmetric KMS key.</p>
1063
- * <p>You cannot enable automatic rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks">asymmetric KMS keys</a>, KMS keys with <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key material</a>, or KMS keys in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. To enable or disable automatic rotation of a set of related <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-replica-key">multi-Region keys</a>, set the property on the primary key.</p>
1064
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
1065
- * 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>
1066
- * <p>
1067
- * <b>Cross-account
1068
- * use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
1069
- *
1070
- * <p>
1071
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:EnableKeyRotation</a> (key policy)</p>
1072
- * <p>
1073
- * <b>Related operations:</b>
1074
- * </p>
1075
- * <ul>
1076
- * <li>
1077
- * <p>
1078
- * <a>DisableKeyRotation</a>
1079
- * </p>
1080
- * </li>
1081
- * <li>
1082
- * <p>
1083
- * <a>GetKeyRotationStatus</a>
1084
- * </p>
1085
- * </li>
1086
- * </ul>
1087
- */
117
+
1088
118
  enableKeyRotation(args: EnableKeyRotationCommandInput, options?: __HttpHandlerOptions): Promise<EnableKeyRotationCommandOutput>;
1089
119
  enableKeyRotation(args: EnableKeyRotationCommandInput, cb: (err: any, data?: EnableKeyRotationCommandOutput) => void): void;
1090
120
  enableKeyRotation(args: EnableKeyRotationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableKeyRotationCommandOutput) => void): void;
1091
- /**
1092
- * <p>Encrypts plaintext into ciphertext by using a KMS key. The <code>Encrypt</code> operation
1093
- * has two primary use cases:</p>
1094
- * <ul>
1095
- * <li>
1096
- * <p>You can encrypt small amounts of arbitrary data, such as a personal identifier or
1097
- * database password, or other sensitive information. </p>
1098
- * </li>
1099
- * <li>
1100
- * <p>You can use the <code>Encrypt</code> operation to move encrypted data from one Amazon Web Services
1101
- * Region to another. For example, in Region A, generate a data key and use the plaintext key
1102
- * to encrypt your data. Then, in Region A, use the <code>Encrypt</code> operation to encrypt
1103
- * the plaintext data key under a KMS key in Region B. Now, you can move the encrypted data
1104
- * and the encrypted data key to Region B. When necessary, you can decrypt the encrypted data
1105
- * key and the encrypted data entirely within in Region B.</p>
1106
- * </li>
1107
- * </ul>
1108
- *
1109
- * <p>You don't need to use the <code>Encrypt</code> operation to encrypt a data key. The <a>GenerateDataKey</a> and <a>GenerateDataKeyPair</a> operations return a
1110
- * plaintext data key and an encrypted copy of that data key.</p>
1111
- *
1112
- * <p>When you encrypt data, you must specify a symmetric or asymmetric KMS key to use in the
1113
- * encryption operation. The KMS key must have a <code>KeyUsage</code> value of
1114
- * <code>ENCRYPT_DECRYPT.</code> To find the <code>KeyUsage</code> of a KMS key, use the <a>DescribeKey</a> operation. </p>
1115
- *
1116
- * <p>If you use a symmetric KMS key, you can use an encryption context to add additional
1117
- * security to your encryption operation. If you specify an <code>EncryptionContext</code> when
1118
- * encrypting data, you must specify the same encryption context (a case-sensitive exact match)
1119
- * when decrypting the data. Otherwise, the request to decrypt fails with an
1120
- * <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
1121
- * Context</a> in the <i>Key Management Service Developer Guide</i>.</p>
1122
- * <p>If you specify an asymmetric KMS key, you must also specify the encryption algorithm. The
1123
- * algorithm must be compatible with the KMS key type.</p>
1124
- * <important>
1125
- * <p>When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails.</p>
1126
- * <p>You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.</p>
1127
- * </important>
1128
- *
1129
- *
1130
- * <p>The maximum size of the data that you can encrypt varies with the type of KMS key and the
1131
- * encryption algorithm that you choose.</p>
1132
- * <ul>
1133
- * <li>
1134
- * <p>Symmetric KMS keys</p>
1135
- * <ul>
1136
- * <li>
1137
- * <p>
1138
- * <code>SYMMETRIC_DEFAULT</code>: 4096 bytes</p>
1139
- * </li>
1140
- * </ul>
1141
- * </li>
1142
- * <li>
1143
- * <p>
1144
- * <code>RSA_2048</code>
1145
- * </p>
1146
- * <ul>
1147
- * <li>
1148
- * <p>
1149
- * <code>RSAES_OAEP_SHA_1</code>: 214 bytes</p>
1150
- * </li>
1151
- * <li>
1152
- * <p>
1153
- * <code>RSAES_OAEP_SHA_256</code>: 190 bytes</p>
1154
- * </li>
1155
- * </ul>
1156
- * </li>
1157
- * <li>
1158
- * <p>
1159
- * <code>RSA_3072</code>
1160
- * </p>
1161
- * <ul>
1162
- * <li>
1163
- * <p>
1164
- * <code>RSAES_OAEP_SHA_1</code>: 342 bytes</p>
1165
- * </li>
1166
- * <li>
1167
- * <p>
1168
- * <code>RSAES_OAEP_SHA_256</code>: 318 bytes</p>
1169
- * </li>
1170
- * </ul>
1171
- * </li>
1172
- * <li>
1173
- * <p>
1174
- * <code>RSA_4096</code>
1175
- * </p>
1176
- * <ul>
1177
- * <li>
1178
- * <p>
1179
- * <code>RSAES_OAEP_SHA_1</code>: 470 bytes</p>
1180
- * </li>
1181
- * <li>
1182
- * <p>
1183
- * <code>RSAES_OAEP_SHA_256</code>: 446 bytes</p>
1184
- * </li>
1185
- * </ul>
1186
- * </li>
1187
- * </ul>
1188
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
1189
- * 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>
1190
- * <p>
1191
- * <b>Cross-account use</b>: Yes.
1192
- * To perform this operation with a KMS key in a different Amazon Web Services account, specify
1193
- * the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
1194
- *
1195
- * <p>
1196
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:Encrypt</a> (key policy)</p>
1197
- * <p>
1198
- * <b>Related operations:</b>
1199
- * </p>
1200
- * <ul>
1201
- * <li>
1202
- * <p>
1203
- * <a>Decrypt</a>
1204
- * </p>
1205
- * </li>
1206
- * <li>
1207
- * <p>
1208
- * <a>GenerateDataKey</a>
1209
- * </p>
1210
- * </li>
1211
- * <li>
1212
- * <p>
1213
- * <a>GenerateDataKeyPair</a>
1214
- * </p>
1215
- * </li>
1216
- * </ul>
1217
- */
121
+
1218
122
  encrypt(args: EncryptCommandInput, options?: __HttpHandlerOptions): Promise<EncryptCommandOutput>;
1219
123
  encrypt(args: EncryptCommandInput, cb: (err: any, data?: EncryptCommandOutput) => void): void;
1220
124
  encrypt(args: EncryptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EncryptCommandOutput) => void): void;
1221
- /**
1222
- * <p>Generates a unique symmetric data key for client-side encryption. This operation returns a
1223
- * plaintext copy of the data key and a copy that is encrypted under a KMS key that you specify.
1224
- * You can use the plaintext key to encrypt your data outside of KMS and store the encrypted
1225
- * data key with the encrypted data.</p>
1226
- *
1227
- * <p>
1228
- * <code>GenerateDataKey</code> returns a unique data key for each request. The bytes in the
1229
- * plaintext key are not related to the caller or the KMS key.</p>
1230
- *
1231
- * <p>To generate a data key, specify the symmetric KMS key that will be used to encrypt the
1232
- * data key. You cannot use an asymmetric KMS key to generate data keys. To get the type of your
1233
- * KMS key, use the <a>DescribeKey</a> operation. You must also specify the length of
1234
- * the data key. Use either the <code>KeySpec</code> or <code>NumberOfBytes</code> parameters
1235
- * (but not both). For 128-bit and 256-bit data keys, use the <code>KeySpec</code> parameter. </p>
1236
- *
1237
- * <p>To get only an encrypted copy of the data key, use <a>GenerateDataKeyWithoutPlaintext</a>. To generate an asymmetric data key pair, use
1238
- * the <a>GenerateDataKeyPair</a> or <a>GenerateDataKeyPairWithoutPlaintext</a> operation. To get a cryptographically secure
1239
- * random byte string, use <a>GenerateRandom</a>.</p>
1240
- *
1241
- * <p>You can use the optional encryption context to add additional security to the encryption
1242
- * operation. If you specify an <code>EncryptionContext</code>, you must specify the same
1243
- * encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
1244
- * Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the
1245
- * <i>Key Management Service Developer Guide</i>.</p>
1246
- * <p>Applications in Amazon Web Services Nitro Enclaves can call this operation by using the <a href="https://github.com/aws/aws-nitro-enclaves-sdk-c">Amazon Web Services Nitro Enclaves Development Kit</a>. For information about the supporting parameters, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves use KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
1247
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
1248
- * 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>
1249
- * <p>
1250
- * <b>How to use your data
1251
- * key</b>
1252
- * </p>
1253
- * <p>We recommend that you use the following pattern to encrypt data locally in your
1254
- * application. You can write your own code or use a client-side encryption library, such as the
1255
- * <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">Amazon Web Services Encryption SDK</a>, the
1256
- * <a href="https://docs.aws.amazon.com/dynamodb-encryption-client/latest/devguide/">Amazon DynamoDB Encryption Client</a>,
1257
- * or <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3
1258
- * client-side encryption</a> to do these tasks for you.</p>
1259
- * <p>To encrypt data outside of KMS:</p>
1260
- * <ol>
1261
- * <li>
1262
- * <p>Use the <code>GenerateDataKey</code> operation to get a data key.</p>
1263
- * </li>
1264
- * <li>
1265
- * <p>Use the plaintext data key (in the <code>Plaintext</code> field of the response) to
1266
- * encrypt your data outside of KMS. Then erase the plaintext data key from memory.</p>
1267
- * </li>
1268
- * <li>
1269
- * <p>Store the encrypted data key (in the <code>CiphertextBlob</code> field of the
1270
- * response) with the encrypted data.</p>
1271
- * </li>
1272
- * </ol>
1273
- * <p>To decrypt data outside of KMS:</p>
1274
- * <ol>
1275
- * <li>
1276
- * <p>Use the <a>Decrypt</a> operation to decrypt the encrypted data key. The
1277
- * operation returns a plaintext copy of the data key.</p>
1278
- * </li>
1279
- * <li>
1280
- * <p>Use the plaintext data key to decrypt data outside of KMS, then erase the plaintext
1281
- * data key from memory.</p>
1282
- * </li>
1283
- * </ol>
1284
- * <p>
1285
- * <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
1286
- * the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
1287
- *
1288
- * <p>
1289
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GenerateDataKey</a> (key policy)</p>
1290
- * <p>
1291
- * <b>Related operations:</b>
1292
- * </p>
1293
- * <ul>
1294
- * <li>
1295
- * <p>
1296
- * <a>Decrypt</a>
1297
- * </p>
1298
- * </li>
1299
- * <li>
1300
- * <p>
1301
- * <a>Encrypt</a>
1302
- * </p>
1303
- * </li>
1304
- * <li>
1305
- * <p>
1306
- * <a>GenerateDataKeyPair</a>
1307
- * </p>
1308
- * </li>
1309
- * <li>
1310
- * <p>
1311
- * <a>GenerateDataKeyPairWithoutPlaintext</a>
1312
- * </p>
1313
- * </li>
1314
- * <li>
1315
- * <p>
1316
- * <a>GenerateDataKeyWithoutPlaintext</a>
1317
- * </p>
1318
- * </li>
1319
- * </ul>
1320
- */
125
+
1321
126
  generateDataKey(args: GenerateDataKeyCommandInput, options?: __HttpHandlerOptions): Promise<GenerateDataKeyCommandOutput>;
1322
127
  generateDataKey(args: GenerateDataKeyCommandInput, cb: (err: any, data?: GenerateDataKeyCommandOutput) => void): void;
1323
128
  generateDataKey(args: GenerateDataKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateDataKeyCommandOutput) => void): void;
1324
- /**
1325
- * <p>Generates a unique asymmetric data key pair. The <code>GenerateDataKeyPair</code>
1326
- * operation returns a plaintext public key, a plaintext private key, and a copy of the private
1327
- * key that is encrypted under the symmetric KMS key you specify. You can use the data key pair
1328
- * to perform asymmetric cryptography and implement digital signatures outside of KMS.</p>
1329
- *
1330
- * <p>You can use the public key that <code>GenerateDataKeyPair</code> returns to encrypt data
1331
- * or verify a signature outside of KMS. Then, store the encrypted private key with the data.
1332
- * When you are ready to decrypt data or sign a message, you can use the <a>Decrypt</a> operation to decrypt the encrypted private key.</p>
1333
- *
1334
- * <p>To generate a data key pair, you must specify a symmetric KMS key to encrypt the private
1335
- * key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a custom key
1336
- * store. To get the type and origin of your KMS key, use the <a>DescribeKey</a>
1337
- * operation. </p>
1338
- * <p>Use the <code>KeyPairSpec</code> parameter to choose an RSA or Elliptic Curve (ECC) data
1339
- * key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs for
1340
- * either encryption or signing, but not both. However, KMS cannot enforce any restrictions on
1341
- * the use of data key pairs outside of KMS.</p>
1342
- *
1343
- * <p>If you are using the data key pair to encrypt data, or for any operation where you don't
1344
- * immediately need a private key, consider using the <a>GenerateDataKeyPairWithoutPlaintext</a> operation.
1345
- * <code>GenerateDataKeyPairWithoutPlaintext</code> returns a plaintext public key and an
1346
- * encrypted private key, but omits the plaintext private key that you need only to decrypt
1347
- * ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use
1348
- * the <a>Decrypt</a> operation to decrypt the encrypted private key in the data key
1349
- * pair.</p>
1350
- *
1351
- * <p>
1352
- * <code>GenerateDataKeyPair</code> returns a unique data key pair for each request. The
1353
- * bytes in the keys are not related to the caller or the KMS key that is used to encrypt the
1354
- * private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in
1355
- * <a href="https://tools.ietf.org/html/rfc5280">RFC 5280</a>. The private key is a
1356
- * DER-encoded PKCS8 PrivateKeyInfo, as specified in <a href="https://tools.ietf.org/html/rfc5958">RFC 5958</a>.</p>
1357
- *
1358
- * <p>You can use the optional encryption context to add additional security to the encryption
1359
- * operation. If you specify an <code>EncryptionContext</code>, you must specify the same
1360
- * encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
1361
- * Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the
1362
- * <i>Key Management Service Developer Guide</i>.</p>
1363
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
1364
- * 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>
1365
- * <p>
1366
- * <b>Cross-account
1367
- * use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
1368
- * the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
1369
- *
1370
- * <p>
1371
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GenerateDataKeyPair</a> (key policy)</p>
1372
- * <p>
1373
- * <b>Related operations:</b>
1374
- * </p>
1375
- * <ul>
1376
- * <li>
1377
- * <p>
1378
- * <a>Decrypt</a>
1379
- * </p>
1380
- * </li>
1381
- * <li>
1382
- * <p>
1383
- * <a>Encrypt</a>
1384
- * </p>
1385
- * </li>
1386
- * <li>
1387
- * <p>
1388
- * <a>GenerateDataKey</a>
1389
- * </p>
1390
- * </li>
1391
- * <li>
1392
- * <p>
1393
- * <a>GenerateDataKeyPairWithoutPlaintext</a>
1394
- * </p>
1395
- * </li>
1396
- * <li>
1397
- * <p>
1398
- * <a>GenerateDataKeyWithoutPlaintext</a>
1399
- * </p>
1400
- * </li>
1401
- * </ul>
1402
- */
129
+
1403
130
  generateDataKeyPair(args: GenerateDataKeyPairCommandInput, options?: __HttpHandlerOptions): Promise<GenerateDataKeyPairCommandOutput>;
1404
131
  generateDataKeyPair(args: GenerateDataKeyPairCommandInput, cb: (err: any, data?: GenerateDataKeyPairCommandOutput) => void): void;
1405
132
  generateDataKeyPair(args: GenerateDataKeyPairCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateDataKeyPairCommandOutput) => void): void;
1406
- /**
1407
- * <p>Generates a unique asymmetric data key pair. The
1408
- * <code>GenerateDataKeyPairWithoutPlaintext</code> operation returns a plaintext public key
1409
- * and a copy of the private key that is encrypted under the symmetric KMS key you specify.
1410
- * Unlike <a>GenerateDataKeyPair</a>, this operation does not return a plaintext
1411
- * private key. </p>
1412
- * <p>You can use the public key that <code>GenerateDataKeyPairWithoutPlaintext</code> returns
1413
- * to encrypt data or verify a signature outside of KMS. Then, store the encrypted private key
1414
- * with the data. When you are ready to decrypt data or sign a message, you can use the <a>Decrypt</a> operation to decrypt the encrypted private key.</p>
1415
- * <p>To generate a data key pair, you must specify a symmetric KMS key to encrypt the private
1416
- * key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a custom key
1417
- * store. To get the type and origin of your KMS key, use the <a>DescribeKey</a>
1418
- * operation. </p>
1419
- * <p>Use the <code>KeyPairSpec</code> parameter to choose an RSA or Elliptic Curve (ECC) data
1420
- * key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs for
1421
- * either encryption or signing, but not both. However, KMS cannot enforce any restrictions on
1422
- * the use of data key pairs outside of KMS.</p>
1423
- * <p>
1424
- * <code>GenerateDataKeyPairWithoutPlaintext</code> returns a unique data key pair for each
1425
- * request. The bytes in the key are not related to the caller or KMS key that is used to encrypt
1426
- * the private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in
1427
- * <a href="https://tools.ietf.org/html/rfc5280">RFC 5280</a>.</p>
1428
- *
1429
- * <p>You can use the optional encryption context to add additional security to the encryption
1430
- * operation. If you specify an <code>EncryptionContext</code>, you must specify the same
1431
- * encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
1432
- * Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the
1433
- * <i>Key Management Service Developer Guide</i>.</p>
1434
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
1435
- * 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>
1436
- * <p>
1437
- * <b>Cross-account
1438
- * use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
1439
- * the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
1440
- *
1441
- * <p>
1442
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GenerateDataKeyPairWithoutPlaintext</a> (key
1443
- * policy)</p>
1444
- * <p>
1445
- * <b>Related operations:</b>
1446
- * </p>
1447
- * <ul>
1448
- * <li>
1449
- * <p>
1450
- * <a>Decrypt</a>
1451
- * </p>
1452
- * </li>
1453
- * <li>
1454
- * <p>
1455
- * <a>Encrypt</a>
1456
- * </p>
1457
- * </li>
1458
- * <li>
1459
- * <p>
1460
- * <a>GenerateDataKey</a>
1461
- * </p>
1462
- * </li>
1463
- * <li>
1464
- * <p>
1465
- * <a>GenerateDataKeyPair</a>
1466
- * </p>
1467
- * </li>
1468
- * <li>
1469
- * <p>
1470
- * <a>GenerateDataKeyWithoutPlaintext</a>
1471
- * </p>
1472
- * </li>
1473
- * </ul>
1474
- */
133
+
1475
134
  generateDataKeyPairWithoutPlaintext(args: GenerateDataKeyPairWithoutPlaintextCommandInput, options?: __HttpHandlerOptions): Promise<GenerateDataKeyPairWithoutPlaintextCommandOutput>;
1476
135
  generateDataKeyPairWithoutPlaintext(args: GenerateDataKeyPairWithoutPlaintextCommandInput, cb: (err: any, data?: GenerateDataKeyPairWithoutPlaintextCommandOutput) => void): void;
1477
136
  generateDataKeyPairWithoutPlaintext(args: GenerateDataKeyPairWithoutPlaintextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateDataKeyPairWithoutPlaintextCommandOutput) => void): void;
1478
- /**
1479
- * <p>Generates a unique symmetric data key. This operation returns a data key that is encrypted
1480
- * under a KMS key that you specify. To request an asymmetric data key pair, use the <a>GenerateDataKeyPair</a> or <a>GenerateDataKeyPairWithoutPlaintext</a>
1481
- * operations.</p>
1482
- * <p>
1483
- * <code>GenerateDataKeyWithoutPlaintext</code> is identical to the <a>GenerateDataKey</a> operation except that returns only the encrypted copy of the
1484
- * data key. This operation is useful for systems that need to encrypt data at some point, but
1485
- * not immediately. When you need to encrypt the data, you call the <a>Decrypt</a>
1486
- * operation on the encrypted copy of the key. </p>
1487
- * <p>It's also useful in distributed systems with different levels of trust. For example, you
1488
- * might store encrypted data in containers. One component of your system creates new containers
1489
- * and stores an encrypted data key with each container. Then, a different component puts the
1490
- * data into the containers. That component first decrypts the data key, uses the plaintext data
1491
- * key to encrypt data, puts the encrypted data into the container, and then destroys the
1492
- * plaintext data key. In this system, the component that creates the containers never sees the
1493
- * plaintext data key.</p>
1494
- * <p>
1495
- * <code>GenerateDataKeyWithoutPlaintext</code> returns a unique data key for each request.
1496
- * The bytes in the keys are not related to the caller or KMS key that is used to encrypt the
1497
- * private key.</p>
1498
- *
1499
- * <p>To generate a data key, you must specify the symmetric KMS key that is used to encrypt the
1500
- * data key. You cannot use an asymmetric KMS key to generate a data key. To get the type of your
1501
- * KMS key, use the <a>DescribeKey</a> operation.</p>
1502
- *
1503
- * <p>If the operation succeeds, you will find the encrypted copy of the data key in the
1504
- * <code>CiphertextBlob</code> field.</p>
1505
- *
1506
- * <p>You can use the optional encryption context to add additional security to the encryption
1507
- * operation. If you specify an <code>EncryptionContext</code>, you must specify the same
1508
- * encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
1509
- * Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the
1510
- * <i>Key Management Service Developer Guide</i>.</p>
1511
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
1512
- * 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>
1513
- * <p>
1514
- * <b>Cross-account
1515
- * use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
1516
- * the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
1517
- *
1518
- * <p>
1519
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GenerateDataKeyWithoutPlaintext</a> (key
1520
- * policy)</p>
1521
- * <p>
1522
- * <b>Related operations:</b>
1523
- * </p>
1524
- * <ul>
1525
- * <li>
1526
- * <p>
1527
- * <a>Decrypt</a>
1528
- * </p>
1529
- * </li>
1530
- * <li>
1531
- * <p>
1532
- * <a>Encrypt</a>
1533
- * </p>
1534
- * </li>
1535
- * <li>
1536
- * <p>
1537
- * <a>GenerateDataKey</a>
1538
- * </p>
1539
- * </li>
1540
- * <li>
1541
- * <p>
1542
- * <a>GenerateDataKeyPair</a>
1543
- * </p>
1544
- * </li>
1545
- * <li>
1546
- * <p>
1547
- * <a>GenerateDataKeyPairWithoutPlaintext</a>
1548
- * </p>
1549
- * </li>
1550
- * </ul>
1551
- */
137
+
1552
138
  generateDataKeyWithoutPlaintext(args: GenerateDataKeyWithoutPlaintextCommandInput, options?: __HttpHandlerOptions): Promise<GenerateDataKeyWithoutPlaintextCommandOutput>;
1553
139
  generateDataKeyWithoutPlaintext(args: GenerateDataKeyWithoutPlaintextCommandInput, cb: (err: any, data?: GenerateDataKeyWithoutPlaintextCommandOutput) => void): void;
1554
140
  generateDataKeyWithoutPlaintext(args: GenerateDataKeyWithoutPlaintextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateDataKeyWithoutPlaintextCommandOutput) => void): void;
1555
- /**
1556
- * <p>Returns a random byte string that is cryptographically secure.</p>
1557
- * <p>By default, the random byte string is generated in KMS. To generate the byte string in
1558
- * the CloudHSM cluster that is associated with a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>, specify the custom key store
1559
- * ID.</p>
1560
- * <p>Applications in Amazon Web Services Nitro Enclaves can call this operation by using the <a href="https://github.com/aws/aws-nitro-enclaves-sdk-c">Amazon Web Services Nitro Enclaves Development Kit</a>. For information about the supporting parameters, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves use KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
1561
- * <p>For more information about entropy and random number generation, see
1562
- * <a href="https://docs.aws.amazon.com/kms/latest/cryptographic-details/">Key Management Service Cryptographic Details</a>.</p>
1563
- *
1564
- * <p>
1565
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GenerateRandom</a> (IAM policy)</p>
1566
- */
141
+
1567
142
  generateRandom(args: GenerateRandomCommandInput, options?: __HttpHandlerOptions): Promise<GenerateRandomCommandOutput>;
1568
143
  generateRandom(args: GenerateRandomCommandInput, cb: (err: any, data?: GenerateRandomCommandOutput) => void): void;
1569
144
  generateRandom(args: GenerateRandomCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateRandomCommandOutput) => void): void;
1570
- /**
1571
- * <p>Gets a key policy attached to the specified KMS key.</p>
1572
- * <p>
1573
- * <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
1574
- *
1575
- * <p>
1576
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GetKeyPolicy</a> (key policy)</p>
1577
- * <p>
1578
- * <b>Related operations</b>: <a>PutKeyPolicy</a>
1579
- * </p>
1580
- */
145
+
1581
146
  getKeyPolicy(args: GetKeyPolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetKeyPolicyCommandOutput>;
1582
147
  getKeyPolicy(args: GetKeyPolicyCommandInput, cb: (err: any, data?: GetKeyPolicyCommandOutput) => void): void;
1583
148
  getKeyPolicy(args: GetKeyPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetKeyPolicyCommandOutput) => void): void;
1584
- /**
1585
- * <p>Gets a Boolean value that indicates whether <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic rotation of the key material</a> is
1586
- * enabled for the specified KMS key.</p>
1587
- * <p>You cannot enable automatic rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks">asymmetric KMS keys</a>, KMS keys with <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key material</a>, or KMS keys in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. To enable or disable automatic rotation of a set of related <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-replica-key">multi-Region keys</a>, set the property on the primary key. The key rotation status for these KMS keys is always
1588
- * <code>false</code>.</p>
1589
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
1590
- * 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>
1591
- * <ul>
1592
- * <li>
1593
- * <p>Disabled: The key rotation status does not change when you disable a KMS key. However,
1594
- * while the KMS key is disabled, KMS does not rotate the key material.</p>
1595
- * </li>
1596
- * <li>
1597
- * <p>Pending deletion: While a KMS key is pending deletion, its key rotation status is
1598
- * <code>false</code> and KMS does not rotate the key material. If you cancel the
1599
- * deletion, the original key rotation status is restored.</p>
1600
- * </li>
1601
- * </ul>
1602
- * <p>
1603
- * <b>Cross-account use</b>: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key
1604
- * ARN in the value of the <code>KeyId</code> parameter.</p>
1605
- *
1606
- * <p>
1607
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GetKeyRotationStatus</a> (key policy)</p>
1608
- * <p>
1609
- * <b>Related operations:</b>
1610
- * </p>
1611
- * <ul>
1612
- * <li>
1613
- * <p>
1614
- * <a>DisableKeyRotation</a>
1615
- * </p>
1616
- * </li>
1617
- * <li>
1618
- * <p>
1619
- * <a>EnableKeyRotation</a>
1620
- * </p>
1621
- * </li>
1622
- * </ul>
1623
- */
149
+
1624
150
  getKeyRotationStatus(args: GetKeyRotationStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetKeyRotationStatusCommandOutput>;
1625
151
  getKeyRotationStatus(args: GetKeyRotationStatusCommandInput, cb: (err: any, data?: GetKeyRotationStatusCommandOutput) => void): void;
1626
152
  getKeyRotationStatus(args: GetKeyRotationStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetKeyRotationStatusCommandOutput) => void): void;
1627
- /**
1628
- * <p>Returns the items you need to import key material into a symmetric, customer managed KMS
1629
- * key. For more information about importing key material into KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a>
1630
- * in the <i>Key Management Service Developer Guide</i>.</p>
1631
- * <p>This operation returns a public key and an import token. Use the public key to encrypt the
1632
- * symmetric key material. Store the import token to send with a subsequent <a>ImportKeyMaterial</a> request.</p>
1633
- * <p>You must specify the key ID of the symmetric KMS key into which you will import key
1634
- * material. This KMS key's <code>Origin</code> must be <code>EXTERNAL</code>. You must also
1635
- * specify the wrapping algorithm and type of wrapping key (public key) that you will use to
1636
- * encrypt the key material. You cannot perform this operation on an asymmetric KMS key or on any KMS key in a different Amazon Web Services account.</p>
1637
- * <p>To import key material, you must use the public key and import token from the same
1638
- * response. These items are valid for 24 hours. The expiration date and time appear in the
1639
- * <code>GetParametersForImport</code> response. You cannot use an expired token in an <a>ImportKeyMaterial</a> request. If your key and token expire, send another
1640
- * <code>GetParametersForImport</code> request.</p>
1641
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
1642
- * 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>
1643
- * <p>
1644
- * <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
1645
- *
1646
- * <p>
1647
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GetParametersForImport</a> (key policy)</p>
1648
- * <p>
1649
- * <b>Related operations:</b>
1650
- * </p>
1651
- * <ul>
1652
- * <li>
1653
- * <p>
1654
- * <a>ImportKeyMaterial</a>
1655
- * </p>
1656
- * </li>
1657
- * <li>
1658
- * <p>
1659
- * <a>DeleteImportedKeyMaterial</a>
1660
- * </p>
1661
- * </li>
1662
- * </ul>
1663
- */
153
+
1664
154
  getParametersForImport(args: GetParametersForImportCommandInput, options?: __HttpHandlerOptions): Promise<GetParametersForImportCommandOutput>;
1665
155
  getParametersForImport(args: GetParametersForImportCommandInput, cb: (err: any, data?: GetParametersForImportCommandOutput) => void): void;
1666
156
  getParametersForImport(args: GetParametersForImportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetParametersForImportCommandOutput) => void): void;
1667
- /**
1668
- * <p>Returns the public key of an asymmetric KMS key. Unlike the private key of a asymmetric
1669
- * KMS key, which never leaves KMS unencrypted, callers with <code>kms:GetPublicKey</code>
1670
- * permission can download the public key of an asymmetric KMS key. You can share the public key
1671
- * to allow others to encrypt messages and verify signatures outside of KMS.
1672
- * For information about symmetric and asymmetric KMS keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
1673
- * <p>You do not need to download the public key. Instead, you can use the public key within
1674
- * KMS by calling the <a>Encrypt</a>, <a>ReEncrypt</a>, or <a>Verify</a> operations with the identifier of an asymmetric KMS key. When you use the
1675
- * public key within KMS, you benefit from the authentication, authorization, and logging that
1676
- * are part of every KMS operation. You also reduce of risk of encrypting data that cannot be
1677
- * decrypted. These features are not effective outside of KMS. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/download-public-key.html#download-public-key-considerations">Special
1678
- * Considerations for Downloading Public Keys</a>.</p>
1679
- * <p>To help you use the public key safely outside of KMS, <code>GetPublicKey</code> returns
1680
- * important information about the public key in the response, including:</p>
1681
- * <ul>
1682
- * <li>
1683
- * <p>
1684
- * <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-KeySpec">KeySpec</a>: The type of key material in the public key, such as
1685
- * <code>RSA_4096</code> or <code>ECC_NIST_P521</code>.</p>
1686
- * </li>
1687
- * <li>
1688
- * <p>
1689
- * <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-KeyUsage">KeyUsage</a>: Whether the key is used for encryption or signing.</p>
1690
- * </li>
1691
- * <li>
1692
- * <p>
1693
- * <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-EncryptionAlgorithms">EncryptionAlgorithms</a> or <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-SigningAlgorithms">SigningAlgorithms</a>: A list of the encryption algorithms or the signing
1694
- * algorithms for the key.</p>
1695
- * </li>
1696
- * </ul>
1697
- * <p>Although KMS cannot enforce these restrictions on external operations, it is crucial
1698
- * that you use this information to prevent the public key from being used improperly. For
1699
- * example, you can prevent a public signing key from being used encrypt data, or prevent a
1700
- * public key from being used with an encryption algorithm that is not supported by KMS. You
1701
- * can also avoid errors, such as using the wrong signing algorithm in a verification
1702
- * operation.</p>
1703
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
1704
- * 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>
1705
- * <p>
1706
- * <b>Cross-account use</b>:
1707
- * Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
1708
- * the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
1709
- *
1710
- * <p>
1711
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GetPublicKey</a> (key policy)</p>
1712
- * <p>
1713
- * <b>Related operations</b>: <a>CreateKey</a>
1714
- * </p>
1715
- */
157
+
1716
158
  getPublicKey(args: GetPublicKeyCommandInput, options?: __HttpHandlerOptions): Promise<GetPublicKeyCommandOutput>;
1717
159
  getPublicKey(args: GetPublicKeyCommandInput, cb: (err: any, data?: GetPublicKeyCommandOutput) => void): void;
1718
160
  getPublicKey(args: GetPublicKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPublicKeyCommandOutput) => void): void;
1719
- /**
1720
- * <p>Imports key material into an existing symmetric KMS KMS key that was created without key
1721
- * material. After you successfully import key material into a KMS key, you can <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#reimport-key-material">reimport
1722
- * the same key material</a> into that KMS key, but you cannot import different key
1723
- * material. </p>
1724
- * <p>You cannot perform this operation on an asymmetric KMS key or on any KMS key in a different Amazon Web Services account. For more information about creating KMS keys with no key material
1725
- * and then importing key material, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a> in the
1726
- * <i>Key Management Service Developer Guide</i>.</p>
1727
- * <p>Before using this operation, call <a>GetParametersForImport</a>. Its response
1728
- * includes a public key and an import token. Use the public key to encrypt the key material.
1729
- * Then, submit the import token from the same <code>GetParametersForImport</code>
1730
- * response.</p>
1731
- * <p>When calling this operation, you must specify the following values:</p>
1732
- * <ul>
1733
- * <li>
1734
- * <p>The key ID or key ARN of a KMS key with no key material. Its <code>Origin</code> must
1735
- * be <code>EXTERNAL</code>.</p>
1736
- * <p>To create a KMS key with no key material, call <a>CreateKey</a> and set the
1737
- * value of its <code>Origin</code> parameter to <code>EXTERNAL</code>. To get the
1738
- * <code>Origin</code> of a KMS key, call <a>DescribeKey</a>.)</p>
1739
- * </li>
1740
- * <li>
1741
- * <p>The encrypted key material. To get the public key to encrypt the key material, call
1742
- * <a>GetParametersForImport</a>.</p>
1743
- * </li>
1744
- * <li>
1745
- * <p>The import token that <a>GetParametersForImport</a> returned. You must use
1746
- * a public key and token from the same <code>GetParametersForImport</code> response.</p>
1747
- * </li>
1748
- * <li>
1749
- * <p>Whether the key material expires and if so, when. If you set an expiration date, KMS
1750
- * deletes the key material from the KMS key on the specified date, and the KMS key becomes
1751
- * unusable. To use the KMS key again, you must reimport the same key material. The only way
1752
- * to change an expiration date is by reimporting the same key material and specifying a new
1753
- * expiration date. </p>
1754
- * </li>
1755
- * </ul>
1756
- * <p>When this operation is successful, the key state of the KMS key changes from
1757
- * <code>PendingImport</code> to <code>Enabled</code>, and you can use the KMS key.</p>
1758
- * <p>If this operation fails, use the exception to help determine the problem. If the error is
1759
- * related to the key material, the import token, or wrapping key, use <a>GetParametersForImport</a> to get a new public key and import token for the KMS key
1760
- * and repeat the import procedure. For help, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#importing-keys-overview">How To Import Key
1761
- * Material</a> in the <i>Key Management Service Developer Guide</i>.</p>
1762
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
1763
- * 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>
1764
- * <p>
1765
- * <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
1766
- *
1767
- * <p>
1768
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ImportKeyMaterial</a> (key policy)</p>
1769
- * <p>
1770
- * <b>Related operations:</b>
1771
- * </p>
1772
- * <ul>
1773
- * <li>
1774
- * <p>
1775
- * <a>DeleteImportedKeyMaterial</a>
1776
- * </p>
1777
- * </li>
1778
- * <li>
1779
- * <p>
1780
- * <a>GetParametersForImport</a>
1781
- * </p>
1782
- * </li>
1783
- * </ul>
1784
- */
161
+
1785
162
  importKeyMaterial(args: ImportKeyMaterialCommandInput, options?: __HttpHandlerOptions): Promise<ImportKeyMaterialCommandOutput>;
1786
163
  importKeyMaterial(args: ImportKeyMaterialCommandInput, cb: (err: any, data?: ImportKeyMaterialCommandOutput) => void): void;
1787
164
  importKeyMaterial(args: ImportKeyMaterialCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportKeyMaterialCommandOutput) => void): void;
1788
- /**
1789
- * <p>Gets a list of aliases in the caller's Amazon Web Services account and region. For more information
1790
- * about aliases, see <a>CreateAlias</a>.</p>
1791
- * <p>By default, the <code>ListAliases</code> operation returns all aliases in the account and
1792
- * region. To get only the aliases associated with a particular KMS key, use the
1793
- * <code>KeyId</code> parameter.</p>
1794
- * <p>The <code>ListAliases</code> response can include aliases that you created and associated
1795
- * with your customer managed keys, and aliases that Amazon Web Services created and associated with Amazon Web Services
1796
- * managed keys in your account. You can recognize Amazon Web Services aliases because their names have the
1797
- * format <code>aws/<service-name></code>, such as <code>aws/dynamodb</code>.</p>
1798
- * <p>The response might also include aliases that have no <code>TargetKeyId</code> field. These
1799
- * are predefined aliases that Amazon Web Services has created but has not yet associated with a KMS key.
1800
- * Aliases that Amazon Web Services creates in your account, including predefined aliases, do not count against
1801
- * your <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit">KMS aliases
1802
- * quota</a>.</p>
1803
- * <p>
1804
- * <b>Cross-account use</b>: No. <code>ListAliases</code> does not
1805
- * return aliases in other Amazon Web Services accounts.</p>
1806
- *
1807
- *
1808
- * <p>
1809
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListAliases</a> (IAM policy)</p>
1810
- * <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
1811
- * <i>Key Management Service Developer Guide</i>.</p>
1812
- * <p>
1813
- * <b>Related operations:</b>
1814
- * </p>
1815
- * <ul>
1816
- * <li>
1817
- * <p>
1818
- * <a>CreateAlias</a>
1819
- * </p>
1820
- * </li>
1821
- * <li>
1822
- * <p>
1823
- * <a>DeleteAlias</a>
1824
- * </p>
1825
- * </li>
1826
- * <li>
1827
- * <p>
1828
- * <a>UpdateAlias</a>
1829
- * </p>
1830
- * </li>
1831
- * </ul>
1832
- */
165
+
1833
166
  listAliases(args: ListAliasesCommandInput, options?: __HttpHandlerOptions): Promise<ListAliasesCommandOutput>;
1834
167
  listAliases(args: ListAliasesCommandInput, cb: (err: any, data?: ListAliasesCommandOutput) => void): void;
1835
168
  listAliases(args: ListAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAliasesCommandOutput) => void): void;
1836
- /**
1837
- * <p>Gets a list of all grants for the specified KMS key. </p>
1838
- * <p>You must specify the KMS key in all requests. You can filter the grant list by grant ID or
1839
- * grantee principal.</p>
1840
- * <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
1841
- * <i>
1842
- * <i>Key Management Service Developer Guide</i>
1843
- * </i>. For examples of working with grants in several
1844
- * programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a>. </p>
1845
- * <note>
1846
- * <p>The <code>GranteePrincipal</code> field in the <code>ListGrants</code> response usually contains the
1847
- * user or role designated as the grantee principal in the grant. However, when the grantee
1848
- * principal in the grant is an Amazon Web Services service, the <code>GranteePrincipal</code> field contains
1849
- * the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services">service
1850
- * principal</a>, which might represent several different grantee principals.</p>
1851
- * </note>
1852
- * <p>
1853
- * <b>Cross-account use</b>: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key
1854
- * ARN in the value of the <code>KeyId</code> parameter.</p>
1855
- *
1856
- * <p>
1857
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListGrants</a> (key policy)</p>
1858
- * <p>
1859
- * <b>Related operations:</b>
1860
- * </p>
1861
- * <ul>
1862
- * <li>
1863
- * <p>
1864
- * <a>CreateGrant</a>
1865
- * </p>
1866
- * </li>
1867
- * <li>
1868
- * <p>
1869
- * <a>ListRetirableGrants</a>
1870
- * </p>
1871
- * </li>
1872
- * <li>
1873
- * <p>
1874
- * <a>RetireGrant</a>
1875
- * </p>
1876
- * </li>
1877
- * <li>
1878
- * <p>
1879
- * <a>RevokeGrant</a>
1880
- * </p>
1881
- * </li>
1882
- * </ul>
1883
- */
169
+
1884
170
  listGrants(args: ListGrantsCommandInput, options?: __HttpHandlerOptions): Promise<ListGrantsCommandOutput>;
1885
171
  listGrants(args: ListGrantsCommandInput, cb: (err: any, data?: ListGrantsCommandOutput) => void): void;
1886
172
  listGrants(args: ListGrantsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGrantsCommandOutput) => void): void;
1887
- /**
1888
- * <p>Gets the names of the key policies that are attached to a KMS key. This operation is
1889
- * designed to get policy names that you can use in a <a>GetKeyPolicy</a> operation.
1890
- * However, the only valid policy name is <code>default</code>. </p>
1891
- * <p>
1892
- * <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
1893
- *
1894
- * <p>
1895
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListKeyPolicies</a> (key policy)</p>
1896
- * <p>
1897
- * <b>Related operations:</b>
1898
- * </p>
1899
- * <ul>
1900
- * <li>
1901
- * <p>
1902
- * <a>GetKeyPolicy</a>
1903
- * </p>
1904
- * </li>
1905
- * <li>
1906
- * <p>
1907
- * <a>PutKeyPolicy</a>
1908
- * </p>
1909
- * </li>
1910
- * </ul>
1911
- */
173
+
1912
174
  listKeyPolicies(args: ListKeyPoliciesCommandInput, options?: __HttpHandlerOptions): Promise<ListKeyPoliciesCommandOutput>;
1913
175
  listKeyPolicies(args: ListKeyPoliciesCommandInput, cb: (err: any, data?: ListKeyPoliciesCommandOutput) => void): void;
1914
176
  listKeyPolicies(args: ListKeyPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListKeyPoliciesCommandOutput) => void): void;
1915
- /**
1916
- * <p>Gets a list of all KMS keys in the caller's Amazon Web Services account and Region.</p>
1917
- * <p>
1918
- * <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
1919
- *
1920
- * <p>
1921
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListKeys</a> (IAM policy)</p>
1922
- * <p>
1923
- * <b>Related operations:</b>
1924
- * </p>
1925
- * <ul>
1926
- * <li>
1927
- * <p>
1928
- * <a>CreateKey</a>
1929
- * </p>
1930
- * </li>
1931
- * <li>
1932
- * <p>
1933
- * <a>DescribeKey</a>
1934
- * </p>
1935
- * </li>
1936
- * <li>
1937
- * <p>
1938
- * <a>ListAliases</a>
1939
- * </p>
1940
- * </li>
1941
- * <li>
1942
- * <p>
1943
- * <a>ListResourceTags</a>
1944
- * </p>
1945
- * </li>
1946
- * </ul>
1947
- */
177
+
1948
178
  listKeys(args: ListKeysCommandInput, options?: __HttpHandlerOptions): Promise<ListKeysCommandOutput>;
1949
179
  listKeys(args: ListKeysCommandInput, cb: (err: any, data?: ListKeysCommandOutput) => void): void;
1950
180
  listKeys(args: ListKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListKeysCommandOutput) => void): void;
1951
- /**
1952
- * <p>Returns all tags on the specified KMS key.</p>
1953
- * <p>For general information about tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in
1954
- * the <i>Amazon Web Services General Reference</i>. For information about using
1955
- * tags in KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">Tagging
1956
- * keys</a>.</p>
1957
- * <p>
1958
- * <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
1959
- *
1960
- * <p>
1961
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListResourceTags</a> (key policy)</p>
1962
- * <p>
1963
- * <b>Related operations:</b>
1964
- * </p>
1965
- * <ul>
1966
- * <li>
1967
- * <p>
1968
- * <a>CreateKey</a>
1969
- * </p>
1970
- * </li>
1971
- * <li>
1972
- * <p>
1973
- * <a>ReplicateKey</a>
1974
- * </p>
1975
- * </li>
1976
- * <li>
1977
- * <p>
1978
- * <a>TagResource</a>
1979
- * </p>
1980
- * </li>
1981
- * <li>
1982
- * <p>
1983
- * <a>UntagResource</a>
1984
- * </p>
1985
- * </li>
1986
- * </ul>
1987
- */
181
+
1988
182
  listResourceTags(args: ListResourceTagsCommandInput, options?: __HttpHandlerOptions): Promise<ListResourceTagsCommandOutput>;
1989
183
  listResourceTags(args: ListResourceTagsCommandInput, cb: (err: any, data?: ListResourceTagsCommandOutput) => void): void;
1990
184
  listResourceTags(args: ListResourceTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceTagsCommandOutput) => void): void;
1991
- /**
1992
- * <p>Returns information about all grants in the Amazon Web Services account and Region that have the
1993
- * specified retiring principal. </p>
1994
- * <p>You can specify any principal in your Amazon Web Services account. The grants that are returned include
1995
- * grants for KMS keys in your Amazon Web Services account and other Amazon Web Services accounts. You might use this
1996
- * operation to determine which grants you may retire. To retire a grant, use the <a>RetireGrant</a> operation.</p>
1997
- * <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
1998
- * <i>
1999
- * <i>Key Management Service Developer Guide</i>
2000
- * </i>. For examples of working with grants in several
2001
- * programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a>. </p>
2002
- * <p>
2003
- * <b>Cross-account use</b>: You must specify a principal in your
2004
- * Amazon Web Services account. However, this operation can return grants in any Amazon Web Services account. You do not need
2005
- * <code>kms:ListRetirableGrants</code> permission (or any other additional permission) in any
2006
- * Amazon Web Services account other than your own.</p>
2007
- *
2008
- * <p>
2009
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListRetirableGrants</a> (IAM policy) in your
2010
- * Amazon Web Services account.</p>
2011
- * <p>
2012
- * <b>Related operations:</b>
2013
- * </p>
2014
- * <ul>
2015
- * <li>
2016
- * <p>
2017
- * <a>CreateGrant</a>
2018
- * </p>
2019
- * </li>
2020
- * <li>
2021
- * <p>
2022
- * <a>ListGrants</a>
2023
- * </p>
2024
- * </li>
2025
- * <li>
2026
- * <p>
2027
- * <a>RetireGrant</a>
2028
- * </p>
2029
- * </li>
2030
- * <li>
2031
- * <p>
2032
- * <a>RevokeGrant</a>
2033
- * </p>
2034
- * </li>
2035
- * </ul>
2036
- */
185
+
2037
186
  listRetirableGrants(args: ListRetirableGrantsCommandInput, options?: __HttpHandlerOptions): Promise<ListRetirableGrantsCommandOutput>;
2038
187
  listRetirableGrants(args: ListRetirableGrantsCommandInput, cb: (err: any, data?: ListRetirableGrantsCommandOutput) => void): void;
2039
188
  listRetirableGrants(args: ListRetirableGrantsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRetirableGrantsCommandOutput) => void): void;
2040
- /**
2041
- * <p>Attaches a key policy to the specified KMS key. </p>
2042
- * <p>For more information about key policies, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">Key Policies</a> in the <i>Key Management Service Developer Guide</i>.
2043
- * For help writing and formatting a JSON policy document, see the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html">IAM JSON Policy Reference</a> in the <i>
2044
- * <i>Identity and Access Management User Guide</i>
2045
- * </i>. For examples of adding a key policy in multiple programming languages,
2046
- * see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-key-policies.html#put-policy">Setting a key policy</a> in the <i>Key Management Service Developer Guide</i>.</p>
2047
- * <p>
2048
- * <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
2049
- *
2050
- * <p>
2051
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:PutKeyPolicy</a> (key policy)</p>
2052
- * <p>
2053
- * <b>Related operations</b>: <a>GetKeyPolicy</a>
2054
- * </p>
2055
- */
189
+
2056
190
  putKeyPolicy(args: PutKeyPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutKeyPolicyCommandOutput>;
2057
191
  putKeyPolicy(args: PutKeyPolicyCommandInput, cb: (err: any, data?: PutKeyPolicyCommandOutput) => void): void;
2058
192
  putKeyPolicy(args: PutKeyPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutKeyPolicyCommandOutput) => void): void;
2059
- /**
2060
- * <p>Decrypts ciphertext and then reencrypts it entirely within KMS. You can use this
2061
- * operation to change the KMS key under which data is encrypted, such as when you <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-manually">manually
2062
- * rotate</a> a KMS key or change the KMS key that protects a ciphertext. You can also use
2063
- * it to reencrypt ciphertext under the same KMS key, such as to change the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">encryption
2064
- * context</a> of a ciphertext.</p>
2065
- * <p>The <code>ReEncrypt</code> operation can decrypt ciphertext that was encrypted by using an
2066
- * KMS KMS key in an KMS operation, such as <a>Encrypt</a> or <a>GenerateDataKey</a>. It can also decrypt ciphertext that was encrypted by using the
2067
- * public key of an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks">asymmetric KMS key</a>
2068
- * outside of KMS. However, it cannot decrypt ciphertext produced by other libraries, such as
2069
- * the <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">Amazon Web Services Encryption SDK</a> or
2070
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3
2071
- * client-side encryption</a>. These libraries return a ciphertext format that is
2072
- * incompatible with KMS.</p>
2073
- * <p>When you use the <code>ReEncrypt</code> operation, you need to provide information for the
2074
- * decrypt operation and the subsequent encrypt operation.</p>
2075
- * <ul>
2076
- * <li>
2077
- * <p>If your ciphertext was encrypted under an asymmetric KMS key, you must use the
2078
- * <code>SourceKeyId</code> parameter to identify the KMS key that encrypted the
2079
- * ciphertext. You must also supply the encryption algorithm that was used. This information
2080
- * is required to decrypt the data.</p>
2081
- * </li>
2082
- * <li>
2083
- * <p>If your ciphertext was encrypted under a symmetric KMS key, the
2084
- * <code>SourceKeyId</code> parameter is optional. KMS can get this information from
2085
- * metadata that it adds to the symmetric ciphertext blob. This feature adds durability to
2086
- * your implementation by ensuring that authorized users can decrypt ciphertext decades after
2087
- * it was encrypted, even if they've lost track of the key ID. However, specifying the source
2088
- * KMS key is always recommended as a best practice. When you use the
2089
- * <code>SourceKeyId</code> parameter to specify a KMS key, KMS uses only the KMS key you
2090
- * specify. If the ciphertext was encrypted under a different KMS key, the
2091
- * <code>ReEncrypt</code> operation fails. This practice ensures that you use the KMS key
2092
- * that you intend.</p>
2093
- * </li>
2094
- * <li>
2095
- * <p>To reencrypt the data, you must use the <code>DestinationKeyId</code> parameter
2096
- * specify the KMS key that re-encrypts the data after it is decrypted. You can select a
2097
- * symmetric or asymmetric KMS key. If the destination KMS key is an asymmetric KMS key, you
2098
- * must also provide the encryption algorithm. The algorithm that you choose must be
2099
- * compatible with the KMS key.</p>
2100
- *
2101
- * <important>
2102
- * <p>When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails.</p>
2103
- * <p>You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.</p>
2104
- * </important>
2105
- * </li>
2106
- * </ul>
2107
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
2108
- * 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>
2109
- * <p>
2110
- * <b>Cross-account use</b>: Yes.
2111
- * The source KMS key and destination KMS key can be in different Amazon Web Services accounts. Either or both
2112
- * KMS keys can be in a different account than the caller. To specify a KMS key in a different
2113
- * account, you must use its key ARN or alias ARN.</p>
2114
- *
2115
- * <p>
2116
- * <b>Required permissions</b>:</p>
2117
- * <ul>
2118
- * <li>
2119
- * <p>
2120
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ReEncryptFrom</a>
2121
- * permission on the source KMS key (key policy)</p>
2122
- * </li>
2123
- * <li>
2124
- * <p>
2125
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ReEncryptTo</a>
2126
- * permission on the destination KMS key (key policy)</p>
2127
- * </li>
2128
- * </ul>
2129
- * <p>To permit reencryption from or to a KMS key, include the <code>"kms:ReEncrypt*"</code>
2130
- * permission in your <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">key policy</a>. This permission is
2131
- * automatically included in the key policy when you use the console to create a KMS key. But you
2132
- * must include it manually when you create a KMS key programmatically or when you use the <a>PutKeyPolicy</a> operation to set a key policy.</p>
2133
- *
2134
- * <p>
2135
- * <b>Related operations:</b>
2136
- * </p>
2137
- * <ul>
2138
- * <li>
2139
- * <p>
2140
- * <a>Decrypt</a>
2141
- * </p>
2142
- * </li>
2143
- * <li>
2144
- * <p>
2145
- * <a>Encrypt</a>
2146
- * </p>
2147
- * </li>
2148
- * <li>
2149
- * <p>
2150
- * <a>GenerateDataKey</a>
2151
- * </p>
2152
- * </li>
2153
- * <li>
2154
- * <p>
2155
- * <a>GenerateDataKeyPair</a>
2156
- * </p>
2157
- * </li>
2158
- * </ul>
2159
- */
193
+
2160
194
  reEncrypt(args: ReEncryptCommandInput, options?: __HttpHandlerOptions): Promise<ReEncryptCommandOutput>;
2161
195
  reEncrypt(args: ReEncryptCommandInput, cb: (err: any, data?: ReEncryptCommandOutput) => void): void;
2162
196
  reEncrypt(args: ReEncryptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReEncryptCommandOutput) => void): void;
2163
- /**
2164
- * <p>Replicates a multi-Region key into the specified Region. This operation creates a
2165
- * multi-Region replica key based on a multi-Region primary key in a different Region of the same
2166
- * Amazon Web Services partition. You can create multiple replicas of a primary key, but each must be in a
2167
- * different Region. To create a multi-Region primary key, use the <a>CreateKey</a>
2168
- * operation.</p>
2169
- * <p>This operation supports <i>multi-Region keys</i>, an KMS feature that lets you create multiple
2170
- * interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key
2171
- * material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt
2172
- * it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
2173
- * <p>A <i>replica key</i> is a fully-functional KMS key that can be used
2174
- * independently of its primary and peer replica keys. A primary key and its replica keys share
2175
- * properties that make them interoperable. They have the same <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id">key ID</a> and key material. They also
2176
- * have the same <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-spec">key
2177
- * spec</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-usage">key
2178
- * usage</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-origin">key
2179
- * material origin</a>, and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic key rotation status</a>. KMS automatically synchronizes these shared
2180
- * properties among related multi-Region keys. All other properties of a replica key can differ,
2181
- * including its <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">key
2182
- * policy</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">tags</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html">aliases</a>, and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">key
2183
- * state</a>. KMS pricing and quotas for KMS keys apply to each primary key and replica
2184
- * key.</p>
2185
- * <p>When this operation completes, the new replica key has a transient key state of
2186
- * <code>Creating</code>. This key state changes to <code>Enabled</code> (or
2187
- * <code>PendingImport</code>) after a few seconds when the process of creating the new replica
2188
- * key is complete. While the key state is <code>Creating</code>, you can manage key, but you
2189
- * cannot yet use it in cryptographic operations. If you are creating and using the replica key
2190
- * programmatically, retry on <code>KMSInvalidStateException</code> or call
2191
- * <code>DescribeKey</code> to check its <code>KeyState</code> value before using it. For
2192
- * details about the <code>Creating</code> key state, see <a href="kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a> in the
2193
- * <i>Key Management Service Developer Guide</i>.</p>
2194
- * <p>The CloudTrail log of a <code>ReplicateKey</code> operation records a
2195
- * <code>ReplicateKey</code> operation in the primary key's Region and a <a>CreateKey</a> operation in the replica key's Region.</p>
2196
- * <p>If you replicate a multi-Region primary key with imported key material, the replica key is
2197
- * created with no key material. You must import the same key material that you imported into the
2198
- * primary key. For details, see <a href="kms/latest/developerguide/multi-region-keys-import.html">Importing key material into multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
2199
- * <p>To convert a replica key to a primary key, use the <a>UpdatePrimaryRegion</a>
2200
- * operation.</p>
2201
- * <note>
2202
- * <p>
2203
- * <code>ReplicateKey</code> uses different default values for the <code>KeyPolicy</code>
2204
- * and <code>Tags</code> parameters than those used in the KMS console. For details, see the
2205
- * parameter descriptions.</p>
2206
- * </note>
2207
- * <p>
2208
- * <b>Cross-account use</b>: No. You cannot use this operation to
2209
- * create a replica key in a different Amazon Web Services account. </p>
2210
- * <p>
2211
- * <b>Required permissions</b>: </p>
2212
- * <ul>
2213
- * <li>
2214
- * <p>
2215
- * <code>kms:ReplicateKey</code> on the primary key (in the primary key's Region).
2216
- * Include this permission in the primary key's key policy.</p>
2217
- * </li>
2218
- * <li>
2219
- * <p>
2220
- * <code>kms:CreateKey</code> in an IAM policy in the replica Region.</p>
2221
- * </li>
2222
- * <li>
2223
- * <p>To use the <code>Tags</code> parameter, <code>kms:TagResource</code> in an IAM policy
2224
- * in the replica Region.</p>
2225
- * </li>
2226
- * </ul>
2227
- * <p>
2228
- * <b>Related operations</b>
2229
- * </p>
2230
- * <ul>
2231
- * <li>
2232
- * <p>
2233
- * <a>CreateKey</a>
2234
- * </p>
2235
- * </li>
2236
- * <li>
2237
- * <p>
2238
- * <a>UpdatePrimaryRegion</a>
2239
- * </p>
2240
- * </li>
2241
- * </ul>
2242
- */
197
+
2243
198
  replicateKey(args: ReplicateKeyCommandInput, options?: __HttpHandlerOptions): Promise<ReplicateKeyCommandOutput>;
2244
199
  replicateKey(args: ReplicateKeyCommandInput, cb: (err: any, data?: ReplicateKeyCommandOutput) => void): void;
2245
200
  replicateKey(args: ReplicateKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReplicateKeyCommandOutput) => void): void;
2246
- /**
2247
- * <p>Deletes a grant. Typically, you retire a grant when you no longer need its permissions. To
2248
- * identify the grant to retire, use a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">grant token</a>, or both the grant ID and a
2249
- * key identifier (key ID or key ARN) of the KMS key. The <a>CreateGrant</a> operation
2250
- * returns both values.</p>
2251
- * <p>This operation can be called by the <i>retiring principal</i> for a grant,
2252
- * by the <i>grantee principal</i> if the grant allows the <code>RetireGrant</code>
2253
- * operation, and by the Amazon Web Services account (root user) in which the grant is created. It can also be
2254
- * called by principals to whom permission for retiring a grant is delegated. For details, see
2255
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete">Retiring and
2256
- * revoking grants</a> in the <i>Key Management Service Developer Guide</i>.</p>
2257
- * <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
2258
- * <i>
2259
- * <i>Key Management Service Developer Guide</i>
2260
- * </i>. For examples of working with grants in several
2261
- * programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a>. </p>
2262
- * <p>
2263
- * <b>Cross-account use</b>: Yes. You can retire a grant on a KMS
2264
- * key in a different Amazon Web Services account.</p>
2265
- * <p>
2266
- * <b>Required permissions:</b>:Permission to retire a grant is
2267
- * determined primarily by the grant. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete">Retiring and revoking grants</a> in
2268
- * the <i>Key Management Service Developer Guide</i>.</p>
2269
- * <p>
2270
- * <b>Related operations:</b>
2271
- * </p>
2272
- * <ul>
2273
- * <li>
2274
- * <p>
2275
- * <a>CreateGrant</a>
2276
- * </p>
2277
- * </li>
2278
- * <li>
2279
- * <p>
2280
- * <a>ListGrants</a>
2281
- * </p>
2282
- * </li>
2283
- * <li>
2284
- * <p>
2285
- * <a>ListRetirableGrants</a>
2286
- * </p>
2287
- * </li>
2288
- * <li>
2289
- * <p>
2290
- * <a>RevokeGrant</a>
2291
- * </p>
2292
- * </li>
2293
- * </ul>
2294
- */
201
+
2295
202
  retireGrant(args: RetireGrantCommandInput, options?: __HttpHandlerOptions): Promise<RetireGrantCommandOutput>;
2296
203
  retireGrant(args: RetireGrantCommandInput, cb: (err: any, data?: RetireGrantCommandOutput) => void): void;
2297
204
  retireGrant(args: RetireGrantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RetireGrantCommandOutput) => void): void;
2298
- /**
2299
- * <p>Deletes the specified grant. You revoke a grant to terminate the permissions that the
2300
- * grant allows. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/managing-grants.html#grant-delete">Retiring and revoking grants</a> in
2301
- * the <i>
2302
- * <i>Key Management Service Developer Guide</i>
2303
- * </i>.</p>
2304
- * <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>. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-eventual-consistency">Eventual consistency</a> in
2305
- * the <i>
2306
- * <i>Key Management Service Developer Guide</i>
2307
- * </i>. </p>
2308
- * <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
2309
- * <i>
2310
- * <i>Key Management Service Developer Guide</i>
2311
- * </i>. For examples of working with grants in several
2312
- * programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a>. </p>
2313
- * <p>
2314
- * <b>Cross-account use</b>: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key
2315
- * ARN in the value of the <code>KeyId</code> parameter.</p>
2316
- * <p>
2317
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:RevokeGrant</a> (key policy).</p>
2318
- * <p>
2319
- * <b>Related operations:</b>
2320
- * </p>
2321
- * <ul>
2322
- * <li>
2323
- * <p>
2324
- * <a>CreateGrant</a>
2325
- * </p>
2326
- * </li>
2327
- * <li>
2328
- * <p>
2329
- * <a>ListGrants</a>
2330
- * </p>
2331
- * </li>
2332
- * <li>
2333
- * <p>
2334
- * <a>ListRetirableGrants</a>
2335
- * </p>
2336
- * </li>
2337
- * <li>
2338
- * <p>
2339
- * <a>RetireGrant</a>
2340
- * </p>
2341
- * </li>
2342
- * </ul>
2343
- */
205
+
2344
206
  revokeGrant(args: RevokeGrantCommandInput, options?: __HttpHandlerOptions): Promise<RevokeGrantCommandOutput>;
2345
207
  revokeGrant(args: RevokeGrantCommandInput, cb: (err: any, data?: RevokeGrantCommandOutput) => void): void;
2346
208
  revokeGrant(args: RevokeGrantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeGrantCommandOutput) => void): void;
2347
- /**
2348
- * <p>Schedules the deletion of a KMS key. By default, KMS applies a waiting period of 30
2349
- * days, but you can specify a waiting period of 7-30 days. When this operation is successful,
2350
- * the key state of the KMS key changes to <code>PendingDeletion</code> and the key can't be used
2351
- * in any cryptographic operations. It remains in this state for the duration of the waiting
2352
- * period. Before the waiting period ends, you can use <a>CancelKeyDeletion</a> to
2353
- * cancel the deletion of the KMS key. After the waiting period ends, KMS deletes the KMS key,
2354
- * its key material, and all KMS data associated with it, including all aliases that refer to
2355
- * it.</p>
2356
- * <important>
2357
- * <p>Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS key
2358
- * is deleted, all data that was encrypted under the KMS key is unrecoverable. (The only
2359
- * exception is a multi-Region replica key.) To prevent the use of a KMS key without deleting
2360
- * it, use <a>DisableKey</a>. </p>
2361
- * </important>
2362
- * <p>If you schedule deletion of a KMS key from a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>, when the waiting period
2363
- * expires, <code>ScheduleKeyDeletion</code> deletes the KMS key from KMS. Then KMS makes a
2364
- * best effort to delete the key material from the associated CloudHSM cluster. However, you might
2365
- * need to manually <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key">delete the orphaned key
2366
- * material</a> from the cluster and its backups.</p>
2367
- * <p>You can schedule the deletion of a multi-Region primary key and its replica keys at any
2368
- * time. However, KMS will not delete a multi-Region primary key with existing replica keys. If
2369
- * you schedule the deletion of a primary key with replicas, its key state changes to
2370
- * <code>PendingReplicaDeletion</code> and it cannot be replicated or used in cryptographic
2371
- * operations. This status can continue indefinitely. When the last of its replicas keys is
2372
- * deleted (not just scheduled), the key state of the primary key changes to
2373
- * <code>PendingDeletion</code> and its waiting period (<code>PendingWindowInDays</code>)
2374
- * begins. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html">Deleting multi-Region keys</a> in the
2375
- * <i>Key Management Service Developer Guide</i>. </p>
2376
- * <p>For more information about scheduling a KMS key for deletion, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting KMS keys</a> in the
2377
- * <i>Key Management Service Developer Guide</i>.</p>
2378
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
2379
- * 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>
2380
- * <p>
2381
- * <b>Cross-account
2382
- * use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
2383
- *
2384
- *
2385
- * <p>
2386
- * <b>Required permissions</b>: kms:ScheduleKeyDeletion (key
2387
- * policy)</p>
2388
- * <p>
2389
- * <b>Related operations</b>
2390
- * </p>
2391
- * <ul>
2392
- * <li>
2393
- * <p>
2394
- * <a>CancelKeyDeletion</a>
2395
- * </p>
2396
- * </li>
2397
- * <li>
2398
- * <p>
2399
- * <a>DisableKey</a>
2400
- * </p>
2401
- * </li>
2402
- * </ul>
2403
- */
209
+
2404
210
  scheduleKeyDeletion(args: ScheduleKeyDeletionCommandInput, options?: __HttpHandlerOptions): Promise<ScheduleKeyDeletionCommandOutput>;
2405
211
  scheduleKeyDeletion(args: ScheduleKeyDeletionCommandInput, cb: (err: any, data?: ScheduleKeyDeletionCommandOutput) => void): void;
2406
212
  scheduleKeyDeletion(args: ScheduleKeyDeletionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ScheduleKeyDeletionCommandOutput) => void): void;
2407
- /**
2408
- * <p>Creates a <a href="https://en.wikipedia.org/wiki/Digital_signature">digital
2409
- * signature</a> for a message or message digest by using the private key in an asymmetric
2410
- * KMS key. To verify the signature, use the <a>Verify</a> operation, or use the
2411
- * public key in the same asymmetric KMS key outside of KMS. For information about symmetric and asymmetric KMS keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
2412
- * <p>Digital signatures are generated and verified by using asymmetric key pair, such as an RSA
2413
- * or ECC pair that is represented by an asymmetric KMS key. The key owner (or an authorized
2414
- * user) uses their private key to sign a message. Anyone with the public key can verify that the
2415
- * message was signed with that particular private key and that the message hasn't changed since
2416
- * it was signed. </p>
2417
- * <p>To use the <code>Sign</code> operation, provide the following information:</p>
2418
- * <ul>
2419
- * <li>
2420
- * <p>Use the <code>KeyId</code> parameter to identify an asymmetric KMS key with a
2421
- * <code>KeyUsage</code> value of <code>SIGN_VERIFY</code>. To get the
2422
- * <code>KeyUsage</code> value of a KMS key, use the <a>DescribeKey</a>
2423
- * operation. The caller must have <code>kms:Sign</code> permission on the KMS key.</p>
2424
- * </li>
2425
- * <li>
2426
- * <p>Use the <code>Message</code> parameter to specify the message or message digest to
2427
- * sign. You can submit messages of up to 4096 bytes. To sign a larger message, generate a
2428
- * hash digest of the message, and then provide the hash digest in the <code>Message</code>
2429
- * parameter. To indicate whether the message is a full message or a digest, use the
2430
- * <code>MessageType</code> parameter.</p>
2431
- * </li>
2432
- * <li>
2433
- * <p>Choose a signing algorithm that is compatible with the KMS key. </p>
2434
- * </li>
2435
- * </ul>
2436
- * <important>
2437
- * <p>When signing a message, be sure to record the KMS key and the signing algorithm. This
2438
- * information is required to verify the signature.</p>
2439
- * </important>
2440
- * <p>To verify the signature that this operation generates, use the <a>Verify</a>
2441
- * operation. Or use the <a>GetPublicKey</a> operation to download the public key and
2442
- * then use the public key to verify the signature outside of KMS. </p>
2443
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
2444
- * 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>
2445
- * <p>
2446
- * <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
2447
- * the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
2448
- *
2449
- * <p>
2450
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:Sign</a> (key policy)</p>
2451
- * <p>
2452
- * <b>Related operations</b>: <a>Verify</a>
2453
- * </p>
2454
- */
213
+
2455
214
  sign(args: SignCommandInput, options?: __HttpHandlerOptions): Promise<SignCommandOutput>;
2456
215
  sign(args: SignCommandInput, cb: (err: any, data?: SignCommandOutput) => void): void;
2457
216
  sign(args: SignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SignCommandOutput) => void): void;
2458
- /**
2459
- * <p>Adds or edits tags on a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>.</p>
2460
- * <note>
2461
- * <p>Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">Using ABAC in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
2462
- * </note>
2463
- * <p>Each tag consists of a tag key and a tag value, both of which are case-sensitive strings.
2464
- * The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag
2465
- * value. To edit a tag, specify an existing tag key and a new tag value.</p>
2466
- * <p>You can use this operation to tag a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>, but you cannot
2467
- * tag an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services
2468
- * managed key</a>, an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk">Amazon Web Services owned key</a>, a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#keystore-concept">custom key
2469
- * store</a>, or an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#alias-concept">alias</a>.</p>
2470
- * <p>You can also add tags to a KMS key while creating it (<a>CreateKey</a>) or
2471
- * replicating it (<a>ReplicateKey</a>).</p>
2472
- * <p>For information about using tags in KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">Tagging keys</a>. For general information about
2473
- * tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon
2474
- * Web Services General Reference</i>. </p>
2475
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
2476
- * 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>
2477
- * <p>
2478
- * <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p>
2479
- *
2480
- * <p>
2481
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:TagResource</a> (key policy)</p>
2482
- * <p>
2483
- * <b>Related operations</b>
2484
- * </p>
2485
- * <ul>
2486
- * <li>
2487
- * <p>
2488
- * <a>CreateKey</a>
2489
- * </p>
2490
- * </li>
2491
- * <li>
2492
- * <p>
2493
- * <a>ListResourceTags</a>
2494
- * </p>
2495
- * </li>
2496
- * <li>
2497
- * <p>
2498
- * <a>ReplicateKey</a>
2499
- * </p>
2500
- * </li>
2501
- * <li>
2502
- * <p>
2503
- * <a>UntagResource</a>
2504
- * </p>
2505
- * </li>
2506
- * </ul>
2507
- */
217
+
2508
218
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
2509
219
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
2510
220
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
2511
- /**
2512
- * <p>Deletes tags from a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>. To delete a tag,
2513
- * specify the tag key and the KMS key.</p>
2514
- * <note>
2515
- * <p>Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">Using ABAC in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
2516
- * </note>
2517
- * <p>When it succeeds, the <code>UntagResource</code> operation doesn't return any output.
2518
- * Also, if the specified tag key isn't found on the KMS key, it doesn't throw an exception or
2519
- * return a response. To confirm that the operation worked, use the <a>ListResourceTags</a> operation.</p>
2520
- *
2521
- * <p>For information about using tags in KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">Tagging keys</a>. For general information about
2522
- * tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon
2523
- * Web Services General Reference</i>. </p>
2524
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
2525
- * 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>
2526
- * <p>
2527
- * <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
2528
- *
2529
- * <p>
2530
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UntagResource</a> (key policy)</p>
2531
- * <p>
2532
- * <b>Related operations</b>
2533
- * </p>
2534
- * <ul>
2535
- * <li>
2536
- * <p>
2537
- * <a>CreateKey</a>
2538
- * </p>
2539
- * </li>
2540
- * <li>
2541
- * <p>
2542
- * <a>ListResourceTags</a>
2543
- * </p>
2544
- * </li>
2545
- * <li>
2546
- * <p>
2547
- * <a>ReplicateKey</a>
2548
- * </p>
2549
- * </li>
2550
- * <li>
2551
- * <p>
2552
- * <a>TagResource</a>
2553
- * </p>
2554
- * </li>
2555
- * </ul>
2556
- */
221
+
2557
222
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
2558
223
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
2559
224
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
2560
- /**
2561
- * <p>Associates an existing KMS alias with a different KMS key. Each alias is associated with
2562
- * only one KMS key at a time, although a KMS key can have multiple aliases. The alias and the
2563
- * KMS key must be in the same Amazon Web Services account and Region.</p>
2564
- * <note>
2565
- * <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>
2566
- * </note>
2567
- * <p>The current and new KMS key must be the same type (both symmetric or both asymmetric), and
2568
- * they must have the same key usage (<code>ENCRYPT_DECRYPT</code> or <code>SIGN_VERIFY</code>).
2569
- * This restriction prevents errors in code that uses aliases. If you must assign an alias to a
2570
- * different type of KMS key, use <a>DeleteAlias</a> to delete the old alias and <a>CreateAlias</a> to create a new alias.</p>
2571
- * <p>You cannot use <code>UpdateAlias</code> to change an alias name. To change an alias name,
2572
- * use <a>DeleteAlias</a> to delete the old alias and <a>CreateAlias</a> to
2573
- * create a new alias.</p>
2574
- * <p>Because an alias is not a property of a KMS key, you can create, update, and delete the
2575
- * aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the
2576
- * response from the <a>DescribeKey</a> operation. To get the aliases of all KMS keys
2577
- * in the account, use the <a>ListAliases</a> operation. </p>
2578
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
2579
- * 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>
2580
- * <p>
2581
- * <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p>
2582
- * <p>
2583
- * <b>Required permissions</b>
2584
- * </p>
2585
- * <ul>
2586
- * <li>
2587
- * <p>
2588
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateAlias</a> on
2589
- * the alias (IAM policy).</p>
2590
- * </li>
2591
- * <li>
2592
- * <p>
2593
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateAlias</a> on
2594
- * the current KMS key (key policy).</p>
2595
- * </li>
2596
- * <li>
2597
- * <p>
2598
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateAlias</a> on
2599
- * the new KMS key (key policy).</p>
2600
- * </li>
2601
- * </ul>
2602
- * <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
2603
- * <i>Key Management Service Developer Guide</i>.</p>
2604
- * <p>
2605
- * <b>Related operations:</b>
2606
- * </p>
2607
- * <ul>
2608
- * <li>
2609
- * <p>
2610
- * <a>CreateAlias</a>
2611
- * </p>
2612
- * </li>
2613
- * <li>
2614
- * <p>
2615
- * <a>DeleteAlias</a>
2616
- * </p>
2617
- * </li>
2618
- * <li>
2619
- * <p>
2620
- * <a>ListAliases</a>
2621
- * </p>
2622
- * </li>
2623
- * </ul>
2624
- */
225
+
2625
226
  updateAlias(args: UpdateAliasCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAliasCommandOutput>;
2626
227
  updateAlias(args: UpdateAliasCommandInput, cb: (err: any, data?: UpdateAliasCommandOutput) => void): void;
2627
228
  updateAlias(args: UpdateAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAliasCommandOutput) => void): void;
2628
- /**
2629
- * <p>Changes the properties of a custom key store. Use the <code>CustomKeyStoreId</code>
2630
- * parameter to identify the custom key store you want to edit. Use the remaining parameters to
2631
- * change the properties of the custom key store.</p>
2632
- * <p>You can only update a custom key store that is disconnected. To disconnect the custom key
2633
- * store, use <a>DisconnectCustomKeyStore</a>. To reconnect the custom key store after
2634
- * the update completes, use <a>ConnectCustomKeyStore</a>. To find the connection
2635
- * state of a custom key store, use the <a>DescribeCustomKeyStores</a>
2636
- * operation.</p>
2637
- * <p>The <code>CustomKeyStoreId</code> parameter is required in all commands. Use the other
2638
- * parameters of <code>UpdateCustomKeyStore</code> to edit your key store settings.</p>
2639
- * <ul>
2640
- * <li>
2641
- * <p>Use the <code>NewCustomKeyStoreName</code> parameter to change the friendly name of
2642
- * the custom key store to the value that you specify.</p>
2643
- * <p> </p>
2644
- * </li>
2645
- * <li>
2646
- * <p>Use the <code>KeyStorePassword</code> parameter tell KMS the current password of the
2647
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser">
2648
- * <code>kmsuser</code> crypto user (CU)</a> in the associated CloudHSM cluster. You
2649
- * can use this parameter to <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-password">fix connection
2650
- * failures</a> that occur when KMS cannot log into the associated cluster because
2651
- * the <code>kmsuser</code> password has changed. This value does not change the password in
2652
- * the CloudHSM cluster.</p>
2653
- * <p> </p>
2654
- * </li>
2655
- * <li>
2656
- * <p>Use the <code>CloudHsmClusterId</code> parameter to associate the custom key store
2657
- * with a different, but related, CloudHSM cluster. You can use this parameter to repair a
2658
- * custom key store if its CloudHSM cluster becomes corrupted or is deleted, or when you need to
2659
- * create or restore a cluster from a backup. </p>
2660
- * </li>
2661
- * </ul>
2662
- * <p>If the operation succeeds, it returns a JSON object with no
2663
- * properties.</p>
2664
- * <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
2665
- * combines the convenience and extensive integration of KMS with the isolation and control of a
2666
- * single-tenant key store.</p>
2667
- * <p>
2668
- * <b>Cross-account
2669
- * use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account. </p>
2670
- * <p>
2671
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateCustomKeyStore</a> (IAM policy)</p>
2672
- * <p>
2673
- * <b>Related operations:</b>
2674
- * </p>
2675
- * <ul>
2676
- * <li>
2677
- * <p>
2678
- * <a>ConnectCustomKeyStore</a>
2679
- * </p>
2680
- * </li>
2681
- * <li>
2682
- * <p>
2683
- * <a>CreateCustomKeyStore</a>
2684
- * </p>
2685
- * </li>
2686
- * <li>
2687
- * <p>
2688
- * <a>DeleteCustomKeyStore</a>
2689
- * </p>
2690
- * </li>
2691
- * <li>
2692
- * <p>
2693
- * <a>DescribeCustomKeyStores</a>
2694
- * </p>
2695
- * </li>
2696
- * <li>
2697
- * <p>
2698
- * <a>DisconnectCustomKeyStore</a>
2699
- * </p>
2700
- * </li>
2701
- * </ul>
2702
- */
229
+
2703
230
  updateCustomKeyStore(args: UpdateCustomKeyStoreCommandInput, options?: __HttpHandlerOptions): Promise<UpdateCustomKeyStoreCommandOutput>;
2704
231
  updateCustomKeyStore(args: UpdateCustomKeyStoreCommandInput, cb: (err: any, data?: UpdateCustomKeyStoreCommandOutput) => void): void;
2705
232
  updateCustomKeyStore(args: UpdateCustomKeyStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCustomKeyStoreCommandOutput) => void): void;
2706
- /**
2707
- * <p>Updates the description of a KMS key. To see the description of a KMS key, use <a>DescribeKey</a>. </p>
2708
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
2709
- * 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>
2710
- * <p>
2711
- * <b>Cross-account
2712
- * use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p>
2713
- *
2714
- * <p>
2715
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateKeyDescription</a> (key policy)</p>
2716
- * <p>
2717
- * <b>Related operations</b>
2718
- * </p>
2719
- * <ul>
2720
- * <li>
2721
- * <p>
2722
- * <a>CreateKey</a>
2723
- * </p>
2724
- * </li>
2725
- * <li>
2726
- * <p>
2727
- * <a>DescribeKey</a>
2728
- * </p>
2729
- * </li>
2730
- * </ul>
2731
- */
233
+
2732
234
  updateKeyDescription(args: UpdateKeyDescriptionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateKeyDescriptionCommandOutput>;
2733
235
  updateKeyDescription(args: UpdateKeyDescriptionCommandInput, cb: (err: any, data?: UpdateKeyDescriptionCommandOutput) => void): void;
2734
236
  updateKeyDescription(args: UpdateKeyDescriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateKeyDescriptionCommandOutput) => void): void;
2735
- /**
2736
- * <p>Changes the primary key of a multi-Region key. </p>
2737
- * <p>This operation changes the replica key in the specified Region to a primary key and
2738
- * changes the former primary key to a replica key. For example, suppose you have a primary key
2739
- * in <code>us-east-1</code> and a replica key in <code>eu-west-2</code>. If you run
2740
- * <code>UpdatePrimaryRegion</code> with a <code>PrimaryRegion</code> value of
2741
- * <code>eu-west-2</code>, the primary key is now the key in <code>eu-west-2</code>, and the
2742
- * key in <code>us-east-1</code> becomes a replica key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-update">Updating the primary Region</a> in the <i>Key Management Service Developer Guide</i>.</p>
2743
- * <p>This operation supports <i>multi-Region keys</i>, an KMS feature that lets you create multiple
2744
- * interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key
2745
- * material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt
2746
- * it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
2747
- * <p>The <i>primary key</i> of a multi-Region key is the source for properties
2748
- * that are always shared by primary and replica keys, including the key material, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id">key ID</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-spec">key spec</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-usage">key usage</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-origin">key material
2749
- * origin</a>, and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic
2750
- * key rotation</a>. It's the only key that can be replicated. You cannot <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html">delete the primary
2751
- * key</a> until all replica keys are deleted.</p>
2752
- * <p>The key ID and primary Region that you specify uniquely identify the replica key that will
2753
- * become the primary key. The primary Region must already have a replica key. This operation
2754
- * does not create a KMS key in the specified Region. To find the replica keys, use the <a>DescribeKey</a> operation on the primary key or any replica key. To create a replica
2755
- * key, use the <a>ReplicateKey</a> operation.</p>
2756
- * <p>You can run this operation while using the affected multi-Region keys in cryptographic
2757
- * operations. This operation should not delay, interrupt, or cause failures in cryptographic
2758
- * operations. </p>
2759
- * <p>Even after this operation completes, the process of updating the primary Region might
2760
- * still be in progress for a few more seconds. Operations such as <code>DescribeKey</code> might
2761
- * display both the old and new primary keys as replicas. The old and new primary keys have a
2762
- * transient key state of <code>Updating</code>. The original key state is restored when the
2763
- * update is complete. While the key state is <code>Updating</code>, you can use the keys in
2764
- * cryptographic operations, but you cannot replicate the new primary key or perform certain
2765
- * management operations, such as enabling or disabling these keys. For details about the
2766
- * <code>Updating</code> key state, see <a href="kms/latest/developerguide/key-state.html">Key state:
2767
- * Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
2768
- * <p>This operation does not return any output. To verify that primary key is changed, use the
2769
- * <a>DescribeKey</a> operation.</p>
2770
- * <p>
2771
- * <b>Cross-account use</b>: No. You cannot use this operation in a
2772
- * different Amazon Web Services account. </p>
2773
- * <p>
2774
- * <b>Required permissions</b>: </p>
2775
- * <ul>
2776
- * <li>
2777
- * <p>
2778
- * <code>kms:UpdatePrimaryRegion</code> on the current primary key (in the primary key's
2779
- * Region). Include this permission primary key's key policy.</p>
2780
- * </li>
2781
- * <li>
2782
- * <p>
2783
- * <code>kms:UpdatePrimaryRegion</code> on the current replica key (in the replica key's
2784
- * Region). Include this permission in the replica key's key policy.</p>
2785
- * </li>
2786
- * </ul>
2787
- * <p>
2788
- * <b>Related operations</b>
2789
- * </p>
2790
- * <ul>
2791
- * <li>
2792
- * <p>
2793
- * <a>CreateKey</a>
2794
- * </p>
2795
- * </li>
2796
- * <li>
2797
- * <p>
2798
- * <a>ReplicateKey</a>
2799
- * </p>
2800
- * </li>
2801
- * </ul>
2802
- */
237
+
2803
238
  updatePrimaryRegion(args: UpdatePrimaryRegionCommandInput, options?: __HttpHandlerOptions): Promise<UpdatePrimaryRegionCommandOutput>;
2804
239
  updatePrimaryRegion(args: UpdatePrimaryRegionCommandInput, cb: (err: any, data?: UpdatePrimaryRegionCommandOutput) => void): void;
2805
240
  updatePrimaryRegion(args: UpdatePrimaryRegionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePrimaryRegionCommandOutput) => void): void;
2806
- /**
2807
- * <p>Verifies a digital signature that was generated by the <a>Sign</a> operation. </p>
2808
- * <p></p>
2809
- * <p>Verification confirms that an authorized user signed the message with the specified KMS
2810
- * key and signing algorithm, and the message hasn't changed since it was signed. If the
2811
- * signature is verified, the value of the <code>SignatureValid</code> field in the response is
2812
- * <code>True</code>. If the signature verification fails, the <code>Verify</code> operation
2813
- * fails with an <code>KMSInvalidSignatureException</code> exception.</p>
2814
- * <p>A digital signature is generated by using the private key in an asymmetric KMS key. The
2815
- * signature is verified by using the public key in the same asymmetric KMS key.
2816
- * For information about symmetric and asymmetric KMS keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
2817
- * <p>To verify a digital signature, you can use the <code>Verify</code> operation. Specify the
2818
- * same asymmetric KMS key, message, and signing algorithm that were used to produce the
2819
- * signature.</p>
2820
- * <p>You can also verify the digital signature by using the public key of the KMS key outside
2821
- * of KMS. Use the <a>GetPublicKey</a> operation to download the public key in the
2822
- * asymmetric KMS key and then use the public key to verify the signature outside of KMS. The
2823
- * advantage of using the <code>Verify</code> operation is that it is performed within KMS. As
2824
- * a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged
2825
- * in CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use
2826
- * the KMS key to verify signatures.</p>
2827
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
2828
- * 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>
2829
- * <p>
2830
- * <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
2831
- * the key ARN or alias ARN in the value of the <code>KeyId</code> parameter. </p>
2832
- *
2833
- * <p>
2834
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:Verify</a> (key policy)</p>
2835
- * <p>
2836
- * <b>Related operations</b>: <a>Sign</a>
2837
- * </p>
2838
- */
241
+
2839
242
  verify(args: VerifyCommandInput, options?: __HttpHandlerOptions): Promise<VerifyCommandOutput>;
2840
243
  verify(args: VerifyCommandInput, cb: (err: any, data?: VerifyCommandOutput) => void): void;
2841
244
  verify(args: VerifyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifyCommandOutput) => void): void;