docs(client-kms): Documentation updates for AWS Key Management Servic…

…e (KMS).
aws · Jan 5, 2024 · 5da34d5 · 5da34d5
1 parent 6f1d52c
commit 5da34d5
Show file tree

Hide file tree

Showing 7 changed files with 318 additions and 66 deletions.
diff --git a/clients/client-kms/src/commands/CreateCustomKeyStoreCommand.ts b/clients/client-kms/src/commands/CreateCustomKeyStoreCommand.ts
@@ -237,9 +237,8 @@ export interface CreateCustomKeyStoreCommandOutput extends CreateCustomKeyStoreR
  *       or in the identification of the external key store proxy.</p>
  *
  * @throws {@link XksProxyInvalidConfigurationException} (client fault)
- *  <p>The request was rejected because the Amazon VPC endpoint service configuration does not fulfill
- *       the requirements for an external key store proxy. For details, see the exception
- *       message.</p>
+ *  <p>The request was rejected because the external key store proxy is not configured correctly.
+ *       To identify the cause, see the error message that accompanies the exception.</p>
  *
  * @throws {@link XksProxyInvalidResponseException} (client fault)
  *  <p></p>
@@ -248,16 +247,15 @@ export interface CreateCustomKeyStoreCommandOutput extends CreateCustomKeyStoreR
  *       issue. If you see this error repeatedly, report it to the proxy vendor.</p>
  *
  * @throws {@link XksProxyUriEndpointInUseException} (client fault)
- *  <p>The request was rejected because the concatenation of the <code>XksProxyUriEndpoint</code>
- *       is already associated with an external key store in the Amazon Web Services account and Region. Each
- *       external key store in an account and Region must use a unique external key store proxy
- *       address.</p>
+ *  <p>The request was rejected because the <code>XksProxyUriEndpoint</code> is already
+ *       associated with another external key store in this Amazon Web Services Region. To identify the cause,
+ *       see the error message that accompanies the exception. </p>
  *
  * @throws {@link XksProxyUriInUseException} (client fault)
  *  <p>The request was rejected because the concatenation of the <code>XksProxyUriEndpoint</code>
- *       and <code>XksProxyUriPath</code> is already associated with an external key store in the
- *       Amazon Web Services account and Region. Each external key store in an account and Region must use a unique
- *       external key store proxy API address.</p>
+ *       and <code>XksProxyUriPath</code> is already associated with another external key store in this
+ *       Amazon Web Services Region. Each external key store in a Region must use a unique external key store proxy
+ *       API address.</p>
  *
  * @throws {@link XksProxyUriUnreachableException} (client fault)
  *  <p>KMS was unable to reach the specified <code>XksProxyUriPath</code>. The path must be
@@ -268,13 +266,14 @@ export interface CreateCustomKeyStoreCommandOutput extends CreateCustomKeyStoreR
  *
  * @throws {@link XksProxyVpcEndpointServiceInUseException} (client fault)
  *  <p>The request was rejected because the specified Amazon VPC endpoint service is already
- *       associated with an external key store in the Amazon Web Services account and Region. Each external key store
- *       in an Amazon Web Services account and Region must use a different Amazon VPC endpoint service.</p>
+ *       associated with another external key store in this Amazon Web Services Region. Each external key store in a
+ *       Region must use a different Amazon VPC endpoint service.</p>
  *
  * @throws {@link XksProxyVpcEndpointServiceInvalidConfigurationException} (client fault)
  *  <p>The request was rejected because the Amazon VPC endpoint service configuration does not fulfill
- *       the requirements for an external key store proxy. For details, see the exception message and
- *         <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
+ *       the requirements for an external key store. To identify the cause, see the error message that
+ *       accompanies the exception and <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
  *       store.</p>
  *
  * @throws {@link XksProxyVpcEndpointServiceNotFoundException} (client fault)

diff --git a/clients/client-kms/src/commands/CreateKeyCommand.ts b/clients/client-kms/src/commands/CreateKeyCommand.ts
@@ -380,9 +380,9 @@ export interface CreateKeyCommandOutput extends CreateKeyResponse, __MetadataBea
  *       resource is not valid for this operation.</p>
  *
  * @throws {@link XksKeyAlreadyInUseException} (client fault)
- *  <p>The request was rejected because the (<code>XksKeyId</code>) is already associated with a
- *       KMS key in this external key store. Each KMS key in an external key store must be associated
- *       with a different external key.</p>
+ *  <p>The request was rejected because the (<code>XksKeyId</code>) is already associated with
+ *       another KMS key in this external key store. Each KMS key in an external key store must be
+ *       associated with a different external key.</p>
  *
  * @throws {@link XksKeyInvalidConfigurationException} (client fault)
  *  <p>The request was rejected because the external key specified by the <code>XksKeyId</code>

diff --git a/clients/client-kms/src/commands/GetParametersForImportCommand.ts b/clients/client-kms/src/commands/GetParametersForImportCommand.ts
@@ -44,12 +44,10 @@ export interface GetParametersForImportCommandOutput extends GetParametersForImp
  *       operation with an <code>Origin</code> value of <code>EXTERNAL</code> to create a KMS key with
  *       no key material. You can import key material for a symmetric encryption KMS key, HMAC KMS key,
  *       asymmetric encryption KMS key, 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 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
- *         store</a>. You can also use <code>GetParametersForImport</code> to get a 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 material</a> into a KMS key whose key material expired or was
- *       deleted.</p>
+ *       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
+ *       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
+ *       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
+ *         material</a> into a KMS key whose key material expired or was deleted.</p>
  *          <p>
  *             <code>GetParametersForImport</code> returns the items that you need to import your key
  *       material.</p>

diff --git a/clients/client-kms/src/commands/ReplicateKeyCommand.ts b/clients/client-kms/src/commands/ReplicateKeyCommand.ts
@@ -67,7 +67,8 @@ export interface ReplicateKeyCommandOutput extends ReplicateKeyResponse, __Metad
  *         <code>ReplicateKey</code> operation in the primary key's Region and a <a>CreateKey</a> operation in the replica key's Region.</p>
  *          <p>If you replicate a multi-Region primary key with imported key material, the replica key is
  *       created with no key material. You must import the same key material that you imported into the
- *       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>
+ *       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>
  *          <p>To convert a replica key to a primary key, use the <a>UpdatePrimaryRegion</a>
  *       operation.</p>
  *          <note>

diff --git a/clients/client-kms/src/commands/UpdateCustomKeyStoreCommand.ts b/clients/client-kms/src/commands/UpdateCustomKeyStoreCommand.ts
@@ -270,9 +270,8 @@ export interface UpdateCustomKeyStoreCommandOutput extends UpdateCustomKeyStoreR
  *       or in the identification of the external key store proxy.</p>
  *
  * @throws {@link XksProxyInvalidConfigurationException} (client fault)
- *  <p>The request was rejected because the Amazon VPC endpoint service configuration does not fulfill
- *       the requirements for an external key store proxy. For details, see the exception
- *       message.</p>
+ *  <p>The request was rejected because the external key store proxy is not configured correctly.
+ *       To identify the cause, see the error message that accompanies the exception.</p>
  *
  * @throws {@link XksProxyInvalidResponseException} (client fault)
  *  <p></p>
@@ -281,16 +280,15 @@ export interface UpdateCustomKeyStoreCommandOutput extends UpdateCustomKeyStoreR
  *       issue. If you see this error repeatedly, report it to the proxy vendor.</p>
  *
  * @throws {@link XksProxyUriEndpointInUseException} (client fault)
- *  <p>The request was rejected because the concatenation of the <code>XksProxyUriEndpoint</code>
- *       is already associated with an external key store in the Amazon Web Services account and Region. Each
- *       external key store in an account and Region must use a unique external key store proxy
- *       address.</p>
+ *  <p>The request was rejected because the <code>XksProxyUriEndpoint</code> is already
+ *       associated with another external key store in this Amazon Web Services Region. To identify the cause,
+ *       see the error message that accompanies the exception. </p>
  *
  * @throws {@link XksProxyUriInUseException} (client fault)
  *  <p>The request was rejected because the concatenation of the <code>XksProxyUriEndpoint</code>
- *       and <code>XksProxyUriPath</code> is already associated with an external key store in the
- *       Amazon Web Services account and Region. Each external key store in an account and Region must use a unique
- *       external key store proxy API address.</p>
+ *       and <code>XksProxyUriPath</code> is already associated with another external key store in this
+ *       Amazon Web Services Region. Each external key store in a Region must use a unique external key store proxy
+ *       API address.</p>
  *
  * @throws {@link XksProxyUriUnreachableException} (client fault)
  *  <p>KMS was unable to reach the specified <code>XksProxyUriPath</code>. The path must be
@@ -301,13 +299,14 @@ export interface UpdateCustomKeyStoreCommandOutput extends UpdateCustomKeyStoreR
  *
  * @throws {@link XksProxyVpcEndpointServiceInUseException} (client fault)
  *  <p>The request was rejected because the specified Amazon VPC endpoint service is already
- *       associated with an external key store in the Amazon Web Services account and Region. Each external key store
- *       in an Amazon Web Services account and Region must use a different Amazon VPC endpoint service.</p>
+ *       associated with another external key store in this Amazon Web Services Region. Each external key store in a
+ *       Region must use a different Amazon VPC endpoint service.</p>
  *
  * @throws {@link XksProxyVpcEndpointServiceInvalidConfigurationException} (client fault)
  *  <p>The request was rejected because the Amazon VPC endpoint service configuration does not fulfill
- *       the requirements for an external key store proxy. For details, see the exception message and
- *         <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
+ *       the requirements for an external key store. To identify the cause, see the error message that
+ *       accompanies the exception and <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
  *       store.</p>
  *
  * @throws {@link XksProxyVpcEndpointServiceNotFoundException} (client fault)

diff --git a/clients/client-kms/src/models/models_0.ts b/clients/client-kms/src/models/models_0.ts
@@ -745,7 +745,7 @@ export interface CreateCustomKeyStoreRequest {
    *             <li>
    *                <p>An external key store with <code>PUBLIC_ENDPOINT</code> connectivity cannot use the
    *           same <code>XksProxyUriEndpoint</code> value as an external key store with
-   *             <code>VPC_ENDPOINT_SERVICE</code> connectivity in the same Amazon Web Services Region.</p>
+   *             <code>VPC_ENDPOINT_SERVICE</code> connectivity in this Amazon Web Services Region.</p>
    *             </li>
    *             <li>
    *                <p>Each external key store with <code>VPC_ENDPOINT_SERVICE</code> connectivity must have
@@ -921,9 +921,8 @@ export class XksProxyIncorrectAuthenticationCredentialException extends __BaseEx
 
 /**
  * @public
- * <p>The request was rejected because the Amazon VPC endpoint service configuration does not fulfill
- *       the requirements for an external key store proxy. For details, see the exception
- *       message.</p>
+ * <p>The request was rejected because the external key store proxy is not configured correctly.
+ *       To identify the cause, see the error message that accompanies the exception.</p>
  */
 export class XksProxyInvalidConfigurationException extends __BaseException {
   readonly name: "XksProxyInvalidConfigurationException" = "XksProxyInvalidConfigurationException";
@@ -966,10 +965,9 @@ export class XksProxyInvalidResponseException extends __BaseException {
 
 /**
  * @public
- * <p>The request was rejected because the concatenation of the <code>XksProxyUriEndpoint</code>
- *       is already associated with an external key store in the Amazon Web Services account and Region. Each
- *       external key store in an account and Region must use a unique external key store proxy
- *       address.</p>
+ * <p>The request was rejected because the <code>XksProxyUriEndpoint</code> is already
+ *       associated with another external key store in this Amazon Web Services Region. To identify the cause,
+ *       see the error message that accompanies the exception. </p>
  */
 export class XksProxyUriEndpointInUseException extends __BaseException {
   readonly name: "XksProxyUriEndpointInUseException" = "XksProxyUriEndpointInUseException";
@@ -990,9 +988,9 @@ export class XksProxyUriEndpointInUseException extends __BaseException {
 /**
  * @public
  * <p>The request was rejected because the concatenation of the <code>XksProxyUriEndpoint</code>
- *       and <code>XksProxyUriPath</code> is already associated with an external key store in the
- *       Amazon Web Services account and Region. Each external key store in an account and Region must use a unique
- *       external key store proxy API address.</p>
+ *       and <code>XksProxyUriPath</code> is already associated with another external key store in this
+ *       Amazon Web Services Region. Each external key store in a Region must use a unique external key store proxy
+ *       API address.</p>
  */
 export class XksProxyUriInUseException extends __BaseException {
   readonly name: "XksProxyUriInUseException" = "XksProxyUriInUseException";
@@ -1037,8 +1035,8 @@ export class XksProxyUriUnreachableException extends __BaseException {
 /**
  * @public
  * <p>The request was rejected because the specified Amazon VPC endpoint service is already
- *       associated with an external key store in the Amazon Web Services account and Region. Each external key store
- *       in an Amazon Web Services account and Region must use a different Amazon VPC endpoint service.</p>
+ *       associated with another external key store in this Amazon Web Services Region. Each external key store in a
+ *       Region must use a different Amazon VPC endpoint service.</p>
  */
 export class XksProxyVpcEndpointServiceInUseException extends __BaseException {
   readonly name: "XksProxyVpcEndpointServiceInUseException" = "XksProxyVpcEndpointServiceInUseException";
@@ -1059,8 +1057,9 @@ export class XksProxyVpcEndpointServiceInUseException extends __BaseException {
 /**
  * @public
  * <p>The request was rejected because the Amazon VPC endpoint service configuration does not fulfill
- *       the requirements for an external key store proxy. For details, see the exception message and
- *         <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
+ *       the requirements for an external key store. To identify the cause, see the error message that
+ *       accompanies the exception and <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
  *       store.</p>
  */
 export class XksProxyVpcEndpointServiceInvalidConfigurationException extends __BaseException {
@@ -2296,9 +2295,9 @@ export class UnsupportedOperationException extends __BaseException {
 
 /**
  * @public
- * <p>The request was rejected because the (<code>XksKeyId</code>) is already associated with a
- *       KMS key in this external key store. Each KMS key in an external key store must be associated
- *       with a different external key.</p>
+ * <p>The request was rejected because the (<code>XksKeyId</code>) is already associated with
+ *       another KMS key in this external key store. Each KMS key in an external key store must be
+ *       associated with a different external key.</p>
  */
 export class XksKeyAlreadyInUseException extends __BaseException {
   readonly name: "XksKeyAlreadyInUseException" = "XksKeyAlreadyInUseException";