@aws-sdk/client-kms 3.36.0 → 3.39.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (131) hide show
  1. package/CHANGELOG.md +42 -0
  2. package/dist-cjs/KMS.js +0 -92
  3. package/dist-cjs/KMSClient.js +0 -97
  4. package/dist-cjs/commands/CancelKeyDeletionCommand.js +0 -37
  5. package/dist-cjs/commands/ConnectCustomKeyStoreCommand.js +0 -85
  6. package/dist-cjs/commands/CreateAliasCommand.js +0 -81
  7. package/dist-cjs/commands/CreateCustomKeyStoreCommand.js +0 -73
  8. package/dist-cjs/commands/CreateGrantCommand.js +0 -86
  9. package/dist-cjs/commands/CreateKeyCommand.js +0 -148
  10. package/dist-cjs/commands/DecryptCommand.js +0 -112
  11. package/dist-cjs/commands/DeleteAliasCommand.js +0 -71
  12. package/dist-cjs/commands/DeleteCustomKeyStoreCommand.js +0 -78
  13. package/dist-cjs/commands/DeleteImportedKeyMaterialCommand.js +0 -53
  14. package/dist-cjs/commands/DescribeCustomKeyStoresCommand.js +0 -77
  15. package/dist-cjs/commands/DescribeKeyCommand.js +0 -103
  16. package/dist-cjs/commands/DisableKeyCommand.js +0 -39
  17. package/dist-cjs/commands/DisableKeyRotationCommand.js +0 -49
  18. package/dist-cjs/commands/DisconnectCustomKeyStoreCommand.js +0 -76
  19. package/dist-cjs/commands/EnableKeyCommand.js +0 -36
  20. package/dist-cjs/commands/EnableKeyRotationCommand.js +0 -49
  21. package/dist-cjs/commands/EncryptCommand.js +0 -148
  22. package/dist-cjs/commands/GenerateDataKeyCommand.js +0 -121
  23. package/dist-cjs/commands/GenerateDataKeyPairCommand.js +0 -100
  24. package/dist-cjs/commands/GenerateDataKeyPairWithoutPlaintextCommand.js +0 -90
  25. package/dist-cjs/commands/GenerateDataKeyWithoutPlaintextCommand.js +0 -95
  26. package/dist-cjs/commands/GenerateRandomCommand.js +0 -33
  27. package/dist-cjs/commands/GetKeyPolicyCommand.js +0 -32
  28. package/dist-cjs/commands/GetKeyRotationStatusCommand.js +0 -61
  29. package/dist-cjs/commands/GetParametersForImportCommand.js +0 -58
  30. package/dist-cjs/commands/GetPublicKeyCommand.js +0 -70
  31. package/dist-cjs/commands/ImportKeyMaterialCommand.js +0 -87
  32. package/dist-cjs/commands/ListAliasesCommand.js +0 -66
  33. package/dist-cjs/commands/ListGrantsCommand.js +0 -69
  34. package/dist-cjs/commands/ListKeyPoliciesCommand.js +0 -46
  35. package/dist-cjs/commands/ListKeysCommand.js +0 -54
  36. package/dist-cjs/commands/ListResourceTagsCommand.js +0 -58
  37. package/dist-cjs/commands/ListRetirableGrantsCommand.js +0 -67
  38. package/dist-cjs/commands/PutKeyPolicyCommand.js +0 -37
  39. package/dist-cjs/commands/ReEncryptCommand.js +0 -122
  40. package/dist-cjs/commands/ReplicateKeyCommand.js +0 -101
  41. package/dist-cjs/commands/RetireGrantCommand.js +0 -70
  42. package/dist-cjs/commands/RevokeGrantCommand.js +0 -67
  43. package/dist-cjs/commands/ScheduleKeyDeletionCommand.js +0 -78
  44. package/dist-cjs/commands/SignCommand.js +0 -69
  45. package/dist-cjs/commands/TagResourceCommand.js +0 -71
  46. package/dist-cjs/commands/UntagResourceCommand.js +0 -67
  47. package/dist-cjs/commands/UpdateAliasCommand.js +0 -86
  48. package/dist-cjs/commands/UpdateCustomKeyStoreCommand.js +0 -96
  49. package/dist-cjs/commands/UpdateKeyDescriptionCommand.js +0 -47
  50. package/dist-cjs/commands/UpdatePrimaryRegionCommand.js +0 -89
  51. package/dist-cjs/commands/VerifyCommand.js +0 -54
  52. package/dist-cjs/commands/index.js +51 -0
  53. package/dist-cjs/endpoints.js +6 -1
  54. package/dist-cjs/index.js +4 -55
  55. package/dist-cjs/models/models_0.js +0 -366
  56. package/dist-cjs/pagination/ListAliasesPaginator.js +0 -10
  57. package/dist-cjs/pagination/ListGrantsPaginator.js +0 -10
  58. package/dist-cjs/pagination/ListKeyPoliciesPaginator.js +0 -10
  59. package/dist-cjs/pagination/ListKeysPaginator.js +0 -10
  60. package/dist-cjs/pagination/index.js +8 -0
  61. package/dist-cjs/protocols/Aws_json1_1.js +0 -5
  62. package/dist-cjs/runtimeConfig.browser.js +1 -5
  63. package/dist-cjs/runtimeConfig.js +1 -5
  64. package/dist-cjs/runtimeConfig.native.js +0 -3
  65. package/dist-cjs/runtimeConfig.shared.js +0 -3
  66. package/dist-es/commands/index.js +48 -0
  67. package/dist-es/endpoints.js +6 -1
  68. package/dist-es/index.js +4 -55
  69. package/dist-es/pagination/index.js +5 -0
  70. package/dist-types/commands/index.d.ts +48 -0
  71. package/dist-types/index.d.ts +4 -55
  72. package/dist-types/pagination/index.d.ts +5 -0
  73. package/dist-types/ts3.4/KMS.d.ts +49 -2646
  74. package/dist-types/ts3.4/KMSClient.d.ts +24 -178
  75. package/dist-types/ts3.4/commands/CancelKeyDeletionCommand.d.ts +2 -33
  76. package/dist-types/ts3.4/commands/ConnectCustomKeyStoreCommand.d.ts +2 -81
  77. package/dist-types/ts3.4/commands/CreateAliasCommand.d.ts +2 -77
  78. package/dist-types/ts3.4/commands/CreateCustomKeyStoreCommand.d.ts +2 -69
  79. package/dist-types/ts3.4/commands/CreateGrantCommand.d.ts +2 -82
  80. package/dist-types/ts3.4/commands/CreateKeyCommand.d.ts +2 -144
  81. package/dist-types/ts3.4/commands/DecryptCommand.d.ts +2 -108
  82. package/dist-types/ts3.4/commands/DeleteAliasCommand.d.ts +2 -67
  83. package/dist-types/ts3.4/commands/DeleteCustomKeyStoreCommand.d.ts +2 -74
  84. package/dist-types/ts3.4/commands/DeleteImportedKeyMaterialCommand.d.ts +2 -49
  85. package/dist-types/ts3.4/commands/DescribeCustomKeyStoresCommand.d.ts +2 -73
  86. package/dist-types/ts3.4/commands/DescribeKeyCommand.d.ts +2 -99
  87. package/dist-types/ts3.4/commands/DisableKeyCommand.d.ts +2 -35
  88. package/dist-types/ts3.4/commands/DisableKeyRotationCommand.d.ts +2 -45
  89. package/dist-types/ts3.4/commands/DisconnectCustomKeyStoreCommand.d.ts +2 -72
  90. package/dist-types/ts3.4/commands/EnableKeyCommand.d.ts +2 -32
  91. package/dist-types/ts3.4/commands/EnableKeyRotationCommand.d.ts +2 -45
  92. package/dist-types/ts3.4/commands/EncryptCommand.d.ts +2 -144
  93. package/dist-types/ts3.4/commands/GenerateDataKeyCommand.d.ts +2 -117
  94. package/dist-types/ts3.4/commands/GenerateDataKeyPairCommand.d.ts +2 -96
  95. package/dist-types/ts3.4/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +2 -86
  96. package/dist-types/ts3.4/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +2 -91
  97. package/dist-types/ts3.4/commands/GenerateRandomCommand.d.ts +2 -29
  98. package/dist-types/ts3.4/commands/GetKeyPolicyCommand.d.ts +2 -28
  99. package/dist-types/ts3.4/commands/GetKeyRotationStatusCommand.d.ts +2 -57
  100. package/dist-types/ts3.4/commands/GetParametersForImportCommand.d.ts +2 -54
  101. package/dist-types/ts3.4/commands/GetPublicKeyCommand.d.ts +2 -66
  102. package/dist-types/ts3.4/commands/ImportKeyMaterialCommand.d.ts +2 -83
  103. package/dist-types/ts3.4/commands/ListAliasesCommand.d.ts +2 -62
  104. package/dist-types/ts3.4/commands/ListGrantsCommand.d.ts +2 -65
  105. package/dist-types/ts3.4/commands/ListKeyPoliciesCommand.d.ts +2 -42
  106. package/dist-types/ts3.4/commands/ListKeysCommand.d.ts +2 -50
  107. package/dist-types/ts3.4/commands/ListResourceTagsCommand.d.ts +2 -54
  108. package/dist-types/ts3.4/commands/ListRetirableGrantsCommand.d.ts +2 -63
  109. package/dist-types/ts3.4/commands/PutKeyPolicyCommand.d.ts +2 -33
  110. package/dist-types/ts3.4/commands/ReEncryptCommand.d.ts +2 -118
  111. package/dist-types/ts3.4/commands/ReplicateKeyCommand.d.ts +2 -97
  112. package/dist-types/ts3.4/commands/RetireGrantCommand.d.ts +2 -66
  113. package/dist-types/ts3.4/commands/RevokeGrantCommand.d.ts +2 -63
  114. package/dist-types/ts3.4/commands/ScheduleKeyDeletionCommand.d.ts +2 -74
  115. package/dist-types/ts3.4/commands/SignCommand.d.ts +2 -65
  116. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -67
  117. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -63
  118. package/dist-types/ts3.4/commands/UpdateAliasCommand.d.ts +2 -82
  119. package/dist-types/ts3.4/commands/UpdateCustomKeyStoreCommand.d.ts +2 -92
  120. package/dist-types/ts3.4/commands/UpdateKeyDescriptionCommand.d.ts +2 -43
  121. package/dist-types/ts3.4/commands/UpdatePrimaryRegionCommand.d.ts +2 -85
  122. package/dist-types/ts3.4/commands/VerifyCommand.d.ts +2 -50
  123. package/dist-types/ts3.4/commands/index.d.ts +48 -0
  124. package/dist-types/ts3.4/index.d.ts +4 -55
  125. package/dist-types/ts3.4/models/models_0.d.ts +445 -2963
  126. package/dist-types/ts3.4/pagination/index.d.ts +5 -0
  127. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  128. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  129. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  130. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  131. package/package.json +32 -32
@@ -6,108 +6,11 @@ export interface DescribeKeyCommandInput extends DescribeKeyRequest {
6
6
  }
7
7
  export interface DescribeKeyCommandOutput extends DescribeKeyResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Provides detailed information about a KMS key. You can run <code>DescribeKey</code> on a
11
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed
12
- * 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>
13
- * <p>This detailed information includes the key ARN, creation date (and deletion date, if
14
- * applicable), the key state, and the origin and expiration date (if any) of the key material.
15
- * It includes fields, like <code>KeySpec</code>, that help you distinguish symmetric from
16
- * asymmetric KMS keys. It also provides information that is particularly important to asymmetric
17
- * keys, such as the key usage (encryption or signing) and the encryption algorithms or signing
18
- * algorithms that the KMS key supports. For KMS keys in custom key stores, it includes
19
- * information about the custom key store, such as the key store ID and the CloudHSM cluster ID. For
20
- * multi-Region keys, it displays the primary key and all related replica keys. </p>
21
- * <p>
22
- * <code>DescribeKey</code> does not return the following information:</p>
23
- * <ul>
24
- * <li>
25
- * <p>Aliases associated with the KMS key. To get this information, use <a>ListAliases</a>.</p>
26
- * </li>
27
- * <li>
28
- * <p>Whether automatic key rotation is enabled on the KMS key. To get this information, use
29
- * <a>GetKeyRotationStatus</a>. Also, some key states prevent a KMS key from
30
- * 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
31
- * Works</a> in <i>Key Management Service Developer Guide</i>.</p>
32
- * </li>
33
- * <li>
34
- * <p>Tags on the KMS key. To get this information, use <a>ListResourceTags</a>.</p>
35
- * </li>
36
- * <li>
37
- * <p>Key policies and grants on the KMS key. To get this information, use <a>GetKeyPolicy</a> and <a>ListGrants</a>.</p>
38
- * </li>
39
- * </ul>
40
- * <p>If you call the <code>DescribeKey</code> operation on a <i>predefined Amazon Web Services
41
- * 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
42
- * key</a>. Then, it associates the alias with the new KMS key, and returns the
43
- * <code>KeyId</code> and <code>Arn</code> of the new KMS key in the response.</p>
44
- * <p>
45
- * <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
46
- * the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
47
- *
48
- * <p>
49
- * <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>
50
- * <p>
51
- * <b>Related operations:</b>
52
- * </p>
53
- * <ul>
54
- * <li>
55
- * <p>
56
- * <a>GetKeyPolicy</a>
57
- * </p>
58
- * </li>
59
- * <li>
60
- * <p>
61
- * <a>GetKeyRotationStatus</a>
62
- * </p>
63
- * </li>
64
- * <li>
65
- * <p>
66
- * <a>ListAliases</a>
67
- * </p>
68
- * </li>
69
- * <li>
70
- * <p>
71
- * <a>ListGrants</a>
72
- * </p>
73
- * </li>
74
- * <li>
75
- * <p>
76
- * <a>ListKeys</a>
77
- * </p>
78
- * </li>
79
- * <li>
80
- * <p>
81
- * <a>ListResourceTags</a>
82
- * </p>
83
- * </li>
84
- * <li>
85
- * <p>
86
- * <a>ListRetirableGrants</a>
87
- * </p>
88
- * </li>
89
- * </ul>
90
- * @example
91
- * Use a bare-bones client and the command you need to make an API call.
92
- * ```javascript
93
- * import { KMSClient, DescribeKeyCommand } from "@aws-sdk/client-kms"; // ES Modules import
94
- * // const { KMSClient, DescribeKeyCommand } = require("@aws-sdk/client-kms"); // CommonJS import
95
- * const client = new KMSClient(config);
96
- * const command = new DescribeKeyCommand(input);
97
- * const response = await client.send(command);
98
- * ```
99
- *
100
- * @see {@link DescribeKeyCommandInput} for command's `input` shape.
101
- * @see {@link DescribeKeyCommandOutput} for command's `response` shape.
102
- * @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
103
- *
104
- */
9
+
105
10
  export declare class DescribeKeyCommand extends $Command<DescribeKeyCommandInput, DescribeKeyCommandOutput, KMSClientResolvedConfig> {
106
11
  readonly input: DescribeKeyCommandInput;
107
12
  constructor(input: DescribeKeyCommandInput);
108
- /**
109
- * @internal
110
- */
13
+
111
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeKeyCommandInput, DescribeKeyCommandOutput>;
112
15
  private serialize;
113
16
  private deserialize;
@@ -6,44 +6,11 @@ export interface DisableKeyCommandInput extends DisableKeyRequest {
6
6
  }
7
7
  export interface DisableKeyCommandOutput extends __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Sets the state of a KMS key to disabled. This change temporarily prevents use of the KMS
11
- * key for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. </p>
12
- * <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
13
- * key</a> in the <i>
14
- * <i>Key Management Service Developer Guide</i>
15
- * </i>.</p>
16
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
17
- * 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>
18
- * <p>
19
- * <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
20
- *
21
- * <p>
22
- * <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>
23
- * <p>
24
- * <b>Related operations</b>: <a>EnableKey</a>
25
- * </p>
26
- * @example
27
- * Use a bare-bones client and the command you need to make an API call.
28
- * ```javascript
29
- * import { KMSClient, DisableKeyCommand } from "@aws-sdk/client-kms"; // ES Modules import
30
- * // const { KMSClient, DisableKeyCommand } = require("@aws-sdk/client-kms"); // CommonJS import
31
- * const client = new KMSClient(config);
32
- * const command = new DisableKeyCommand(input);
33
- * const response = await client.send(command);
34
- * ```
35
- *
36
- * @see {@link DisableKeyCommandInput} for command's `input` shape.
37
- * @see {@link DisableKeyCommandOutput} for command's `response` shape.
38
- * @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
39
- *
40
- */
9
+
41
10
  export declare class DisableKeyCommand extends $Command<DisableKeyCommandInput, DisableKeyCommandOutput, KMSClientResolvedConfig> {
42
11
  readonly input: DisableKeyCommandInput;
43
12
  constructor(input: DisableKeyCommandInput);
44
- /**
45
- * @internal
46
- */
13
+
47
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisableKeyCommandInput, DisableKeyCommandOutput>;
48
15
  private serialize;
49
16
  private deserialize;
@@ -6,54 +6,11 @@ export interface DisableKeyRotationCommandInput extends DisableKeyRotationReques
6
6
  }
7
7
  export interface DisableKeyRotationCommandOutput extends __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Disables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic
11
- * rotation of the key material</a> for the specified symmetric KMS key.</p>
12
- * <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>
13
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
14
- * details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
15
- * <p>
16
- * <b>Cross-account
17
- * use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
18
- *
19
- * <p>
20
- * <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>
21
- * <p>
22
- * <b>Related operations:</b>
23
- * </p>
24
- * <ul>
25
- * <li>
26
- * <p>
27
- * <a>EnableKeyRotation</a>
28
- * </p>
29
- * </li>
30
- * <li>
31
- * <p>
32
- * <a>GetKeyRotationStatus</a>
33
- * </p>
34
- * </li>
35
- * </ul>
36
- * @example
37
- * Use a bare-bones client and the command you need to make an API call.
38
- * ```javascript
39
- * import { KMSClient, DisableKeyRotationCommand } from "@aws-sdk/client-kms"; // ES Modules import
40
- * // const { KMSClient, DisableKeyRotationCommand } = require("@aws-sdk/client-kms"); // CommonJS import
41
- * const client = new KMSClient(config);
42
- * const command = new DisableKeyRotationCommand(input);
43
- * const response = await client.send(command);
44
- * ```
45
- *
46
- * @see {@link DisableKeyRotationCommandInput} for command's `input` shape.
47
- * @see {@link DisableKeyRotationCommandOutput} for command's `response` shape.
48
- * @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
49
- *
50
- */
9
+
51
10
  export declare class DisableKeyRotationCommand extends $Command<DisableKeyRotationCommandInput, DisableKeyRotationCommandOutput, KMSClientResolvedConfig> {
52
11
  readonly input: DisableKeyRotationCommandInput;
53
12
  constructor(input: DisableKeyRotationCommandInput);
54
- /**
55
- * @internal
56
- */
13
+
57
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisableKeyRotationCommandInput, DisableKeyRotationCommandOutput>;
58
15
  private serialize;
59
16
  private deserialize;
@@ -6,81 +6,11 @@ export interface DisconnectCustomKeyStoreCommandInput extends DisconnectCustomKe
6
6
  }
7
7
  export interface DisconnectCustomKeyStoreCommandOutput extends DisconnectCustomKeyStoreResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <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
11
- * store is disconnected, you can manage the custom key store and its KMS keys, but you cannot
12
- * create or use KMS keys in the custom key store. You can reconnect the custom key store at any
13
- * time.</p>
14
- * <note>
15
- * <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
16
- * fail. This action can prevent users from storing and accessing sensitive data.</p>
17
- * </note>
18
- * <p></p>
19
- * <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
20
- * <a>ConnectCustomKeyStore</a> operation.</p>
21
- * <p>If the operation succeeds, it returns a JSON object with no
22
- * properties.</p>
23
- * <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
24
- * combines the convenience and extensive integration of KMS with the isolation and control of a
25
- * single-tenant key store.</p>
26
- *
27
- * <p>
28
- * <b>Cross-account use</b>: No.
29
- * You cannot perform this operation on a custom key store 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:DisconnectCustomKeyStore</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>DescribeCustomKeyStores</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, DisconnectCustomKeyStoreCommand } from "@aws-sdk/client-kms"; // ES Modules import
67
- * // const { KMSClient, DisconnectCustomKeyStoreCommand } = require("@aws-sdk/client-kms"); // CommonJS import
68
- * const client = new KMSClient(config);
69
- * const command = new DisconnectCustomKeyStoreCommand(input);
70
- * const response = await client.send(command);
71
- * ```
72
- *
73
- * @see {@link DisconnectCustomKeyStoreCommandInput} for command's `input` shape.
74
- * @see {@link DisconnectCustomKeyStoreCommandOutput} for command's `response` shape.
75
- * @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
76
- *
77
- */
9
+
78
10
  export declare class DisconnectCustomKeyStoreCommand extends $Command<DisconnectCustomKeyStoreCommandInput, DisconnectCustomKeyStoreCommandOutput, KMSClientResolvedConfig> {
79
11
  readonly input: DisconnectCustomKeyStoreCommandInput;
80
12
  constructor(input: DisconnectCustomKeyStoreCommandInput);
81
- /**
82
- * @internal
83
- */
13
+
84
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisconnectCustomKeyStoreCommandInput, DisconnectCustomKeyStoreCommandOutput>;
85
15
  private serialize;
86
16
  private deserialize;
@@ -6,41 +6,11 @@ export interface EnableKeyCommandInput extends EnableKeyRequest {
6
6
  }
7
7
  export interface EnableKeyCommandOutput extends __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Sets the key state of a KMS key to enabled. This allows you to use the KMS key for
11
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. </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:EnableKey</a> (key policy)</p>
20
- * <p>
21
- * <b>Related operations</b>: <a>DisableKey</a>
22
- * </p>
23
- * @example
24
- * Use a bare-bones client and the command you need to make an API call.
25
- * ```javascript
26
- * import { KMSClient, EnableKeyCommand } from "@aws-sdk/client-kms"; // ES Modules import
27
- * // const { KMSClient, EnableKeyCommand } = require("@aws-sdk/client-kms"); // CommonJS import
28
- * const client = new KMSClient(config);
29
- * const command = new EnableKeyCommand(input);
30
- * const response = await client.send(command);
31
- * ```
32
- *
33
- * @see {@link EnableKeyCommandInput} for command's `input` shape.
34
- * @see {@link EnableKeyCommandOutput} for command's `response` shape.
35
- * @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
36
- *
37
- */
9
+
38
10
  export declare class EnableKeyCommand extends $Command<EnableKeyCommandInput, EnableKeyCommandOutput, KMSClientResolvedConfig> {
39
11
  readonly input: EnableKeyCommandInput;
40
12
  constructor(input: EnableKeyCommandInput);
41
- /**
42
- * @internal
43
- */
13
+
44
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<EnableKeyCommandInput, EnableKeyCommandOutput>;
45
15
  private serialize;
46
16
  private deserialize;
@@ -6,54 +6,11 @@ export interface EnableKeyRotationCommandInput extends EnableKeyRotationRequest
6
6
  }
7
7
  export interface EnableKeyRotationCommandOutput extends __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Enables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic rotation
11
- * of the key material</a> for the specified symmetric KMS key.</p>
12
- * <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>
13
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
14
- * details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
15
- * <p>
16
- * <b>Cross-account
17
- * use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
18
- *
19
- * <p>
20
- * <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>
21
- * <p>
22
- * <b>Related operations:</b>
23
- * </p>
24
- * <ul>
25
- * <li>
26
- * <p>
27
- * <a>DisableKeyRotation</a>
28
- * </p>
29
- * </li>
30
- * <li>
31
- * <p>
32
- * <a>GetKeyRotationStatus</a>
33
- * </p>
34
- * </li>
35
- * </ul>
36
- * @example
37
- * Use a bare-bones client and the command you need to make an API call.
38
- * ```javascript
39
- * import { KMSClient, EnableKeyRotationCommand } from "@aws-sdk/client-kms"; // ES Modules import
40
- * // const { KMSClient, EnableKeyRotationCommand } = require("@aws-sdk/client-kms"); // CommonJS import
41
- * const client = new KMSClient(config);
42
- * const command = new EnableKeyRotationCommand(input);
43
- * const response = await client.send(command);
44
- * ```
45
- *
46
- * @see {@link EnableKeyRotationCommandInput} for command's `input` shape.
47
- * @see {@link EnableKeyRotationCommandOutput} for command's `response` shape.
48
- * @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
49
- *
50
- */
9
+
51
10
  export declare class EnableKeyRotationCommand extends $Command<EnableKeyRotationCommandInput, EnableKeyRotationCommandOutput, KMSClientResolvedConfig> {
52
11
  readonly input: EnableKeyRotationCommandInput;
53
12
  constructor(input: EnableKeyRotationCommandInput);
54
- /**
55
- * @internal
56
- */
13
+
57
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<EnableKeyRotationCommandInput, EnableKeyRotationCommandOutput>;
58
15
  private serialize;
59
16
  private deserialize;
@@ -6,153 +6,11 @@ export interface EncryptCommandInput extends EncryptRequest {
6
6
  }
7
7
  export interface EncryptCommandOutput extends EncryptResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Encrypts plaintext into ciphertext by using a KMS key. The <code>Encrypt</code> operation
11
- * has two primary use cases:</p>
12
- * <ul>
13
- * <li>
14
- * <p>You can encrypt small amounts of arbitrary data, such as a personal identifier or
15
- * database password, or other sensitive information. </p>
16
- * </li>
17
- * <li>
18
- * <p>You can use the <code>Encrypt</code> operation to move encrypted data from one Amazon Web Services
19
- * Region to another. For example, in Region A, generate a data key and use the plaintext key
20
- * to encrypt your data. Then, in Region A, use the <code>Encrypt</code> operation to encrypt
21
- * the plaintext data key under a KMS key in Region B. Now, you can move the encrypted data
22
- * and the encrypted data key to Region B. When necessary, you can decrypt the encrypted data
23
- * key and the encrypted data entirely within in Region B.</p>
24
- * </li>
25
- * </ul>
26
- *
27
- * <p>You don't need to use the <code>Encrypt</code> operation to encrypt a data key. The <a>GenerateDataKey</a> and <a>GenerateDataKeyPair</a> operations return a
28
- * plaintext data key and an encrypted copy of that data key.</p>
29
- *
30
- * <p>When you encrypt data, you must specify a symmetric or asymmetric KMS key to use in the
31
- * encryption operation. The KMS key must have a <code>KeyUsage</code> value of
32
- * <code>ENCRYPT_DECRYPT.</code> To find the <code>KeyUsage</code> of a KMS key, use the <a>DescribeKey</a> operation. </p>
33
- *
34
- * <p>If you use a symmetric KMS key, you can use an encryption context to add additional
35
- * security to your encryption operation. If you specify an <code>EncryptionContext</code> when
36
- * encrypting data, you must specify the same encryption context (a case-sensitive exact match)
37
- * when decrypting the data. Otherwise, the request to decrypt fails with an
38
- * <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
39
- * Context</a> in the <i>Key Management Service Developer Guide</i>.</p>
40
- * <p>If you specify an asymmetric KMS key, you must also specify the encryption algorithm. The
41
- * algorithm must be compatible with the KMS key type.</p>
42
- * <important>
43
- * <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>
44
- * <p>You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric 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>
45
- * </important>
46
- *
47
- *
48
- * <p>The maximum size of the data that you can encrypt varies with the type of KMS key and the
49
- * encryption algorithm that you choose.</p>
50
- * <ul>
51
- * <li>
52
- * <p>Symmetric KMS keys</p>
53
- * <ul>
54
- * <li>
55
- * <p>
56
- * <code>SYMMETRIC_DEFAULT</code>: 4096 bytes</p>
57
- * </li>
58
- * </ul>
59
- * </li>
60
- * <li>
61
- * <p>
62
- * <code>RSA_2048</code>
63
- * </p>
64
- * <ul>
65
- * <li>
66
- * <p>
67
- * <code>RSAES_OAEP_SHA_1</code>: 214 bytes</p>
68
- * </li>
69
- * <li>
70
- * <p>
71
- * <code>RSAES_OAEP_SHA_256</code>: 190 bytes</p>
72
- * </li>
73
- * </ul>
74
- * </li>
75
- * <li>
76
- * <p>
77
- * <code>RSA_3072</code>
78
- * </p>
79
- * <ul>
80
- * <li>
81
- * <p>
82
- * <code>RSAES_OAEP_SHA_1</code>: 342 bytes</p>
83
- * </li>
84
- * <li>
85
- * <p>
86
- * <code>RSAES_OAEP_SHA_256</code>: 318 bytes</p>
87
- * </li>
88
- * </ul>
89
- * </li>
90
- * <li>
91
- * <p>
92
- * <code>RSA_4096</code>
93
- * </p>
94
- * <ul>
95
- * <li>
96
- * <p>
97
- * <code>RSAES_OAEP_SHA_1</code>: 470 bytes</p>
98
- * </li>
99
- * <li>
100
- * <p>
101
- * <code>RSAES_OAEP_SHA_256</code>: 446 bytes</p>
102
- * </li>
103
- * </ul>
104
- * </li>
105
- * </ul>
106
- * <p>The KMS key that you use for this operation must be in a compatible key state. For
107
- * 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>
108
- * <p>
109
- * <b>Cross-account use</b>: Yes.
110
- * To perform this operation with a KMS key in a different Amazon Web Services account, specify
111
- * the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
112
- *
113
- * <p>
114
- * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:Encrypt</a> (key policy)</p>
115
- * <p>
116
- * <b>Related operations:</b>
117
- * </p>
118
- * <ul>
119
- * <li>
120
- * <p>
121
- * <a>Decrypt</a>
122
- * </p>
123
- * </li>
124
- * <li>
125
- * <p>
126
- * <a>GenerateDataKey</a>
127
- * </p>
128
- * </li>
129
- * <li>
130
- * <p>
131
- * <a>GenerateDataKeyPair</a>
132
- * </p>
133
- * </li>
134
- * </ul>
135
- * @example
136
- * Use a bare-bones client and the command you need to make an API call.
137
- * ```javascript
138
- * import { KMSClient, EncryptCommand } from "@aws-sdk/client-kms"; // ES Modules import
139
- * // const { KMSClient, EncryptCommand } = require("@aws-sdk/client-kms"); // CommonJS import
140
- * const client = new KMSClient(config);
141
- * const command = new EncryptCommand(input);
142
- * const response = await client.send(command);
143
- * ```
144
- *
145
- * @see {@link EncryptCommandInput} for command's `input` shape.
146
- * @see {@link EncryptCommandOutput} for command's `response` shape.
147
- * @see {@link KMSClientResolvedConfig | config} for command's `input` shape.
148
- *
149
- */
9
+
150
10
  export declare class EncryptCommand extends $Command<EncryptCommandInput, EncryptCommandOutput, KMSClientResolvedConfig> {
151
11
  readonly input: EncryptCommandInput;
152
12
  constructor(input: EncryptCommandInput);
153
- /**
154
- * @internal
155
- */
13
+
156
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<EncryptCommandInput, EncryptCommandOutput>;
157
15
  private serialize;
158
16
  private deserialize;