@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
@@ -6,153 +6,11 @@ export interface CreateKeyCommandInput extends CreateKeyRequest {
6
6
  }
7
7
  export interface CreateKeyCommandOutput extends CreateKeyResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <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
11
- * Region.</p>
12
- * <note>
13
- * <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>
14
- * </note>
15
- *
16
- * <p>You can use the <code>CreateKey</code> operation to create symmetric or asymmetric KMS
17
- * keys.</p>
18
- * <ul>
19
- * <li>
20
- * <p>
21
- * <b>Symmetric KMS keys</b> contain a 256-bit symmetric key
22
- * that never leaves KMS unencrypted. To use the KMS key, you must call KMS. You can use
23
- * a symmetric KMS key to encrypt and decrypt small amounts of data, but they are typically
24
- * 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,
25
- * see <a>GenerateDataKey</a> and <a>GenerateDataKeyPair</a>.</p>
26
- * </li>
27
- * <li>
28
- * <p>
29
- * <b>Asymmetric KMS keys</b> can contain an RSA key pair or an
30
- * Elliptic Curve (ECC) key pair. The private key in an asymmetric KMS key never leaves KMS
31
- * unencrypted. However, you can use the <a>GetPublicKey</a> operation to download
32
- * the public key so it can be used outside of KMS. KMS keys with RSA key pairs can be used
33
- * to encrypt or decrypt data or sign and verify messages (but not both). KMS keys with ECC
34
- * key pairs can be used only to sign and verify messages.</p>
35
- * </li>
36
- * </ul>
37
- * <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>
38
- *
39
- *
40
- * <p>To create different types of KMS keys, use the following guidance:</p>
41
- *
42
- * <dl>
43
- * <dt>Asymmetric KMS keys</dt>
44
- * <dd>
45
- * <p>To create an asymmetric KMS key, use the <code>KeySpec</code> parameter to specify
46
- * the type of key material in the KMS key. Then, use the <code>KeyUsage</code> parameter
47
- * to determine whether the KMS key will be used to encrypt and decrypt or sign and verify.
48
- * You can't change these properties after the KMS key is created.</p>
49
- * <p> </p>
50
- * </dd>
51
- * <dt>Symmetric KMS keys</dt>
52
- * <dd>
53
- * <p>When creating a symmetric KMS key, you don't need to specify the
54
- * <code>KeySpec</code> or <code>KeyUsage</code> parameters. The default value for
55
- * <code>KeySpec</code>, <code>SYMMETRIC_DEFAULT</code>, and the default value for
56
- * <code>KeyUsage</code>, <code>ENCRYPT_DECRYPT</code>, are the only valid values for
57
- * symmetric KMS keys. </p>
58
- * <p> </p>
59
- * </dd>
60
- * <dt>Multi-Region primary keys</dt>
61
- * <dt>Imported key material</dt>
62
- * <dd>
63
- * <p>To create a multi-Region <i>primary key</i> in the local Amazon Web Services Region,
64
- * use the <code>MultiRegion</code> parameter with a value of <code>True</code>. To create
65
- * a multi-Region <i>replica key</i>, that is, a KMS key with the same key ID
66
- * 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
67
- * primary key to a replica key, use the <a>UpdatePrimaryRegion</a>
68
- * operation.</p>
69
- * <p>This operation supports <i>multi-Region keys</i>, an KMS feature that lets you create multiple
70
- * interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key
71
- * material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt
72
- * 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>
73
- * <p>You can create symmetric and asymmetric multi-Region keys and multi-Region keys with
74
- * imported key material. You cannot create multi-Region keys in a custom key store.</p>
75
- * <p> </p>
76
- * </dd>
77
- * <dd>
78
- * <p>To import your own key material, begin by creating a symmetric KMS key with no key
79
- * material. To do this, use the <code>Origin</code> parameter of <code>CreateKey</code>
80
- * 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
81
- * your key material. Then, use <a>ImportKeyMaterial</a> with your import token
82
- * 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>
83
- * <i>Key Management Service Developer Guide</i>
84
- * </i>. You
85
- * cannot import the key material into an asymmetric KMS key.</p>
86
- * <p>To create a multi-Region primary key with imported key material, use the
87
- * <code>Origin</code> parameter of <code>CreateKey</code> with a value of
88
- * <code>EXTERNAL</code> and the <code>MultiRegion</code> parameter with a value of
89
- * <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>
90
- * <p> </p>
91
- * </dd>
92
- * <dt>Custom key store</dt>
93
- * <dd>
94
- * <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
95
- * <code>CustomKeyStoreId</code> parameter to specify the custom key store. You must also
96
- * use the <code>Origin</code> parameter with a value of <code>AWS_CLOUDHSM</code>. The
97
- * CloudHSM cluster that is associated with the custom key store must have at least two active
98
- * HSMs in different Availability Zones in the Amazon Web Services Region. </p>
99
- * <p>You cannot create an asymmetric KMS key in a custom key store. For information about
100
- * 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
101
- * the <i>
102
- * <i>Key Management Service Developer Guide</i>
103
- * </i>.</p>
104
- * </dd>
105
- * </dl>
106
- * <p>
107
- * <b>Cross-account use</b>: No. You cannot use this operation to
108
- * create a KMS key in a different Amazon Web Services account.</p>
109
- *
110
- * <p>
111
- * <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
112
- * <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
113
- * 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
114
- * KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
115
- * <p>
116
- * <b>Related operations:</b>
117
- * </p>
118
- * <ul>
119
- * <li>
120
- * <p>
121
- * <a>DescribeKey</a>
122
- * </p>
123
- * </li>
124
- * <li>
125
- * <p>
126
- * <a>ListKeys</a>
127
- * </p>
128
- * </li>
129
- * <li>
130
- * <p>
131
- * <a>ScheduleKeyDeletion</a>
132
- * </p>
133
- * </li>
134
- * </ul>
135
- * @example
136
- * Use a bare-bones client and the command you need to make an API call.
137
- * ```javascript
138
- * import { KMSClient, CreateKeyCommand } from "@aws-sdk/client-kms"; // ES Modules import
139
- * // const { KMSClient, CreateKeyCommand } = require("@aws-sdk/client-kms"); // CommonJS import
140
- * const client = new KMSClient(config);
141
- * const command = new CreateKeyCommand(input);
142
- * const response = await client.send(command);
143
- * ```
144
- *
145
- * @see {@link CreateKeyCommandInput} for command's `input` shape.
146
- * @see {@link CreateKeyCommandOutput} for command's `response` shape.
147
- * @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
148
- *
149
- */
9
+
150
10
  export declare class CreateKeyCommand extends $Command<CreateKeyCommandInput, CreateKeyCommandOutput, KMSClientResolvedConfig> {
151
11
  readonly input: CreateKeyCommandInput;
152
12
  constructor(input: CreateKeyCommandInput);
153
- /**
154
- * @internal
155
- */
13
+
156
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateKeyCommandInput, CreateKeyCommandOutput>;
157
15
  private serialize;
158
16
  private deserialize;
@@ -6,117 +6,11 @@ export interface DecryptCommandInput extends DecryptRequest {
6
6
  }
7
7
  export interface DecryptCommandOutput extends DecryptResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Decrypts ciphertext that was encrypted by a KMS key using any of the following
11
- * operations:</p>
12
- * <ul>
13
- * <li>
14
- * <p>
15
- * <a>Encrypt</a>
16
- * </p>
17
- * </li>
18
- * <li>
19
- * <p>
20
- * <a>GenerateDataKey</a>
21
- * </p>
22
- * </li>
23
- * <li>
24
- * <p>
25
- * <a>GenerateDataKeyPair</a>
26
- * </p>
27
- * </li>
28
- * <li>
29
- * <p>
30
- * <a>GenerateDataKeyWithoutPlaintext</a>
31
- * </p>
32
- * </li>
33
- * <li>
34
- * <p>
35
- * <a>GenerateDataKeyPairWithoutPlaintext</a>
36
- * </p>
37
- * </li>
38
- * </ul>
39
- * <p>You can use this operation to decrypt ciphertext that was encrypted under a symmetric or
40
- * asymmetric KMS key. When the KMS key is asymmetric, you must specify the KMS key and the
41
- * 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>
42
- * <p>The Decrypt operation also decrypts ciphertext that was encrypted outside of KMS by the
43
- * public key in an KMS asymmetric KMS key. However, it cannot decrypt ciphertext produced by
44
- * other libraries, such as the <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">Amazon Web Services
45
- * Encryption SDK</a> or <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3 client-side encryption</a>.
46
- * These libraries return a ciphertext format that is incompatible with KMS.</p>
47
- * <p>If the ciphertext was encrypted under a symmetric KMS key, the <code>KeyId</code>
48
- * parameter is optional. KMS can get this information from metadata that it adds to the
49
- * symmetric ciphertext blob. This feature adds durability to your implementation by ensuring
50
- * that authorized users can decrypt ciphertext decades after it was encrypted, even if they've
51
- * lost track of the key ID. However, specifying the KMS key is always recommended as a best
52
- * practice. When you use the <code>KeyId</code> parameter to specify a KMS key, KMS only uses
53
- * the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the
54
- * <code>Decrypt</code> operation fails. This practice ensures that you use the KMS key that
55
- * you intend.</p>
56
- * <p>Whenever possible, use key policies to give users permission to call the
57
- * <code>Decrypt</code> operation on a particular KMS key, instead of using IAM policies.
58
- * Otherwise, you might create an IAM user policy that gives the user <code>Decrypt</code>
59
- * permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys
60
- * in other accounts if the key policy for the cross-account KMS key permits it. If you must use
61
- * an IAM policy for <code>Decrypt</code> permissions, limit the user to particular KMS keys or
62
- * 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
63
- * policies</a> in the <i>Key Management Service Developer Guide</i>.</p>
64
- * <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>
65
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
66
- * 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>
67
- * <p>
68
- * <b>Cross-account
69
- * use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
70
- * the key ARN or alias ARN in the value of the <code>KeyId</code> parameter. </p>
71
- *
72
- * <p>
73
- * <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>
74
- * <p>
75
- * <b>Related operations:</b>
76
- * </p>
77
- * <ul>
78
- * <li>
79
- * <p>
80
- * <a>Encrypt</a>
81
- * </p>
82
- * </li>
83
- * <li>
84
- * <p>
85
- * <a>GenerateDataKey</a>
86
- * </p>
87
- * </li>
88
- * <li>
89
- * <p>
90
- * <a>GenerateDataKeyPair</a>
91
- * </p>
92
- * </li>
93
- * <li>
94
- * <p>
95
- * <a>ReEncrypt</a>
96
- * </p>
97
- * </li>
98
- * </ul>
99
- * @example
100
- * Use a bare-bones client and the command you need to make an API call.
101
- * ```javascript
102
- * import { KMSClient, DecryptCommand } from "@aws-sdk/client-kms"; // ES Modules import
103
- * // const { KMSClient, DecryptCommand } = require("@aws-sdk/client-kms"); // CommonJS import
104
- * const client = new KMSClient(config);
105
- * const command = new DecryptCommand(input);
106
- * const response = await client.send(command);
107
- * ```
108
- *
109
- * @see {@link DecryptCommandInput} for command's `input` shape.
110
- * @see {@link DecryptCommandOutput} for command's `response` shape.
111
- * @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
112
- *
113
- */
9
+
114
10
  export declare class DecryptCommand extends $Command<DecryptCommandInput, DecryptCommandOutput, KMSClientResolvedConfig> {
115
11
  readonly input: DecryptCommandInput;
116
12
  constructor(input: DecryptCommandInput);
117
- /**
118
- * @internal
119
- */
13
+
120
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DecryptCommandInput, DecryptCommandOutput>;
121
15
  private serialize;
122
16
  private deserialize;
@@ -6,76 +6,11 @@ export interface DeleteAliasCommandInput extends DeleteAliasRequest {
6
6
  }
7
7
  export interface DeleteAliasCommandOutput extends __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Deletes the specified alias. </p>
11
- * <note>
12
- * <p>Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">Using ABAC in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
13
- * </note>
14
- * <p>Because an alias is not a property of a KMS key, you can delete and change the aliases of
15
- * a KMS key without affecting the KMS key. Also, aliases do not appear in the response from the
16
- * <a>DescribeKey</a> operation. To get the aliases of all KMS keys, use the <a>ListAliases</a> operation. </p>
17
- * <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
18
- * create a new alias. To associate an existing alias with a different KMS key, call <a>UpdateAlias</a>.</p>
19
- * <p>
20
- * <b>Cross-account use</b>: No. You cannot perform this operation on an alias in a different Amazon Web Services account.</p>
21
- * <p>
22
- * <b>Required permissions</b>
23
- * </p>
24
- * <ul>
25
- * <li>
26
- * <p>
27
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteAlias</a> on
28
- * the alias (IAM policy).</p>
29
- * </li>
30
- * <li>
31
- * <p>
32
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteAlias</a> on
33
- * the KMS key (key policy).</p>
34
- * </li>
35
- * </ul>
36
- * <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
37
- * <i>Key Management Service Developer Guide</i>.</p>
38
- * <p>
39
- * <b>Related operations:</b>
40
- * </p>
41
- * <ul>
42
- * <li>
43
- * <p>
44
- * <a>CreateAlias</a>
45
- * </p>
46
- * </li>
47
- * <li>
48
- * <p>
49
- * <a>ListAliases</a>
50
- * </p>
51
- * </li>
52
- * <li>
53
- * <p>
54
- * <a>UpdateAlias</a>
55
- * </p>
56
- * </li>
57
- * </ul>
58
- * @example
59
- * Use a bare-bones client and the command you need to make an API call.
60
- * ```javascript
61
- * import { KMSClient, DeleteAliasCommand } from "@aws-sdk/client-kms"; // ES Modules import
62
- * // const { KMSClient, DeleteAliasCommand } = require("@aws-sdk/client-kms"); // CommonJS import
63
- * const client = new KMSClient(config);
64
- * const command = new DeleteAliasCommand(input);
65
- * const response = await client.send(command);
66
- * ```
67
- *
68
- * @see {@link DeleteAliasCommandInput} for command's `input` shape.
69
- * @see {@link DeleteAliasCommandOutput} for command's `response` shape.
70
- * @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
71
- *
72
- */
9
+
73
10
  export declare class DeleteAliasCommand extends $Command<DeleteAliasCommandInput, DeleteAliasCommandOutput, KMSClientResolvedConfig> {
74
11
  readonly input: DeleteAliasCommandInput;
75
12
  constructor(input: DeleteAliasCommandInput);
76
- /**
77
- * @internal
78
- */
13
+
79
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteAliasCommandInput, DeleteAliasCommandOutput>;
80
15
  private serialize;
81
16
  private deserialize;
@@ -6,83 +6,11 @@ export interface DeleteCustomKeyStoreCommandInput extends DeleteCustomKeyStoreRe
6
6
  }
7
7
  export interface DeleteCustomKeyStoreCommandOutput extends DeleteCustomKeyStoreResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <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
11
- * associated with the custom key store, or affect any users or keys in the cluster.</p>
12
- * <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,
13
- * verify that you will never need to use any of the KMS keys in the key store for any
14
- * <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
15
- * key store. When the scheduled waiting period expires, the <code>ScheduleKeyDeletion</code>
16
- * operation deletes the KMS keys. Then it makes a best effort to delete the key material from
17
- * 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
18
- * material</a> from the cluster and its backups.</p>
19
- * <p>After all KMS keys are deleted from KMS, use <a>DisconnectCustomKeyStore</a>
20
- * to disconnect the key store from KMS. Then, you can delete the custom key store.</p>
21
- * <p>Instead of deleting the custom key store, consider using <a>DisconnectCustomKeyStore</a> to disconnect it from KMS. While the key store is
22
- * disconnected, you cannot create or use the KMS keys in the key store. But, you do not need to
23
- * delete KMS keys and you can reconnect a disconnected custom key store at any time.</p>
24
- * <p>If the operation succeeds, it returns a JSON object with no
25
- * properties.</p>
26
- * <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
27
- * combines the convenience and extensive integration of KMS with the isolation and control of a
28
- * single-tenant key store.</p>
29
- * <p>
30
- * <b>Cross-account use</b>: No.
31
- * You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
32
- *
33
- * <p>
34
- * <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>
35
- * <p>
36
- * <b>Related operations:</b>
37
- * </p>
38
- * <ul>
39
- * <li>
40
- * <p>
41
- * <a>ConnectCustomKeyStore</a>
42
- * </p>
43
- * </li>
44
- * <li>
45
- * <p>
46
- * <a>CreateCustomKeyStore</a>
47
- * </p>
48
- * </li>
49
- * <li>
50
- * <p>
51
- * <a>DescribeCustomKeyStores</a>
52
- * </p>
53
- * </li>
54
- * <li>
55
- * <p>
56
- * <a>DisconnectCustomKeyStore</a>
57
- * </p>
58
- * </li>
59
- * <li>
60
- * <p>
61
- * <a>UpdateCustomKeyStore</a>
62
- * </p>
63
- * </li>
64
- * </ul>
65
- * @example
66
- * Use a bare-bones client and the command you need to make an API call.
67
- * ```javascript
68
- * import { KMSClient, DeleteCustomKeyStoreCommand } from "@aws-sdk/client-kms"; // ES Modules import
69
- * // const { KMSClient, DeleteCustomKeyStoreCommand } = require("@aws-sdk/client-kms"); // CommonJS import
70
- * const client = new KMSClient(config);
71
- * const command = new DeleteCustomKeyStoreCommand(input);
72
- * const response = await client.send(command);
73
- * ```
74
- *
75
- * @see {@link DeleteCustomKeyStoreCommandInput} for command's `input` shape.
76
- * @see {@link DeleteCustomKeyStoreCommandOutput} for command's `response` shape.
77
- * @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
78
- *
79
- */
9
+
80
10
  export declare class DeleteCustomKeyStoreCommand extends $Command<DeleteCustomKeyStoreCommandInput, DeleteCustomKeyStoreCommandOutput, KMSClientResolvedConfig> {
81
11
  readonly input: DeleteCustomKeyStoreCommandInput;
82
12
  constructor(input: DeleteCustomKeyStoreCommandInput);
83
- /**
84
- * @internal
85
- */
13
+
86
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteCustomKeyStoreCommandInput, DeleteCustomKeyStoreCommandOutput>;
87
15
  private serialize;
88
16
  private deserialize;
@@ -6,58 +6,11 @@ export interface DeleteImportedKeyMaterialCommandInput extends DeleteImportedKey
6
6
  }
7
7
  export interface DeleteImportedKeyMaterialCommandOutput extends __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Deletes key material that you previously imported. This operation makes the specified KMS
11
- * 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>
12
- * in the <i>Key Management Service Developer Guide</i>. </p>
13
- * <p>When the specified KMS key is in the <code>PendingDeletion</code> state, this operation
14
- * does not change the KMS key's state. Otherwise, it changes the KMS key's state to
15
- * <code>PendingImport</code>.</p>
16
- * <p>After you delete key material, you can use <a>ImportKeyMaterial</a> to reimport
17
- * the same key material into the KMS key.</p>
18
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
19
- * 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>
20
- * <p>
21
- * <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
22
- *
23
- * <p>
24
- * <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>
25
- * <p>
26
- * <b>Related operations:</b>
27
- * </p>
28
- * <ul>
29
- * <li>
30
- * <p>
31
- * <a>GetParametersForImport</a>
32
- * </p>
33
- * </li>
34
- * <li>
35
- * <p>
36
- * <a>ImportKeyMaterial</a>
37
- * </p>
38
- * </li>
39
- * </ul>
40
- * @example
41
- * Use a bare-bones client and the command you need to make an API call.
42
- * ```javascript
43
- * import { KMSClient, DeleteImportedKeyMaterialCommand } from "@aws-sdk/client-kms"; // ES Modules import
44
- * // const { KMSClient, DeleteImportedKeyMaterialCommand } = require("@aws-sdk/client-kms"); // CommonJS import
45
- * const client = new KMSClient(config);
46
- * const command = new DeleteImportedKeyMaterialCommand(input);
47
- * const response = await client.send(command);
48
- * ```
49
- *
50
- * @see {@link DeleteImportedKeyMaterialCommandInput} for command's `input` shape.
51
- * @see {@link DeleteImportedKeyMaterialCommandOutput} for command's `response` shape.
52
- * @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
53
- *
54
- */
9
+
55
10
  export declare class DeleteImportedKeyMaterialCommand extends $Command<DeleteImportedKeyMaterialCommandInput, DeleteImportedKeyMaterialCommandOutput, KMSClientResolvedConfig> {
56
11
  readonly input: DeleteImportedKeyMaterialCommandInput;
57
12
  constructor(input: DeleteImportedKeyMaterialCommandInput);
58
- /**
59
- * @internal
60
- */
13
+
61
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteImportedKeyMaterialCommandInput, DeleteImportedKeyMaterialCommandOutput>;
62
15
  private serialize;
63
16
  private deserialize;
@@ -6,82 +6,11 @@ export interface DescribeCustomKeyStoresCommandInput extends DescribeCustomKeySt
6
6
  }
7
7
  export interface DescribeCustomKeyStoresCommandOutput extends DescribeCustomKeyStoresResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <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>
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>By default, this operation returns information about all custom key
15
- * stores in the account and Region. To get only information about a particular custom key store,
16
- * use either the <code>CustomKeyStoreName</code> or <code>CustomKeyStoreId</code> parameter (but
17
- * not both).</p>
18
- * <p>To determine whether the custom key store is connected to its CloudHSM cluster, use the
19
- * <code>ConnectionState</code> element in the response. If an attempt to connect the custom
20
- * key store failed, the <code>ConnectionState</code> value is <code>FAILED</code> and the
21
- * <code>ConnectionErrorCode</code> element in the response indicates the cause of the failure.
22
- * For help interpreting the <code>ConnectionErrorCode</code>, see <a>CustomKeyStoresListEntry</a>.</p>
23
- * <p>Custom key stores have a <code>DISCONNECTED</code> connection state if the key store has
24
- * never been connected or you use the <a>DisconnectCustomKeyStore</a> operation to
25
- * disconnect it. If your custom key store state is <code>CONNECTED</code> but you are having
26
- * trouble using it, make sure that its associated CloudHSM cluster is active and contains the
27
- * minimum number of HSMs required for the operation, if any.</p>
28
- * <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
29
- * <i>Key Management Service Developer Guide</i>.</p>
30
- * <p>
31
- * <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
32
- * <p>
33
- * <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>
34
- * <p>
35
- * <b>Related operations:</b>
36
- * </p>
37
- * <ul>
38
- * <li>
39
- * <p>
40
- * <a>ConnectCustomKeyStore</a>
41
- * </p>
42
- * </li>
43
- * <li>
44
- * <p>
45
- * <a>CreateCustomKeyStore</a>
46
- * </p>
47
- * </li>
48
- * <li>
49
- * <p>
50
- * <a>DeleteCustomKeyStore</a>
51
- * </p>
52
- * </li>
53
- * <li>
54
- * <p>
55
- * <a>DisconnectCustomKeyStore</a>
56
- * </p>
57
- * </li>
58
- * <li>
59
- * <p>
60
- * <a>UpdateCustomKeyStore</a>
61
- * </p>
62
- * </li>
63
- * </ul>
64
- * @example
65
- * Use a bare-bones client and the command you need to make an API call.
66
- * ```javascript
67
- * import { KMSClient, DescribeCustomKeyStoresCommand } from "@aws-sdk/client-kms"; // ES Modules import
68
- * // const { KMSClient, DescribeCustomKeyStoresCommand } = require("@aws-sdk/client-kms"); // CommonJS import
69
- * const client = new KMSClient(config);
70
- * const command = new DescribeCustomKeyStoresCommand(input);
71
- * const response = await client.send(command);
72
- * ```
73
- *
74
- * @see {@link DescribeCustomKeyStoresCommandInput} for command's `input` shape.
75
- * @see {@link DescribeCustomKeyStoresCommandOutput} for command's `response` shape.
76
- * @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
77
- *
78
- */
9
+
79
10
  export declare class DescribeCustomKeyStoresCommand extends $Command<DescribeCustomKeyStoresCommandInput, DescribeCustomKeyStoresCommandOutput, KMSClientResolvedConfig> {
80
11
  readonly input: DescribeCustomKeyStoresCommandInput;
81
12
  constructor(input: DescribeCustomKeyStoresCommandInput);
82
- /**
83
- * @internal
84
- */
13
+
85
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeCustomKeyStoresCommandInput, DescribeCustomKeyStoresCommandOutput>;
86
15
  private serialize;
87
16
  private deserialize;