Skip to content

Commit 0afc7d5

Browse files
author
awstools
committed
feat(client-acm): This update returns additional certificate details such as certificate SANs and allows sorting in the ListCertificates API.
1 parent 0c9f5df commit 0afc7d5

14 files changed

+990
-518
lines changed

clients/client-acm/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@
99

1010
AWS SDK for JavaScript ACM Client for Node.js, Browser and React Native.
1111

12-
<fullname>Amazon Web Services Certificate Manager</fullname>
12+
<fullname>Certificate Manager</fullname>
1313

14-
<p>You can use Amazon Web Services Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites
15-
and applications. For more information about using ACM, see the <a href="https://docs.aws.amazon.com/acm/latest/userguide/">Amazon Web Services Certificate Manager User Guide</a>.</p>
14+
<p>You can use Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites
15+
and applications. For more information about using ACM, see the <a href="https://docs.aws.amazon.com/acm/latest/userguide/">Certificate Manager User Guide</a>.</p>
1616

1717
## Installing
1818

clients/client-acm/src/ACM.ts

Lines changed: 18 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -79,17 +79,16 @@ import {
7979
} from "./commands/UpdateCertificateOptionsCommand";
8080

8181
/**
82-
* <fullname>Amazon Web Services Certificate Manager</fullname>
83-
* <p>You can use Amazon Web Services Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites
84-
* and applications. For more information about using ACM, see the <a href="https://docs.aws.amazon.com/acm/latest/userguide/">Amazon Web Services Certificate Manager User Guide</a>.</p>
82+
* <fullname>Certificate Manager</fullname>
83+
* <p>You can use Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites
84+
* and applications. For more information about using ACM, see the <a href="https://docs.aws.amazon.com/acm/latest/userguide/">Certificate Manager User Guide</a>.</p>
8585
*/
8686
export class ACM extends ACMClient {
8787
/**
8888
* <p>Adds one or more tags to an ACM certificate. Tags are labels that you can use to
8989
* identify and organize your Amazon Web Services resources. Each tag consists of a <code>key</code> and an
9090
* optional <code>value</code>. You specify the certificate on input by its Amazon Resource Name
9191
* (ARN). You specify the tag by using a key-value pair. </p>
92-
*
9392
* <p>You can apply a tag to just one certificate if you want to identify a specific
9493
* characteristic of that certificate, or you can apply the same tag to multiple certificates if
9594
* you want to filter for a common relationship among those certificates. Similarly, you can
@@ -98,7 +97,6 @@ export class ACM extends ACMClient {
9897
* Balancing load balancer to indicate that they are both used by the same website. For more
9998
* information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/tags.html">Tagging ACM
10099
* certificates</a>. </p>
101-
*
102100
* <p>To remove one or more tags, use the <a>RemoveTagsFromCertificate</a> action. To
103101
* view all of the tags that have been applied to the certificate, use the <a>ListTagsForCertificate</a> action. </p>
104102
*/
@@ -172,6 +170,8 @@ export class ACM extends ACMClient {
172170

173171
/**
174172
* <p>Returns detailed metadata about the specified ACM certificate.</p>
173+
* <p>If you have just created a certificate using the <code>RequestCertificate</code> action,
174+
* there is a delay of several seconds before you can retrieve information about it.</p>
175175
*/
176176
public describeCertificate(
177177
args: DescribeCertificateCommandInput,
@@ -241,8 +241,7 @@ export class ACM extends ACMClient {
241241
}
242242

243243
/**
244-
* <p>Returns the account
245-
* configuration options associated with an Amazon Web Services account.</p>
244+
* <p>Returns the account configuration options associated with an Amazon Web Services account.</p>
246245
*/
247246
public getAccountConfiguration(
248247
args: GetAccountConfigurationCommandInput,
@@ -309,21 +308,17 @@ export class ACM extends ACMClient {
309308
}
310309

311310
/**
312-
* <p>Imports a certificate into Amazon Web Services Certificate Manager (ACM) to use with services that are integrated with
311+
* <p>Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with
313312
* ACM. Note that <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-services.html">integrated
314313
* services</a> allow only certificate types and keys they support to be associated with
315314
* their resources. Further, their support differs depending on whether the certificate is
316315
* imported into IAM or into ACM. For more information, see the documentation for each
317316
* service. For more information about importing certificates into ACM, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing
318-
* Certificates</a> in the <i>Amazon Web Services Certificate Manager User Guide</i>. </p>
319-
*
317+
* Certificates</a> in the <i>Certificate Manager User Guide</i>. </p>
320318
* <note>
321319
* <p>ACM does not provide <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html">managed renewal</a> for certificates that you import.</p>
322320
* </note>
323-
*
324321
* <p>Note the following guidelines when importing third party certificates:</p>
325-
*
326-
*
327322
* <ul>
328323
* <li>
329324
* <p>You must enter the private key that matches the certificate you are importing.</p>
@@ -379,7 +374,6 @@ export class ACM extends ACMClient {
379374
* must also be RSA.</p>
380375
* </li>
381376
* </ul>
382-
*
383377
* <p>This operation returns the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
384378
* Resource Name (ARN)</a> of the imported certificate.</p>
385379
*/
@@ -482,12 +476,9 @@ export class ACM extends ACMClient {
482476
}
483477

484478
/**
485-
* <p>Adds or modifies
486-
* account-level configurations in ACM.
487-
* </p>
488-
* <p>The
489-
* supported configuration option is <code>DaysBeforeExpiry</code>. This option specifies the
490-
* number of days prior to certificate expiration when ACM starts generating
479+
* <p>Adds or modifies account-level configurations in ACM. </p>
480+
* <p>The supported configuration option is <code>DaysBeforeExpiry</code>. This option specifies
481+
* the number of days prior to certificate expiration when ACM starts generating
491482
* <code>EventBridge</code> events. ACM sends one event per day per certificate until the
492483
* certificate expires. By default, accounts receive events starting 45 days before certificate
493484
* expiration.</p>
@@ -526,7 +517,6 @@ export class ACM extends ACMClient {
526517
* you do not specify the value portion of the tag when calling this function, the tag will be
527518
* removed regardless of value. If you specify a value, the tag is removed only if it is
528519
* associated with the specified value. </p>
529-
*
530520
* <p>To add tags to a certificate, use the <a>AddTagsToCertificate</a> action. To
531521
* view all of the tags that have been applied to a specific ACM certificate, use the <a>ListTagsForCertificate</a> action. </p>
532522
*/
@@ -561,8 +551,8 @@ export class ACM extends ACMClient {
561551

562552
/**
563553
* <p>Renews an eligible ACM certificate. At this time, only exported private certificates can
564-
* be renewed with this operation. In order to renew your ACM PCA certificates with ACM, you must
565-
* first <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaPermissions.html">grant the ACM
554+
* be renewed with this operation. In order to renew your ACM Private CA certificates with ACM, you
555+
* must first <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaPermissions.html">grant the ACM
566556
* service principal permission to do so</a>. For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/manual-renewal.html">Testing Managed Renewal</a>
567557
* in the ACM User Guide.</p>
568558
*/
@@ -605,12 +595,13 @@ export class ACM extends ACMClient {
605595
* that you own or control the domain. You can use <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html">DNS validation</a> or <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html">email validation</a>.
606596
* We recommend that you use DNS validation. ACM issues public certificates after receiving
607597
* approval from the domain owner. </p>
608-
*
609598
* <note>
610-
* <p>ACM behavior differs from the <a href="https://tools.ietf.org/html/rfc6125#appendix-B.2">https://tools.ietf.org/html/rfc6125#appendix-B.2</a>RFC 6125 specification of the
611-
* certificate validation process. first checks for a subject alternative name, and, if it
612-
* finds one, ignores the common name (CN)</p>
599+
* <p>ACM behavior differs from the <a href="https://datatracker.ietf.org/doc/html/rfc6125#appendix-B.2">RFC 6125</a>
600+
* specification of the certificate validation process. ACM first checks for a Subject
601+
* Alternative Name, and, if it finds one, ignores the common name (CN).</p>
613602
* </note>
603+
* <p>After successful completion of the <code>RequestCertificate</code> action, there is a
604+
* delay of several seconds before you can retrieve information about the new certificate.</p>
614605
*/
615606
public requestCertificate(
616607
args: RequestCertificateCommandInput,

clients/client-acm/src/ACMClient.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -282,9 +282,9 @@ type ACMClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOp
282282
export interface ACMClientResolvedConfig extends ACMClientResolvedConfigType {}
283283

284284
/**
285-
* <fullname>Amazon Web Services Certificate Manager</fullname>
286-
* <p>You can use Amazon Web Services Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites
287-
* and applications. For more information about using ACM, see the <a href="https://docs.aws.amazon.com/acm/latest/userguide/">Amazon Web Services Certificate Manager User Guide</a>.</p>
285+
* <fullname>Certificate Manager</fullname>
286+
* <p>You can use Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites
287+
* and applications. For more information about using ACM, see the <a href="https://docs.aws.amazon.com/acm/latest/userguide/">Certificate Manager User Guide</a>.</p>
288288
*/
289289
export class ACMClient extends __Client<
290290
__HttpHandlerOptions,

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ export interface AddTagsToCertificateCommandOutput extends __MetadataBearer {}
2727
* identify and organize your Amazon Web Services resources. Each tag consists of a <code>key</code> and an
2828
* optional <code>value</code>. You specify the certificate on input by its Amazon Resource Name
2929
* (ARN). You specify the tag by using a key-value pair. </p>
30-
*
3130
* <p>You can apply a tag to just one certificate if you want to identify a specific
3231
* characteristic of that certificate, or you can apply the same tag to multiple certificates if
3332
* you want to filter for a common relationship among those certificates. Similarly, you can
@@ -36,7 +35,6 @@ export interface AddTagsToCertificateCommandOutput extends __MetadataBearer {}
3635
* Balancing load balancer to indicate that they are both used by the same website. For more
3736
* information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/tags.html">Tagging ACM
3837
* certificates</a>. </p>
39-
*
4038
* <p>To remove one or more tags, use the <a>RemoveTagsFromCertificate</a> action. To
4139
* view all of the tags that have been applied to the certificate, use the <a>ListTagsForCertificate</a> action. </p>
4240
* @example

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ export interface DescribeCertificateCommandOutput extends DescribeCertificateRes
2929

3030
/**
3131
* <p>Returns detailed metadata about the specified ACM certificate.</p>
32+
* <p>If you have just created a certificate using the <code>RequestCertificate</code> action,
33+
* there is a delay of several seconds before you can retrieve information about it.</p>
3234
* @example
3335
* Use a bare-bones client and the command you need to make an API call.
3436
* ```javascript

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ export interface GetAccountConfigurationCommandInput {}
2323
export interface GetAccountConfigurationCommandOutput extends GetAccountConfigurationResponse, __MetadataBearer {}
2424

2525
/**
26-
* <p>Returns the account
27-
* configuration options associated with an Amazon Web Services account.</p>
26+
* <p>Returns the account configuration options associated with an Amazon Web Services account.</p>
2827
* @example
2928
* Use a bare-bones client and the command you need to make an API call.
3029
* ```javascript

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

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,21 +28,17 @@ export interface ImportCertificateCommandInput extends ImportCertificateRequest
2828
export interface ImportCertificateCommandOutput extends ImportCertificateResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Imports a certificate into Amazon Web Services Certificate Manager (ACM) to use with services that are integrated with
31+
* <p>Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with
3232
* ACM. Note that <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-services.html">integrated
3333
* services</a> allow only certificate types and keys they support to be associated with
3434
* their resources. Further, their support differs depending on whether the certificate is
3535
* imported into IAM or into ACM. For more information, see the documentation for each
3636
* service. For more information about importing certificates into ACM, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing
37-
* Certificates</a> in the <i>Amazon Web Services Certificate Manager User Guide</i>. </p>
38-
*
37+
* Certificates</a> in the <i>Certificate Manager User Guide</i>. </p>
3938
* <note>
4039
* <p>ACM does not provide <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html">managed renewal</a> for certificates that you import.</p>
4140
* </note>
42-
*
4341
* <p>Note the following guidelines when importing third party certificates:</p>
44-
*
45-
*
4642
* <ul>
4743
* <li>
4844
* <p>You must enter the private key that matches the certificate you are importing.</p>
@@ -98,7 +94,6 @@ export interface ImportCertificateCommandOutput extends ImportCertificateRespons
9894
* must also be RSA.</p>
9995
* </li>
10096
* </ul>
101-
*
10297
* <p>This operation returns the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
10398
* Resource Name (ARN)</a> of the imported certificate.</p>
10499
* @example

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

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,9 @@ export interface PutAccountConfigurationCommandInput extends PutAccountConfigura
2323
export interface PutAccountConfigurationCommandOutput extends __MetadataBearer {}
2424

2525
/**
26-
* <p>Adds or modifies
27-
* account-level configurations in ACM.
28-
* </p>
29-
* <p>The
30-
* supported configuration option is <code>DaysBeforeExpiry</code>. This option specifies the
31-
* number of days prior to certificate expiration when ACM starts generating
26+
* <p>Adds or modifies account-level configurations in ACM. </p>
27+
* <p>The supported configuration option is <code>DaysBeforeExpiry</code>. This option specifies
28+
* the number of days prior to certificate expiration when ACM starts generating
3229
* <code>EventBridge</code> events. ACM sends one event per day per certificate until the
3330
* certificate expires. By default, accounts receive events starting 45 days before certificate
3431
* expiration.</p>

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ export interface RemoveTagsFromCertificateCommandOutput extends __MetadataBearer
3030
* you do not specify the value portion of the tag when calling this function, the tag will be
3131
* removed regardless of value. If you specify a value, the tag is removed only if it is
3232
* associated with the specified value. </p>
33-
*
3433
* <p>To add tags to a certificate, use the <a>AddTagsToCertificate</a> action. To
3534
* view all of the tags that have been applied to a specific ACM certificate, use the <a>ListTagsForCertificate</a> action. </p>
3635
* @example

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ export interface RenewCertificateCommandOutput extends __MetadataBearer {}
2424

2525
/**
2626
* <p>Renews an eligible ACM certificate. At this time, only exported private certificates can
27-
* be renewed with this operation. In order to renew your ACM PCA certificates with ACM, you must
28-
* first <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaPermissions.html">grant the ACM
27+
* be renewed with this operation. In order to renew your ACM Private CA certificates with ACM, you
28+
* must first <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaPermissions.html">grant the ACM
2929
* service principal permission to do so</a>. For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/manual-renewal.html">Testing Managed Renewal</a>
3030
* in the ACM User Guide.</p>
3131
* @example

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,13 @@ export interface RequestCertificateCommandOutput extends RequestCertificateRespo
3737
* that you own or control the domain. You can use <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html">DNS validation</a> or <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html">email validation</a>.
3838
* We recommend that you use DNS validation. ACM issues public certificates after receiving
3939
* approval from the domain owner. </p>
40-
*
4140
* <note>
42-
* <p>ACM behavior differs from the <a href="https://tools.ietf.org/html/rfc6125#appendix-B.2">https://tools.ietf.org/html/rfc6125#appendix-B.2</a>RFC 6125 specification of the
43-
* certificate validation process. first checks for a subject alternative name, and, if it
44-
* finds one, ignores the common name (CN)</p>
41+
* <p>ACM behavior differs from the <a href="https://datatracker.ietf.org/doc/html/rfc6125#appendix-B.2">RFC 6125</a>
42+
* specification of the certificate validation process. ACM first checks for a Subject
43+
* Alternative Name, and, if it finds one, ignores the common name (CN).</p>
4544
* </note>
45+
* <p>After successful completion of the <code>RequestCertificate</code> action, there is a
46+
* delay of several seconds before you can retrieve information about the new certificate.</p>
4647
* @example
4748
* Use a bare-bones client and the command you need to make an API call.
4849
* ```javascript

0 commit comments

Comments
 (0)