docs(client-acm-pca): Doc-only update to add more information to GetCertificate action.

Author: awstools

clients/client-acm-pca/README.md

@@ -6,22 +6,7 @@
 
 AWS SDK for JavaScript ACMPCA Client for Node.js, Browser and React Native.
 
-<p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions,
-syntax, and usage examples for each of the actions and data types involved in creating
-and managing a private certificate authority (CA) for your organization.</p>
-<p>The documentation for each action shows the API request parameters and the JSON
-response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is
-tailored to the programming language or platform that you prefer. For more information,
-see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p>
-<p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the
-operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates
-depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid
-request because the request exceeds the operation's quota for the number of requests per
-second. When a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request
-rate for APIs. </p>
-<p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,
-log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
-console.</p>
+<p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing a private certificate authority (CA) for your organization.</p> <p>The documentation for each action shows the API request parameters and the JSON response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you prefer. For more information, see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p> <p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid request because the request exceeds the operation's quota for the number of requests per second. When a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request rate for APIs. </p> <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase, log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a> console.</p>
 
 ## Installing
 

clients/client-acm-pca/src/ACMPCA.ts

@@ -498,22 +498,7 @@ export interface ACMPCA {
 }
 
 /**
- * <p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions,
- * 			syntax, and usage examples for each of the actions and data types involved in creating
- * 			and managing a private certificate authority (CA) for your organization.</p>
- *          <p>The documentation for each action shows the API request parameters and the JSON
- * 			response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is
- * 			tailored to the programming language or platform that you prefer. For more information,
- * 			see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p>
- *          <p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the
- * 			operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates
- * 			depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid
- * 			request because the request exceeds the operation's quota for the number of requests per
- * 			second. When a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request
- * 			rate for APIs. </p>
- *          <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,
- * 			log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
- * 			console.</p>
+ * <p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing a private certificate authority (CA) for your organization.</p> <p>The documentation for each action shows the API request parameters and the JSON response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you prefer. For more information, see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p> <p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid request because the request exceeds the operation's quota for the number of requests per second. When a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request rate for APIs. </p> <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase, log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a> console.</p>
  * @public
  */
 export class ACMPCA extends ACMPCAClient implements ACMPCA {}

clients/client-acm-pca/src/ACMPCAClient.ts

@@ -373,22 +373,7 @@ export type ACMPCAClientResolvedConfigType = __SmithyResolvedConfiguration<__Htt
 export interface ACMPCAClientResolvedConfig extends ACMPCAClientResolvedConfigType {}
 
 /**
- * <p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions,
- * 			syntax, and usage examples for each of the actions and data types involved in creating
- * 			and managing a private certificate authority (CA) for your organization.</p>
- *          <p>The documentation for each action shows the API request parameters and the JSON
- * 			response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is
- * 			tailored to the programming language or platform that you prefer. For more information,
- * 			see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p>
- *          <p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the
- * 			operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates
- * 			depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid
- * 			request because the request exceeds the operation's quota for the number of requests per
- * 			second. When a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request
- * 			rate for APIs. </p>
- *          <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,
- * 			log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
- * 			console.</p>
+ * <p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing a private certificate authority (CA) for your organization.</p> <p>The documentation for each action shows the API request parameters and the JSON response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you prefer. For more information, see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p> <p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid request because the request exceeds the operation's quota for the number of requests per second. When a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request rate for APIs. </p> <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase, log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a> console.</p>
  * @public
  */
 export class ACMPCAClient extends __Client<

clients/client-acm-pca/src/commands/CreateCertificateAuthorityAuditReportCommand.ts

@@ -37,15 +37,7 @@ export interface CreateCertificateAuthorityAuditReportCommandOutput
     __MetadataBearer {}
 
 /**
- * <p>Creates an audit report that lists every time that your CA private key is used to issue a certificate. The <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a> and <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a> actions use
- * 			the private key.</p>
- *          <p>To save the audit report to your designated Amazon S3 bucket, you must create a bucket policy that grants Amazon Web Services Private CA permission to access and write to it. For an example policy, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaAuditReport.html#s3-access">Prepare an Amazon S3 bucket for audit reports</a>.</p>
- *          <p>Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption.
- *   For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaAuditReport.html#audit-report-encryption">Encrypting Your Audit
- * 				Reports</a>.</p>
- *          <note>
- *             <p>You can generate a maximum of one report every 30 minutes.</p>
- *          </note>
+ * <p>Creates an audit report that lists every time that your CA private key is used to issue a certificate. The <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a> and <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a> actions use the private key.</p> <p>To save the audit report to your designated Amazon S3 bucket, you must create a bucket policy that grants Amazon Web Services Private CA permission to access and write to it. For an example policy, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaAuditReport.html#s3-access">Prepare an Amazon S3 bucket for audit reports</a>.</p> <p>Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaAuditReport.html#audit-report-encryption">Encrypting Your Audit Reports</a>.</p> <note> <p>You can generate a maximum of one report every 30 minutes.</p> </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -76,8 +68,7 @@ export interface CreateCertificateAuthorityAuditReportCommandOutput
  *  <p>One or more of the specified arguments was not valid.</p>
  *
  * @throws {@link InvalidArnException} (client fault)
- *  <p>The requested Amazon Resource Name (ARN) does not refer to an existing
- * 			resource.</p>
+ *  <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
  *
  * @throws {@link InvalidStateException} (client fault)
  *  <p>The state of the private CA does not allow this action to occur.</p>
@@ -89,8 +80,7 @@ export interface CreateCertificateAuthorityAuditReportCommandOutput
  *  <p>Your request is already in progress.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy
- * 			cannot be found.</p>
+ *  <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.</p>
  *
  * @throws {@link ACMPCAServiceException}
  * <p>Base exception class for all service exceptions from ACMPCA service.</p>

clients/client-acm-pca/src/commands/CreateCertificateAuthorityCommand.ts

@@ -28,27 +28,7 @@ export interface CreateCertificateAuthorityCommandInput extends CreateCertificat
 export interface CreateCertificateAuthorityCommandOutput extends CreateCertificateAuthorityResponse, __MetadataBearer {}
 
 /**
- * <p>Creates a root or subordinate private certificate authority (CA). You must specify the
- * 			CA configuration, an optional configuration for Online Certificate Status Protocol
- * 			(OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional
- * 			idempotency token to avoid accidental creation of multiple CAs. The CA configuration
- * 			specifies the name of the algorithm and key size to be used to create the CA private
- * 			key, the type of signing algorithm that the CA uses, and X.500 subject information. The
- * 			OCSP configuration can optionally specify a custom URL for the OCSP responder. The CRL
- * 			configuration specifies the CRL expiration period in days (the validity period of the
- * 			CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3
- * 			bucket that is included in certificates issued by the CA. If successful, this action
- * 			returns the Amazon Resource Name (ARN) of the CA.</p>
- *          <note>
- *             <p>Both Amazon Web Services Private CA and the IAM principal must have permission to write to
- *                         the S3 bucket that you specify. If the IAM principal making the call
- *                         does not have permission to write to the bucket, then an exception is
- *                         thrown. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
- * 						policies for CRLs in Amazon S3</a>.</p>
- *          </note>
- *          <p>Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption.
- *   For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#crl-encryption">Encrypting Your
- * 			CRLs</a>.</p>
+ * <p>Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, an optional configuration for Online Certificate Status Protocol (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional idempotency token to avoid accidental creation of multiple CAs. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses, and X.500 subject information. The OCSP configuration can optionally specify a custom URL for the OCSP responder. The CRL configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this action returns the Amazon Resource Name (ARN) of the CA.</p> <note> <p>Both Amazon Web Services Private CA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access policies for CRLs in Amazon S3</a>.</p> </note> <p>Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#crl-encryption">Encrypting Your CRLs</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -187,16 +167,13 @@ export interface CreateCertificateAuthorityCommandOutput extends CreateCertifica
  *  <p>One or more of the specified arguments was not valid.</p>
  *
  * @throws {@link InvalidPolicyException} (client fault)
- *  <p>The resource policy is invalid or is missing a required statement. For general
- * 			information about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview of JSON Policies</a>.</p>
+ *  <p>The resource policy is invalid or is missing a required statement. For general information about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview of JSON Policies</a>.</p>
  *
  * @throws {@link InvalidTagException} (client fault)
- *  <p>The tag associated with the CA is not valid. The invalid argument is contained in the
- * 			message field.</p>
+ *  <p>The tag associated with the CA is not valid. The invalid argument is contained in the message field.</p>
  *
  * @throws {@link LimitExceededException} (client fault)
- *  <p>An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to determine
- * 			the quota that was exceeded.</p>
+ *  <p>An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to determine the quota that was exceeded.</p>
  *
  * @throws {@link ACMPCAServiceException}
  * <p>Base exception class for all service exceptions from ACMPCA service.</p>