@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
package/CHANGELOG.md CHANGED
@@ -3,6 +3,48 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # [3.39.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.38.0...v3.39.0) (2021-10-29)
7
+
8
+ **Note:** Version bump only for package @aws-sdk/client-kms
9
+
10
+
11
+
12
+
13
+
14
+ # [3.38.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.37.0...v3.38.0) (2021-10-22)
15
+
16
+
17
+ ### Features
18
+
19
+ * **client-documentation-generator:** rename package ([#2916](https://github.com/aws/aws-sdk-js-v3/issues/2916)) ([1a80bfd](https://github.com/aws/aws-sdk-js-v3/commit/1a80bfd2dfc583001ddb4a21b6432eaaad699aa7))
20
+ * **clients:** export folder from index.ts ([#2912](https://github.com/aws/aws-sdk-js-v3/issues/2912)) ([183b46d](https://github.com/aws/aws-sdk-js-v3/commit/183b46dde7f5613128038bf1c076f3c0b693203b))
21
+
22
+
23
+
24
+
25
+
26
+ # [3.37.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.36.1...v3.37.0) (2021-10-15)
27
+
28
+
29
+ ### Features
30
+
31
+ * **clients:** update clients as of 10/15/2021 ([#2902](https://github.com/aws/aws-sdk-js-v3/issues/2902)) ([2730b54](https://github.com/aws/aws-sdk-js-v3/commit/2730b5424377944a5a2ad5e1ad7d3ca4135dae1c))
32
+
33
+
34
+
35
+
36
+
37
+ ## [3.36.1](https://github.com/aws/aws-sdk-js-v3/compare/v3.36.0...v3.36.1) (2021-10-12)
38
+
39
+
40
+ ### Bug Fixes
41
+
42
+ * **clients:** emitDeclarationOnly in tsconfig.types.json ([#2893](https://github.com/aws/aws-sdk-js-v3/issues/2893)) ([6dc3d56](https://github.com/aws/aws-sdk-js-v3/commit/6dc3d56c20809c90cbdc4dd48627eeebc64af99d))
43
+
44
+
45
+
46
+
47
+
6
48
  # [3.36.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.35.0...v3.36.0) (2021-10-08)
7
49
 
8
50
 
package/dist-cjs/KMS.js CHANGED
@@ -50,98 +50,6 @@ const UpdateKeyDescriptionCommand_1 = require("./commands/UpdateKeyDescriptionCo
50
50
  const UpdatePrimaryRegionCommand_1 = require("./commands/UpdatePrimaryRegionCommand");
51
51
  const VerifyCommand_1 = require("./commands/VerifyCommand");
52
52
  const KMSClient_1 = require("./KMSClient");
53
- /**
54
- * <fullname>Key Management Service</fullname>
55
- * <p>Key Management Service (KMS) is an encryption and key management web service. This guide describes
56
- * the KMS operations that you can call programmatically. For general information about KMS,
57
- * see the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/">
58
- * <i>Key Management Service Developer Guide</i>
59
- * </a>.</p>
60
- * <note>
61
- * <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>
62
- * <p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming
63
- * languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a
64
- * convenient way to create programmatic access to KMS and other Amazon Web Services services. For example,
65
- * the SDKs take care of tasks such as signing requests (see below), managing errors, and
66
- * retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to
67
- * download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web
68
- * Services</a>.</p>
69
- * </note>
70
- * <p>We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.</p>
71
- * <p>Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients
72
- * must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral
73
- * Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems
74
- * such as Java 7 and later support these modes.</p>
75
- * <p>
76
- * <b>Signing Requests</b>
77
- * </p>
78
- * <p>Requests must be signed by using an access key ID and a secret access key. We strongly
79
- * recommend that you <i>do not</i> use your Amazon Web Services account (root) access key ID and
80
- * secret key for everyday work with KMS. Instead, use the access key ID and secret access key
81
- * for an IAM user. You can also use the Amazon Web Services Security Token Service to generate temporary
82
- * security credentials that you can use to sign requests.</p>
83
- * <p>All KMS operations require <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p>
84
- * <p>
85
- * <b>Logging API Requests</b>
86
- * </p>
87
- * <p>KMS supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your
88
- * Amazon Web Services account and delivers them to an Amazon S3 bucket that you specify. By using the
89
- * information collected by CloudTrail, you can determine what requests were made to KMS, who made
90
- * the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it
91
- * on and find your log files, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/">CloudTrail User Guide</a>.</p>
92
- * <p>
93
- * <b>Additional Resources</b>
94
- * </p>
95
- * <p>For more information about credentials and request signing, see the following:</p>
96
- * <ul>
97
- * <li>
98
- * <p>
99
- * <a href="https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html">Amazon Web Services
100
- * Security Credentials</a> - This topic provides general information about the types
101
- * of credentials used to access Amazon Web Services.</p>
102
- * </li>
103
- * <li>
104
- * <p>
105
- * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html">Temporary
106
- * Security Credentials</a> - This section of the <i>IAM User Guide</i>
107
- * describes how to create and use temporary security credentials.</p>
108
- * </li>
109
- * <li>
110
- * <p>
111
- * <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version
112
- * 4 Signing Process</a> - This set of topics walks you through the process of signing
113
- * a request using an access key ID and a secret access key.</p>
114
- * </li>
115
- * </ul>
116
- * <p>
117
- * <b>Commonly Used API Operations</b>
118
- * </p>
119
- * <p>Of the API operations discussed in this guide, the following will prove the most useful
120
- * for most applications. You will likely perform operations other than these, such as creating
121
- * keys and assigning policies, by using the console.</p>
122
- * <ul>
123
- * <li>
124
- * <p>
125
- * <a>Encrypt</a>
126
- * </p>
127
- * </li>
128
- * <li>
129
- * <p>
130
- * <a>Decrypt</a>
131
- * </p>
132
- * </li>
133
- * <li>
134
- * <p>
135
- * <a>GenerateDataKey</a>
136
- * </p>
137
- * </li>
138
- * <li>
139
- * <p>
140
- * <a>GenerateDataKeyWithoutPlaintext</a>
141
- * </p>
142
- * </li>
143
- * </ul>
144
- */
145
53
  class KMS extends KMSClient_1.KMSClient {
146
54
  cancelKeyDeletion(args, optionsOrCb, cb) {
147
55
  const command = new CancelKeyDeletionCommand_1.CancelKeyDeletionCommand(args);
@@ -10,98 +10,6 @@ const middleware_signing_1 = require("@aws-sdk/middleware-signing");
10
10
  const middleware_user_agent_1 = require("@aws-sdk/middleware-user-agent");
11
11
  const smithy_client_1 = require("@aws-sdk/smithy-client");
12
12
  const runtimeConfig_1 = require("./runtimeConfig");
13
- /**
14
- * <fullname>Key Management Service</fullname>
15
- * <p>Key Management Service (KMS) is an encryption and key management web service. This guide describes
16
- * the KMS operations that you can call programmatically. For general information about KMS,
17
- * see the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/">
18
- * <i>Key Management Service Developer Guide</i>
19
- * </a>.</p>
20
- * <note>
21
- * <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>
22
- * <p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming
23
- * languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a
24
- * convenient way to create programmatic access to KMS and other Amazon Web Services services. For example,
25
- * the SDKs take care of tasks such as signing requests (see below), managing errors, and
26
- * retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to
27
- * download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web
28
- * Services</a>.</p>
29
- * </note>
30
- * <p>We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.</p>
31
- * <p>Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients
32
- * must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral
33
- * Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems
34
- * such as Java 7 and later support these modes.</p>
35
- * <p>
36
- * <b>Signing Requests</b>
37
- * </p>
38
- * <p>Requests must be signed by using an access key ID and a secret access key. We strongly
39
- * recommend that you <i>do not</i> use your Amazon Web Services account (root) access key ID and
40
- * secret key for everyday work with KMS. Instead, use the access key ID and secret access key
41
- * for an IAM user. You can also use the Amazon Web Services Security Token Service to generate temporary
42
- * security credentials that you can use to sign requests.</p>
43
- * <p>All KMS operations require <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p>
44
- * <p>
45
- * <b>Logging API Requests</b>
46
- * </p>
47
- * <p>KMS supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your
48
- * Amazon Web Services account and delivers them to an Amazon S3 bucket that you specify. By using the
49
- * information collected by CloudTrail, you can determine what requests were made to KMS, who made
50
- * the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it
51
- * on and find your log files, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/">CloudTrail User Guide</a>.</p>
52
- * <p>
53
- * <b>Additional Resources</b>
54
- * </p>
55
- * <p>For more information about credentials and request signing, see the following:</p>
56
- * <ul>
57
- * <li>
58
- * <p>
59
- * <a href="https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html">Amazon Web Services
60
- * Security Credentials</a> - This topic provides general information about the types
61
- * of credentials used to access Amazon Web Services.</p>
62
- * </li>
63
- * <li>
64
- * <p>
65
- * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html">Temporary
66
- * Security Credentials</a> - This section of the <i>IAM User Guide</i>
67
- * describes how to create and use temporary security credentials.</p>
68
- * </li>
69
- * <li>
70
- * <p>
71
- * <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version
72
- * 4 Signing Process</a> - This set of topics walks you through the process of signing
73
- * a request using an access key ID and a secret access key.</p>
74
- * </li>
75
- * </ul>
76
- * <p>
77
- * <b>Commonly Used API Operations</b>
78
- * </p>
79
- * <p>Of the API operations discussed in this guide, the following will prove the most useful
80
- * for most applications. You will likely perform operations other than these, such as creating
81
- * keys and assigning policies, by using the console.</p>
82
- * <ul>
83
- * <li>
84
- * <p>
85
- * <a>Encrypt</a>
86
- * </p>
87
- * </li>
88
- * <li>
89
- * <p>
90
- * <a>Decrypt</a>
91
- * </p>
92
- * </li>
93
- * <li>
94
- * <p>
95
- * <a>GenerateDataKey</a>
96
- * </p>
97
- * </li>
98
- * <li>
99
- * <p>
100
- * <a>GenerateDataKeyWithoutPlaintext</a>
101
- * </p>
102
- * </li>
103
- * </ul>
104
- */
105
13
  class KMSClient extends smithy_client_1.Client {
106
14
  constructor(configuration) {
107
15
  const _config_0 = runtimeConfig_1.getRuntimeConfig(configuration);
@@ -120,11 +28,6 @@ class KMSClient extends smithy_client_1.Client {
120
28
  this.middlewareStack.use(middleware_signing_1.getAwsAuthPlugin(this.config));
121
29
  this.middlewareStack.use(middleware_user_agent_1.getUserAgentPlugin(this.config));
122
30
  }
123
- /**
124
- * Destroy underlying resources, like sockets. It's usually not necessary to do this.
125
- * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
126
- * Otherwise, sockets might stay open for quite a long time before the server terminates them.
127
- */
128
31
  destroy() {
129
32
  super.destroy();
130
33
  }
@@ -5,48 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>Cancels the deletion of a KMS key. When this operation succeeds, the key state of the KMS
10
- * key is <code>Disabled</code>. To enable the KMS key, use <a>EnableKey</a>. </p>
11
- * <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
12
- * <i>Key Management Service Developer Guide</i>.</p>
13
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
14
- * 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>
15
- * <p>
16
- * <b>Cross-account
17
- * use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
18
- * <p>
19
- * <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>
20
- * <p>
21
- * <b>Related operations</b>: <a>ScheduleKeyDeletion</a>
22
- * </p>
23
- * @example
24
- * Use a bare-bones client and the command you need to make an API call.
25
- * ```javascript
26
- * import { KMSClient, CancelKeyDeletionCommand } from "@aws-sdk/client-kms"; // ES Modules import
27
- * // const { KMSClient, CancelKeyDeletionCommand } = require("@aws-sdk/client-kms"); // CommonJS import
28
- * const client = new KMSClient(config);
29
- * const command = new CancelKeyDeletionCommand(input);
30
- * const response = await client.send(command);
31
- * ```
32
- *
33
- * @see {@link CancelKeyDeletionCommandInput} for command's `input` shape.
34
- * @see {@link CancelKeyDeletionCommandOutput} for command's `response` shape.
35
- * @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
36
- *
37
- */
38
8
  class CancelKeyDeletionCommand extends smithy_client_1.Command {
39
- // Start section: command_properties
40
- // End section: command_properties
41
9
  constructor(input) {
42
- // Start section: command_constructor
43
10
  super();
44
11
  this.input = input;
45
- // End section: command_constructor
46
12
  }
47
- /**
48
- * @internal
49
- */
50
13
  resolveMiddleware(clientStack, configuration, options) {
51
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
52
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,96 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <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>
10
- * <p>The custom key store must be connected before you can create KMS keys in the key store or
11
- * use the KMS keys it contains. You can disconnect and reconnect a custom key store at any
12
- * time.</p>
13
- * <p>To connect a custom key store, its associated CloudHSM cluster must have at least one active
14
- * 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
15
- * 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">
16
- * <code>kmsuser</code> crypto
17
- * user</a> (CU) must not be logged into the cluster. This prevents KMS from using this
18
- * account to log in.</p>
19
- * <p>The connection process can take an extended amount of time to complete; up to 20 minutes.
20
- * This operation starts the connection process, but it does not wait for it to complete. When it
21
- * succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no
22
- * properties. However, this response does not indicate that the custom key store is connected.
23
- * To get the connection state of the custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p>
24
- * <p>During the connection process, KMS finds the CloudHSM cluster that is associated with the
25
- * custom key store, creates the connection infrastructure, connects to the cluster, logs into
26
- * the CloudHSM client as the <code>kmsuser</code> CU, and rotates its password.</p>
27
- * <p>The <code>ConnectCustomKeyStore</code> operation might fail for various reasons. To find
28
- * the reason, use the <a>DescribeCustomKeyStores</a> operation and see the
29
- * <code>ConnectionErrorCode</code> in the response. For help interpreting the
30
- * <code>ConnectionErrorCode</code>, see <a>CustomKeyStoresListEntry</a>.</p>
31
- * <p>To fix the failure, use the <a>DisconnectCustomKeyStore</a> operation to
32
- * disconnect the custom key store, correct the error, use the <a>UpdateCustomKeyStore</a> operation if necessary, and then use
33
- * <code>ConnectCustomKeyStore</code> again.</p>
34
- * <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
35
- * Store</a> in the <i>Key Management Service Developer Guide</i>.</p>
36
- * <p>
37
- * <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
38
- *
39
- * <p>
40
- * <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>
41
- * <p>
42
- * <b>Related operations</b>
43
- * </p>
44
- * <ul>
45
- * <li>
46
- * <p>
47
- * <a>CreateCustomKeyStore</a>
48
- * </p>
49
- * </li>
50
- * <li>
51
- * <p>
52
- * <a>DeleteCustomKeyStore</a>
53
- * </p>
54
- * </li>
55
- * <li>
56
- * <p>
57
- * <a>DescribeCustomKeyStores</a>
58
- * </p>
59
- * </li>
60
- * <li>
61
- * <p>
62
- * <a>DisconnectCustomKeyStore</a>
63
- * </p>
64
- * </li>
65
- * <li>
66
- * <p>
67
- * <a>UpdateCustomKeyStore</a>
68
- * </p>
69
- * </li>
70
- * </ul>
71
- * @example
72
- * Use a bare-bones client and the command you need to make an API call.
73
- * ```javascript
74
- * import { KMSClient, ConnectCustomKeyStoreCommand } from "@aws-sdk/client-kms"; // ES Modules import
75
- * // const { KMSClient, ConnectCustomKeyStoreCommand } = require("@aws-sdk/client-kms"); // CommonJS import
76
- * const client = new KMSClient(config);
77
- * const command = new ConnectCustomKeyStoreCommand(input);
78
- * const response = await client.send(command);
79
- * ```
80
- *
81
- * @see {@link ConnectCustomKeyStoreCommandInput} for command's `input` shape.
82
- * @see {@link ConnectCustomKeyStoreCommandOutput} for command's `response` shape.
83
- * @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
84
- *
85
- */
86
8
  class ConnectCustomKeyStoreCommand extends smithy_client_1.Command {
87
- // Start section: command_properties
88
- // End section: command_properties
89
9
  constructor(input) {
90
- // Start section: command_constructor
91
10
  super();
92
11
  this.input = input;
93
- // End section: command_constructor
94
12
  }
95
- /**
96
- * @internal
97
- */
98
13
  resolveMiddleware(clientStack, configuration, options) {
99
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
100
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,92 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>Creates a friendly name for a KMS key. </p>
10
- * <note>
11
- * <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>
12
- * </note>
13
- * <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
14
- * <a>GenerateDataKey</a>. You can also change the KMS key that's associated with
15
- * the alias (<a>UpdateAlias</a>) or delete the alias (<a>DeleteAlias</a>)
16
- * at any time. These operations don't affect the underlying KMS key. </p>
17
- * <p>You can associate the alias with any customer managed key in the same Amazon Web Services Region. Each
18
- * alias is associated with only one KMS key at a time, but a KMS key can have multiple aliases.
19
- * A valid KMS key is required. You can't create an alias without a KMS key.</p>
20
- * <p>The alias must be unique in the account and Region, but you can have aliases with the same
21
- * 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
22
- * <i>Key Management Service Developer Guide</i>.</p>
23
- * <p>This operation does not return a response. To get the alias that you created, use the
24
- * <a>ListAliases</a> operation.</p>
25
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
26
- * 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>
27
- * <p>
28
- * <b>Cross-account use</b>: No. You cannot perform this operation on an alias in a different Amazon Web Services account.</p>
29
- *
30
- * <p>
31
- * <b>Required permissions</b>
32
- * </p>
33
- * <ul>
34
- * <li>
35
- * <p>
36
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateAlias</a> on
37
- * the alias (IAM policy).</p>
38
- * </li>
39
- * <li>
40
- * <p>
41
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateAlias</a> on
42
- * the KMS key (key policy).</p>
43
- * </li>
44
- * </ul>
45
- * <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
46
- * <i>Key Management Service Developer Guide</i>.</p>
47
- * <p>
48
- * <b>Related operations:</b>
49
- * </p>
50
- * <ul>
51
- * <li>
52
- * <p>
53
- * <a>DeleteAlias</a>
54
- * </p>
55
- * </li>
56
- * <li>
57
- * <p>
58
- * <a>ListAliases</a>
59
- * </p>
60
- * </li>
61
- * <li>
62
- * <p>
63
- * <a>UpdateAlias</a>
64
- * </p>
65
- * </li>
66
- * </ul>
67
- * @example
68
- * Use a bare-bones client and the command you need to make an API call.
69
- * ```javascript
70
- * import { KMSClient, CreateAliasCommand } from "@aws-sdk/client-kms"; // ES Modules import
71
- * // const { KMSClient, CreateAliasCommand } = require("@aws-sdk/client-kms"); // CommonJS import
72
- * const client = new KMSClient(config);
73
- * const command = new CreateAliasCommand(input);
74
- * const response = await client.send(command);
75
- * ```
76
- *
77
- * @see {@link CreateAliasCommandInput} for command's `input` shape.
78
- * @see {@link CreateAliasCommandOutput} for command's `response` shape.
79
- * @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
80
- *
81
- */
82
8
  class CreateAliasCommand extends smithy_client_1.Command {
83
- // Start section: command_properties
84
- // End section: command_properties
85
9
  constructor(input) {
86
- // Start section: command_constructor
87
10
  super();
88
11
  this.input = input;
89
- // End section: command_constructor
90
12
  }
91
- /**
92
- * @internal
93
- */
94
13
  resolveMiddleware(clientStack, configuration, options) {
95
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
96
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,84 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <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
10
- * manage.</p>
11
- * <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
12
- * combines the convenience and extensive integration of KMS with the isolation and control of a
13
- * single-tenant key store.</p>
14
- * <p>Before you create the custom key store, you must assemble
15
- * the required elements, including an CloudHSM cluster that fulfills the requirements for a custom
16
- * 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>
17
- * in the <i>Key Management Service Developer Guide</i>.</p>
18
- * <p>When the operation completes successfully, it returns the ID of the new custom key store.
19
- * 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
20
- * cluster. Even if you are not going to use your custom key store immediately, you might want to
21
- * connect it to verify that all settings are correct and then disconnect it until you are ready
22
- * to use it.</p>
23
- * <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
24
- * <i>Key Management Service Developer Guide</i>.</p>
25
- * <p>
26
- * <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
27
- * <p>
28
- * <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>
29
- * <p>
30
- * <b>Related operations:</b>
31
- * </p>
32
- * <ul>
33
- * <li>
34
- * <p>
35
- * <a>ConnectCustomKeyStore</a>
36
- * </p>
37
- * </li>
38
- * <li>
39
- * <p>
40
- * <a>DeleteCustomKeyStore</a>
41
- * </p>
42
- * </li>
43
- * <li>
44
- * <p>
45
- * <a>DescribeCustomKeyStores</a>
46
- * </p>
47
- * </li>
48
- * <li>
49
- * <p>
50
- * <a>DisconnectCustomKeyStore</a>
51
- * </p>
52
- * </li>
53
- * <li>
54
- * <p>
55
- * <a>UpdateCustomKeyStore</a>
56
- * </p>
57
- * </li>
58
- * </ul>
59
- * @example
60
- * Use a bare-bones client and the command you need to make an API call.
61
- * ```javascript
62
- * import { KMSClient, CreateCustomKeyStoreCommand } from "@aws-sdk/client-kms"; // ES Modules import
63
- * // const { KMSClient, CreateCustomKeyStoreCommand } = require("@aws-sdk/client-kms"); // CommonJS import
64
- * const client = new KMSClient(config);
65
- * const command = new CreateCustomKeyStoreCommand(input);
66
- * const response = await client.send(command);
67
- * ```
68
- *
69
- * @see {@link CreateCustomKeyStoreCommandInput} for command's `input` shape.
70
- * @see {@link CreateCustomKeyStoreCommandOutput} for command's `response` shape.
71
- * @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
72
- *
73
- */
74
8
  class CreateCustomKeyStoreCommand extends smithy_client_1.Command {
75
- // Start section: command_properties
76
- // End section: command_properties
77
9
  constructor(input) {
78
- // Start section: command_constructor
79
10
  super();
80
11
  this.input = input;
81
- // End section: command_constructor
82
12
  }
83
- /**
84
- * @internal
85
- */
86
13
  resolveMiddleware(clientStack, configuration, options) {
87
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
88
15
  const stack = clientStack.concat(this.middlewareStack);