@aws-sdk/client-kms 3.823.0 → 3.826.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/dist-cjs/index.js +50 -5
- package/dist-es/models/models_0.js +17 -0
- package/dist-es/protocols/Aws_json1_1.js +21 -1
- package/dist-types/commands/CancelKeyDeletionCommand.d.ts +1 -1
- package/dist-types/commands/ConnectCustomKeyStoreCommand.d.ts +4 -4
- package/dist-types/commands/CreateAliasCommand.d.ts +7 -7
- package/dist-types/commands/CreateCustomKeyStoreCommand.d.ts +6 -7
- package/dist-types/commands/CreateGrantCommand.d.ts +8 -7
- package/dist-types/commands/CreateKeyCommand.d.ts +21 -20
- package/dist-types/commands/DecryptCommand.d.ts +17 -16
- package/dist-types/commands/DeleteAliasCommand.d.ts +1 -1
- package/dist-types/commands/DeleteCustomKeyStoreCommand.d.ts +4 -4
- package/dist-types/commands/DeleteImportedKeyMaterialCommand.d.ts +14 -5
- package/dist-types/commands/DeriveSharedSecretCommand.d.ts +40 -33
- package/dist-types/commands/DescribeCustomKeyStoresCommand.d.ts +3 -3
- package/dist-types/commands/DescribeKeyCommand.d.ts +79 -78
- package/dist-types/commands/DisableKeyCommand.d.ts +5 -6
- package/dist-types/commands/DisableKeyRotationCommand.d.ts +4 -4
- package/dist-types/commands/DisconnectCustomKeyStoreCommand.d.ts +4 -4
- package/dist-types/commands/EnableKeyCommand.d.ts +5 -4
- package/dist-types/commands/EnableKeyRotationCommand.d.ts +12 -14
- package/dist-types/commands/EncryptCommand.d.ts +4 -4
- package/dist-types/commands/GenerateDataKeyCommand.d.ts +5 -4
- package/dist-types/commands/GenerateDataKeyPairCommand.d.ts +5 -4
- package/dist-types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +5 -4
- package/dist-types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +5 -4
- package/dist-types/commands/GenerateMacCommand.d.ts +3 -3
- package/dist-types/commands/GenerateRandomCommand.d.ts +2 -3
- package/dist-types/commands/GetKeyPolicyCommand.d.ts +1 -1
- package/dist-types/commands/GetKeyRotationStatusCommand.d.ts +12 -11
- package/dist-types/commands/GetParametersForImportCommand.d.ts +7 -7
- package/dist-types/commands/GetPublicKeyCommand.d.ts +8 -8
- package/dist-types/commands/ImportKeyMaterialCommand.d.ts +54 -38
- package/dist-types/commands/ListAliasesCommand.d.ts +4 -5
- package/dist-types/commands/ListGrantsCommand.d.ts +3 -3
- package/dist-types/commands/ListKeyPoliciesCommand.d.ts +1 -1
- package/dist-types/commands/ListKeyRotationsCommand.d.ts +22 -4
- package/dist-types/commands/ListKeysCommand.d.ts +1 -1
- package/dist-types/commands/ListResourceTagsCommand.d.ts +3 -3
- package/dist-types/commands/ListRetirableGrantsCommand.d.ts +3 -3
- package/dist-types/commands/PutKeyPolicyCommand.d.ts +6 -4
- package/dist-types/commands/ReEncryptCommand.d.ts +12 -13
- package/dist-types/commands/ReplicateKeyCommand.d.ts +10 -13
- package/dist-types/commands/RetireGrantCommand.d.ts +6 -7
- package/dist-types/commands/RevokeGrantCommand.d.ts +5 -5
- package/dist-types/commands/RotateKeyOnDemandCommand.d.ts +33 -23
- package/dist-types/commands/ScheduleKeyDeletionCommand.d.ts +15 -15
- package/dist-types/commands/SignCommand.d.ts +19 -19
- package/dist-types/commands/TagResourceCommand.d.ts +6 -5
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAliasCommand.d.ts +4 -3
- package/dist-types/commands/UpdateCustomKeyStoreCommand.d.ts +12 -12
- package/dist-types/commands/UpdateKeyDescriptionCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePrimaryRegionCommand.d.ts +2 -2
- package/dist-types/commands/VerifyCommand.d.ts +4 -4
- package/dist-types/commands/VerifyMacCommand.d.ts +3 -3
- package/dist-types/models/models_0.d.ts +420 -150
- package/dist-types/ts3.4/commands/DeleteImportedKeyMaterialCommand.d.ts +7 -3
- package/dist-types/ts3.4/commands/ImportKeyMaterialCommand.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +50 -1
- package/package.json +11 -11
|
@@ -28,41 +28,36 @@ declare const ImportKeyMaterialCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Imports or reimports key material into an existing KMS key that was created without key
|
|
31
|
-
* material.
|
|
31
|
+
* material. You can also use this operation to set or update the expiration model and expiration date of
|
|
32
32
|
* the imported key material.</p>
|
|
33
|
-
* <p>By default, KMS
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
33
|
+
* <p>By default, KMS creates KMS keys with key material that it generates. You can also generate and
|
|
34
|
+
* import your own key material. For more information about importing key material, see
|
|
35
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing key
|
|
36
|
+
* material</a>.</p>
|
|
37
|
+
* <p>For asymmetric, HMAC and multi-Region keys, you cannot change the key material after the initial import.
|
|
38
|
+
* You can import multiple key materials into single-Region, symmetric encryption keys and rotate the key material
|
|
39
|
+
* on demand using <code>RotateKeyOnDemand</code>.</p>
|
|
40
|
+
* <p>After you import key material, you can <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-import-key-material.html#reimport-key-material">reimport
|
|
41
|
+
* the same key material</a> into that KMS key or, if the key supports on-demand rotation,
|
|
42
|
+
* import new key material. You can use the <code>ImportType</code> parameter to indicate
|
|
43
|
+
* whether you are importing new key material or re-importing previously imported key material.
|
|
44
|
+
* You might reimport key material to replace key material that expired or key material
|
|
42
45
|
* that you deleted. You might also reimport key material to change the expiration model or
|
|
43
|
-
* expiration date of the key material
|
|
46
|
+
* expiration date of the key material.</p>
|
|
44
47
|
* <p>Each time you import key material into KMS, you can determine whether
|
|
45
48
|
* (<code>ExpirationModel</code>) and when (<code>ValidTo</code>) the key material expires. To
|
|
46
49
|
* change the expiration of your key material, you must import it again, either by calling
|
|
47
|
-
* <code>ImportKeyMaterial</code> or using the <a href="kms/latest/developerguide/importing-keys-import-key-material.html#importing-keys-import-key-material-console">import features</a> of the KMS console.</p>
|
|
48
|
-
* <p>Before
|
|
50
|
+
* <code>ImportKeyMaterial</code> or using the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-import-key-material.html#importing-keys-import-key-material-console">import features</a> of the KMS console.</p>
|
|
51
|
+
* <p>Before you call <code>ImportKeyMaterial</code>, complete these steps:</p>
|
|
49
52
|
* <ul>
|
|
50
53
|
* <li>
|
|
51
|
-
* <p>Create or identify a KMS key with
|
|
52
|
-
* <code>Origin</code> value of <code>EXTERNAL</code>, which indicates that the KMS key is
|
|
54
|
+
* <p>Create or identify a KMS key with <code>EXTERNAL</code> origin, which indicates that the KMS key is
|
|
53
55
|
* designed for imported key material. </p>
|
|
54
|
-
* <p>To create
|
|
55
|
-
* symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key,
|
|
56
|
-
* signing KMS key. You can also import key material into a <a href="kms/latest/developerguide/multi-region-keys-overview.html">multi-Region key</a> of any
|
|
57
|
-
* supported type. However, you can't import key material into a KMS key in a
|
|
58
|
-
*
|
|
59
|
-
* <li>
|
|
60
|
-
* <p>Use the <a>DescribeKey</a> operation to verify that the
|
|
61
|
-
* <code>KeyState</code> of the KMS key is <code>PendingImport</code>, which indicates that
|
|
62
|
-
* the KMS key has no key material. </p>
|
|
63
|
-
* <p>If you are reimporting the same key material into an existing KMS key, you might need
|
|
64
|
-
* to call the <a>DeleteImportedKeyMaterial</a> to delete its existing key
|
|
65
|
-
* material.</p>
|
|
56
|
+
* <p>To create a new KMS key for imported key material, call the <a>CreateKey</a> operation with an <code>Origin</code> value of <code>EXTERNAL</code>. You can create a
|
|
57
|
+
* symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, asymmetric key agreement key,
|
|
58
|
+
* or asymmetric signing KMS key. You can also import key material into a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">multi-Region key</a> of any
|
|
59
|
+
* supported type. However, you can't import key material into a KMS key in a
|
|
60
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html">custom key store</a>.</p>
|
|
66
61
|
* </li>
|
|
67
62
|
* <li>
|
|
68
63
|
* <p>Call the <a>GetParametersForImport</a> operation to get a public key and
|
|
@@ -80,9 +75,9 @@ declare const ImportKeyMaterialCommand_base: {
|
|
|
80
75
|
* <li>
|
|
81
76
|
* <p>The key ID or key ARN of the KMS key to associate with the imported key material. Its
|
|
82
77
|
* <code>Origin</code> must be <code>EXTERNAL</code> and its <code>KeyState</code> must be
|
|
83
|
-
* <code>PendingImport</code>. You cannot perform this operation on a KMS key in a
|
|
84
|
-
* key in a different Amazon Web Services account. To get the
|
|
85
|
-
*
|
|
78
|
+
* <code>PendingImport</code>. You cannot perform this operation on a KMS key in a
|
|
79
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html">custom key store</a>, or on a KMS key in a different Amazon Web Services account. To get the
|
|
80
|
+
* <code>Origin</code> and <code>KeyState</code> of a KMS key, call <a>DescribeKey</a>.</p>
|
|
86
81
|
* </li>
|
|
87
82
|
* <li>
|
|
88
83
|
* <p>The encrypted key material. </p>
|
|
@@ -93,7 +88,7 @@ declare const ImportKeyMaterialCommand_base: {
|
|
|
93
88
|
* </li>
|
|
94
89
|
* <li>
|
|
95
90
|
* <p>Whether the key material expires (<code>ExpirationModel</code>) and, if so, when
|
|
96
|
-
* (<code>ValidTo</code>). For help with this choice, see <a href="https://docs.aws.amazon.com/
|
|
91
|
+
* (<code>ValidTo</code>). For help with this choice, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-import-key-material.html#importing-keys-expiration">Setting an expiration time</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
97
92
|
* <p>If you set an expiration date, KMS deletes the key material from the KMS key on the
|
|
98
93
|
* specified date, making the KMS key unusable. To use the KMS key in cryptographic
|
|
99
94
|
* operations again, you must reimport the same key material. However, you can delete and
|
|
@@ -103,11 +98,14 @@ declare const ImportKeyMaterialCommand_base: {
|
|
|
103
98
|
* </ul>
|
|
104
99
|
* <p>When this operation is successful, the key state of the KMS key changes from
|
|
105
100
|
* <code>PendingImport</code> to <code>Enabled</code>, and you can use the KMS key in
|
|
106
|
-
* cryptographic operations
|
|
101
|
+
* cryptographic operations. For single-Region, symmetric encryption keys, you will need to
|
|
102
|
+
* import all of the key materials associated with the KMS key to change its state to <code>Enabled</code>.
|
|
103
|
+
* Use the <code>ListKeyRotations</code> operation to list the ID and import state of each key material
|
|
104
|
+
* associated with a KMS key.</p>
|
|
107
105
|
* <p>If this operation fails, use the exception to help determine the problem. If the error is
|
|
108
106
|
* related to the key material, the import token, or wrapping key, use <a>GetParametersForImport</a> to get a new public key and import token for the KMS key
|
|
109
|
-
* and repeat the import procedure. For help, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html
|
|
110
|
-
*
|
|
107
|
+
* and repeat the import procedure. For help, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-conceptual.html">Create a KMS key with imported key
|
|
108
|
+
* material</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
111
109
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
112
110
|
* 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>
|
|
113
111
|
* <p>
|
|
@@ -128,10 +126,20 @@ declare const ImportKeyMaterialCommand_base: {
|
|
|
128
126
|
* <a>GetParametersForImport</a>
|
|
129
127
|
* </p>
|
|
130
128
|
* </li>
|
|
129
|
+
* <li>
|
|
130
|
+
* <p>
|
|
131
|
+
* <a>ListKeyRotations</a>
|
|
132
|
+
* </p>
|
|
133
|
+
* </li>
|
|
134
|
+
* <li>
|
|
135
|
+
* <p>
|
|
136
|
+
* <a>RotateKeyOnDemand</a>
|
|
137
|
+
* </p>
|
|
138
|
+
* </li>
|
|
131
139
|
* </ul>
|
|
132
140
|
* <p>
|
|
133
141
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
134
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
142
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
|
|
135
143
|
* @example
|
|
136
144
|
* Use a bare-bones client and the command you need to make an API call.
|
|
137
145
|
* ```javascript
|
|
@@ -144,10 +152,16 @@ declare const ImportKeyMaterialCommand_base: {
|
|
|
144
152
|
* EncryptedKeyMaterial: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") // required
|
|
145
153
|
* ValidTo: new Date("TIMESTAMP"),
|
|
146
154
|
* ExpirationModel: "KEY_MATERIAL_EXPIRES" || "KEY_MATERIAL_DOES_NOT_EXPIRE",
|
|
155
|
+
* ImportType: "NEW_KEY_MATERIAL" || "EXISTING_KEY_MATERIAL",
|
|
156
|
+
* KeyMaterialDescription: "STRING_VALUE",
|
|
157
|
+
* KeyMaterialId: "STRING_VALUE",
|
|
147
158
|
* };
|
|
148
159
|
* const command = new ImportKeyMaterialCommand(input);
|
|
149
160
|
* const response = await client.send(command);
|
|
150
|
-
* // {
|
|
161
|
+
* // { // ImportKeyMaterialResponse
|
|
162
|
+
* // KeyId: "STRING_VALUE",
|
|
163
|
+
* // KeyMaterialId: "STRING_VALUE",
|
|
164
|
+
* // };
|
|
151
165
|
*
|
|
152
166
|
* ```
|
|
153
167
|
*
|
|
@@ -167,7 +181,9 @@ declare const ImportKeyMaterialCommand_base: {
|
|
|
167
181
|
*
|
|
168
182
|
* @throws {@link IncorrectKeyMaterialException} (client fault)
|
|
169
183
|
* <p>The request was rejected because the key material in the request is, expired, invalid, or
|
|
170
|
-
* is not the same key material that was previously imported
|
|
184
|
+
* does not meet expectations. For example, it is not the same key material that was previously imported or
|
|
185
|
+
* KMS expected new key material but the key material being imported is already associated with
|
|
186
|
+
* the KMS key.</p>
|
|
171
187
|
*
|
|
172
188
|
* @throws {@link InvalidArnException} (client fault)
|
|
173
189
|
* <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
|
|
@@ -244,7 +260,7 @@ export declare class ImportKeyMaterialCommand extends ImportKeyMaterialCommand_b
|
|
|
244
260
|
protected static __types: {
|
|
245
261
|
api: {
|
|
246
262
|
input: ImportKeyMaterialRequest;
|
|
247
|
-
output:
|
|
263
|
+
output: ImportKeyMaterialResponse;
|
|
248
264
|
};
|
|
249
265
|
sdk: {
|
|
250
266
|
input: ImportKeyMaterialCommandInput;
|
|
@@ -39,15 +39,14 @@ declare const ListAliasesCommand_base: {
|
|
|
39
39
|
* <p>The response might also include aliases that have no <code>TargetKeyId</code> field. These
|
|
40
40
|
* are predefined aliases that Amazon Web Services has created but has not yet associated with a KMS key.
|
|
41
41
|
* Aliases that Amazon Web Services creates in your account, including predefined aliases, do not count against
|
|
42
|
-
* your <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-
|
|
43
|
-
* quota</a>.</p>
|
|
42
|
+
* your <a href="https://docs.aws.amazon.com/kms/latest/developerguide/resource-limits.html#aliases-per-key">KMS
|
|
43
|
+
* aliases quota</a>.</p>
|
|
44
44
|
* <p>
|
|
45
45
|
* <b>Cross-account use</b>: No. <code>ListAliases</code> does not
|
|
46
46
|
* return aliases in other Amazon Web Services accounts.</p>
|
|
47
47
|
* <p>
|
|
48
48
|
* <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>
|
|
49
|
-
* <p>For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
50
|
-
* <i>Key Management Service Developer Guide</i>.</p>
|
|
49
|
+
* <p>For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/alias-access.html">Controlling access to aliases</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
51
50
|
* <p>
|
|
52
51
|
* <b>Related operations:</b>
|
|
53
52
|
* </p>
|
|
@@ -70,7 +69,7 @@ declare const ListAliasesCommand_base: {
|
|
|
70
69
|
* </ul>
|
|
71
70
|
* <p>
|
|
72
71
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
73
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
72
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
|
|
74
73
|
* @example
|
|
75
74
|
* Use a bare-bones client and the command you need to make an API call.
|
|
76
75
|
* ```javascript
|
|
@@ -33,8 +33,8 @@ declare const ListGrantsCommand_base: {
|
|
|
33
33
|
* <p>For detailed information about grants, including grant terminology, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Grants in KMS</a> in the
|
|
34
34
|
* <i>
|
|
35
35
|
* <i>Key Management Service Developer Guide</i>
|
|
36
|
-
* </i>. For examples of
|
|
37
|
-
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
36
|
+
* </i>. For examples of creating grants in several
|
|
37
|
+
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/example_kms_CreateGrant_section.html">Use CreateGrant with an Amazon Web Services SDK or CLI</a>. </p>
|
|
38
38
|
* <note>
|
|
39
39
|
* <p>The <code>GranteePrincipal</code> field in the <code>ListGrants</code> response usually contains the
|
|
40
40
|
* user or role designated as the grantee principal in the grant. However, when the grantee
|
|
@@ -74,7 +74,7 @@ declare const ListGrantsCommand_base: {
|
|
|
74
74
|
* </ul>
|
|
75
75
|
* <p>
|
|
76
76
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
77
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
77
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
|
|
78
78
|
* @example
|
|
79
79
|
* Use a bare-bones client and the command you need to make an API call.
|
|
80
80
|
* ```javascript
|
|
@@ -51,7 +51,7 @@ declare const ListKeyPoliciesCommand_base: {
|
|
|
51
51
|
* </ul>
|
|
52
52
|
* <p>
|
|
53
53
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
54
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
54
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
|
|
55
55
|
* @example
|
|
56
56
|
* Use a bare-bones client and the command you need to make an API call.
|
|
57
57
|
* ```javascript
|
|
@@ -27,11 +27,12 @@ declare const ListKeyRotationsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns information about
|
|
31
|
-
* key
|
|
30
|
+
* <p>Returns information about the key materials associated with the specified KMS
|
|
31
|
+
* key. You can use the optional <code>IncludeKeyMaterial</code> parameter to control which key materials
|
|
32
|
+
* are included in the response.</p>
|
|
32
33
|
* <p>You must specify the KMS key in all requests. You can refine the key rotations list by
|
|
33
34
|
* limiting the number of rotations returned.</p>
|
|
34
|
-
* <p>For detailed information about automatic and on-demand key rotations, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">
|
|
35
|
+
* <p>For detailed information about automatic and on-demand key rotations, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">Rotate KMS keys</a> in the
|
|
35
36
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
36
37
|
* <p>
|
|
37
38
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
@@ -48,6 +49,11 @@ declare const ListKeyRotationsCommand_base: {
|
|
|
48
49
|
* </li>
|
|
49
50
|
* <li>
|
|
50
51
|
* <p>
|
|
52
|
+
* <a>DeleteImportedKeyMaterial</a>
|
|
53
|
+
* </p>
|
|
54
|
+
* </li>
|
|
55
|
+
* <li>
|
|
56
|
+
* <p>
|
|
51
57
|
* <a>DisableKeyRotation</a>
|
|
52
58
|
* </p>
|
|
53
59
|
* </li>
|
|
@@ -58,13 +64,18 @@ declare const ListKeyRotationsCommand_base: {
|
|
|
58
64
|
* </li>
|
|
59
65
|
* <li>
|
|
60
66
|
* <p>
|
|
67
|
+
* <a>ImportKeyMaterial</a>
|
|
68
|
+
* </p>
|
|
69
|
+
* </li>
|
|
70
|
+
* <li>
|
|
71
|
+
* <p>
|
|
61
72
|
* <a>RotateKeyOnDemand</a>
|
|
62
73
|
* </p>
|
|
63
74
|
* </li>
|
|
64
75
|
* </ul>
|
|
65
76
|
* <p>
|
|
66
77
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
67
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
78
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
|
|
68
79
|
* @example
|
|
69
80
|
* Use a bare-bones client and the command you need to make an API call.
|
|
70
81
|
* ```javascript
|
|
@@ -73,6 +84,7 @@ declare const ListKeyRotationsCommand_base: {
|
|
|
73
84
|
* const client = new KMSClient(config);
|
|
74
85
|
* const input = { // ListKeyRotationsRequest
|
|
75
86
|
* KeyId: "STRING_VALUE", // required
|
|
87
|
+
* IncludeKeyMaterial: "ALL_KEY_MATERIAL" || "ROTATIONS_ONLY",
|
|
76
88
|
* Limit: Number("int"),
|
|
77
89
|
* Marker: "STRING_VALUE",
|
|
78
90
|
* };
|
|
@@ -82,6 +94,12 @@ declare const ListKeyRotationsCommand_base: {
|
|
|
82
94
|
* // Rotations: [ // RotationsList
|
|
83
95
|
* // { // RotationsListEntry
|
|
84
96
|
* // KeyId: "STRING_VALUE",
|
|
97
|
+
* // KeyMaterialId: "STRING_VALUE",
|
|
98
|
+
* // KeyMaterialDescription: "STRING_VALUE",
|
|
99
|
+
* // ImportState: "IMPORTED" || "PENDING_IMPORT",
|
|
100
|
+
* // KeyMaterialState: "NON_CURRENT" || "CURRENT" || "PENDING_ROTATION",
|
|
101
|
+
* // ExpirationModel: "KEY_MATERIAL_EXPIRES" || "KEY_MATERIAL_DOES_NOT_EXPIRE",
|
|
102
|
+
* // ValidTo: new Date("TIMESTAMP"),
|
|
85
103
|
* // RotationDate: new Date("TIMESTAMP"),
|
|
86
104
|
* // RotationType: "AUTOMATIC" || "ON_DEMAND",
|
|
87
105
|
* // },
|
|
@@ -59,7 +59,7 @@ declare const ListKeysCommand_base: {
|
|
|
59
59
|
* </ul>
|
|
60
60
|
* <p>
|
|
61
61
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
62
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
62
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
|
|
63
63
|
* @example
|
|
64
64
|
* Use a bare-bones client and the command you need to make an API call.
|
|
65
65
|
* ```javascript
|
|
@@ -30,8 +30,8 @@ declare const ListResourceTagsCommand_base: {
|
|
|
30
30
|
* <p>Returns all tags on the specified KMS key.</p>
|
|
31
31
|
* <p>For general information about 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
|
|
32
32
|
* the <i>Amazon Web Services General Reference</i>. For information about using
|
|
33
|
-
* tags in KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">
|
|
34
|
-
*
|
|
33
|
+
* tags in KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">Tags in
|
|
34
|
+
* KMS</a>.</p>
|
|
35
35
|
* <p>
|
|
36
36
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
37
37
|
* <p>
|
|
@@ -63,7 +63,7 @@ declare const ListResourceTagsCommand_base: {
|
|
|
63
63
|
* </ul>
|
|
64
64
|
* <p>
|
|
65
65
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
66
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
66
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
|
|
67
67
|
* @example
|
|
68
68
|
* Use a bare-bones client and the command you need to make an API call.
|
|
69
69
|
* ```javascript
|
|
@@ -35,8 +35,8 @@ declare const ListRetirableGrantsCommand_base: {
|
|
|
35
35
|
* <p>For detailed information about grants, including grant terminology, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Grants in KMS</a> in the
|
|
36
36
|
* <i>
|
|
37
37
|
* <i>Key Management Service Developer Guide</i>
|
|
38
|
-
* </i>. For examples of
|
|
39
|
-
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
38
|
+
* </i>. For examples of creating grants in several
|
|
39
|
+
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/example_kms_CreateGrant_section.html">Use CreateGrant with an Amazon Web Services SDK or CLI</a>. </p>
|
|
40
40
|
* <p>
|
|
41
41
|
* <b>Cross-account use</b>: You must specify a principal in your
|
|
42
42
|
* Amazon Web Services account. This operation returns a list of grants where the retiring principal specified
|
|
@@ -81,7 +81,7 @@ declare const ListRetirableGrantsCommand_base: {
|
|
|
81
81
|
* </ul>
|
|
82
82
|
* <p>
|
|
83
83
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
84
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
84
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
|
|
85
85
|
* @example
|
|
86
86
|
* Use a bare-bones client and the command you need to make an API call.
|
|
87
87
|
* ```javascript
|
|
@@ -32,7 +32,8 @@ declare const PutKeyPolicyCommand_base: {
|
|
|
32
32
|
* For help writing and formatting a JSON policy document, see the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html">IAM JSON Policy Reference</a> in the <i>
|
|
33
33
|
* <i>Identity and Access Management User Guide</i>
|
|
34
34
|
* </i>. For examples of adding a key policy in multiple programming languages,
|
|
35
|
-
* see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
35
|
+
* see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/example_kms_PutKeyPolicy_section.html">Use
|
|
36
|
+
* PutKeyPolicy with an Amazon Web Services SDK or CLI</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
36
37
|
* <p>
|
|
37
38
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
38
39
|
* <p>
|
|
@@ -42,7 +43,7 @@ declare const PutKeyPolicyCommand_base: {
|
|
|
42
43
|
* </p>
|
|
43
44
|
* <p>
|
|
44
45
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
45
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
46
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
|
|
46
47
|
* @example
|
|
47
48
|
* Use a bare-bones client and the command you need to make an API call.
|
|
48
49
|
* ```javascript
|
|
@@ -100,8 +101,9 @@ declare const PutKeyPolicyCommand_base: {
|
|
|
100
101
|
* </ul>
|
|
101
102
|
*
|
|
102
103
|
* @throws {@link LimitExceededException} (client fault)
|
|
103
|
-
* <p>The request was rejected because a quota was exceeded. For more
|
|
104
|
-
*
|
|
104
|
+
* <p>The request was rejected because a length constraint or quota was exceeded. For more
|
|
105
|
+
* information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Quotas</a> in
|
|
106
|
+
* the <i>Key Management Service Developer Guide</i>.</p>
|
|
105
107
|
*
|
|
106
108
|
* @throws {@link MalformedPolicyDocumentException} (client fault)
|
|
107
109
|
* <p>The request was rejected because the specified policy is not syntactically or semantically
|
|
@@ -28,18 +28,15 @@ declare const ReEncryptCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Decrypts ciphertext and then reencrypts it entirely within KMS. You can use this
|
|
31
|
-
* operation to change the KMS key under which data is encrypted, such as when you <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
* context</a> of a ciphertext.</p>
|
|
31
|
+
* operation to change the KMS key under which data is encrypted, such as when you <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys-manually.html">manually rotate</a> a
|
|
32
|
+
* KMS key or change the KMS key that protects a ciphertext. You can also use it to reencrypt
|
|
33
|
+
* ciphertext under the same KMS key, such as to change the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/encrypt_context.html">encryption context</a> of a ciphertext.</p>
|
|
35
34
|
* <p>The <code>ReEncrypt</code> operation can decrypt ciphertext that was encrypted by using a
|
|
36
35
|
* KMS key in an KMS operation, such as <a>Encrypt</a> or <a>GenerateDataKey</a>. It can also decrypt ciphertext that was encrypted by using the
|
|
37
|
-
* public key of an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
* client-side encryption</a>. These libraries return a ciphertext format that is
|
|
42
|
-
* incompatible with KMS.</p>
|
|
36
|
+
* public key of an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">asymmetric KMS key</a> outside of KMS. However, it cannot decrypt ciphertext produced
|
|
37
|
+
* by other libraries, such as the <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">Amazon Web Services
|
|
38
|
+
* Encryption SDK</a> or <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3 client-side encryption</a>.
|
|
39
|
+
* These libraries return a ciphertext format that is incompatible with KMS.</p>
|
|
43
40
|
* <p>When you use the <code>ReEncrypt</code> operation, you need to provide information for the
|
|
44
41
|
* decrypt operation and the subsequent encrypt operation.</p>
|
|
45
42
|
* <ul>
|
|
@@ -124,7 +121,7 @@ declare const ReEncryptCommand_base: {
|
|
|
124
121
|
* </ul>
|
|
125
122
|
* <p>
|
|
126
123
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
127
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
124
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
|
|
128
125
|
* @example
|
|
129
126
|
* Use a bare-bones client and the command you need to make an API call.
|
|
130
127
|
* ```javascript
|
|
@@ -156,6 +153,8 @@ declare const ReEncryptCommand_base: {
|
|
|
156
153
|
* // KeyId: "STRING_VALUE",
|
|
157
154
|
* // SourceEncryptionAlgorithm: "SYMMETRIC_DEFAULT" || "RSAES_OAEP_SHA_1" || "RSAES_OAEP_SHA_256" || "SM2PKE",
|
|
158
155
|
* // DestinationEncryptionAlgorithm: "SYMMETRIC_DEFAULT" || "RSAES_OAEP_SHA_1" || "RSAES_OAEP_SHA_256" || "SM2PKE",
|
|
156
|
+
* // SourceKeyMaterialId: "STRING_VALUE",
|
|
157
|
+
* // DestinationKeyMaterialId: "STRING_VALUE",
|
|
159
158
|
* // };
|
|
160
159
|
*
|
|
161
160
|
* ```
|
|
@@ -210,8 +209,8 @@ declare const ReEncryptCommand_base: {
|
|
|
210
209
|
* messages, the <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. For generating and
|
|
211
210
|
* verifying message authentication codes (MACs), the <code>KeyUsage</code> must be
|
|
212
211
|
* <code>GENERATE_VERIFY_MAC</code>. For deriving key agreement secrets, the
|
|
213
|
-
*
|
|
214
|
-
*
|
|
212
|
+
* <code>KeyUsage</code> must be <code>KEY_AGREEMENT</code>. To find the <code>KeyUsage</code>
|
|
213
|
+
* of a KMS key, use the <a>DescribeKey</a> operation.</p>
|
|
215
214
|
* <p>To find the encryption or signing algorithms supported for a particular KMS key, use the
|
|
216
215
|
* <a>DescribeKey</a> operation.</p>
|
|
217
216
|
*
|
|
@@ -39,14 +39,10 @@ declare const ReplicateKeyCommand_base: {
|
|
|
39
39
|
* <p>A <i>replica key</i> is a fully-functional KMS key that can be used
|
|
40
40
|
* independently of its primary and peer replica keys. A primary key and its replica keys share
|
|
41
41
|
* properties that make them interoperable. They have the same <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id">key ID</a> and key material. They also
|
|
42
|
-
* have the same
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
* properties among related multi-Region keys. All other properties of a replica key can differ,
|
|
47
|
-
* including its <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">key
|
|
48
|
-
* policy</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">tags</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html">aliases</a>, and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a>. KMS pricing and quotas for KMS keys apply to each
|
|
49
|
-
* primary key and replica key.</p>
|
|
42
|
+
* have the same key spec, key usage, key material origin, and automatic key rotation status.
|
|
43
|
+
* KMS automatically synchronizes these shared properties among related multi-Region keys. All
|
|
44
|
+
* other properties of a replica key can differ, including its <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">key policy</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">tags</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html">aliases</a>, and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">key state</a>. KMS pricing and quotas for KMS keys
|
|
45
|
+
* apply to each primary key and replica key.</p>
|
|
50
46
|
* <p>When this operation completes, the new replica key has a transient key state of
|
|
51
47
|
* <code>Creating</code>. This key state changes to <code>Enabled</code> (or
|
|
52
48
|
* <code>PendingImport</code>) after a few seconds when the process of creating the new replica
|
|
@@ -66,8 +62,7 @@ declare const ReplicateKeyCommand_base: {
|
|
|
66
62
|
* <code>ReplicateKey</code> operation in the primary key's Region and a <a>CreateKey</a> operation in the replica key's Region.</p>
|
|
67
63
|
* <p>If you replicate a multi-Region primary key with imported key material, the replica key is
|
|
68
64
|
* created with no key material. You must import the same key material that you imported into the
|
|
69
|
-
* primary key
|
|
70
|
-
* keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
65
|
+
* primary key.</p>
|
|
71
66
|
* <p>To convert a replica key to a primary key, use the <a>UpdatePrimaryRegion</a>
|
|
72
67
|
* operation.</p>
|
|
73
68
|
* <note>
|
|
@@ -113,7 +108,7 @@ declare const ReplicateKeyCommand_base: {
|
|
|
113
108
|
* </ul>
|
|
114
109
|
* <p>
|
|
115
110
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
116
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
111
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
|
|
117
112
|
* @example
|
|
118
113
|
* Use a bare-bones client and the command you need to make an API call.
|
|
119
114
|
* ```javascript
|
|
@@ -184,6 +179,7 @@ declare const ReplicateKeyCommand_base: {
|
|
|
184
179
|
* // XksKeyConfiguration: { // XksKeyConfigurationType
|
|
185
180
|
* // Id: "STRING_VALUE",
|
|
186
181
|
* // },
|
|
182
|
+
* // CurrentKeyMaterialId: "STRING_VALUE",
|
|
187
183
|
* // },
|
|
188
184
|
* // ReplicaPolicy: "STRING_VALUE",
|
|
189
185
|
* // ReplicaTags: [ // TagList
|
|
@@ -238,8 +234,9 @@ declare const ReplicateKeyCommand_base: {
|
|
|
238
234
|
* </ul>
|
|
239
235
|
*
|
|
240
236
|
* @throws {@link LimitExceededException} (client fault)
|
|
241
|
-
* <p>The request was rejected because a quota was exceeded. For more
|
|
242
|
-
*
|
|
237
|
+
* <p>The request was rejected because a length constraint or quota was exceeded. For more
|
|
238
|
+
* information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Quotas</a> in
|
|
239
|
+
* the <i>Key Management Service Developer Guide</i>.</p>
|
|
243
240
|
*
|
|
244
241
|
* @throws {@link MalformedPolicyDocumentException} (client fault)
|
|
245
242
|
* <p>The request was rejected because the specified policy is not syntactically or semantically
|
|
@@ -34,20 +34,19 @@ declare const RetireGrantCommand_base: {
|
|
|
34
34
|
* <p>This operation can be called by the <i>retiring principal</i> for a grant,
|
|
35
35
|
* by the <i>grantee principal</i> if the grant allows the <code>RetireGrant</code>
|
|
36
36
|
* operation, and by the Amazon Web Services account in which the grant is created. It can also be called by
|
|
37
|
-
* principals to whom permission for retiring a grant is delegated
|
|
38
|
-
* grants</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
37
|
+
* principals to whom permission for retiring a grant is delegated.</p>
|
|
39
38
|
* <p>For detailed information about grants, including grant terminology, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Grants in KMS</a> in the
|
|
40
39
|
* <i>
|
|
41
40
|
* <i>Key Management Service Developer Guide</i>
|
|
42
|
-
* </i>. For examples of
|
|
43
|
-
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
41
|
+
* </i>. For examples of creating grants in several
|
|
42
|
+
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/example_kms_CreateGrant_section.html">Use CreateGrant with an Amazon Web Services SDK or CLI</a>. </p>
|
|
44
43
|
* <p>
|
|
45
44
|
* <b>Cross-account use</b>: Yes. You can retire a grant on a KMS
|
|
46
45
|
* key in a different Amazon Web Services account.</p>
|
|
47
46
|
* <p>
|
|
48
47
|
* <b>Required permissions</b>: Permission to retire a grant is
|
|
49
|
-
* determined primarily by the grant. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-
|
|
50
|
-
*
|
|
48
|
+
* determined primarily by the grant. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-delete.html">Retiring and revoking grants</a> in the
|
|
49
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
51
50
|
* <p>
|
|
52
51
|
* <b>Related operations:</b>
|
|
53
52
|
* </p>
|
|
@@ -75,7 +74,7 @@ declare const RetireGrantCommand_base: {
|
|
|
75
74
|
* </ul>
|
|
76
75
|
* <p>
|
|
77
76
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
78
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
77
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
|
|
79
78
|
* @example
|
|
80
79
|
* Use a bare-bones client and the command you need to make an API call.
|
|
81
80
|
* ```javascript
|
|
@@ -28,8 +28,8 @@ declare const RevokeGrantCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Deletes the specified grant. You revoke a grant to terminate the permissions that the
|
|
31
|
-
* grant allows. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-
|
|
32
|
-
*
|
|
31
|
+
* grant allows. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-delete.html">Retiring and revoking grants</a> in the
|
|
32
|
+
* <i>
|
|
33
33
|
* <i>Key Management Service Developer Guide</i>
|
|
34
34
|
* </i>.</p>
|
|
35
35
|
* <p>When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as <i>eventual consistency</i>. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-eventual-consistency">Eventual consistency</a> in
|
|
@@ -39,8 +39,8 @@ declare const RevokeGrantCommand_base: {
|
|
|
39
39
|
* <p>For detailed information about grants, including grant terminology, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Grants in KMS</a> in the
|
|
40
40
|
* <i>
|
|
41
41
|
* <i>Key Management Service Developer Guide</i>
|
|
42
|
-
* </i>. For examples of
|
|
43
|
-
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
42
|
+
* </i>. For examples of creating grants in several
|
|
43
|
+
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/example_kms_CreateGrant_section.html">Use CreateGrant with an Amazon Web Services SDK or CLI</a>. </p>
|
|
44
44
|
* <p>
|
|
45
45
|
* <b>Cross-account use</b>: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key
|
|
46
46
|
* ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
@@ -73,7 +73,7 @@ declare const RevokeGrantCommand_base: {
|
|
|
73
73
|
* </ul>
|
|
74
74
|
* <p>
|
|
75
75
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
76
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
76
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
|
|
77
77
|
* @example
|
|
78
78
|
* Use a bare-bones client and the command you need to make an API call.
|
|
79
79
|
* ```javascript
|