@aws-sdk/client-kms 3.278.0 → 3.281.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 (59) hide show
  1. package/README.md +409 -6
  2. package/dist-cjs/endpoint/ruleset.js +3 -3
  3. package/dist-es/endpoint/ruleset.js +3 -3
  4. package/dist-types/KMS.d.ts +17 -78
  5. package/dist-types/KMSClient.d.ts +6 -6
  6. package/dist-types/commands/CancelKeyDeletionCommand.d.ts +6 -0
  7. package/dist-types/commands/ConnectCustomKeyStoreCommand.d.ts +6 -1
  8. package/dist-types/commands/CreateAliasCommand.d.ts +6 -1
  9. package/dist-types/commands/CreateCustomKeyStoreCommand.d.ts +6 -0
  10. package/dist-types/commands/CreateGrantCommand.d.ts +6 -0
  11. package/dist-types/commands/CreateKeyCommand.d.ts +6 -4
  12. package/dist-types/commands/DecryptCommand.d.ts +11 -5
  13. package/dist-types/commands/DeleteAliasCommand.d.ts +6 -0
  14. package/dist-types/commands/DeleteCustomKeyStoreCommand.d.ts +6 -1
  15. package/dist-types/commands/DeleteImportedKeyMaterialCommand.d.ts +6 -1
  16. package/dist-types/commands/DescribeCustomKeyStoresCommand.d.ts +6 -0
  17. package/dist-types/commands/DescribeKeyCommand.d.ts +6 -1
  18. package/dist-types/commands/DisableKeyCommand.d.ts +6 -1
  19. package/dist-types/commands/DisableKeyRotationCommand.d.ts +6 -1
  20. package/dist-types/commands/DisconnectCustomKeyStoreCommand.d.ts +6 -1
  21. package/dist-types/commands/EnableKeyCommand.d.ts +6 -1
  22. package/dist-types/commands/EnableKeyRotationCommand.d.ts +6 -1
  23. package/dist-types/commands/EncryptCommand.d.ts +6 -3
  24. package/dist-types/commands/GenerateDataKeyCommand.d.ts +8 -8
  25. package/dist-types/commands/GenerateDataKeyPairCommand.d.ts +6 -6
  26. package/dist-types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +6 -2
  27. package/dist-types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +6 -6
  28. package/dist-types/commands/GenerateMacCommand.d.ts +6 -0
  29. package/dist-types/commands/GenerateRandomCommand.d.ts +6 -1
  30. package/dist-types/commands/GetKeyPolicyCommand.d.ts +6 -1
  31. package/dist-types/commands/GetKeyRotationStatusCommand.d.ts +6 -1
  32. package/dist-types/commands/GetParametersForImportCommand.d.ts +6 -1
  33. package/dist-types/commands/GetPublicKeyCommand.d.ts +6 -2
  34. package/dist-types/commands/ImportKeyMaterialCommand.d.ts +6 -1
  35. package/dist-types/commands/ListAliasesCommand.d.ts +6 -2
  36. package/dist-types/commands/ListGrantsCommand.d.ts +6 -1
  37. package/dist-types/commands/ListKeyPoliciesCommand.d.ts +6 -1
  38. package/dist-types/commands/ListKeysCommand.d.ts +6 -1
  39. package/dist-types/commands/ListResourceTagsCommand.d.ts +6 -1
  40. package/dist-types/commands/ListRetirableGrantsCommand.d.ts +6 -1
  41. package/dist-types/commands/PutKeyPolicyCommand.d.ts +6 -1
  42. package/dist-types/commands/ReEncryptCommand.d.ts +6 -3
  43. package/dist-types/commands/ReplicateKeyCommand.d.ts +6 -0
  44. package/dist-types/commands/RetireGrantCommand.d.ts +6 -0
  45. package/dist-types/commands/RevokeGrantCommand.d.ts +6 -0
  46. package/dist-types/commands/ScheduleKeyDeletionCommand.d.ts +6 -2
  47. package/dist-types/commands/SignCommand.d.ts +6 -1
  48. package/dist-types/commands/TagResourceCommand.d.ts +6 -1
  49. package/dist-types/commands/UntagResourceCommand.d.ts +6 -2
  50. package/dist-types/commands/UpdateAliasCommand.d.ts +6 -0
  51. package/dist-types/commands/UpdateCustomKeyStoreCommand.d.ts +6 -0
  52. package/dist-types/commands/UpdateKeyDescriptionCommand.d.ts +6 -1
  53. package/dist-types/commands/UpdatePrimaryRegionCommand.d.ts +6 -0
  54. package/dist-types/commands/VerifyCommand.d.ts +10 -2
  55. package/dist-types/commands/VerifyMacCommand.d.ts +6 -1
  56. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  57. package/dist-types/models/models_0.d.ts +123 -125
  58. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  59. package/package.json +6 -6
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { GetPublicKeyRequest, GetPublicKeyResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link GetPublicKeyCommand}.
8
+ */
6
9
  export interface GetPublicKeyCommandInput extends GetPublicKeyRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link GetPublicKeyCommand}.
13
+ */
8
14
  export interface GetPublicKeyCommandOutput extends GetPublicKeyResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -18,7 +24,6 @@ export interface GetPublicKeyCommandOutput extends GetPublicKeyResponse, __Metad
18
24
  * public key within KMS, you benefit from the authentication, authorization, and logging that
19
25
  * are part of every KMS operation. You also reduce of risk of encrypting data that cannot be
20
26
  * decrypted. These features are not effective outside of KMS.</p>
21
- *
22
27
  * <p>To help you use the public key safely outside of KMS, <code>GetPublicKey</code> returns
23
28
  * important information about the public key in the response, including:</p>
24
29
  * <ul>
@@ -53,7 +58,6 @@ export interface GetPublicKeyCommandOutput extends GetPublicKeyResponse, __Metad
53
58
  * <b>Cross-account use</b>:
54
59
  * Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
55
60
  * the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
56
- *
57
61
  * <p>
58
62
  * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GetPublicKey</a> (key policy)</p>
59
63
  * <p>
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { ImportKeyMaterialRequest, ImportKeyMaterialResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link ImportKeyMaterialCommand}.
8
+ */
6
9
  export interface ImportKeyMaterialCommandInput extends ImportKeyMaterialRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link ImportKeyMaterialCommand}.
13
+ */
8
14
  export interface ImportKeyMaterialCommandOutput extends ImportKeyMaterialResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -55,7 +61,6 @@ export interface ImportKeyMaterialCommandOutput extends ImportKeyMaterialRespons
55
61
  * details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
56
62
  * <p>
57
63
  * <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
58
- *
59
64
  * <p>
60
65
  * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ImportKeyMaterial</a> (key policy)</p>
61
66
  * <p>
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { ListAliasesRequest, ListAliasesResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link ListAliasesCommand}.
8
+ */
6
9
  export interface ListAliasesCommandInput extends ListAliasesRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link ListAliasesCommand}.
13
+ */
8
14
  export interface ListAliasesCommandOutput extends ListAliasesResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -25,8 +31,6 @@ export interface ListAliasesCommandOutput extends ListAliasesResponse, __Metadat
25
31
  * <p>
26
32
  * <b>Cross-account use</b>: No. <code>ListAliases</code> does not
27
33
  * return aliases in other Amazon Web Services accounts.</p>
28
- *
29
- *
30
34
  * <p>
31
35
  * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListAliases</a> (IAM policy)</p>
32
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
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { ListGrantsRequest, ListGrantsResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link ListGrantsCommand}.
8
+ */
6
9
  export interface ListGrantsCommandInput extends ListGrantsRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link ListGrantsCommand}.
13
+ */
8
14
  export interface ListGrantsCommandOutput extends ListGrantsResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -26,7 +32,6 @@ export interface ListGrantsCommandOutput extends ListGrantsResponse, __MetadataB
26
32
  * <p>
27
33
  * <b>Cross-account use</b>: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key
28
34
  * ARN in the value of the <code>KeyId</code> parameter.</p>
29
- *
30
35
  * <p>
31
36
  * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListGrants</a> (key policy)</p>
32
37
  * <p>
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { ListKeyPoliciesRequest, ListKeyPoliciesResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link ListKeyPoliciesCommand}.
8
+ */
6
9
  export interface ListKeyPoliciesCommandInput extends ListKeyPoliciesRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link ListKeyPoliciesCommand}.
13
+ */
8
14
  export interface ListKeyPoliciesCommandOutput extends ListKeyPoliciesResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -13,7 +19,6 @@ export interface ListKeyPoliciesCommandOutput extends ListKeyPoliciesResponse, _
13
19
  * However, the only valid policy name is <code>default</code>. </p>
14
20
  * <p>
15
21
  * <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
16
- *
17
22
  * <p>
18
23
  * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListKeyPolicies</a> (key policy)</p>
19
24
  * <p>
@@ -3,15 +3,20 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { ListKeysRequest, ListKeysResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link ListKeysCommand}.
8
+ */
6
9
  export interface ListKeysCommandInput extends ListKeysRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link ListKeysCommand}.
13
+ */
8
14
  export interface ListKeysCommandOutput extends ListKeysResponse, __MetadataBearer {
9
15
  }
10
16
  /**
11
17
  * <p>Gets a list of all KMS keys in the caller's Amazon Web Services account and Region.</p>
12
18
  * <p>
13
19
  * <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
14
- *
15
20
  * <p>
16
21
  * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListKeys</a> (IAM policy)</p>
17
22
  * <p>
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { ListResourceTagsRequest, ListResourceTagsResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link ListResourceTagsCommand}.
8
+ */
6
9
  export interface ListResourceTagsCommandInput extends ListResourceTagsRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link ListResourceTagsCommand}.
13
+ */
8
14
  export interface ListResourceTagsCommandOutput extends ListResourceTagsResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -15,7 +21,6 @@ export interface ListResourceTagsCommandOutput extends ListResourceTagsResponse,
15
21
  * keys</a>.</p>
16
22
  * <p>
17
23
  * <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
18
- *
19
24
  * <p>
20
25
  * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListResourceTags</a> (key policy)</p>
21
26
  * <p>
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { ListGrantsResponse, ListRetirableGrantsRequest } from "../models/models_0";
6
+ /**
7
+ * The input for {@link ListRetirableGrantsCommand}.
8
+ */
6
9
  export interface ListRetirableGrantsCommandInput extends ListRetirableGrantsRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link ListRetirableGrantsCommand}.
13
+ */
8
14
  export interface ListRetirableGrantsCommandOutput extends ListGrantsResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -23,7 +29,6 @@ export interface ListRetirableGrantsCommandOutput extends ListGrantsResponse, __
23
29
  * Amazon Web Services account. However, this operation can return grants in any Amazon Web Services account. You do not need
24
30
  * <code>kms:ListRetirableGrants</code> permission (or any other additional permission) in any
25
31
  * Amazon Web Services account other than your own.</p>
26
- *
27
32
  * <p>
28
33
  * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListRetirableGrants</a> (IAM policy) in your
29
34
  * Amazon Web Services account.</p>
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { PutKeyPolicyRequest } from "../models/models_0";
6
+ /**
7
+ * The input for {@link PutKeyPolicyCommand}.
8
+ */
6
9
  export interface PutKeyPolicyCommandInput extends PutKeyPolicyRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link PutKeyPolicyCommand}.
13
+ */
8
14
  export interface PutKeyPolicyCommandOutput extends __MetadataBearer {
9
15
  }
10
16
  /**
@@ -16,7 +22,6 @@ export interface PutKeyPolicyCommandOutput extends __MetadataBearer {
16
22
  * see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-key-policies.html#put-policy">Setting a key policy</a> in the <i>Key Management Service Developer Guide</i>.</p>
17
23
  * <p>
18
24
  * <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
25
  * <p>
21
26
  * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:PutKeyPolicy</a> (key policy)</p>
22
27
  * <p>
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { ReEncryptRequest, ReEncryptResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link ReEncryptCommand}.
8
+ */
6
9
  export interface ReEncryptCommandInput extends ReEncryptRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link ReEncryptCommand}.
13
+ */
8
14
  export interface ReEncryptCommandOutput extends ReEncryptResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -47,7 +53,6 @@ export interface ReEncryptCommandOutput extends ReEncryptResponse, __MetadataBea
47
53
  * specify the KMS key that re-encrypts the data after it is decrypted. If the destination
48
54
  * KMS key is an asymmetric KMS key, you must also provide the encryption algorithm. The
49
55
  * algorithm that you choose must be compatible with the KMS key.</p>
50
- *
51
56
  * <important>
52
57
  * <p>When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails.</p>
53
58
  * <p>You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric encryption KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.</p>
@@ -61,7 +66,6 @@ export interface ReEncryptCommandOutput extends ReEncryptResponse, __MetadataBea
61
66
  * destination KMS key can be in different Amazon Web Services accounts. Either or both KMS keys can be in a
62
67
  * different account than the caller. To specify a KMS key in a different account, you must use
63
68
  * its key ARN or alias ARN.</p>
64
- *
65
69
  * <p>
66
70
  * <b>Required permissions</b>:</p>
67
71
  * <ul>
@@ -80,7 +84,6 @@ export interface ReEncryptCommandOutput extends ReEncryptResponse, __MetadataBea
80
84
  * permission in your <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">key policy</a>. This permission is
81
85
  * automatically included in the key policy when you use the console to create a KMS key. But you
82
86
  * must include it manually when you create a KMS key programmatically or when you use the <a>PutKeyPolicy</a> operation to set a key policy.</p>
83
- *
84
87
  * <p>
85
88
  * <b>Related operations:</b>
86
89
  * </p>
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { ReplicateKeyRequest, ReplicateKeyResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link ReplicateKeyCommand}.
8
+ */
6
9
  export interface ReplicateKeyCommandInput extends ReplicateKeyRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link ReplicateKeyCommand}.
13
+ */
8
14
  export interface ReplicateKeyCommandOutput extends ReplicateKeyResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { RetireGrantRequest } from "../models/models_0";
6
+ /**
7
+ * The input for {@link RetireGrantCommand}.
8
+ */
6
9
  export interface RetireGrantCommandInput extends RetireGrantRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link RetireGrantCommand}.
13
+ */
8
14
  export interface RetireGrantCommandOutput extends __MetadataBearer {
9
15
  }
10
16
  /**
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { RevokeGrantRequest } from "../models/models_0";
6
+ /**
7
+ * The input for {@link RevokeGrantCommand}.
8
+ */
6
9
  export interface RevokeGrantCommandInput extends RevokeGrantRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link RevokeGrantCommand}.
13
+ */
8
14
  export interface RevokeGrantCommandOutput extends __MetadataBearer {
9
15
  }
10
16
  /**
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { ScheduleKeyDeletionRequest, ScheduleKeyDeletionResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link ScheduleKeyDeletionCommand}.
8
+ */
6
9
  export interface ScheduleKeyDeletionCommandInput extends ScheduleKeyDeletionRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link ScheduleKeyDeletionCommand}.
13
+ */
8
14
  export interface ScheduleKeyDeletionCommandOutput extends ScheduleKeyDeletionResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -46,8 +52,6 @@ export interface ScheduleKeyDeletionCommandOutput extends ScheduleKeyDeletionRes
46
52
  * details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
47
53
  * <p>
48
54
  * <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
49
- *
50
- *
51
55
  * <p>
52
56
  * <b>Required permissions</b>: kms:ScheduleKeyDeletion (key
53
57
  * policy)</p>
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { SignRequest, SignResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link SignCommand}.
8
+ */
6
9
  export interface SignCommandInput extends SignRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link SignCommand}.
13
+ */
8
14
  export interface SignCommandOutput extends SignResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -55,7 +61,6 @@ export interface SignCommandOutput extends SignResponse, __MetadataBearer {
55
61
  * <p>
56
62
  * <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
57
63
  * the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
58
- *
59
64
  * <p>
60
65
  * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:Sign</a> (key policy)</p>
61
66
  * <p>
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { TagResourceRequest } from "../models/models_0";
6
+ /**
7
+ * The input for {@link TagResourceCommand}.
8
+ */
6
9
  export interface TagResourceCommandInput extends TagResourceRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link TagResourceCommand}.
13
+ */
8
14
  export interface TagResourceCommandOutput extends __MetadataBearer {
9
15
  }
10
16
  /**
@@ -28,7 +34,6 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
28
34
  * details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
29
35
  * <p>
30
36
  * <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p>
31
- *
32
37
  * <p>
33
38
  * <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>
34
39
  * <p>
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { UntagResourceRequest } from "../models/models_0";
6
+ /**
7
+ * The input for {@link UntagResourceCommand}.
8
+ */
6
9
  export interface UntagResourceCommandInput extends UntagResourceRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link UntagResourceCommand}.
13
+ */
8
14
  export interface UntagResourceCommandOutput extends __MetadataBearer {
9
15
  }
10
16
  /**
@@ -16,7 +22,6 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
16
22
  * <p>When it succeeds, the <code>UntagResource</code> operation doesn't return any output.
17
23
  * Also, if the specified tag key isn't found on the KMS key, it doesn't throw an exception or
18
24
  * return a response. To confirm that the operation worked, use the <a>ListResourceTags</a> operation.</p>
19
- *
20
25
  * <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
21
26
  * 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
22
27
  * Web Services General Reference</i>. </p>
@@ -24,7 +29,6 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
24
29
  * details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
25
30
  * <p>
26
31
  * <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
27
- *
28
32
  * <p>
29
33
  * <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>
30
34
  * <p>
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { UpdateAliasRequest } from "../models/models_0";
6
+ /**
7
+ * The input for {@link UpdateAliasCommand}.
8
+ */
6
9
  export interface UpdateAliasCommandInput extends UpdateAliasRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link UpdateAliasCommand}.
13
+ */
8
14
  export interface UpdateAliasCommandOutput extends __MetadataBearer {
9
15
  }
10
16
  /**
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { UpdateCustomKeyStoreRequest, UpdateCustomKeyStoreResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link UpdateCustomKeyStoreCommand}.
8
+ */
6
9
  export interface UpdateCustomKeyStoreCommandInput extends UpdateCustomKeyStoreRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link UpdateCustomKeyStoreCommand}.
13
+ */
8
14
  export interface UpdateCustomKeyStoreCommandOutput extends UpdateCustomKeyStoreResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { UpdateKeyDescriptionRequest } from "../models/models_0";
6
+ /**
7
+ * The input for {@link UpdateKeyDescriptionCommand}.
8
+ */
6
9
  export interface UpdateKeyDescriptionCommandInput extends UpdateKeyDescriptionRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link UpdateKeyDescriptionCommand}.
13
+ */
8
14
  export interface UpdateKeyDescriptionCommandOutput extends __MetadataBearer {
9
15
  }
10
16
  /**
@@ -13,7 +19,6 @@ export interface UpdateKeyDescriptionCommandOutput extends __MetadataBearer {
13
19
  * details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
14
20
  * <p>
15
21
  * <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p>
16
- *
17
22
  * <p>
18
23
  * <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
24
  * <p>
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { UpdatePrimaryRegionRequest } from "../models/models_0";
6
+ /**
7
+ * The input for {@link UpdatePrimaryRegionCommand}.
8
+ */
6
9
  export interface UpdatePrimaryRegionCommandInput extends UpdatePrimaryRegionRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link UpdatePrimaryRegionCommand}.
13
+ */
8
14
  export interface UpdatePrimaryRegionCommandOutput extends __MetadataBearer {
9
15
  }
10
16
  /**
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { VerifyRequest, VerifyResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link VerifyCommand}.
8
+ */
6
9
  export interface VerifyCommandInput extends VerifyRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link VerifyCommand}.
13
+ */
8
14
  export interface VerifyCommandOutput extends VerifyResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -18,9 +24,11 @@ export interface VerifyCommandOutput extends VerifyResponse, __MetadataBearer {
18
24
  * <p>A digital signature is generated by using the private key in an asymmetric KMS key. The
19
25
  * signature is verified by using the public key in the same asymmetric KMS key.
20
26
  * For information about asymmetric KMS keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
21
- * <p>To verify a digital signature, you can use the <code>Verify</code> operation. Specify the
27
+ * <p>To use the <code>Verify</code> operation, specify the
22
28
  * same asymmetric KMS key, message, and signing algorithm that were used to produce the
23
- * signature.</p>
29
+ * signature. The message type does not need to be the same as the one used for signing, but it must
30
+ * indicate whether the value of the <code>Message</code> parameter should be
31
+ * hashed as part of the verification process.</p>
24
32
  * <p>You can also verify the digital signature by using the public key of the KMS key outside
25
33
  * of KMS. Use the <a>GetPublicKey</a> operation to download the public key in the
26
34
  * asymmetric KMS key and then use the public key to verify the signature outside of KMS. The
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
5
5
  import { VerifyMacRequest, VerifyMacResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link VerifyMacCommand}.
8
+ */
6
9
  export interface VerifyMacCommandInput extends VerifyMacRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link VerifyMacCommand}.
13
+ */
8
14
  export interface VerifyMacCommandOutput extends VerifyMacResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -24,7 +30,6 @@ export interface VerifyMacCommandOutput extends VerifyMacResponse, __MetadataBea
24
30
  * <p>
25
31
  * <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
26
32
  * the key ARN or alias ARN in the value of the <code>KeyId</code> parameter. </p>
27
- *
28
33
  * <p>
29
34
  * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:VerifyMac</a> (key policy)</p>
30
35
  * <p>
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
12
12
  defaultSigningName: string;
13
13
  };
14
14
  export interface EndpointParameters extends __EndpointParameters {
15
- Region: string;
15
+ Region?: string;
16
16
  UseDualStack?: boolean;
17
17
  UseFIPS?: boolean;
18
18
  Endpoint?: string;