@aws-sdk/client-kms 3.36.0 → 3.39.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +42 -0
- package/dist-cjs/KMS.js +0 -92
- package/dist-cjs/KMSClient.js +0 -97
- package/dist-cjs/commands/CancelKeyDeletionCommand.js +0 -37
- package/dist-cjs/commands/ConnectCustomKeyStoreCommand.js +0 -85
- package/dist-cjs/commands/CreateAliasCommand.js +0 -81
- package/dist-cjs/commands/CreateCustomKeyStoreCommand.js +0 -73
- package/dist-cjs/commands/CreateGrantCommand.js +0 -86
- package/dist-cjs/commands/CreateKeyCommand.js +0 -148
- package/dist-cjs/commands/DecryptCommand.js +0 -112
- package/dist-cjs/commands/DeleteAliasCommand.js +0 -71
- package/dist-cjs/commands/DeleteCustomKeyStoreCommand.js +0 -78
- package/dist-cjs/commands/DeleteImportedKeyMaterialCommand.js +0 -53
- package/dist-cjs/commands/DescribeCustomKeyStoresCommand.js +0 -77
- package/dist-cjs/commands/DescribeKeyCommand.js +0 -103
- package/dist-cjs/commands/DisableKeyCommand.js +0 -39
- package/dist-cjs/commands/DisableKeyRotationCommand.js +0 -49
- package/dist-cjs/commands/DisconnectCustomKeyStoreCommand.js +0 -76
- package/dist-cjs/commands/EnableKeyCommand.js +0 -36
- package/dist-cjs/commands/EnableKeyRotationCommand.js +0 -49
- package/dist-cjs/commands/EncryptCommand.js +0 -148
- package/dist-cjs/commands/GenerateDataKeyCommand.js +0 -121
- package/dist-cjs/commands/GenerateDataKeyPairCommand.js +0 -100
- package/dist-cjs/commands/GenerateDataKeyPairWithoutPlaintextCommand.js +0 -90
- package/dist-cjs/commands/GenerateDataKeyWithoutPlaintextCommand.js +0 -95
- package/dist-cjs/commands/GenerateRandomCommand.js +0 -33
- package/dist-cjs/commands/GetKeyPolicyCommand.js +0 -32
- package/dist-cjs/commands/GetKeyRotationStatusCommand.js +0 -61
- package/dist-cjs/commands/GetParametersForImportCommand.js +0 -58
- package/dist-cjs/commands/GetPublicKeyCommand.js +0 -70
- package/dist-cjs/commands/ImportKeyMaterialCommand.js +0 -87
- package/dist-cjs/commands/ListAliasesCommand.js +0 -66
- package/dist-cjs/commands/ListGrantsCommand.js +0 -69
- package/dist-cjs/commands/ListKeyPoliciesCommand.js +0 -46
- package/dist-cjs/commands/ListKeysCommand.js +0 -54
- package/dist-cjs/commands/ListResourceTagsCommand.js +0 -58
- package/dist-cjs/commands/ListRetirableGrantsCommand.js +0 -67
- package/dist-cjs/commands/PutKeyPolicyCommand.js +0 -37
- package/dist-cjs/commands/ReEncryptCommand.js +0 -122
- package/dist-cjs/commands/ReplicateKeyCommand.js +0 -101
- package/dist-cjs/commands/RetireGrantCommand.js +0 -70
- package/dist-cjs/commands/RevokeGrantCommand.js +0 -67
- package/dist-cjs/commands/ScheduleKeyDeletionCommand.js +0 -78
- package/dist-cjs/commands/SignCommand.js +0 -69
- package/dist-cjs/commands/TagResourceCommand.js +0 -71
- package/dist-cjs/commands/UntagResourceCommand.js +0 -67
- package/dist-cjs/commands/UpdateAliasCommand.js +0 -86
- package/dist-cjs/commands/UpdateCustomKeyStoreCommand.js +0 -96
- package/dist-cjs/commands/UpdateKeyDescriptionCommand.js +0 -47
- package/dist-cjs/commands/UpdatePrimaryRegionCommand.js +0 -89
- package/dist-cjs/commands/VerifyCommand.js +0 -54
- package/dist-cjs/commands/index.js +51 -0
- package/dist-cjs/endpoints.js +6 -1
- package/dist-cjs/index.js +4 -55
- package/dist-cjs/models/models_0.js +0 -366
- package/dist-cjs/pagination/ListAliasesPaginator.js +0 -10
- package/dist-cjs/pagination/ListGrantsPaginator.js +0 -10
- package/dist-cjs/pagination/ListKeyPoliciesPaginator.js +0 -10
- package/dist-cjs/pagination/ListKeysPaginator.js +0 -10
- package/dist-cjs/pagination/index.js +8 -0
- package/dist-cjs/protocols/Aws_json1_1.js +0 -5
- package/dist-cjs/runtimeConfig.browser.js +1 -5
- package/dist-cjs/runtimeConfig.js +1 -5
- package/dist-cjs/runtimeConfig.native.js +0 -3
- package/dist-cjs/runtimeConfig.shared.js +0 -3
- package/dist-es/commands/index.js +48 -0
- package/dist-es/endpoints.js +6 -1
- package/dist-es/index.js +4 -55
- package/dist-es/pagination/index.js +5 -0
- package/dist-types/commands/index.d.ts +48 -0
- package/dist-types/index.d.ts +4 -55
- package/dist-types/pagination/index.d.ts +5 -0
- package/dist-types/ts3.4/KMS.d.ts +49 -2646
- package/dist-types/ts3.4/KMSClient.d.ts +24 -178
- package/dist-types/ts3.4/commands/CancelKeyDeletionCommand.d.ts +2 -33
- package/dist-types/ts3.4/commands/ConnectCustomKeyStoreCommand.d.ts +2 -81
- package/dist-types/ts3.4/commands/CreateAliasCommand.d.ts +2 -77
- package/dist-types/ts3.4/commands/CreateCustomKeyStoreCommand.d.ts +2 -69
- package/dist-types/ts3.4/commands/CreateGrantCommand.d.ts +2 -82
- package/dist-types/ts3.4/commands/CreateKeyCommand.d.ts +2 -144
- package/dist-types/ts3.4/commands/DecryptCommand.d.ts +2 -108
- package/dist-types/ts3.4/commands/DeleteAliasCommand.d.ts +2 -67
- package/dist-types/ts3.4/commands/DeleteCustomKeyStoreCommand.d.ts +2 -74
- package/dist-types/ts3.4/commands/DeleteImportedKeyMaterialCommand.d.ts +2 -49
- package/dist-types/ts3.4/commands/DescribeCustomKeyStoresCommand.d.ts +2 -73
- package/dist-types/ts3.4/commands/DescribeKeyCommand.d.ts +2 -99
- package/dist-types/ts3.4/commands/DisableKeyCommand.d.ts +2 -35
- package/dist-types/ts3.4/commands/DisableKeyRotationCommand.d.ts +2 -45
- package/dist-types/ts3.4/commands/DisconnectCustomKeyStoreCommand.d.ts +2 -72
- package/dist-types/ts3.4/commands/EnableKeyCommand.d.ts +2 -32
- package/dist-types/ts3.4/commands/EnableKeyRotationCommand.d.ts +2 -45
- package/dist-types/ts3.4/commands/EncryptCommand.d.ts +2 -144
- package/dist-types/ts3.4/commands/GenerateDataKeyCommand.d.ts +2 -117
- package/dist-types/ts3.4/commands/GenerateDataKeyPairCommand.d.ts +2 -96
- package/dist-types/ts3.4/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +2 -86
- package/dist-types/ts3.4/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +2 -91
- package/dist-types/ts3.4/commands/GenerateRandomCommand.d.ts +2 -29
- package/dist-types/ts3.4/commands/GetKeyPolicyCommand.d.ts +2 -28
- package/dist-types/ts3.4/commands/GetKeyRotationStatusCommand.d.ts +2 -57
- package/dist-types/ts3.4/commands/GetParametersForImportCommand.d.ts +2 -54
- package/dist-types/ts3.4/commands/GetPublicKeyCommand.d.ts +2 -66
- package/dist-types/ts3.4/commands/ImportKeyMaterialCommand.d.ts +2 -83
- package/dist-types/ts3.4/commands/ListAliasesCommand.d.ts +2 -62
- package/dist-types/ts3.4/commands/ListGrantsCommand.d.ts +2 -65
- package/dist-types/ts3.4/commands/ListKeyPoliciesCommand.d.ts +2 -42
- package/dist-types/ts3.4/commands/ListKeysCommand.d.ts +2 -50
- package/dist-types/ts3.4/commands/ListResourceTagsCommand.d.ts +2 -54
- package/dist-types/ts3.4/commands/ListRetirableGrantsCommand.d.ts +2 -63
- package/dist-types/ts3.4/commands/PutKeyPolicyCommand.d.ts +2 -33
- package/dist-types/ts3.4/commands/ReEncryptCommand.d.ts +2 -118
- package/dist-types/ts3.4/commands/ReplicateKeyCommand.d.ts +2 -97
- package/dist-types/ts3.4/commands/RetireGrantCommand.d.ts +2 -66
- package/dist-types/ts3.4/commands/RevokeGrantCommand.d.ts +2 -63
- package/dist-types/ts3.4/commands/ScheduleKeyDeletionCommand.d.ts +2 -74
- package/dist-types/ts3.4/commands/SignCommand.d.ts +2 -65
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -67
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -63
- package/dist-types/ts3.4/commands/UpdateAliasCommand.d.ts +2 -82
- package/dist-types/ts3.4/commands/UpdateCustomKeyStoreCommand.d.ts +2 -92
- package/dist-types/ts3.4/commands/UpdateKeyDescriptionCommand.d.ts +2 -43
- package/dist-types/ts3.4/commands/UpdatePrimaryRegionCommand.d.ts +2 -85
- package/dist-types/ts3.4/commands/VerifyCommand.d.ts +2 -50
- package/dist-types/ts3.4/commands/index.d.ts +48 -0
- package/dist-types/ts3.4/index.d.ts +4 -55
- package/dist-types/ts3.4/models/models_0.d.ts +445 -2963
- package/dist-types/ts3.4/pagination/index.d.ts +5 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
- package/package.json +32 -32
|
@@ -5,88 +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>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>
|
|
10
|
-
* <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
|
|
11
|
-
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
12
|
-
* single-tenant key store.</p>
|
|
13
|
-
* <p>By default, this operation returns information about all custom key
|
|
14
|
-
* stores in the account and Region. To get only information about a particular custom key store,
|
|
15
|
-
* use either the <code>CustomKeyStoreName</code> or <code>CustomKeyStoreId</code> parameter (but
|
|
16
|
-
* not both).</p>
|
|
17
|
-
* <p>To determine whether the custom key store is connected to its CloudHSM cluster, use the
|
|
18
|
-
* <code>ConnectionState</code> element in the response. If an attempt to connect the custom
|
|
19
|
-
* key store failed, the <code>ConnectionState</code> value is <code>FAILED</code> and the
|
|
20
|
-
* <code>ConnectionErrorCode</code> element in the response indicates the cause of the failure.
|
|
21
|
-
* For help interpreting the <code>ConnectionErrorCode</code>, see <a>CustomKeyStoresListEntry</a>.</p>
|
|
22
|
-
* <p>Custom key stores have a <code>DISCONNECTED</code> connection state if the key store has
|
|
23
|
-
* never been connected or you use the <a>DisconnectCustomKeyStore</a> operation to
|
|
24
|
-
* disconnect it. If your custom key store state is <code>CONNECTED</code> but you are having
|
|
25
|
-
* trouble using it, make sure that its associated CloudHSM cluster is active and contains the
|
|
26
|
-
* minimum number of HSMs required for the operation, if any.</p>
|
|
27
|
-
* <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
|
|
28
|
-
* <i>Key Management Service Developer Guide</i>.</p>
|
|
29
|
-
* <p>
|
|
30
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
31
|
-
* <p>
|
|
32
|
-
* <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>
|
|
33
|
-
* <p>
|
|
34
|
-
* <b>Related operations:</b>
|
|
35
|
-
* </p>
|
|
36
|
-
* <ul>
|
|
37
|
-
* <li>
|
|
38
|
-
* <p>
|
|
39
|
-
* <a>ConnectCustomKeyStore</a>
|
|
40
|
-
* </p>
|
|
41
|
-
* </li>
|
|
42
|
-
* <li>
|
|
43
|
-
* <p>
|
|
44
|
-
* <a>CreateCustomKeyStore</a>
|
|
45
|
-
* </p>
|
|
46
|
-
* </li>
|
|
47
|
-
* <li>
|
|
48
|
-
* <p>
|
|
49
|
-
* <a>DeleteCustomKeyStore</a>
|
|
50
|
-
* </p>
|
|
51
|
-
* </li>
|
|
52
|
-
* <li>
|
|
53
|
-
* <p>
|
|
54
|
-
* <a>DisconnectCustomKeyStore</a>
|
|
55
|
-
* </p>
|
|
56
|
-
* </li>
|
|
57
|
-
* <li>
|
|
58
|
-
* <p>
|
|
59
|
-
* <a>UpdateCustomKeyStore</a>
|
|
60
|
-
* </p>
|
|
61
|
-
* </li>
|
|
62
|
-
* </ul>
|
|
63
|
-
* @example
|
|
64
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
65
|
-
* ```javascript
|
|
66
|
-
* import { KMSClient, DescribeCustomKeyStoresCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
67
|
-
* // const { KMSClient, DescribeCustomKeyStoresCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
68
|
-
* const client = new KMSClient(config);
|
|
69
|
-
* const command = new DescribeCustomKeyStoresCommand(input);
|
|
70
|
-
* const response = await client.send(command);
|
|
71
|
-
* ```
|
|
72
|
-
*
|
|
73
|
-
* @see {@link DescribeCustomKeyStoresCommandInput} for command's `input` shape.
|
|
74
|
-
* @see {@link DescribeCustomKeyStoresCommandOutput} for command's `response` shape.
|
|
75
|
-
* @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
|
|
76
|
-
*
|
|
77
|
-
*/
|
|
78
8
|
class DescribeCustomKeyStoresCommand extends smithy_client_1.Command {
|
|
79
|
-
// Start section: command_properties
|
|
80
|
-
// End section: command_properties
|
|
81
9
|
constructor(input) {
|
|
82
|
-
// Start section: command_constructor
|
|
83
10
|
super();
|
|
84
11
|
this.input = input;
|
|
85
|
-
// End section: command_constructor
|
|
86
12
|
}
|
|
87
|
-
/**
|
|
88
|
-
* @internal
|
|
89
|
-
*/
|
|
90
13
|
resolveMiddleware(clientStack, configuration, options) {
|
|
91
14
|
this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
|
|
92
15
|
const stack = clientStack.concat(this.middlewareStack);
|
|
@@ -5,114 +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>Provides detailed information about a KMS key. You can run <code>DescribeKey</code> on a
|
|
10
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed
|
|
11
|
-
* 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>
|
|
12
|
-
* <p>This detailed information includes the key ARN, creation date (and deletion date, if
|
|
13
|
-
* applicable), the key state, and the origin and expiration date (if any) of the key material.
|
|
14
|
-
* It includes fields, like <code>KeySpec</code>, that help you distinguish symmetric from
|
|
15
|
-
* asymmetric KMS keys. It also provides information that is particularly important to asymmetric
|
|
16
|
-
* keys, such as the key usage (encryption or signing) and the encryption algorithms or signing
|
|
17
|
-
* algorithms that the KMS key supports. For KMS keys in custom key stores, it includes
|
|
18
|
-
* information about the custom key store, such as the key store ID and the CloudHSM cluster ID. For
|
|
19
|
-
* multi-Region keys, it displays the primary key and all related replica keys. </p>
|
|
20
|
-
* <p>
|
|
21
|
-
* <code>DescribeKey</code> does not return the following information:</p>
|
|
22
|
-
* <ul>
|
|
23
|
-
* <li>
|
|
24
|
-
* <p>Aliases associated with the KMS key. To get this information, use <a>ListAliases</a>.</p>
|
|
25
|
-
* </li>
|
|
26
|
-
* <li>
|
|
27
|
-
* <p>Whether automatic key rotation is enabled on the KMS key. To get this information, use
|
|
28
|
-
* <a>GetKeyRotationStatus</a>. Also, some key states prevent a KMS key from
|
|
29
|
-
* 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
|
|
30
|
-
* Works</a> in <i>Key Management Service Developer Guide</i>.</p>
|
|
31
|
-
* </li>
|
|
32
|
-
* <li>
|
|
33
|
-
* <p>Tags on the KMS key. To get this information, use <a>ListResourceTags</a>.</p>
|
|
34
|
-
* </li>
|
|
35
|
-
* <li>
|
|
36
|
-
* <p>Key policies and grants on the KMS key. To get this information, use <a>GetKeyPolicy</a> and <a>ListGrants</a>.</p>
|
|
37
|
-
* </li>
|
|
38
|
-
* </ul>
|
|
39
|
-
* <p>If you call the <code>DescribeKey</code> operation on a <i>predefined Amazon Web Services
|
|
40
|
-
* 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
|
|
41
|
-
* key</a>. Then, it associates the alias with the new KMS key, and returns the
|
|
42
|
-
* <code>KeyId</code> and <code>Arn</code> of the new KMS key in the response.</p>
|
|
43
|
-
* <p>
|
|
44
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
45
|
-
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
46
|
-
*
|
|
47
|
-
* <p>
|
|
48
|
-
* <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>
|
|
49
|
-
* <p>
|
|
50
|
-
* <b>Related operations:</b>
|
|
51
|
-
* </p>
|
|
52
|
-
* <ul>
|
|
53
|
-
* <li>
|
|
54
|
-
* <p>
|
|
55
|
-
* <a>GetKeyPolicy</a>
|
|
56
|
-
* </p>
|
|
57
|
-
* </li>
|
|
58
|
-
* <li>
|
|
59
|
-
* <p>
|
|
60
|
-
* <a>GetKeyRotationStatus</a>
|
|
61
|
-
* </p>
|
|
62
|
-
* </li>
|
|
63
|
-
* <li>
|
|
64
|
-
* <p>
|
|
65
|
-
* <a>ListAliases</a>
|
|
66
|
-
* </p>
|
|
67
|
-
* </li>
|
|
68
|
-
* <li>
|
|
69
|
-
* <p>
|
|
70
|
-
* <a>ListGrants</a>
|
|
71
|
-
* </p>
|
|
72
|
-
* </li>
|
|
73
|
-
* <li>
|
|
74
|
-
* <p>
|
|
75
|
-
* <a>ListKeys</a>
|
|
76
|
-
* </p>
|
|
77
|
-
* </li>
|
|
78
|
-
* <li>
|
|
79
|
-
* <p>
|
|
80
|
-
* <a>ListResourceTags</a>
|
|
81
|
-
* </p>
|
|
82
|
-
* </li>
|
|
83
|
-
* <li>
|
|
84
|
-
* <p>
|
|
85
|
-
* <a>ListRetirableGrants</a>
|
|
86
|
-
* </p>
|
|
87
|
-
* </li>
|
|
88
|
-
* </ul>
|
|
89
|
-
* @example
|
|
90
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
91
|
-
* ```javascript
|
|
92
|
-
* import { KMSClient, DescribeKeyCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
93
|
-
* // const { KMSClient, DescribeKeyCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
94
|
-
* const client = new KMSClient(config);
|
|
95
|
-
* const command = new DescribeKeyCommand(input);
|
|
96
|
-
* const response = await client.send(command);
|
|
97
|
-
* ```
|
|
98
|
-
*
|
|
99
|
-
* @see {@link DescribeKeyCommandInput} for command's `input` shape.
|
|
100
|
-
* @see {@link DescribeKeyCommandOutput} for command's `response` shape.
|
|
101
|
-
* @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
|
|
102
|
-
*
|
|
103
|
-
*/
|
|
104
8
|
class DescribeKeyCommand extends smithy_client_1.Command {
|
|
105
|
-
// Start section: command_properties
|
|
106
|
-
// End section: command_properties
|
|
107
9
|
constructor(input) {
|
|
108
|
-
// Start section: command_constructor
|
|
109
10
|
super();
|
|
110
11
|
this.input = input;
|
|
111
|
-
// End section: command_constructor
|
|
112
12
|
}
|
|
113
|
-
/**
|
|
114
|
-
* @internal
|
|
115
|
-
*/
|
|
116
13
|
resolveMiddleware(clientStack, configuration, options) {
|
|
117
14
|
this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
|
|
118
15
|
const stack = clientStack.concat(this.middlewareStack);
|
|
@@ -5,50 +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>Sets the state of a KMS key to disabled. This change temporarily prevents use of the KMS
|
|
10
|
-
* key for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. </p>
|
|
11
|
-
* <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
|
|
12
|
-
* key</a> in the <i>
|
|
13
|
-
* <i>Key Management Service Developer Guide</i>
|
|
14
|
-
* </i>.</p>
|
|
15
|
-
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
16
|
-
* 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>
|
|
17
|
-
* <p>
|
|
18
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
19
|
-
*
|
|
20
|
-
* <p>
|
|
21
|
-
* <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>
|
|
22
|
-
* <p>
|
|
23
|
-
* <b>Related operations</b>: <a>EnableKey</a>
|
|
24
|
-
* </p>
|
|
25
|
-
* @example
|
|
26
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
27
|
-
* ```javascript
|
|
28
|
-
* import { KMSClient, DisableKeyCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
29
|
-
* // const { KMSClient, DisableKeyCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
30
|
-
* const client = new KMSClient(config);
|
|
31
|
-
* const command = new DisableKeyCommand(input);
|
|
32
|
-
* const response = await client.send(command);
|
|
33
|
-
* ```
|
|
34
|
-
*
|
|
35
|
-
* @see {@link DisableKeyCommandInput} for command's `input` shape.
|
|
36
|
-
* @see {@link DisableKeyCommandOutput} for command's `response` shape.
|
|
37
|
-
* @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
|
|
38
|
-
*
|
|
39
|
-
*/
|
|
40
8
|
class DisableKeyCommand extends smithy_client_1.Command {
|
|
41
|
-
// Start section: command_properties
|
|
42
|
-
// End section: command_properties
|
|
43
9
|
constructor(input) {
|
|
44
|
-
// Start section: command_constructor
|
|
45
10
|
super();
|
|
46
11
|
this.input = input;
|
|
47
|
-
// End section: command_constructor
|
|
48
12
|
}
|
|
49
|
-
/**
|
|
50
|
-
* @internal
|
|
51
|
-
*/
|
|
52
13
|
resolveMiddleware(clientStack, configuration, options) {
|
|
53
14
|
this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
|
|
54
15
|
const stack = clientStack.concat(this.middlewareStack);
|
|
@@ -5,60 +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>Disables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic
|
|
10
|
-
* rotation of the key material</a> for the specified symmetric KMS key.</p>
|
|
11
|
-
* <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>
|
|
12
|
-
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
13
|
-
* 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>
|
|
14
|
-
* <p>
|
|
15
|
-
* <b>Cross-account
|
|
16
|
-
* use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
17
|
-
*
|
|
18
|
-
* <p>
|
|
19
|
-
* <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>
|
|
20
|
-
* <p>
|
|
21
|
-
* <b>Related operations:</b>
|
|
22
|
-
* </p>
|
|
23
|
-
* <ul>
|
|
24
|
-
* <li>
|
|
25
|
-
* <p>
|
|
26
|
-
* <a>EnableKeyRotation</a>
|
|
27
|
-
* </p>
|
|
28
|
-
* </li>
|
|
29
|
-
* <li>
|
|
30
|
-
* <p>
|
|
31
|
-
* <a>GetKeyRotationStatus</a>
|
|
32
|
-
* </p>
|
|
33
|
-
* </li>
|
|
34
|
-
* </ul>
|
|
35
|
-
* @example
|
|
36
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
37
|
-
* ```javascript
|
|
38
|
-
* import { KMSClient, DisableKeyRotationCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
39
|
-
* // const { KMSClient, DisableKeyRotationCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
40
|
-
* const client = new KMSClient(config);
|
|
41
|
-
* const command = new DisableKeyRotationCommand(input);
|
|
42
|
-
* const response = await client.send(command);
|
|
43
|
-
* ```
|
|
44
|
-
*
|
|
45
|
-
* @see {@link DisableKeyRotationCommandInput} for command's `input` shape.
|
|
46
|
-
* @see {@link DisableKeyRotationCommandOutput} for command's `response` shape.
|
|
47
|
-
* @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
|
|
48
|
-
*
|
|
49
|
-
*/
|
|
50
8
|
class DisableKeyRotationCommand extends smithy_client_1.Command {
|
|
51
|
-
// Start section: command_properties
|
|
52
|
-
// End section: command_properties
|
|
53
9
|
constructor(input) {
|
|
54
|
-
// Start section: command_constructor
|
|
55
10
|
super();
|
|
56
11
|
this.input = input;
|
|
57
|
-
// End section: command_constructor
|
|
58
12
|
}
|
|
59
|
-
/**
|
|
60
|
-
* @internal
|
|
61
|
-
*/
|
|
62
13
|
resolveMiddleware(clientStack, configuration, options) {
|
|
63
14
|
this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
|
|
64
15
|
const stack = clientStack.concat(this.middlewareStack);
|
|
@@ -5,87 +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>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
|
|
10
|
-
* store is disconnected, you can manage the custom key store and its KMS keys, but you cannot
|
|
11
|
-
* create or use KMS keys in the custom key store. You can reconnect the custom key store at any
|
|
12
|
-
* time.</p>
|
|
13
|
-
* <note>
|
|
14
|
-
* <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
|
|
15
|
-
* fail. This action can prevent users from storing and accessing sensitive data.</p>
|
|
16
|
-
* </note>
|
|
17
|
-
* <p></p>
|
|
18
|
-
* <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
|
|
19
|
-
* <a>ConnectCustomKeyStore</a> operation.</p>
|
|
20
|
-
* <p>If the operation succeeds, it returns a JSON object with no
|
|
21
|
-
* properties.</p>
|
|
22
|
-
* <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
|
|
23
|
-
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
24
|
-
* single-tenant key store.</p>
|
|
25
|
-
*
|
|
26
|
-
* <p>
|
|
27
|
-
* <b>Cross-account use</b>: No.
|
|
28
|
-
* You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
29
|
-
*
|
|
30
|
-
* <p>
|
|
31
|
-
* <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>
|
|
32
|
-
* <p>
|
|
33
|
-
* <b>Related operations:</b>
|
|
34
|
-
* </p>
|
|
35
|
-
* <ul>
|
|
36
|
-
* <li>
|
|
37
|
-
* <p>
|
|
38
|
-
* <a>ConnectCustomKeyStore</a>
|
|
39
|
-
* </p>
|
|
40
|
-
* </li>
|
|
41
|
-
* <li>
|
|
42
|
-
* <p>
|
|
43
|
-
* <a>CreateCustomKeyStore</a>
|
|
44
|
-
* </p>
|
|
45
|
-
* </li>
|
|
46
|
-
* <li>
|
|
47
|
-
* <p>
|
|
48
|
-
* <a>DeleteCustomKeyStore</a>
|
|
49
|
-
* </p>
|
|
50
|
-
* </li>
|
|
51
|
-
* <li>
|
|
52
|
-
* <p>
|
|
53
|
-
* <a>DescribeCustomKeyStores</a>
|
|
54
|
-
* </p>
|
|
55
|
-
* </li>
|
|
56
|
-
* <li>
|
|
57
|
-
* <p>
|
|
58
|
-
* <a>UpdateCustomKeyStore</a>
|
|
59
|
-
* </p>
|
|
60
|
-
* </li>
|
|
61
|
-
* </ul>
|
|
62
|
-
* @example
|
|
63
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
64
|
-
* ```javascript
|
|
65
|
-
* import { KMSClient, DisconnectCustomKeyStoreCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
66
|
-
* // const { KMSClient, DisconnectCustomKeyStoreCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
67
|
-
* const client = new KMSClient(config);
|
|
68
|
-
* const command = new DisconnectCustomKeyStoreCommand(input);
|
|
69
|
-
* const response = await client.send(command);
|
|
70
|
-
* ```
|
|
71
|
-
*
|
|
72
|
-
* @see {@link DisconnectCustomKeyStoreCommandInput} for command's `input` shape.
|
|
73
|
-
* @see {@link DisconnectCustomKeyStoreCommandOutput} for command's `response` shape.
|
|
74
|
-
* @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
|
|
75
|
-
*
|
|
76
|
-
*/
|
|
77
8
|
class DisconnectCustomKeyStoreCommand extends smithy_client_1.Command {
|
|
78
|
-
// Start section: command_properties
|
|
79
|
-
// End section: command_properties
|
|
80
9
|
constructor(input) {
|
|
81
|
-
// Start section: command_constructor
|
|
82
10
|
super();
|
|
83
11
|
this.input = input;
|
|
84
|
-
// End section: command_constructor
|
|
85
12
|
}
|
|
86
|
-
/**
|
|
87
|
-
* @internal
|
|
88
|
-
*/
|
|
89
13
|
resolveMiddleware(clientStack, configuration, options) {
|
|
90
14
|
this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
|
|
91
15
|
const stack = clientStack.concat(this.middlewareStack);
|
|
@@ -5,47 +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>Sets the key state of a KMS key to enabled. This allows you to use the KMS key for
|
|
10
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. </p>
|
|
11
|
-
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
12
|
-
* 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>
|
|
13
|
-
* <p>
|
|
14
|
-
* <b>Cross-account
|
|
15
|
-
* use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
16
|
-
*
|
|
17
|
-
* <p>
|
|
18
|
-
* <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>
|
|
19
|
-
* <p>
|
|
20
|
-
* <b>Related operations</b>: <a>DisableKey</a>
|
|
21
|
-
* </p>
|
|
22
|
-
* @example
|
|
23
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
24
|
-
* ```javascript
|
|
25
|
-
* import { KMSClient, EnableKeyCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
26
|
-
* // const { KMSClient, EnableKeyCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
27
|
-
* const client = new KMSClient(config);
|
|
28
|
-
* const command = new EnableKeyCommand(input);
|
|
29
|
-
* const response = await client.send(command);
|
|
30
|
-
* ```
|
|
31
|
-
*
|
|
32
|
-
* @see {@link EnableKeyCommandInput} for command's `input` shape.
|
|
33
|
-
* @see {@link EnableKeyCommandOutput} for command's `response` shape.
|
|
34
|
-
* @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
|
|
35
|
-
*
|
|
36
|
-
*/
|
|
37
8
|
class EnableKeyCommand extends smithy_client_1.Command {
|
|
38
|
-
// Start section: command_properties
|
|
39
|
-
// End section: command_properties
|
|
40
9
|
constructor(input) {
|
|
41
|
-
// Start section: command_constructor
|
|
42
10
|
super();
|
|
43
11
|
this.input = input;
|
|
44
|
-
// End section: command_constructor
|
|
45
12
|
}
|
|
46
|
-
/**
|
|
47
|
-
* @internal
|
|
48
|
-
*/
|
|
49
13
|
resolveMiddleware(clientStack, configuration, options) {
|
|
50
14
|
this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
|
|
51
15
|
const stack = clientStack.concat(this.middlewareStack);
|
|
@@ -5,60 +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>Enables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic rotation
|
|
10
|
-
* of the key material</a> for the specified symmetric KMS key.</p>
|
|
11
|
-
* <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>
|
|
12
|
-
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
13
|
-
* 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>
|
|
14
|
-
* <p>
|
|
15
|
-
* <b>Cross-account
|
|
16
|
-
* use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
17
|
-
*
|
|
18
|
-
* <p>
|
|
19
|
-
* <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>
|
|
20
|
-
* <p>
|
|
21
|
-
* <b>Related operations:</b>
|
|
22
|
-
* </p>
|
|
23
|
-
* <ul>
|
|
24
|
-
* <li>
|
|
25
|
-
* <p>
|
|
26
|
-
* <a>DisableKeyRotation</a>
|
|
27
|
-
* </p>
|
|
28
|
-
* </li>
|
|
29
|
-
* <li>
|
|
30
|
-
* <p>
|
|
31
|
-
* <a>GetKeyRotationStatus</a>
|
|
32
|
-
* </p>
|
|
33
|
-
* </li>
|
|
34
|
-
* </ul>
|
|
35
|
-
* @example
|
|
36
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
37
|
-
* ```javascript
|
|
38
|
-
* import { KMSClient, EnableKeyRotationCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
39
|
-
* // const { KMSClient, EnableKeyRotationCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
40
|
-
* const client = new KMSClient(config);
|
|
41
|
-
* const command = new EnableKeyRotationCommand(input);
|
|
42
|
-
* const response = await client.send(command);
|
|
43
|
-
* ```
|
|
44
|
-
*
|
|
45
|
-
* @see {@link EnableKeyRotationCommandInput} for command's `input` shape.
|
|
46
|
-
* @see {@link EnableKeyRotationCommandOutput} for command's `response` shape.
|
|
47
|
-
* @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
|
|
48
|
-
*
|
|
49
|
-
*/
|
|
50
8
|
class EnableKeyRotationCommand extends smithy_client_1.Command {
|
|
51
|
-
// Start section: command_properties
|
|
52
|
-
// End section: command_properties
|
|
53
9
|
constructor(input) {
|
|
54
|
-
// Start section: command_constructor
|
|
55
10
|
super();
|
|
56
11
|
this.input = input;
|
|
57
|
-
// End section: command_constructor
|
|
58
12
|
}
|
|
59
|
-
/**
|
|
60
|
-
* @internal
|
|
61
|
-
*/
|
|
62
13
|
resolveMiddleware(clientStack, configuration, options) {
|
|
63
14
|
this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
|
|
64
15
|
const stack = clientStack.concat(this.middlewareStack);
|