Skip to content

Commit 5da34d5

Browse files
author
awstools
committed
docs(client-kms): Documentation updates for AWS Key Management Service (KMS).
1 parent 6f1d52c commit 5da34d5

File tree

7 files changed

+318
-66
lines changed

7 files changed

+318
-66
lines changed

clients/client-kms/src/commands/CreateCustomKeyStoreCommand.ts

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -237,9 +237,8 @@ export interface CreateCustomKeyStoreCommandOutput extends CreateCustomKeyStoreR
237237
* or in the identification of the external key store proxy.</p>
238238
*
239239
* @throws {@link XksProxyInvalidConfigurationException} (client fault)
240-
* <p>The request was rejected because the Amazon VPC endpoint service configuration does not fulfill
241-
* the requirements for an external key store proxy. For details, see the exception
242-
* message.</p>
240+
* <p>The request was rejected because the external key store proxy is not configured correctly.
241+
* To identify the cause, see the error message that accompanies the exception.</p>
243242
*
244243
* @throws {@link XksProxyInvalidResponseException} (client fault)
245244
* <p></p>
@@ -248,16 +247,15 @@ export interface CreateCustomKeyStoreCommandOutput extends CreateCustomKeyStoreR
248247
* issue. If you see this error repeatedly, report it to the proxy vendor.</p>
249248
*
250249
* @throws {@link XksProxyUriEndpointInUseException} (client fault)
251-
* <p>The request was rejected because the concatenation of the <code>XksProxyUriEndpoint</code>
252-
* is already associated with an external key store in the Amazon Web Services account and Region. Each
253-
* external key store in an account and Region must use a unique external key store proxy
254-
* address.</p>
250+
* <p>The request was rejected because the <code>XksProxyUriEndpoint</code> is already
251+
* associated with another external key store in this Amazon Web Services Region. To identify the cause,
252+
* see the error message that accompanies the exception. </p>
255253
*
256254
* @throws {@link XksProxyUriInUseException} (client fault)
257255
* <p>The request was rejected because the concatenation of the <code>XksProxyUriEndpoint</code>
258-
* and <code>XksProxyUriPath</code> is already associated with an external key store in the
259-
* Amazon Web Services account and Region. Each external key store in an account and Region must use a unique
260-
* external key store proxy API address.</p>
256+
* and <code>XksProxyUriPath</code> is already associated with another external key store in this
257+
* Amazon Web Services Region. Each external key store in a Region must use a unique external key store proxy
258+
* API address.</p>
261259
*
262260
* @throws {@link XksProxyUriUnreachableException} (client fault)
263261
* <p>KMS was unable to reach the specified <code>XksProxyUriPath</code>. The path must be
@@ -268,13 +266,14 @@ export interface CreateCustomKeyStoreCommandOutput extends CreateCustomKeyStoreR
268266
*
269267
* @throws {@link XksProxyVpcEndpointServiceInUseException} (client fault)
270268
* <p>The request was rejected because the specified Amazon VPC endpoint service is already
271-
* associated with an external key store in the Amazon Web Services account and Region. Each external key store
272-
* in an Amazon Web Services account and Region must use a different Amazon VPC endpoint service.</p>
269+
* associated with another external key store in this Amazon Web Services Region. Each external key store in a
270+
* Region must use a different Amazon VPC endpoint service.</p>
273271
*
274272
* @throws {@link XksProxyVpcEndpointServiceInvalidConfigurationException} (client fault)
275273
* <p>The request was rejected because the Amazon VPC endpoint service configuration does not fulfill
276-
* the requirements for an external key store proxy. For details, see the exception message and
277-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/vpc-connectivity.html#xks-vpc-requirements">review the requirements</a> for Amazon VPC endpoint service connectivity for an external key
274+
* the requirements for an external key store. To identify the cause, see the error message that
275+
* accompanies the exception and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/vpc-connectivity.html#xks-vpc-requirements">review the
276+
* requirements</a> for Amazon VPC endpoint service connectivity for an external key
278277
* store.</p>
279278
*
280279
* @throws {@link XksProxyVpcEndpointServiceNotFoundException} (client fault)

clients/client-kms/src/commands/CreateKeyCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -380,9 +380,9 @@ export interface CreateKeyCommandOutput extends CreateKeyResponse, __MetadataBea
380380
* resource is not valid for this operation.</p>
381381
*
382382
* @throws {@link XksKeyAlreadyInUseException} (client fault)
383-
* <p>The request was rejected because the (<code>XksKeyId</code>) is already associated with a
384-
* KMS key in this external key store. Each KMS key in an external key store must be associated
385-
* with a different external key.</p>
383+
* <p>The request was rejected because the (<code>XksKeyId</code>) is already associated with
384+
* another KMS key in this external key store. Each KMS key in an external key store must be
385+
* associated with a different external key.</p>
386386
*
387387
* @throws {@link XksKeyInvalidConfigurationException} (client fault)
388388
* <p>The request was rejected because the external key specified by the <code>XksKeyId</code>

clients/client-kms/src/commands/GetParametersForImportCommand.ts

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,10 @@ export interface GetParametersForImportCommandOutput extends GetParametersForImp
4444
* operation with an <code>Origin</code> value of <code>EXTERNAL</code> to create a KMS key with
4545
* no key material. You can import key material for a symmetric encryption KMS key, HMAC KMS key,
4646
* asymmetric encryption KMS key, or asymmetric signing KMS key. You can also import key material
47-
* into a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">multi-Region key</a> of
48-
* any supported type. However, you can't import key material into a KMS key in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key
49-
* store</a>. You can also use <code>GetParametersForImport</code> to get a public key and
50-
* import token to <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#reimport-key-material">reimport
51-
* the original key material</a> into a KMS key whose key material expired or was
52-
* deleted.</p>
47+
* into a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">multi-Region key</a> of any supported type. However, you can't import key material into
48+
* a KMS key in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. You can also use <code>GetParametersForImport</code> to get a
49+
* public key and import token to <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#reimport-key-material">reimport the original key
50+
* material</a> into a KMS key whose key material expired or was deleted.</p>
5351
* <p>
5452
* <code>GetParametersForImport</code> returns the items that you need to import your key
5553
* material.</p>

clients/client-kms/src/commands/ReplicateKeyCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,8 @@ export interface ReplicateKeyCommandOutput extends ReplicateKeyResponse, __Metad
6767
* <code>ReplicateKey</code> operation in the primary key's Region and a <a>CreateKey</a> operation in the replica key's Region.</p>
6868
* <p>If you replicate a multi-Region primary key with imported key material, the replica key is
6969
* created with no key material. You must import the same key material that you imported into the
70-
* primary key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-import.html">Importing key material into multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
70+
* primary key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-import.html">Importing key material into multi-Region
71+
* keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
7172
* <p>To convert a replica key to a primary key, use the <a>UpdatePrimaryRegion</a>
7273
* operation.</p>
7374
* <note>

clients/client-kms/src/commands/UpdateCustomKeyStoreCommand.ts

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -270,9 +270,8 @@ export interface UpdateCustomKeyStoreCommandOutput extends UpdateCustomKeyStoreR
270270
* or in the identification of the external key store proxy.</p>
271271
*
272272
* @throws {@link XksProxyInvalidConfigurationException} (client fault)
273-
* <p>The request was rejected because the Amazon VPC endpoint service configuration does not fulfill
274-
* the requirements for an external key store proxy. For details, see the exception
275-
* message.</p>
273+
* <p>The request was rejected because the external key store proxy is not configured correctly.
274+
* To identify the cause, see the error message that accompanies the exception.</p>
276275
*
277276
* @throws {@link XksProxyInvalidResponseException} (client fault)
278277
* <p></p>
@@ -281,16 +280,15 @@ export interface UpdateCustomKeyStoreCommandOutput extends UpdateCustomKeyStoreR
281280
* issue. If you see this error repeatedly, report it to the proxy vendor.</p>
282281
*
283282
* @throws {@link XksProxyUriEndpointInUseException} (client fault)
284-
* <p>The request was rejected because the concatenation of the <code>XksProxyUriEndpoint</code>
285-
* is already associated with an external key store in the Amazon Web Services account and Region. Each
286-
* external key store in an account and Region must use a unique external key store proxy
287-
* address.</p>
283+
* <p>The request was rejected because the <code>XksProxyUriEndpoint</code> is already
284+
* associated with another external key store in this Amazon Web Services Region. To identify the cause,
285+
* see the error message that accompanies the exception. </p>
288286
*
289287
* @throws {@link XksProxyUriInUseException} (client fault)
290288
* <p>The request was rejected because the concatenation of the <code>XksProxyUriEndpoint</code>
291-
* and <code>XksProxyUriPath</code> is already associated with an external key store in the
292-
* Amazon Web Services account and Region. Each external key store in an account and Region must use a unique
293-
* external key store proxy API address.</p>
289+
* and <code>XksProxyUriPath</code> is already associated with another external key store in this
290+
* Amazon Web Services Region. Each external key store in a Region must use a unique external key store proxy
291+
* API address.</p>
294292
*
295293
* @throws {@link XksProxyUriUnreachableException} (client fault)
296294
* <p>KMS was unable to reach the specified <code>XksProxyUriPath</code>. The path must be
@@ -301,13 +299,14 @@ export interface UpdateCustomKeyStoreCommandOutput extends UpdateCustomKeyStoreR
301299
*
302300
* @throws {@link XksProxyVpcEndpointServiceInUseException} (client fault)
303301
* <p>The request was rejected because the specified Amazon VPC endpoint service is already
304-
* associated with an external key store in the Amazon Web Services account and Region. Each external key store
305-
* in an Amazon Web Services account and Region must use a different Amazon VPC endpoint service.</p>
302+
* associated with another external key store in this Amazon Web Services Region. Each external key store in a
303+
* Region must use a different Amazon VPC endpoint service.</p>
306304
*
307305
* @throws {@link XksProxyVpcEndpointServiceInvalidConfigurationException} (client fault)
308306
* <p>The request was rejected because the Amazon VPC endpoint service configuration does not fulfill
309-
* the requirements for an external key store proxy. For details, see the exception message and
310-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/vpc-connectivity.html#xks-vpc-requirements">review the requirements</a> for Amazon VPC endpoint service connectivity for an external key
307+
* the requirements for an external key store. To identify the cause, see the error message that
308+
* accompanies the exception and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/vpc-connectivity.html#xks-vpc-requirements">review the
309+
* requirements</a> for Amazon VPC endpoint service connectivity for an external key
311310
* store.</p>
312311
*
313312
* @throws {@link XksProxyVpcEndpointServiceNotFoundException} (client fault)

clients/client-kms/src/models/models_0.ts

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -745,7 +745,7 @@ export interface CreateCustomKeyStoreRequest {
745745
* <li>
746746
* <p>An external key store with <code>PUBLIC_ENDPOINT</code> connectivity cannot use the
747747
* same <code>XksProxyUriEndpoint</code> value as an external key store with
748-
* <code>VPC_ENDPOINT_SERVICE</code> connectivity in the same Amazon Web Services Region.</p>
748+
* <code>VPC_ENDPOINT_SERVICE</code> connectivity in this Amazon Web Services Region.</p>
749749
* </li>
750750
* <li>
751751
* <p>Each external key store with <code>VPC_ENDPOINT_SERVICE</code> connectivity must have
@@ -921,9 +921,8 @@ export class XksProxyIncorrectAuthenticationCredentialException extends __BaseEx
921921

922922
/**
923923
* @public
924-
* <p>The request was rejected because the Amazon VPC endpoint service configuration does not fulfill
925-
* the requirements for an external key store proxy. For details, see the exception
926-
* message.</p>
924+
* <p>The request was rejected because the external key store proxy is not configured correctly.
925+
* To identify the cause, see the error message that accompanies the exception.</p>
927926
*/
928927
export class XksProxyInvalidConfigurationException extends __BaseException {
929928
readonly name: "XksProxyInvalidConfigurationException" = "XksProxyInvalidConfigurationException";
@@ -966,10 +965,9 @@ export class XksProxyInvalidResponseException extends __BaseException {
966965

967966
/**
968967
* @public
969-
* <p>The request was rejected because the concatenation of the <code>XksProxyUriEndpoint</code>
970-
* is already associated with an external key store in the Amazon Web Services account and Region. Each
971-
* external key store in an account and Region must use a unique external key store proxy
972-
* address.</p>
968+
* <p>The request was rejected because the <code>XksProxyUriEndpoint</code> is already
969+
* associated with another external key store in this Amazon Web Services Region. To identify the cause,
970+
* see the error message that accompanies the exception. </p>
973971
*/
974972
export class XksProxyUriEndpointInUseException extends __BaseException {
975973
readonly name: "XksProxyUriEndpointInUseException" = "XksProxyUriEndpointInUseException";
@@ -990,9 +988,9 @@ export class XksProxyUriEndpointInUseException extends __BaseException {
990988
/**
991989
* @public
992990
* <p>The request was rejected because the concatenation of the <code>XksProxyUriEndpoint</code>
993-
* and <code>XksProxyUriPath</code> is already associated with an external key store in the
994-
* Amazon Web Services account and Region. Each external key store in an account and Region must use a unique
995-
* external key store proxy API address.</p>
991+
* and <code>XksProxyUriPath</code> is already associated with another external key store in this
992+
* Amazon Web Services Region. Each external key store in a Region must use a unique external key store proxy
993+
* API address.</p>
996994
*/
997995
export class XksProxyUriInUseException extends __BaseException {
998996
readonly name: "XksProxyUriInUseException" = "XksProxyUriInUseException";
@@ -1037,8 +1035,8 @@ export class XksProxyUriUnreachableException extends __BaseException {
10371035
/**
10381036
* @public
10391037
* <p>The request was rejected because the specified Amazon VPC endpoint service is already
1040-
* associated with an external key store in the Amazon Web Services account and Region. Each external key store
1041-
* in an Amazon Web Services account and Region must use a different Amazon VPC endpoint service.</p>
1038+
* associated with another external key store in this Amazon Web Services Region. Each external key store in a
1039+
* Region must use a different Amazon VPC endpoint service.</p>
10421040
*/
10431041
export class XksProxyVpcEndpointServiceInUseException extends __BaseException {
10441042
readonly name: "XksProxyVpcEndpointServiceInUseException" = "XksProxyVpcEndpointServiceInUseException";
@@ -1059,8 +1057,9 @@ export class XksProxyVpcEndpointServiceInUseException extends __BaseException {
10591057
/**
10601058
* @public
10611059
* <p>The request was rejected because the Amazon VPC endpoint service configuration does not fulfill
1062-
* the requirements for an external key store proxy. For details, see the exception message and
1063-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/vpc-connectivity.html#xks-vpc-requirements">review the requirements</a> for Amazon VPC endpoint service connectivity for an external key
1060+
* the requirements for an external key store. To identify the cause, see the error message that
1061+
* accompanies the exception and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/vpc-connectivity.html#xks-vpc-requirements">review the
1062+
* requirements</a> for Amazon VPC endpoint service connectivity for an external key
10641063
* store.</p>
10651064
*/
10661065
export class XksProxyVpcEndpointServiceInvalidConfigurationException extends __BaseException {
@@ -2296,9 +2295,9 @@ export class UnsupportedOperationException extends __BaseException {
22962295

22972296
/**
22982297
* @public
2299-
* <p>The request was rejected because the (<code>XksKeyId</code>) is already associated with a
2300-
* KMS key in this external key store. Each KMS key in an external key store must be associated
2301-
* with a different external key.</p>
2298+
* <p>The request was rejected because the (<code>XksKeyId</code>) is already associated with
2299+
* another KMS key in this external key store. Each KMS key in an external key store must be
2300+
* associated with a different external key.</p>
23022301
*/
23032302
export class XksKeyAlreadyInUseException extends __BaseException {
23042303
readonly name: "XksKeyAlreadyInUseException" = "XksKeyAlreadyInUseException";

0 commit comments

Comments
 (0)