@aws-sdk/client-kms 3.289.0 → 3.290.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-types/commands/CancelKeyDeletionCommand.d.ts +35 -0
- package/dist-types/commands/ConnectCustomKeyStoreCommand.d.ts +85 -0
- package/dist-types/commands/CreateAliasCommand.d.ts +42 -0
- package/dist-types/commands/CreateCustomKeyStoreCommand.d.ts +125 -0
- package/dist-types/commands/CreateGrantCommand.d.ts +45 -0
- package/dist-types/commands/CreateKeyCommand.d.ts +122 -0
- package/dist-types/commands/DecryptCommand.d.ts +76 -0
- package/dist-types/commands/DeleteAliasCommand.d.ts +31 -0
- package/dist-types/commands/DeleteCustomKeyStoreCommand.d.ts +51 -0
- package/dist-types/commands/DeleteImportedKeyMaterialCommand.d.ts +39 -0
- package/dist-types/commands/DescribeCustomKeyStoresCommand.d.ts +13 -0
- package/dist-types/commands/DescribeKeyCommand.d.ts +17 -0
- package/dist-types/commands/DisableKeyCommand.d.ts +35 -0
- package/dist-types/commands/DisableKeyRotationCommand.d.ts +42 -0
- package/dist-types/commands/DisconnectCustomKeyStoreCommand.d.ts +45 -0
- package/dist-types/commands/EnableKeyCommand.d.ts +39 -0
- package/dist-types/commands/EnableKeyRotationCommand.d.ts +42 -0
- package/dist-types/commands/EncryptCommand.d.ts +62 -0
- package/dist-types/commands/GenerateDataKeyCommand.d.ts +62 -0
- package/dist-types/commands/GenerateDataKeyPairCommand.d.ts +66 -0
- package/dist-types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +66 -0
- package/dist-types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +62 -0
- package/dist-types/commands/GenerateMacCommand.d.ts +58 -0
- package/dist-types/commands/GenerateRandomCommand.d.ts +53 -0
- package/dist-types/commands/GetKeyPolicyCommand.d.ts +35 -0
- package/dist-types/commands/GetKeyRotationStatusCommand.d.ts +39 -0
- package/dist-types/commands/GetParametersForImportCommand.d.ts +39 -0
- package/dist-types/commands/GetPublicKeyCommand.d.ts +70 -0
- package/dist-types/commands/ImportKeyMaterialCommand.d.ts +59 -0
- package/dist-types/commands/ListAliasesCommand.d.ts +21 -0
- package/dist-types/commands/ListGrantsCommand.d.ts +42 -0
- package/dist-types/commands/ListKeyPoliciesCommand.d.ts +35 -0
- package/dist-types/commands/ListKeysCommand.d.ts +13 -0
- package/dist-types/commands/ListResourceTagsCommand.d.ts +17 -0
- package/dist-types/commands/ListRetirableGrantsCommand.d.ts +21 -0
- package/dist-types/commands/PutKeyPolicyCommand.d.ts +47 -0
- package/dist-types/commands/ReEncryptCommand.d.ts +76 -0
- package/dist-types/commands/ReplicateKeyCommand.d.ts +53 -0
- package/dist-types/commands/RetireGrantCommand.d.ts +41 -0
- package/dist-types/commands/RevokeGrantCommand.d.ts +38 -0
- package/dist-types/commands/ScheduleKeyDeletionCommand.d.ts +35 -0
- package/dist-types/commands/SignCommand.d.ts +62 -0
- package/dist-types/commands/TagResourceCommand.d.ts +38 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +34 -0
- package/dist-types/commands/UpdateAliasCommand.d.ts +35 -0
- package/dist-types/commands/UpdateCustomKeyStoreCommand.d.ts +157 -0
- package/dist-types/commands/UpdateKeyDescriptionCommand.d.ts +35 -0
- package/dist-types/commands/UpdatePrimaryRegionCommand.d.ts +38 -0
- package/dist-types/commands/VerifyCommand.d.ts +67 -0
- package/dist-types/commands/VerifyMacCommand.d.ts +63 -0
- package/package.json +29 -29
|
@@ -50,6 +50,41 @@ export interface ListKeyPoliciesCommandOutput extends ListKeyPoliciesResponse, _
|
|
|
50
50
|
* @see {@link ListKeyPoliciesCommandOutput} for command's `response` shape.
|
|
51
51
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
52
52
|
*
|
|
53
|
+
* @throws {@link DependencyTimeoutException} (server fault)
|
|
54
|
+
* <p>The system timed out while trying to fulfill the request. You can retry the
|
|
55
|
+
* request.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link InvalidArnException} (client fault)
|
|
58
|
+
* <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
|
|
59
|
+
* valid.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link KMSInternalException} (server fault)
|
|
62
|
+
* <p>The request was rejected because an internal exception occurred. The request can be
|
|
63
|
+
* retried.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link KMSInvalidStateException} (client fault)
|
|
66
|
+
* <p>The request was rejected because the state of the specified resource is not valid for this
|
|
67
|
+
* request.</p>
|
|
68
|
+
* <p>This exceptions means one of the following:</p>
|
|
69
|
+
* <ul>
|
|
70
|
+
* <li>
|
|
71
|
+
* <p>The key state of the KMS key is not compatible with the operation. </p>
|
|
72
|
+
* <p>To find the key state, use the <a>DescribeKey</a> operation. For more
|
|
73
|
+
* information about which key states are compatible with each KMS operation, see
|
|
74
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>
|
|
75
|
+
* <i>Key Management Service Developer Guide</i>
|
|
76
|
+
* </i>.</p>
|
|
77
|
+
* </li>
|
|
78
|
+
* <li>
|
|
79
|
+
* <p>For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.</p>
|
|
80
|
+
* </li>
|
|
81
|
+
* </ul>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link NotFoundException} (client fault)
|
|
84
|
+
* <p>The request was rejected because the specified entity or resource could not be
|
|
85
|
+
* found.</p>
|
|
86
|
+
*
|
|
87
|
+
*
|
|
53
88
|
* @example To list key policies for a KMS key
|
|
54
89
|
* ```javascript
|
|
55
90
|
* // The following example lists key policies for the specified KMS key.
|
|
@@ -58,6 +58,19 @@ export interface ListKeysCommandOutput extends ListKeysResponse, __MetadataBeare
|
|
|
58
58
|
* @see {@link ListKeysCommandOutput} for command's `response` shape.
|
|
59
59
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
60
60
|
*
|
|
61
|
+
* @throws {@link DependencyTimeoutException} (server fault)
|
|
62
|
+
* <p>The system timed out while trying to fulfill the request. You can retry the
|
|
63
|
+
* request.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InvalidMarkerException} (client fault)
|
|
66
|
+
* <p>The request was rejected because the marker that specifies where pagination should next
|
|
67
|
+
* begin is not valid.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link KMSInternalException} (server fault)
|
|
70
|
+
* <p>The request was rejected because an internal exception occurred. The request can be
|
|
71
|
+
* retried.</p>
|
|
72
|
+
*
|
|
73
|
+
*
|
|
61
74
|
* @example To list KMS keys
|
|
62
75
|
* ```javascript
|
|
63
76
|
* // The following example lists KMS keys.
|
|
@@ -62,6 +62,23 @@ export interface ListResourceTagsCommandOutput extends ListResourceTagsResponse,
|
|
|
62
62
|
* @see {@link ListResourceTagsCommandOutput} for command's `response` shape.
|
|
63
63
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
64
64
|
*
|
|
65
|
+
* @throws {@link InvalidArnException} (client fault)
|
|
66
|
+
* <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
|
|
67
|
+
* valid.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link InvalidMarkerException} (client fault)
|
|
70
|
+
* <p>The request was rejected because the marker that specifies where pagination should next
|
|
71
|
+
* begin is not valid.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link KMSInternalException} (server fault)
|
|
74
|
+
* <p>The request was rejected because an internal exception occurred. The request can be
|
|
75
|
+
* retried.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link NotFoundException} (client fault)
|
|
78
|
+
* <p>The request was rejected because the specified entity or resource could not be
|
|
79
|
+
* found.</p>
|
|
80
|
+
*
|
|
81
|
+
*
|
|
65
82
|
* @example To list tags for a KMS key
|
|
66
83
|
* ```javascript
|
|
67
84
|
* // The following example lists tags for a KMS key.
|
|
@@ -71,6 +71,27 @@ export interface ListRetirableGrantsCommandOutput extends ListGrantsResponse, __
|
|
|
71
71
|
* @see {@link ListRetirableGrantsCommandOutput} for command's `response` shape.
|
|
72
72
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
73
73
|
*
|
|
74
|
+
* @throws {@link DependencyTimeoutException} (server fault)
|
|
75
|
+
* <p>The system timed out while trying to fulfill the request. You can retry the
|
|
76
|
+
* request.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link InvalidArnException} (client fault)
|
|
79
|
+
* <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
|
|
80
|
+
* valid.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link InvalidMarkerException} (client fault)
|
|
83
|
+
* <p>The request was rejected because the marker that specifies where pagination should next
|
|
84
|
+
* begin is not valid.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link KMSInternalException} (server fault)
|
|
87
|
+
* <p>The request was rejected because an internal exception occurred. The request can be
|
|
88
|
+
* retried.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link NotFoundException} (client fault)
|
|
91
|
+
* <p>The request was rejected because the specified entity or resource could not be
|
|
92
|
+
* found.</p>
|
|
93
|
+
*
|
|
94
|
+
*
|
|
74
95
|
* @example To list grants that the specified principal can retire
|
|
75
96
|
* ```javascript
|
|
76
97
|
* // The following example lists the grants that the specified principal (identity) can retire.
|
|
@@ -41,6 +41,53 @@ export interface PutKeyPolicyCommandOutput extends __MetadataBearer {
|
|
|
41
41
|
* @see {@link PutKeyPolicyCommandOutput} for command's `response` shape.
|
|
42
42
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
43
43
|
*
|
|
44
|
+
* @throws {@link DependencyTimeoutException} (server fault)
|
|
45
|
+
* <p>The system timed out while trying to fulfill the request. You can retry the
|
|
46
|
+
* request.</p>
|
|
47
|
+
*
|
|
48
|
+
* @throws {@link InvalidArnException} (client fault)
|
|
49
|
+
* <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
|
|
50
|
+
* valid.</p>
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link KMSInternalException} (server fault)
|
|
53
|
+
* <p>The request was rejected because an internal exception occurred. The request can be
|
|
54
|
+
* retried.</p>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link KMSInvalidStateException} (client fault)
|
|
57
|
+
* <p>The request was rejected because the state of the specified resource is not valid for this
|
|
58
|
+
* request.</p>
|
|
59
|
+
* <p>This exceptions means one of the following:</p>
|
|
60
|
+
* <ul>
|
|
61
|
+
* <li>
|
|
62
|
+
* <p>The key state of the KMS key is not compatible with the operation. </p>
|
|
63
|
+
* <p>To find the key state, use the <a>DescribeKey</a> operation. For more
|
|
64
|
+
* information about which key states are compatible with each KMS operation, see
|
|
65
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>
|
|
66
|
+
* <i>Key Management Service Developer Guide</i>
|
|
67
|
+
* </i>.</p>
|
|
68
|
+
* </li>
|
|
69
|
+
* <li>
|
|
70
|
+
* <p>For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.</p>
|
|
71
|
+
* </li>
|
|
72
|
+
* </ul>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
75
|
+
* <p>The request was rejected because a quota was exceeded. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Quotas</a> in the
|
|
76
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link MalformedPolicyDocumentException} (client fault)
|
|
79
|
+
* <p>The request was rejected because the specified policy is not syntactically or semantically
|
|
80
|
+
* correct.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link NotFoundException} (client fault)
|
|
83
|
+
* <p>The request was rejected because the specified entity or resource could not be
|
|
84
|
+
* found.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link UnsupportedOperationException} (client fault)
|
|
87
|
+
* <p>The request was rejected because a specified parameter is not supported or a specified
|
|
88
|
+
* resource is not valid for this operation.</p>
|
|
89
|
+
*
|
|
90
|
+
*
|
|
44
91
|
* @example To attach a key policy to a KMS key
|
|
45
92
|
* ```javascript
|
|
46
93
|
* // The following example attaches a key policy to the specified KMS key.
|
|
@@ -123,6 +123,82 @@ export interface ReEncryptCommandOutput extends ReEncryptResponse, __MetadataBea
|
|
|
123
123
|
* @see {@link ReEncryptCommandOutput} for command's `response` shape.
|
|
124
124
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
125
125
|
*
|
|
126
|
+
* @throws {@link DependencyTimeoutException} (server fault)
|
|
127
|
+
* <p>The system timed out while trying to fulfill the request. You can retry the
|
|
128
|
+
* request.</p>
|
|
129
|
+
*
|
|
130
|
+
* @throws {@link DisabledException} (client fault)
|
|
131
|
+
* <p>The request was rejected because the specified KMS key is not enabled.</p>
|
|
132
|
+
*
|
|
133
|
+
* @throws {@link IncorrectKeyException} (client fault)
|
|
134
|
+
* <p>The request was rejected because the specified KMS key cannot decrypt the data. The
|
|
135
|
+
* <code>KeyId</code> in a <a>Decrypt</a> request and the <code>SourceKeyId</code>
|
|
136
|
+
* in a <a>ReEncrypt</a> request must identify the same KMS key that was used to
|
|
137
|
+
* encrypt the ciphertext.</p>
|
|
138
|
+
*
|
|
139
|
+
* @throws {@link InvalidCiphertextException} (client fault)
|
|
140
|
+
* <p>From the <a>Decrypt</a> or <a>ReEncrypt</a> operation, the request
|
|
141
|
+
* was rejected because the specified ciphertext, or additional authenticated data incorporated
|
|
142
|
+
* into the ciphertext, such as the encryption context, is corrupted, missing, or otherwise
|
|
143
|
+
* invalid.</p>
|
|
144
|
+
* <p>From the <a>ImportKeyMaterial</a> operation, the request was rejected because
|
|
145
|
+
* KMS could not decrypt the encrypted (wrapped) key material. </p>
|
|
146
|
+
*
|
|
147
|
+
* @throws {@link InvalidGrantTokenException} (client fault)
|
|
148
|
+
* <p>The request was rejected because the specified grant token is not valid.</p>
|
|
149
|
+
*
|
|
150
|
+
* @throws {@link InvalidKeyUsageException} (client fault)
|
|
151
|
+
* <p>The request was rejected for one of the following reasons: </p>
|
|
152
|
+
* <ul>
|
|
153
|
+
* <li>
|
|
154
|
+
* <p>The <code>KeyUsage</code> value of the KMS key is incompatible with the API
|
|
155
|
+
* operation.</p>
|
|
156
|
+
* </li>
|
|
157
|
+
* <li>
|
|
158
|
+
* <p>The encryption algorithm or signing algorithm specified for the operation is
|
|
159
|
+
* incompatible with the type of key material in the KMS key <code>(KeySpec</code>).</p>
|
|
160
|
+
* </li>
|
|
161
|
+
* </ul>
|
|
162
|
+
* <p>For encrypting, decrypting, re-encrypting, and generating data keys, the
|
|
163
|
+
* <code>KeyUsage</code> must be <code>ENCRYPT_DECRYPT</code>. For signing and verifying
|
|
164
|
+
* messages, the <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. For generating and
|
|
165
|
+
* verifying message authentication codes (MACs), the <code>KeyUsage</code> must be
|
|
166
|
+
* <code>GENERATE_VERIFY_MAC</code>. To find the <code>KeyUsage</code> of a KMS key, use the
|
|
167
|
+
* <a>DescribeKey</a> operation.</p>
|
|
168
|
+
* <p>To find the encryption or signing algorithms supported for a particular KMS key, use the
|
|
169
|
+
* <a>DescribeKey</a> operation.</p>
|
|
170
|
+
*
|
|
171
|
+
* @throws {@link KeyUnavailableException} (server fault)
|
|
172
|
+
* <p>The request was rejected because the specified KMS key was not available. You can retry
|
|
173
|
+
* the request.</p>
|
|
174
|
+
*
|
|
175
|
+
* @throws {@link KMSInternalException} (server fault)
|
|
176
|
+
* <p>The request was rejected because an internal exception occurred. The request can be
|
|
177
|
+
* retried.</p>
|
|
178
|
+
*
|
|
179
|
+
* @throws {@link KMSInvalidStateException} (client fault)
|
|
180
|
+
* <p>The request was rejected because the state of the specified resource is not valid for this
|
|
181
|
+
* request.</p>
|
|
182
|
+
* <p>This exceptions means one of the following:</p>
|
|
183
|
+
* <ul>
|
|
184
|
+
* <li>
|
|
185
|
+
* <p>The key state of the KMS key is not compatible with the operation. </p>
|
|
186
|
+
* <p>To find the key state, use the <a>DescribeKey</a> operation. For more
|
|
187
|
+
* information about which key states are compatible with each KMS operation, see
|
|
188
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>
|
|
189
|
+
* <i>Key Management Service Developer Guide</i>
|
|
190
|
+
* </i>.</p>
|
|
191
|
+
* </li>
|
|
192
|
+
* <li>
|
|
193
|
+
* <p>For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.</p>
|
|
194
|
+
* </li>
|
|
195
|
+
* </ul>
|
|
196
|
+
*
|
|
197
|
+
* @throws {@link NotFoundException} (client fault)
|
|
198
|
+
* <p>The request was rejected because the specified entity or resource could not be
|
|
199
|
+
* found.</p>
|
|
200
|
+
*
|
|
201
|
+
*
|
|
126
202
|
* @example To reencrypt data
|
|
127
203
|
* ```javascript
|
|
128
204
|
* // The following example reencrypts data with the specified KMS key.
|
|
@@ -111,6 +111,59 @@ export interface ReplicateKeyCommandOutput extends ReplicateKeyResponse, __Metad
|
|
|
111
111
|
* @see {@link ReplicateKeyCommandOutput} for command's `response` shape.
|
|
112
112
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
113
113
|
*
|
|
114
|
+
* @throws {@link AlreadyExistsException} (client fault)
|
|
115
|
+
* <p>The request was rejected because it attempted to create a resource that already
|
|
116
|
+
* exists.</p>
|
|
117
|
+
*
|
|
118
|
+
* @throws {@link DisabledException} (client fault)
|
|
119
|
+
* <p>The request was rejected because the specified KMS key is not enabled.</p>
|
|
120
|
+
*
|
|
121
|
+
* @throws {@link InvalidArnException} (client fault)
|
|
122
|
+
* <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
|
|
123
|
+
* valid.</p>
|
|
124
|
+
*
|
|
125
|
+
* @throws {@link KMSInternalException} (server fault)
|
|
126
|
+
* <p>The request was rejected because an internal exception occurred. The request can be
|
|
127
|
+
* retried.</p>
|
|
128
|
+
*
|
|
129
|
+
* @throws {@link KMSInvalidStateException} (client fault)
|
|
130
|
+
* <p>The request was rejected because the state of the specified resource is not valid for this
|
|
131
|
+
* request.</p>
|
|
132
|
+
* <p>This exceptions means one of the following:</p>
|
|
133
|
+
* <ul>
|
|
134
|
+
* <li>
|
|
135
|
+
* <p>The key state of the KMS key is not compatible with the operation. </p>
|
|
136
|
+
* <p>To find the key state, use the <a>DescribeKey</a> operation. For more
|
|
137
|
+
* information about which key states are compatible with each KMS operation, see
|
|
138
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>
|
|
139
|
+
* <i>Key Management Service Developer Guide</i>
|
|
140
|
+
* </i>.</p>
|
|
141
|
+
* </li>
|
|
142
|
+
* <li>
|
|
143
|
+
* <p>For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.</p>
|
|
144
|
+
* </li>
|
|
145
|
+
* </ul>
|
|
146
|
+
*
|
|
147
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
148
|
+
* <p>The request was rejected because a quota was exceeded. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Quotas</a> in the
|
|
149
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
150
|
+
*
|
|
151
|
+
* @throws {@link MalformedPolicyDocumentException} (client fault)
|
|
152
|
+
* <p>The request was rejected because the specified policy is not syntactically or semantically
|
|
153
|
+
* correct.</p>
|
|
154
|
+
*
|
|
155
|
+
* @throws {@link NotFoundException} (client fault)
|
|
156
|
+
* <p>The request was rejected because the specified entity or resource could not be
|
|
157
|
+
* found.</p>
|
|
158
|
+
*
|
|
159
|
+
* @throws {@link TagException} (client fault)
|
|
160
|
+
* <p>The request was rejected because one or more tags are not valid.</p>
|
|
161
|
+
*
|
|
162
|
+
* @throws {@link UnsupportedOperationException} (client fault)
|
|
163
|
+
* <p>The request was rejected because a specified parameter is not supported or a specified
|
|
164
|
+
* resource is not valid for this operation.</p>
|
|
165
|
+
*
|
|
166
|
+
*
|
|
114
167
|
* @example To replicate a multi-Region key in a different AWS Region
|
|
115
168
|
* ```javascript
|
|
116
169
|
* // This example creates a multi-Region replica key in us-west-2 of a multi-Region primary key in us-east-1.
|
|
@@ -74,6 +74,47 @@ export interface RetireGrantCommandOutput extends __MetadataBearer {
|
|
|
74
74
|
* @see {@link RetireGrantCommandOutput} for command's `response` shape.
|
|
75
75
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
76
76
|
*
|
|
77
|
+
* @throws {@link DependencyTimeoutException} (server fault)
|
|
78
|
+
* <p>The system timed out while trying to fulfill the request. You can retry the
|
|
79
|
+
* request.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link InvalidArnException} (client fault)
|
|
82
|
+
* <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
|
|
83
|
+
* valid.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link InvalidGrantIdException} (client fault)
|
|
86
|
+
* <p>The request was rejected because the specified <code>GrantId</code> is not valid.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link InvalidGrantTokenException} (client fault)
|
|
89
|
+
* <p>The request was rejected because the specified grant token is not valid.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link KMSInternalException} (server fault)
|
|
92
|
+
* <p>The request was rejected because an internal exception occurred. The request can be
|
|
93
|
+
* retried.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link KMSInvalidStateException} (client fault)
|
|
96
|
+
* <p>The request was rejected because the state of the specified resource is not valid for this
|
|
97
|
+
* request.</p>
|
|
98
|
+
* <p>This exceptions means one of the following:</p>
|
|
99
|
+
* <ul>
|
|
100
|
+
* <li>
|
|
101
|
+
* <p>The key state of the KMS key is not compatible with the operation. </p>
|
|
102
|
+
* <p>To find the key state, use the <a>DescribeKey</a> operation. For more
|
|
103
|
+
* information about which key states are compatible with each KMS operation, see
|
|
104
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>
|
|
105
|
+
* <i>Key Management Service Developer Guide</i>
|
|
106
|
+
* </i>.</p>
|
|
107
|
+
* </li>
|
|
108
|
+
* <li>
|
|
109
|
+
* <p>For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.</p>
|
|
110
|
+
* </li>
|
|
111
|
+
* </ul>
|
|
112
|
+
*
|
|
113
|
+
* @throws {@link NotFoundException} (client fault)
|
|
114
|
+
* <p>The request was rejected because the specified entity or resource could not be
|
|
115
|
+
* found.</p>
|
|
116
|
+
*
|
|
117
|
+
*
|
|
77
118
|
* @example To retire a grant
|
|
78
119
|
* ```javascript
|
|
79
120
|
* // The following example retires a grant.
|
|
@@ -72,6 +72,44 @@ export interface RevokeGrantCommandOutput extends __MetadataBearer {
|
|
|
72
72
|
* @see {@link RevokeGrantCommandOutput} for command's `response` shape.
|
|
73
73
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
74
74
|
*
|
|
75
|
+
* @throws {@link DependencyTimeoutException} (server fault)
|
|
76
|
+
* <p>The system timed out while trying to fulfill the request. You can retry the
|
|
77
|
+
* request.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link InvalidArnException} (client fault)
|
|
80
|
+
* <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
|
|
81
|
+
* valid.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link InvalidGrantIdException} (client fault)
|
|
84
|
+
* <p>The request was rejected because the specified <code>GrantId</code> is not valid.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link KMSInternalException} (server fault)
|
|
87
|
+
* <p>The request was rejected because an internal exception occurred. The request can be
|
|
88
|
+
* retried.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link KMSInvalidStateException} (client fault)
|
|
91
|
+
* <p>The request was rejected because the state of the specified resource is not valid for this
|
|
92
|
+
* request.</p>
|
|
93
|
+
* <p>This exceptions means one of the following:</p>
|
|
94
|
+
* <ul>
|
|
95
|
+
* <li>
|
|
96
|
+
* <p>The key state of the KMS key is not compatible with the operation. </p>
|
|
97
|
+
* <p>To find the key state, use the <a>DescribeKey</a> operation. For more
|
|
98
|
+
* information about which key states are compatible with each KMS operation, see
|
|
99
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>
|
|
100
|
+
* <i>Key Management Service Developer Guide</i>
|
|
101
|
+
* </i>.</p>
|
|
102
|
+
* </li>
|
|
103
|
+
* <li>
|
|
104
|
+
* <p>For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.</p>
|
|
105
|
+
* </li>
|
|
106
|
+
* </ul>
|
|
107
|
+
*
|
|
108
|
+
* @throws {@link NotFoundException} (client fault)
|
|
109
|
+
* <p>The request was rejected because the specified entity or resource could not be
|
|
110
|
+
* found.</p>
|
|
111
|
+
*
|
|
112
|
+
*
|
|
75
113
|
* @example To revoke a grant
|
|
76
114
|
* ```javascript
|
|
77
115
|
* // The following example revokes a grant.
|
|
@@ -84,6 +84,41 @@ export interface ScheduleKeyDeletionCommandOutput extends ScheduleKeyDeletionRes
|
|
|
84
84
|
* @see {@link ScheduleKeyDeletionCommandOutput} for command's `response` shape.
|
|
85
85
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
86
86
|
*
|
|
87
|
+
* @throws {@link DependencyTimeoutException} (server fault)
|
|
88
|
+
* <p>The system timed out while trying to fulfill the request. You can retry the
|
|
89
|
+
* request.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link InvalidArnException} (client fault)
|
|
92
|
+
* <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
|
|
93
|
+
* valid.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link KMSInternalException} (server fault)
|
|
96
|
+
* <p>The request was rejected because an internal exception occurred. The request can be
|
|
97
|
+
* retried.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link KMSInvalidStateException} (client fault)
|
|
100
|
+
* <p>The request was rejected because the state of the specified resource is not valid for this
|
|
101
|
+
* request.</p>
|
|
102
|
+
* <p>This exceptions means one of the following:</p>
|
|
103
|
+
* <ul>
|
|
104
|
+
* <li>
|
|
105
|
+
* <p>The key state of the KMS key is not compatible with the operation. </p>
|
|
106
|
+
* <p>To find the key state, use the <a>DescribeKey</a> operation. For more
|
|
107
|
+
* information about which key states are compatible with each KMS operation, see
|
|
108
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>
|
|
109
|
+
* <i>Key Management Service Developer Guide</i>
|
|
110
|
+
* </i>.</p>
|
|
111
|
+
* </li>
|
|
112
|
+
* <li>
|
|
113
|
+
* <p>For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.</p>
|
|
114
|
+
* </li>
|
|
115
|
+
* </ul>
|
|
116
|
+
*
|
|
117
|
+
* @throws {@link NotFoundException} (client fault)
|
|
118
|
+
* <p>The request was rejected because the specified entity or resource could not be
|
|
119
|
+
* found.</p>
|
|
120
|
+
*
|
|
121
|
+
*
|
|
87
122
|
* @example To schedule a KMS key for deletion
|
|
88
123
|
* ```javascript
|
|
89
124
|
* // The following example schedules the specified KMS key for deletion.
|
|
@@ -80,6 +80,68 @@ export interface SignCommandOutput extends SignResponse, __MetadataBearer {
|
|
|
80
80
|
* @see {@link SignCommandOutput} for command's `response` shape.
|
|
81
81
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
82
82
|
*
|
|
83
|
+
* @throws {@link DependencyTimeoutException} (server fault)
|
|
84
|
+
* <p>The system timed out while trying to fulfill the request. You can retry the
|
|
85
|
+
* request.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link DisabledException} (client fault)
|
|
88
|
+
* <p>The request was rejected because the specified KMS key is not enabled.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link InvalidGrantTokenException} (client fault)
|
|
91
|
+
* <p>The request was rejected because the specified grant token is not valid.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link InvalidKeyUsageException} (client fault)
|
|
94
|
+
* <p>The request was rejected for one of the following reasons: </p>
|
|
95
|
+
* <ul>
|
|
96
|
+
* <li>
|
|
97
|
+
* <p>The <code>KeyUsage</code> value of the KMS key is incompatible with the API
|
|
98
|
+
* operation.</p>
|
|
99
|
+
* </li>
|
|
100
|
+
* <li>
|
|
101
|
+
* <p>The encryption algorithm or signing algorithm specified for the operation is
|
|
102
|
+
* incompatible with the type of key material in the KMS key <code>(KeySpec</code>).</p>
|
|
103
|
+
* </li>
|
|
104
|
+
* </ul>
|
|
105
|
+
* <p>For encrypting, decrypting, re-encrypting, and generating data keys, the
|
|
106
|
+
* <code>KeyUsage</code> must be <code>ENCRYPT_DECRYPT</code>. For signing and verifying
|
|
107
|
+
* messages, the <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. For generating and
|
|
108
|
+
* verifying message authentication codes (MACs), the <code>KeyUsage</code> must be
|
|
109
|
+
* <code>GENERATE_VERIFY_MAC</code>. To find the <code>KeyUsage</code> of a KMS key, use the
|
|
110
|
+
* <a>DescribeKey</a> operation.</p>
|
|
111
|
+
* <p>To find the encryption or signing algorithms supported for a particular KMS key, use the
|
|
112
|
+
* <a>DescribeKey</a> operation.</p>
|
|
113
|
+
*
|
|
114
|
+
* @throws {@link KeyUnavailableException} (server fault)
|
|
115
|
+
* <p>The request was rejected because the specified KMS key was not available. You can retry
|
|
116
|
+
* the request.</p>
|
|
117
|
+
*
|
|
118
|
+
* @throws {@link KMSInternalException} (server fault)
|
|
119
|
+
* <p>The request was rejected because an internal exception occurred. The request can be
|
|
120
|
+
* retried.</p>
|
|
121
|
+
*
|
|
122
|
+
* @throws {@link KMSInvalidStateException} (client fault)
|
|
123
|
+
* <p>The request was rejected because the state of the specified resource is not valid for this
|
|
124
|
+
* request.</p>
|
|
125
|
+
* <p>This exceptions means one of the following:</p>
|
|
126
|
+
* <ul>
|
|
127
|
+
* <li>
|
|
128
|
+
* <p>The key state of the KMS key is not compatible with the operation. </p>
|
|
129
|
+
* <p>To find the key state, use the <a>DescribeKey</a> operation. For more
|
|
130
|
+
* information about which key states are compatible with each KMS operation, see
|
|
131
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>
|
|
132
|
+
* <i>Key Management Service Developer Guide</i>
|
|
133
|
+
* </i>.</p>
|
|
134
|
+
* </li>
|
|
135
|
+
* <li>
|
|
136
|
+
* <p>For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.</p>
|
|
137
|
+
* </li>
|
|
138
|
+
* </ul>
|
|
139
|
+
*
|
|
140
|
+
* @throws {@link NotFoundException} (client fault)
|
|
141
|
+
* <p>The request was rejected because the specified entity or resource could not be
|
|
142
|
+
* found.</p>
|
|
143
|
+
*
|
|
144
|
+
*
|
|
83
145
|
* @example To digitally sign a message with an asymmetric KMS key.
|
|
84
146
|
* ```javascript
|
|
85
147
|
* // This operation uses the private key in an asymmetric elliptic curve (ECC) KMS key to generate a digital signature for a given message.
|
|
@@ -75,6 +75,44 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
|
|
|
75
75
|
* @see {@link TagResourceCommandOutput} for command's `response` shape.
|
|
76
76
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
77
77
|
*
|
|
78
|
+
* @throws {@link InvalidArnException} (client fault)
|
|
79
|
+
* <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
|
|
80
|
+
* valid.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link KMSInternalException} (server fault)
|
|
83
|
+
* <p>The request was rejected because an internal exception occurred. The request can be
|
|
84
|
+
* retried.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link KMSInvalidStateException} (client fault)
|
|
87
|
+
* <p>The request was rejected because the state of the specified resource is not valid for this
|
|
88
|
+
* request.</p>
|
|
89
|
+
* <p>This exceptions means one of the following:</p>
|
|
90
|
+
* <ul>
|
|
91
|
+
* <li>
|
|
92
|
+
* <p>The key state of the KMS key is not compatible with the operation. </p>
|
|
93
|
+
* <p>To find the key state, use the <a>DescribeKey</a> operation. For more
|
|
94
|
+
* information about which key states are compatible with each KMS operation, see
|
|
95
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>
|
|
96
|
+
* <i>Key Management Service Developer Guide</i>
|
|
97
|
+
* </i>.</p>
|
|
98
|
+
* </li>
|
|
99
|
+
* <li>
|
|
100
|
+
* <p>For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.</p>
|
|
101
|
+
* </li>
|
|
102
|
+
* </ul>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
105
|
+
* <p>The request was rejected because a quota was exceeded. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Quotas</a> in the
|
|
106
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
107
|
+
*
|
|
108
|
+
* @throws {@link NotFoundException} (client fault)
|
|
109
|
+
* <p>The request was rejected because the specified entity or resource could not be
|
|
110
|
+
* found.</p>
|
|
111
|
+
*
|
|
112
|
+
* @throws {@link TagException} (client fault)
|
|
113
|
+
* <p>The request was rejected because one or more tags are not valid.</p>
|
|
114
|
+
*
|
|
115
|
+
*
|
|
78
116
|
* @example To tag a KMS key
|
|
79
117
|
* ```javascript
|
|
80
118
|
* // The following example tags a KMS key.
|
|
@@ -70,6 +70,40 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
|
|
|
70
70
|
* @see {@link UntagResourceCommandOutput} for command's `response` shape.
|
|
71
71
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
72
72
|
*
|
|
73
|
+
* @throws {@link InvalidArnException} (client fault)
|
|
74
|
+
* <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
|
|
75
|
+
* valid.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link KMSInternalException} (server fault)
|
|
78
|
+
* <p>The request was rejected because an internal exception occurred. The request can be
|
|
79
|
+
* retried.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link KMSInvalidStateException} (client fault)
|
|
82
|
+
* <p>The request was rejected because the state of the specified resource is not valid for this
|
|
83
|
+
* request.</p>
|
|
84
|
+
* <p>This exceptions means one of the following:</p>
|
|
85
|
+
* <ul>
|
|
86
|
+
* <li>
|
|
87
|
+
* <p>The key state of the KMS key is not compatible with the operation. </p>
|
|
88
|
+
* <p>To find the key state, use the <a>DescribeKey</a> operation. For more
|
|
89
|
+
* information about which key states are compatible with each KMS operation, see
|
|
90
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>
|
|
91
|
+
* <i>Key Management Service Developer Guide</i>
|
|
92
|
+
* </i>.</p>
|
|
93
|
+
* </li>
|
|
94
|
+
* <li>
|
|
95
|
+
* <p>For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.</p>
|
|
96
|
+
* </li>
|
|
97
|
+
* </ul>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link NotFoundException} (client fault)
|
|
100
|
+
* <p>The request was rejected because the specified entity or resource could not be
|
|
101
|
+
* found.</p>
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link TagException} (client fault)
|
|
104
|
+
* <p>The request was rejected because one or more tags are not valid.</p>
|
|
105
|
+
*
|
|
106
|
+
*
|
|
73
107
|
* @example To remove tags from a KMS key
|
|
74
108
|
* ```javascript
|
|
75
109
|
* // The following example removes tags from a KMS key.
|
|
@@ -91,6 +91,41 @@ export interface UpdateAliasCommandOutput extends __MetadataBearer {
|
|
|
91
91
|
* @see {@link UpdateAliasCommandOutput} for command's `response` shape.
|
|
92
92
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
93
93
|
*
|
|
94
|
+
* @throws {@link DependencyTimeoutException} (server fault)
|
|
95
|
+
* <p>The system timed out while trying to fulfill the request. You can retry the
|
|
96
|
+
* request.</p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link KMSInternalException} (server fault)
|
|
99
|
+
* <p>The request was rejected because an internal exception occurred. The request can be
|
|
100
|
+
* retried.</p>
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link KMSInvalidStateException} (client fault)
|
|
103
|
+
* <p>The request was rejected because the state of the specified resource is not valid for this
|
|
104
|
+
* request.</p>
|
|
105
|
+
* <p>This exceptions means one of the following:</p>
|
|
106
|
+
* <ul>
|
|
107
|
+
* <li>
|
|
108
|
+
* <p>The key state of the KMS key is not compatible with the operation. </p>
|
|
109
|
+
* <p>To find the key state, use the <a>DescribeKey</a> operation. For more
|
|
110
|
+
* information about which key states are compatible with each KMS operation, see
|
|
111
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>
|
|
112
|
+
* <i>Key Management Service Developer Guide</i>
|
|
113
|
+
* </i>.</p>
|
|
114
|
+
* </li>
|
|
115
|
+
* <li>
|
|
116
|
+
* <p>For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.</p>
|
|
117
|
+
* </li>
|
|
118
|
+
* </ul>
|
|
119
|
+
*
|
|
120
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
121
|
+
* <p>The request was rejected because a quota was exceeded. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Quotas</a> in the
|
|
122
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
123
|
+
*
|
|
124
|
+
* @throws {@link NotFoundException} (client fault)
|
|
125
|
+
* <p>The request was rejected because the specified entity or resource could not be
|
|
126
|
+
* found.</p>
|
|
127
|
+
*
|
|
128
|
+
*
|
|
94
129
|
* @example To update an alias
|
|
95
130
|
* ```javascript
|
|
96
131
|
* // The following example updates the specified alias to refer to the specified KMS key.
|