Skip to content

Commit 7c919df

Browse files
author
awstools
committed
docs(client-acm): Documentation updates, including fixes for xml formatting, broken links, and ListCertificates description.
1 parent 3022150 commit 7c919df

File tree

5 files changed

+53
-31
lines changed

5 files changed

+53
-31
lines changed

clients/client-acm/src/commands/GetCertificateCommand.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,11 @@ export interface GetCertificateCommandInput extends GetCertificateRequest {}
2828
export interface GetCertificateCommandOutput extends GetCertificateResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Retrieves an Amazon-issued certificate and its certificate chain. The chain consists of
32-
* the certificate of the issuing CA and the intermediate certificates of any other subordinate
33-
* CAs. All of the certificates are base64 encoded. You can use <a href="https://wiki.openssl.org/index.php/Command_Line_Utilities">OpenSSL</a> to decode
31+
* <p>Retrieves a certificate and its certificate chain. The certificate may be either a public
32+
* or private certificate issued using the ACM <code>RequestCertificate</code> action, or a
33+
* certificate imported into ACM using the <code>ImportCertificate</code> action. The chain
34+
* consists of the certificate of the issuing CA and the intermediate certificates of any other
35+
* subordinate CAs. All of the certificates are base64 encoded. You can use <a href="https://wiki.openssl.org/index.php/Command_Line_Utilities">OpenSSL</a> to decode
3436
* the certificates and inspect individual fields.</p>
3537
* @example
3638
* Use a bare-bones client and the command you need to make an API call.

clients/client-acm/src/commands/ImportCertificateCommand.ts

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,14 +55,6 @@ export interface ImportCertificateCommandOutput extends ImportCertificateRespons
5555
* <p>The private key must be no larger than 5 KB (5,120 bytes).</p>
5656
* </li>
5757
* <li>
58-
* <p>If the certificate you are importing is not self-signed, you must enter its
59-
* certificate chain.</p>
60-
* </li>
61-
* <li>
62-
* <p>If a certificate chain is included, the issuer must be the subject of one of the
63-
* certificates in the chain.</p>
64-
* </li>
65-
* <li>
6658
* <p>The certificate, private key, and certificate chain must be PEM-encoded.</p>
6759
* </li>
6860
* <li>

clients/client-acm/src/commands/ListCertificatesCommand.ts

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,8 @@ export interface ListCertificatesCommandInput extends ListCertificatesRequest {}
2828
export interface ListCertificatesCommandOutput extends ListCertificatesResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Retrieves a list of certificate ARNs and domain names. You can request that only
32-
* certificates that match a specific status be listed. You can also filter by specific
33-
* attributes of the certificate. Default filtering returns only <code>RSA_2048</code>
34-
* certificates. For more information, see <a>Filters</a>.</p>
31+
* <p>Retrieves a list of certificate ARNs and domain names. By default, the API returns RSA_2048 certificates. To return all certificates in the account, include the <code>keyType</code> filter with the values <code>[RSA_1024, RSA_2048, RSA_3072, RSA_4096, EC_prime256v1, EC_secp384r1, EC_secp521r1]</code>.</p>
32+
* <p>In addition to <code>keyType</code>, you can also filter by the <code>CertificateStatuses</code>, <code>keyUsage</code>, and <code>extendedKeyUsage</code> attributes on the certificate. For more information, see <a>Filters</a>.</p>
3533
* @example
3634
* Use a bare-bones client and the command you need to make an API call.
3735
* ```javascript

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

Lines changed: 39 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -309,11 +309,13 @@ export interface DomainValidation {
309309
* </li>
310310
* <li>
311311
* <p>
312-
* <code></code>SUCCESS</p>
312+
* <code>SUCCESS</code>
313+
* </p>
313314
* </li>
314315
* <li>
315316
* <p>
316-
* <code></code>FAILED</p>
317+
* <code>FAILED</code>
318+
* </p>
317319
* </li>
318320
* </ul>
319321
* @public
@@ -1318,19 +1320,19 @@ export interface CertificateSummary {
13181320
* list contains the domain names that are bound to the public key that is contained in the
13191321
* certificate. The subject alternative names include the canonical domain name (CN) of the
13201322
* certificate and additional domain names that can be used to connect to the website. </p>
1321-
* <p>When called by <a href="https://docs.aws.amazon.com/acm/latestAPIReference/API_ListCertificates.html">ListCertificates</a>, this parameter will only return the first 100 subject alternative
1323+
* <p>When called by <a>ListCertificates</a>, this parameter will only return the first 100 subject alternative
13221324
* names included in the certificate. To display the full list of subject alternative names, use
1323-
* <a href="https://docs.aws.amazon.com/acm/latestAPIReference/API_DescribeCertificate.html">DescribeCertificate</a>.</p>
1325+
* <a>DescribeCertificate</a>.</p>
13241326
* @public
13251327
*/
13261328
SubjectAlternativeNameSummaries?: string[];
13271329

13281330
/**
1329-
* <p>When called by <a href="https://docs.aws.amazon.com/acm/latestAPIReference/API_ListCertificates.html">ListCertificates</a>, indicates whether the full list of subject alternative names has
1331+
* <p>When called by <a>ListCertificates</a>, indicates whether the full list of subject alternative names has
13301332
* been included in the response. If false, the response includes all of the subject alternative
13311333
* names included in the certificate. If true, the response only includes the first 100 subject
13321334
* alternative names included in the certificate. To display the full list of subject alternative
1333-
* names, use <a href="https://docs.aws.amazon.com/acm/latestAPIReference/API_DescribeCertificate.html">DescribeCertificate</a>.</p>
1335+
* names, use <a>DescribeCertificate</a>.</p>
13341336
* @public
13351337
*/
13361338
HasAdditionalSubjectAlternativeNames?: boolean;
@@ -1733,9 +1735,37 @@ export interface RequestCertificateRequest {
17331735
* encrypt data. RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital
17341736
* Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but
17351737
* with greater computing efficiency. However, ECDSA is not supported by all network clients.
1736-
* Some AWS services may require RSA keys, or only support ECDSA keys of a particular size, while
1737-
* others allow the use of either RSA and ECDSA keys to ensure that compatibility is not broken.
1738-
* Check the requirements for the AWS service where you plan to deploy your certificate.</p>
1738+
* Some Amazon Web Services services may require RSA keys, or only support ECDSA keys of a particular size,
1739+
* while others allow the use of either RSA and ECDSA keys to ensure that compatibility is not
1740+
* broken. Check the requirements for the Amazon Web Services service where you plan to deploy your
1741+
* certificate. For more information about selecting an algorithm, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-certificate.html#algorithms">Key
1742+
* algorithms</a>.</p>
1743+
* <note>
1744+
* <p>Algorithms supported for an ACM certificate request include: </p>
1745+
* <ul>
1746+
* <li>
1747+
* <p>
1748+
* <code>RSA_2048</code>
1749+
* </p>
1750+
* </li>
1751+
* <li>
1752+
* <p>
1753+
* <code>EC_prime256v1</code>
1754+
* </p>
1755+
* </li>
1756+
* <li>
1757+
* <p>
1758+
* <code>EC_secp384r1</code>
1759+
* </p>
1760+
* </li>
1761+
* </ul>
1762+
* <p>Other listed algorithms are for imported certificates only. </p>
1763+
* </note>
1764+
* <note>
1765+
* <p>When you request a private PKI certificate signed by a CA from Amazon Web Services Private CA, the
1766+
* specified signing algorithm family (RSA or ECDSA) must match the algorithm family of
1767+
* the CA's secret key.</p>
1768+
* </note>
17391769
* <p>Default: RSA_2048</p>
17401770
* @public
17411771
*/

0 commit comments

Comments
 (0)