@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
|
@@ -6,76 +6,11 @@ export interface TagResourceCommandInput extends TagResourceRequest {
|
|
|
6
6
|
}
|
|
7
7
|
export interface TagResourceCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Adds or edits tags on a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>.</p>
|
|
11
|
-
* <note>
|
|
12
|
-
* <p>Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">Using ABAC in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
13
|
-
* </note>
|
|
14
|
-
* <p>Each tag consists of a tag key and a tag value, both of which are case-sensitive strings.
|
|
15
|
-
* The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag
|
|
16
|
-
* value. To edit a tag, specify an existing tag key and a new tag value.</p>
|
|
17
|
-
* <p>You can use this operation to tag a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>, but you cannot
|
|
18
|
-
* tag an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services
|
|
19
|
-
* managed key</a>, an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk">Amazon Web Services owned key</a>, a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#keystore-concept">custom key
|
|
20
|
-
* store</a>, or an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#alias-concept">alias</a>.</p>
|
|
21
|
-
* <p>You can also add tags to a KMS key while creating it (<a>CreateKey</a>) or
|
|
22
|
-
* replicating it (<a>ReplicateKey</a>).</p>
|
|
23
|
-
* <p>For information about using tags in KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">Tagging keys</a>. For general information about
|
|
24
|
-
* tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon
|
|
25
|
-
* Web Services General Reference</i>. </p>
|
|
26
|
-
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
27
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
28
|
-
* <p>
|
|
29
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p>
|
|
30
|
-
*
|
|
31
|
-
* <p>
|
|
32
|
-
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:TagResource</a> (key policy)</p>
|
|
33
|
-
* <p>
|
|
34
|
-
* <b>Related operations</b>
|
|
35
|
-
* </p>
|
|
36
|
-
* <ul>
|
|
37
|
-
* <li>
|
|
38
|
-
* <p>
|
|
39
|
-
* <a>CreateKey</a>
|
|
40
|
-
* </p>
|
|
41
|
-
* </li>
|
|
42
|
-
* <li>
|
|
43
|
-
* <p>
|
|
44
|
-
* <a>ListResourceTags</a>
|
|
45
|
-
* </p>
|
|
46
|
-
* </li>
|
|
47
|
-
* <li>
|
|
48
|
-
* <p>
|
|
49
|
-
* <a>ReplicateKey</a>
|
|
50
|
-
* </p>
|
|
51
|
-
* </li>
|
|
52
|
-
* <li>
|
|
53
|
-
* <p>
|
|
54
|
-
* <a>UntagResource</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, TagResourceCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
62
|
-
* // const { KMSClient, TagResourceCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
63
|
-
* const client = new KMSClient(config);
|
|
64
|
-
* const command = new TagResourceCommand(input);
|
|
65
|
-
* const response = await client.send(command);
|
|
66
|
-
* ```
|
|
67
|
-
*
|
|
68
|
-
* @see {@link TagResourceCommandInput} for command's `input` shape.
|
|
69
|
-
* @see {@link TagResourceCommandOutput} for command's `response` shape.
|
|
70
|
-
* @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
|
|
71
|
-
*
|
|
72
|
-
*/
|
|
9
|
+
|
|
73
10
|
export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, KMSClientResolvedConfig> {
|
|
74
11
|
readonly input: TagResourceCommandInput;
|
|
75
12
|
constructor(input: TagResourceCommandInput);
|
|
76
|
-
|
|
77
|
-
* @internal
|
|
78
|
-
*/
|
|
13
|
+
|
|
79
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
|
|
80
15
|
private serialize;
|
|
81
16
|
private deserialize;
|
|
@@ -6,72 +6,11 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {
|
|
|
6
6
|
}
|
|
7
7
|
export interface UntagResourceCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Deletes tags from a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>. To delete a tag,
|
|
11
|
-
* specify the tag key and the KMS key.</p>
|
|
12
|
-
* <note>
|
|
13
|
-
* <p>Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">Using ABAC in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
14
|
-
* </note>
|
|
15
|
-
* <p>When it succeeds, the <code>UntagResource</code> operation doesn't return any output.
|
|
16
|
-
* Also, if the specified tag key isn't found on the KMS key, it doesn't throw an exception or
|
|
17
|
-
* return a response. To confirm that the operation worked, use the <a>ListResourceTags</a> operation.</p>
|
|
18
|
-
*
|
|
19
|
-
* <p>For information about using tags in KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">Tagging keys</a>. For general information about
|
|
20
|
-
* tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon
|
|
21
|
-
* Web Services General Reference</i>. </p>
|
|
22
|
-
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
23
|
-
* 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>
|
|
24
|
-
* <p>
|
|
25
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
26
|
-
*
|
|
27
|
-
* <p>
|
|
28
|
-
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UntagResource</a> (key policy)</p>
|
|
29
|
-
* <p>
|
|
30
|
-
* <b>Related operations</b>
|
|
31
|
-
* </p>
|
|
32
|
-
* <ul>
|
|
33
|
-
* <li>
|
|
34
|
-
* <p>
|
|
35
|
-
* <a>CreateKey</a>
|
|
36
|
-
* </p>
|
|
37
|
-
* </li>
|
|
38
|
-
* <li>
|
|
39
|
-
* <p>
|
|
40
|
-
* <a>ListResourceTags</a>
|
|
41
|
-
* </p>
|
|
42
|
-
* </li>
|
|
43
|
-
* <li>
|
|
44
|
-
* <p>
|
|
45
|
-
* <a>ReplicateKey</a>
|
|
46
|
-
* </p>
|
|
47
|
-
* </li>
|
|
48
|
-
* <li>
|
|
49
|
-
* <p>
|
|
50
|
-
* <a>TagResource</a>
|
|
51
|
-
* </p>
|
|
52
|
-
* </li>
|
|
53
|
-
* </ul>
|
|
54
|
-
* @example
|
|
55
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
56
|
-
* ```javascript
|
|
57
|
-
* import { KMSClient, UntagResourceCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
58
|
-
* // const { KMSClient, UntagResourceCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
59
|
-
* const client = new KMSClient(config);
|
|
60
|
-
* const command = new UntagResourceCommand(input);
|
|
61
|
-
* const response = await client.send(command);
|
|
62
|
-
* ```
|
|
63
|
-
*
|
|
64
|
-
* @see {@link UntagResourceCommandInput} for command's `input` shape.
|
|
65
|
-
* @see {@link UntagResourceCommandOutput} for command's `response` shape.
|
|
66
|
-
* @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
|
|
67
|
-
*
|
|
68
|
-
*/
|
|
9
|
+
|
|
69
10
|
export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, KMSClientResolvedConfig> {
|
|
70
11
|
readonly input: UntagResourceCommandInput;
|
|
71
12
|
constructor(input: UntagResourceCommandInput);
|
|
72
|
-
|
|
73
|
-
* @internal
|
|
74
|
-
*/
|
|
13
|
+
|
|
75
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
|
|
76
15
|
private serialize;
|
|
77
16
|
private deserialize;
|
|
@@ -6,91 +6,11 @@ export interface UpdateAliasCommandInput extends UpdateAliasRequest {
|
|
|
6
6
|
}
|
|
7
7
|
export interface UpdateAliasCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Associates an existing KMS alias with a different KMS key. Each alias is associated with
|
|
11
|
-
* only one KMS key at a time, although a KMS key can have multiple aliases. The alias and the
|
|
12
|
-
* KMS key must be in the same Amazon Web Services account and Region.</p>
|
|
13
|
-
* <note>
|
|
14
|
-
* <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>
|
|
15
|
-
* </note>
|
|
16
|
-
* <p>The current and new KMS key must be the same type (both symmetric or both asymmetric), and
|
|
17
|
-
* they must have the same key usage (<code>ENCRYPT_DECRYPT</code> or <code>SIGN_VERIFY</code>).
|
|
18
|
-
* This restriction prevents errors in code that uses aliases. If you must assign an alias to a
|
|
19
|
-
* different type of KMS key, use <a>DeleteAlias</a> to delete the old alias and <a>CreateAlias</a> to create a new alias.</p>
|
|
20
|
-
* <p>You cannot use <code>UpdateAlias</code> to change an alias name. To change an alias name,
|
|
21
|
-
* use <a>DeleteAlias</a> to delete the old alias and <a>CreateAlias</a> to
|
|
22
|
-
* create a new alias.</p>
|
|
23
|
-
* <p>Because an alias is not a property of a KMS key, you can create, update, and delete the
|
|
24
|
-
* aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the
|
|
25
|
-
* response from the <a>DescribeKey</a> operation. To get the aliases of all KMS keys
|
|
26
|
-
* in the account, use the <a>ListAliases</a> operation. </p>
|
|
27
|
-
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
28
|
-
* 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>
|
|
29
|
-
* <p>
|
|
30
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p>
|
|
31
|
-
* <p>
|
|
32
|
-
* <b>Required permissions</b>
|
|
33
|
-
* </p>
|
|
34
|
-
* <ul>
|
|
35
|
-
* <li>
|
|
36
|
-
* <p>
|
|
37
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateAlias</a> on
|
|
38
|
-
* the alias (IAM policy).</p>
|
|
39
|
-
* </li>
|
|
40
|
-
* <li>
|
|
41
|
-
* <p>
|
|
42
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateAlias</a> on
|
|
43
|
-
* the current KMS key (key policy).</p>
|
|
44
|
-
* </li>
|
|
45
|
-
* <li>
|
|
46
|
-
* <p>
|
|
47
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateAlias</a> on
|
|
48
|
-
* the new KMS key (key policy).</p>
|
|
49
|
-
* </li>
|
|
50
|
-
* </ul>
|
|
51
|
-
* <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
|
|
52
|
-
* <i>Key Management Service Developer Guide</i>.</p>
|
|
53
|
-
* <p>
|
|
54
|
-
* <b>Related operations:</b>
|
|
55
|
-
* </p>
|
|
56
|
-
* <ul>
|
|
57
|
-
* <li>
|
|
58
|
-
* <p>
|
|
59
|
-
* <a>CreateAlias</a>
|
|
60
|
-
* </p>
|
|
61
|
-
* </li>
|
|
62
|
-
* <li>
|
|
63
|
-
* <p>
|
|
64
|
-
* <a>DeleteAlias</a>
|
|
65
|
-
* </p>
|
|
66
|
-
* </li>
|
|
67
|
-
* <li>
|
|
68
|
-
* <p>
|
|
69
|
-
* <a>ListAliases</a>
|
|
70
|
-
* </p>
|
|
71
|
-
* </li>
|
|
72
|
-
* </ul>
|
|
73
|
-
* @example
|
|
74
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
75
|
-
* ```javascript
|
|
76
|
-
* import { KMSClient, UpdateAliasCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
77
|
-
* // const { KMSClient, UpdateAliasCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
78
|
-
* const client = new KMSClient(config);
|
|
79
|
-
* const command = new UpdateAliasCommand(input);
|
|
80
|
-
* const response = await client.send(command);
|
|
81
|
-
* ```
|
|
82
|
-
*
|
|
83
|
-
* @see {@link UpdateAliasCommandInput} for command's `input` shape.
|
|
84
|
-
* @see {@link UpdateAliasCommandOutput} for command's `response` shape.
|
|
85
|
-
* @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
|
|
86
|
-
*
|
|
87
|
-
*/
|
|
9
|
+
|
|
88
10
|
export declare class UpdateAliasCommand extends $Command<UpdateAliasCommandInput, UpdateAliasCommandOutput, KMSClientResolvedConfig> {
|
|
89
11
|
readonly input: UpdateAliasCommandInput;
|
|
90
12
|
constructor(input: UpdateAliasCommandInput);
|
|
91
|
-
|
|
92
|
-
* @internal
|
|
93
|
-
*/
|
|
13
|
+
|
|
94
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateAliasCommandInput, UpdateAliasCommandOutput>;
|
|
95
15
|
private serialize;
|
|
96
16
|
private deserialize;
|
|
@@ -6,101 +6,11 @@ export interface UpdateCustomKeyStoreCommandInput extends UpdateCustomKeyStoreRe
|
|
|
6
6
|
}
|
|
7
7
|
export interface UpdateCustomKeyStoreCommandOutput extends UpdateCustomKeyStoreResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Changes the properties of a custom key store. Use the <code>CustomKeyStoreId</code>
|
|
11
|
-
* parameter to identify the custom key store you want to edit. Use the remaining parameters to
|
|
12
|
-
* change the properties of the custom key store.</p>
|
|
13
|
-
* <p>You can only update a custom key store that is disconnected. To disconnect the custom key
|
|
14
|
-
* store, use <a>DisconnectCustomKeyStore</a>. To reconnect the custom key store after
|
|
15
|
-
* the update completes, use <a>ConnectCustomKeyStore</a>. To find the connection
|
|
16
|
-
* state of a custom key store, use the <a>DescribeCustomKeyStores</a>
|
|
17
|
-
* operation.</p>
|
|
18
|
-
* <p>The <code>CustomKeyStoreId</code> parameter is required in all commands. Use the other
|
|
19
|
-
* parameters of <code>UpdateCustomKeyStore</code> to edit your key store settings.</p>
|
|
20
|
-
* <ul>
|
|
21
|
-
* <li>
|
|
22
|
-
* <p>Use the <code>NewCustomKeyStoreName</code> parameter to change the friendly name of
|
|
23
|
-
* the custom key store to the value that you specify.</p>
|
|
24
|
-
* <p> </p>
|
|
25
|
-
* </li>
|
|
26
|
-
* <li>
|
|
27
|
-
* <p>Use the <code>KeyStorePassword</code> parameter tell KMS the current password of the
|
|
28
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser">
|
|
29
|
-
* <code>kmsuser</code> crypto user (CU)</a> in the associated CloudHSM cluster. You
|
|
30
|
-
* can use this parameter to <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-password">fix connection
|
|
31
|
-
* failures</a> that occur when KMS cannot log into the associated cluster because
|
|
32
|
-
* the <code>kmsuser</code> password has changed. This value does not change the password in
|
|
33
|
-
* the CloudHSM cluster.</p>
|
|
34
|
-
* <p> </p>
|
|
35
|
-
* </li>
|
|
36
|
-
* <li>
|
|
37
|
-
* <p>Use the <code>CloudHsmClusterId</code> parameter to associate the custom key store
|
|
38
|
-
* with a different, but related, CloudHSM cluster. You can use this parameter to repair a
|
|
39
|
-
* custom key store if its CloudHSM cluster becomes corrupted or is deleted, or when you need to
|
|
40
|
-
* create or restore a cluster from a backup. </p>
|
|
41
|
-
* </li>
|
|
42
|
-
* </ul>
|
|
43
|
-
* <p>If the operation succeeds, it returns a JSON object with no
|
|
44
|
-
* properties.</p>
|
|
45
|
-
* <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
|
|
46
|
-
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
47
|
-
* single-tenant key store.</p>
|
|
48
|
-
* <p>
|
|
49
|
-
* <b>Cross-account
|
|
50
|
-
* use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account. </p>
|
|
51
|
-
* <p>
|
|
52
|
-
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateCustomKeyStore</a> (IAM policy)</p>
|
|
53
|
-
* <p>
|
|
54
|
-
* <b>Related operations:</b>
|
|
55
|
-
* </p>
|
|
56
|
-
* <ul>
|
|
57
|
-
* <li>
|
|
58
|
-
* <p>
|
|
59
|
-
* <a>ConnectCustomKeyStore</a>
|
|
60
|
-
* </p>
|
|
61
|
-
* </li>
|
|
62
|
-
* <li>
|
|
63
|
-
* <p>
|
|
64
|
-
* <a>CreateCustomKeyStore</a>
|
|
65
|
-
* </p>
|
|
66
|
-
* </li>
|
|
67
|
-
* <li>
|
|
68
|
-
* <p>
|
|
69
|
-
* <a>DeleteCustomKeyStore</a>
|
|
70
|
-
* </p>
|
|
71
|
-
* </li>
|
|
72
|
-
* <li>
|
|
73
|
-
* <p>
|
|
74
|
-
* <a>DescribeCustomKeyStores</a>
|
|
75
|
-
* </p>
|
|
76
|
-
* </li>
|
|
77
|
-
* <li>
|
|
78
|
-
* <p>
|
|
79
|
-
* <a>DisconnectCustomKeyStore</a>
|
|
80
|
-
* </p>
|
|
81
|
-
* </li>
|
|
82
|
-
* </ul>
|
|
83
|
-
* @example
|
|
84
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
85
|
-
* ```javascript
|
|
86
|
-
* import { KMSClient, UpdateCustomKeyStoreCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
87
|
-
* // const { KMSClient, UpdateCustomKeyStoreCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
88
|
-
* const client = new KMSClient(config);
|
|
89
|
-
* const command = new UpdateCustomKeyStoreCommand(input);
|
|
90
|
-
* const response = await client.send(command);
|
|
91
|
-
* ```
|
|
92
|
-
*
|
|
93
|
-
* @see {@link UpdateCustomKeyStoreCommandInput} for command's `input` shape.
|
|
94
|
-
* @see {@link UpdateCustomKeyStoreCommandOutput} for command's `response` shape.
|
|
95
|
-
* @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
|
|
96
|
-
*
|
|
97
|
-
*/
|
|
9
|
+
|
|
98
10
|
export declare class UpdateCustomKeyStoreCommand extends $Command<UpdateCustomKeyStoreCommandInput, UpdateCustomKeyStoreCommandOutput, KMSClientResolvedConfig> {
|
|
99
11
|
readonly input: UpdateCustomKeyStoreCommandInput;
|
|
100
12
|
constructor(input: UpdateCustomKeyStoreCommandInput);
|
|
101
|
-
|
|
102
|
-
* @internal
|
|
103
|
-
*/
|
|
13
|
+
|
|
104
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateCustomKeyStoreCommandInput, UpdateCustomKeyStoreCommandOutput>;
|
|
105
15
|
private serialize;
|
|
106
16
|
private deserialize;
|
|
@@ -6,52 +6,11 @@ export interface UpdateKeyDescriptionCommandInput extends UpdateKeyDescriptionRe
|
|
|
6
6
|
}
|
|
7
7
|
export interface UpdateKeyDescriptionCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Updates the description of a KMS key. To see the description of a KMS key, use <a>DescribeKey</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:UpdateKeyDescription</a> (key policy)</p>
|
|
19
|
-
* <p>
|
|
20
|
-
* <b>Related operations</b>
|
|
21
|
-
* </p>
|
|
22
|
-
* <ul>
|
|
23
|
-
* <li>
|
|
24
|
-
* <p>
|
|
25
|
-
* <a>CreateKey</a>
|
|
26
|
-
* </p>
|
|
27
|
-
* </li>
|
|
28
|
-
* <li>
|
|
29
|
-
* <p>
|
|
30
|
-
* <a>DescribeKey</a>
|
|
31
|
-
* </p>
|
|
32
|
-
* </li>
|
|
33
|
-
* </ul>
|
|
34
|
-
* @example
|
|
35
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
36
|
-
* ```javascript
|
|
37
|
-
* import { KMSClient, UpdateKeyDescriptionCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
38
|
-
* // const { KMSClient, UpdateKeyDescriptionCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
39
|
-
* const client = new KMSClient(config);
|
|
40
|
-
* const command = new UpdateKeyDescriptionCommand(input);
|
|
41
|
-
* const response = await client.send(command);
|
|
42
|
-
* ```
|
|
43
|
-
*
|
|
44
|
-
* @see {@link UpdateKeyDescriptionCommandInput} for command's `input` shape.
|
|
45
|
-
* @see {@link UpdateKeyDescriptionCommandOutput} for command's `response` shape.
|
|
46
|
-
* @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
|
|
47
|
-
*
|
|
48
|
-
*/
|
|
9
|
+
|
|
49
10
|
export declare class UpdateKeyDescriptionCommand extends $Command<UpdateKeyDescriptionCommandInput, UpdateKeyDescriptionCommandOutput, KMSClientResolvedConfig> {
|
|
50
11
|
readonly input: UpdateKeyDescriptionCommandInput;
|
|
51
12
|
constructor(input: UpdateKeyDescriptionCommandInput);
|
|
52
|
-
|
|
53
|
-
* @internal
|
|
54
|
-
*/
|
|
13
|
+
|
|
55
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateKeyDescriptionCommandInput, UpdateKeyDescriptionCommandOutput>;
|
|
56
15
|
private serialize;
|
|
57
16
|
private deserialize;
|
|
@@ -6,94 +6,11 @@ export interface UpdatePrimaryRegionCommandInput extends UpdatePrimaryRegionRequ
|
|
|
6
6
|
}
|
|
7
7
|
export interface UpdatePrimaryRegionCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Changes the primary key of a multi-Region key. </p>
|
|
11
|
-
* <p>This operation changes the replica key in the specified Region to a primary key and
|
|
12
|
-
* changes the former primary key to a replica key. For example, suppose you have a primary key
|
|
13
|
-
* in <code>us-east-1</code> and a replica key in <code>eu-west-2</code>. If you run
|
|
14
|
-
* <code>UpdatePrimaryRegion</code> with a <code>PrimaryRegion</code> value of
|
|
15
|
-
* <code>eu-west-2</code>, the primary key is now the key in <code>eu-west-2</code>, and the
|
|
16
|
-
* key in <code>us-east-1</code> becomes a replica key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-update">Updating the primary Region</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
17
|
-
* <p>This operation supports <i>multi-Region keys</i>, an KMS feature that lets you create multiple
|
|
18
|
-
* interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key
|
|
19
|
-
* material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt
|
|
20
|
-
* 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>
|
|
21
|
-
* <p>The <i>primary key</i> of a multi-Region key is the source for properties
|
|
22
|
-
* that are always shared by primary and replica keys, including the key material, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id">key ID</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-spec">key spec</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-usage">key usage</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-origin">key material
|
|
23
|
-
* origin</a>, and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic
|
|
24
|
-
* key rotation</a>. It's the only key that can be replicated. You cannot <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html">delete the primary
|
|
25
|
-
* key</a> until all replica keys are deleted.</p>
|
|
26
|
-
* <p>The key ID and primary Region that you specify uniquely identify the replica key that will
|
|
27
|
-
* become the primary key. The primary Region must already have a replica key. This operation
|
|
28
|
-
* does not create a KMS key in the specified Region. To find the replica keys, use the <a>DescribeKey</a> operation on the primary key or any replica key. To create a replica
|
|
29
|
-
* key, use the <a>ReplicateKey</a> operation.</p>
|
|
30
|
-
* <p>You can run this operation while using the affected multi-Region keys in cryptographic
|
|
31
|
-
* operations. This operation should not delay, interrupt, or cause failures in cryptographic
|
|
32
|
-
* operations. </p>
|
|
33
|
-
* <p>Even after this operation completes, the process of updating the primary Region might
|
|
34
|
-
* still be in progress for a few more seconds. Operations such as <code>DescribeKey</code> might
|
|
35
|
-
* display both the old and new primary keys as replicas. The old and new primary keys have a
|
|
36
|
-
* transient key state of <code>Updating</code>. The original key state is restored when the
|
|
37
|
-
* update is complete. While the key state is <code>Updating</code>, you can use the keys in
|
|
38
|
-
* cryptographic operations, but you cannot replicate the new primary key or perform certain
|
|
39
|
-
* management operations, such as enabling or disabling these keys. For details about the
|
|
40
|
-
* <code>Updating</code> key state, see <a href="kms/latest/developerguide/key-state.html">Key state:
|
|
41
|
-
* Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
42
|
-
* <p>This operation does not return any output. To verify that primary key is changed, use the
|
|
43
|
-
* <a>DescribeKey</a> operation.</p>
|
|
44
|
-
* <p>
|
|
45
|
-
* <b>Cross-account use</b>: No. You cannot use this operation in a
|
|
46
|
-
* different Amazon Web Services account. </p>
|
|
47
|
-
* <p>
|
|
48
|
-
* <b>Required permissions</b>: </p>
|
|
49
|
-
* <ul>
|
|
50
|
-
* <li>
|
|
51
|
-
* <p>
|
|
52
|
-
* <code>kms:UpdatePrimaryRegion</code> on the current primary key (in the primary key's
|
|
53
|
-
* Region). Include this permission primary key's key policy.</p>
|
|
54
|
-
* </li>
|
|
55
|
-
* <li>
|
|
56
|
-
* <p>
|
|
57
|
-
* <code>kms:UpdatePrimaryRegion</code> on the current replica key (in the replica key's
|
|
58
|
-
* Region). Include this permission in the replica key's key policy.</p>
|
|
59
|
-
* </li>
|
|
60
|
-
* </ul>
|
|
61
|
-
* <p>
|
|
62
|
-
* <b>Related operations</b>
|
|
63
|
-
* </p>
|
|
64
|
-
* <ul>
|
|
65
|
-
* <li>
|
|
66
|
-
* <p>
|
|
67
|
-
* <a>CreateKey</a>
|
|
68
|
-
* </p>
|
|
69
|
-
* </li>
|
|
70
|
-
* <li>
|
|
71
|
-
* <p>
|
|
72
|
-
* <a>ReplicateKey</a>
|
|
73
|
-
* </p>
|
|
74
|
-
* </li>
|
|
75
|
-
* </ul>
|
|
76
|
-
* @example
|
|
77
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
78
|
-
* ```javascript
|
|
79
|
-
* import { KMSClient, UpdatePrimaryRegionCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
80
|
-
* // const { KMSClient, UpdatePrimaryRegionCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
81
|
-
* const client = new KMSClient(config);
|
|
82
|
-
* const command = new UpdatePrimaryRegionCommand(input);
|
|
83
|
-
* const response = await client.send(command);
|
|
84
|
-
* ```
|
|
85
|
-
*
|
|
86
|
-
* @see {@link UpdatePrimaryRegionCommandInput} for command's `input` shape.
|
|
87
|
-
* @see {@link UpdatePrimaryRegionCommandOutput} for command's `response` shape.
|
|
88
|
-
* @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
|
|
89
|
-
*
|
|
90
|
-
*/
|
|
9
|
+
|
|
91
10
|
export declare class UpdatePrimaryRegionCommand extends $Command<UpdatePrimaryRegionCommandInput, UpdatePrimaryRegionCommandOutput, KMSClientResolvedConfig> {
|
|
92
11
|
readonly input: UpdatePrimaryRegionCommandInput;
|
|
93
12
|
constructor(input: UpdatePrimaryRegionCommandInput);
|
|
94
|
-
|
|
95
|
-
* @internal
|
|
96
|
-
*/
|
|
13
|
+
|
|
97
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdatePrimaryRegionCommandInput, UpdatePrimaryRegionCommandOutput>;
|
|
98
15
|
private serialize;
|
|
99
16
|
private deserialize;
|
|
@@ -6,59 +6,11 @@ export interface VerifyCommandInput extends VerifyRequest {
|
|
|
6
6
|
}
|
|
7
7
|
export interface VerifyCommandOutput extends VerifyResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Verifies a digital signature that was generated by the <a>Sign</a> operation. </p>
|
|
11
|
-
* <p></p>
|
|
12
|
-
* <p>Verification confirms that an authorized user signed the message with the specified KMS
|
|
13
|
-
* key and signing algorithm, and the message hasn't changed since it was signed. If the
|
|
14
|
-
* signature is verified, the value of the <code>SignatureValid</code> field in the response is
|
|
15
|
-
* <code>True</code>. If the signature verification fails, the <code>Verify</code> operation
|
|
16
|
-
* fails with an <code>KMSInvalidSignatureException</code> exception.</p>
|
|
17
|
-
* <p>A digital signature is generated by using the private key in an asymmetric KMS key. The
|
|
18
|
-
* signature is verified by using the public key in the same asymmetric KMS key.
|
|
19
|
-
* 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>
|
|
20
|
-
* <p>To verify a digital signature, you can use the <code>Verify</code> operation. Specify the
|
|
21
|
-
* same asymmetric KMS key, message, and signing algorithm that were used to produce the
|
|
22
|
-
* signature.</p>
|
|
23
|
-
* <p>You can also verify the digital signature by using the public key of the KMS key outside
|
|
24
|
-
* of KMS. Use the <a>GetPublicKey</a> operation to download the public key in the
|
|
25
|
-
* asymmetric KMS key and then use the public key to verify the signature outside of KMS. The
|
|
26
|
-
* advantage of using the <code>Verify</code> operation is that it is performed within KMS. As
|
|
27
|
-
* a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged
|
|
28
|
-
* in CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use
|
|
29
|
-
* the KMS key to verify signatures.</p>
|
|
30
|
-
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
31
|
-
* 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>
|
|
32
|
-
* <p>
|
|
33
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
34
|
-
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter. </p>
|
|
35
|
-
*
|
|
36
|
-
* <p>
|
|
37
|
-
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:Verify</a> (key policy)</p>
|
|
38
|
-
* <p>
|
|
39
|
-
* <b>Related operations</b>: <a>Sign</a>
|
|
40
|
-
* </p>
|
|
41
|
-
* @example
|
|
42
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
43
|
-
* ```javascript
|
|
44
|
-
* import { KMSClient, VerifyCommand } from "@aws-sdk/client-kms"; // ES Modules import
|
|
45
|
-
* // const { KMSClient, VerifyCommand } = require("@aws-sdk/client-kms"); // CommonJS import
|
|
46
|
-
* const client = new KMSClient(config);
|
|
47
|
-
* const command = new VerifyCommand(input);
|
|
48
|
-
* const response = await client.send(command);
|
|
49
|
-
* ```
|
|
50
|
-
*
|
|
51
|
-
* @see {@link VerifyCommandInput} for command's `input` shape.
|
|
52
|
-
* @see {@link VerifyCommandOutput} for command's `response` shape.
|
|
53
|
-
* @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
|
|
54
|
-
*
|
|
55
|
-
*/
|
|
9
|
+
|
|
56
10
|
export declare class VerifyCommand extends $Command<VerifyCommandInput, VerifyCommandOutput, KMSClientResolvedConfig> {
|
|
57
11
|
readonly input: VerifyCommandInput;
|
|
58
12
|
constructor(input: VerifyCommandInput);
|
|
59
|
-
|
|
60
|
-
* @internal
|
|
61
|
-
*/
|
|
13
|
+
|
|
62
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<VerifyCommandInput, VerifyCommandOutput>;
|
|
63
15
|
private serialize;
|
|
64
16
|
private deserialize;
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
export * from "./CancelKeyDeletionCommand";
|
|
2
|
+
export * from "./ConnectCustomKeyStoreCommand";
|
|
3
|
+
export * from "./CreateAliasCommand";
|
|
4
|
+
export * from "./CreateCustomKeyStoreCommand";
|
|
5
|
+
export * from "./CreateGrantCommand";
|
|
6
|
+
export * from "./CreateKeyCommand";
|
|
7
|
+
export * from "./DecryptCommand";
|
|
8
|
+
export * from "./DeleteAliasCommand";
|
|
9
|
+
export * from "./DeleteCustomKeyStoreCommand";
|
|
10
|
+
export * from "./DeleteImportedKeyMaterialCommand";
|
|
11
|
+
export * from "./DescribeCustomKeyStoresCommand";
|
|
12
|
+
export * from "./DescribeKeyCommand";
|
|
13
|
+
export * from "./DisableKeyCommand";
|
|
14
|
+
export * from "./DisableKeyRotationCommand";
|
|
15
|
+
export * from "./DisconnectCustomKeyStoreCommand";
|
|
16
|
+
export * from "./EnableKeyCommand";
|
|
17
|
+
export * from "./EnableKeyRotationCommand";
|
|
18
|
+
export * from "./EncryptCommand";
|
|
19
|
+
export * from "./GenerateDataKeyCommand";
|
|
20
|
+
export * from "./GenerateDataKeyPairCommand";
|
|
21
|
+
export * from "./GenerateDataKeyPairWithoutPlaintextCommand";
|
|
22
|
+
export * from "./GenerateDataKeyWithoutPlaintextCommand";
|
|
23
|
+
export * from "./GenerateRandomCommand";
|
|
24
|
+
export * from "./GetKeyPolicyCommand";
|
|
25
|
+
export * from "./GetKeyRotationStatusCommand";
|
|
26
|
+
export * from "./GetParametersForImportCommand";
|
|
27
|
+
export * from "./GetPublicKeyCommand";
|
|
28
|
+
export * from "./ImportKeyMaterialCommand";
|
|
29
|
+
export * from "./ListAliasesCommand";
|
|
30
|
+
export * from "./ListGrantsCommand";
|
|
31
|
+
export * from "./ListKeyPoliciesCommand";
|
|
32
|
+
export * from "./ListKeysCommand";
|
|
33
|
+
export * from "./ListResourceTagsCommand";
|
|
34
|
+
export * from "./ListRetirableGrantsCommand";
|
|
35
|
+
export * from "./PutKeyPolicyCommand";
|
|
36
|
+
export * from "./ReEncryptCommand";
|
|
37
|
+
export * from "./ReplicateKeyCommand";
|
|
38
|
+
export * from "./RetireGrantCommand";
|
|
39
|
+
export * from "./RevokeGrantCommand";
|
|
40
|
+
export * from "./ScheduleKeyDeletionCommand";
|
|
41
|
+
export * from "./SignCommand";
|
|
42
|
+
export * from "./TagResourceCommand";
|
|
43
|
+
export * from "./UntagResourceCommand";
|
|
44
|
+
export * from "./UpdateAliasCommand";
|
|
45
|
+
export * from "./UpdateCustomKeyStoreCommand";
|
|
46
|
+
export * from "./UpdateKeyDescriptionCommand";
|
|
47
|
+
export * from "./UpdatePrimaryRegionCommand";
|
|
48
|
+
export * from "./VerifyCommand";
|