You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: clients/client-acm/README.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -9,10 +9,10 @@
9
9
10
10
AWS SDK for JavaScript ACM Client for Node.js, Browser and React Native.
11
11
12
-
<fullname>Amazon Web Services Certificate Manager</fullname>
12
+
<fullname>Certificate Manager</fullname>
13
13
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 <ahref="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 <ahref="https://docs.aws.amazon.com/acm/latest/userguide/">Certificate Manager User Guide</a>.</p>
* <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>
85
85
*/
86
86
exportclassACMextendsACMClient{
87
87
/**
88
88
* <p>Adds one or more tags to an ACM certificate. Tags are labels that you can use to
89
89
* identify and organize your Amazon Web Services resources. Each tag consists of a <code>key</code> and an
90
90
* optional <code>value</code>. You specify the certificate on input by its Amazon Resource Name
91
91
* (ARN). You specify the tag by using a key-value pair. </p>
92
-
*
93
92
* <p>You can apply a tag to just one certificate if you want to identify a specific
94
93
* characteristic of that certificate, or you can apply the same tag to multiple certificates if
95
94
* you want to filter for a common relationship among those certificates. Similarly, you can
@@ -98,7 +97,6 @@ export class ACM extends ACMClient {
98
97
* Balancing load balancer to indicate that they are both used by the same website. For more
99
98
* information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/tags.html">Tagging ACM
100
99
* certificates</a>. </p>
101
-
*
102
100
* <p>To remove one or more tags, use the <a>RemoveTagsFromCertificate</a> action. To
103
101
* view all of the tags that have been applied to the certificate, use the <a>ListTagsForCertificate</a> action. </p>
104
102
*/
@@ -172,6 +170,8 @@ export class ACM extends ACMClient {
172
170
173
171
/**
174
172
* <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>
175
175
*/
176
176
publicdescribeCertificate(
177
177
args: DescribeCertificateCommandInput,
@@ -241,8 +241,7 @@ export class ACM extends ACMClient {
241
241
}
242
242
243
243
/**
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>
246
245
*/
247
246
publicgetAccountConfiguration(
248
247
args: GetAccountConfigurationCommandInput,
@@ -309,21 +308,17 @@ export class ACM extends ACMClient {
309
308
}
310
309
311
310
/**
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
313
312
* ACM. Note that <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-services.html">integrated
314
313
* services</a> allow only certificate types and keys they support to be associated with
315
314
* their resources. Further, their support differs depending on whether the certificate is
316
315
* imported into IAM or into ACM. For more information, see the documentation for each
317
316
* 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>
320
318
* <note>
321
319
* <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>
322
320
* </note>
323
-
*
324
321
* <p>Note the following guidelines when importing third party certificates:</p>
325
-
*
326
-
*
327
322
* <ul>
328
323
* <li>
329
324
* <p>You must enter the private key that matches the certificate you are importing.</p>
@@ -379,7 +374,6 @@ export class ACM extends ACMClient {
379
374
* must also be RSA.</p>
380
375
* </li>
381
376
* </ul>
382
-
*
383
377
* <p>This operation returns the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
384
378
* Resource Name (ARN)</a> of the imported certificate.</p>
385
379
*/
@@ -482,12 +476,9 @@ export class ACM extends ACMClient {
482
476
}
483
477
484
478
/**
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
491
482
* <code>EventBridge</code> events. ACM sends one event per day per certificate until the
492
483
* certificate expires. By default, accounts receive events starting 45 days before certificate
493
484
* expiration.</p>
@@ -526,7 +517,6 @@ export class ACM extends ACMClient {
526
517
* you do not specify the value portion of the tag when calling this function, the tag will be
527
518
* removed regardless of value. If you specify a value, the tag is removed only if it is
528
519
* associated with the specified value. </p>
529
-
*
530
520
* <p>To add tags to a certificate, use the <a>AddTagsToCertificate</a> action. To
531
521
* view all of the tags that have been applied to a specific ACM certificate, use the <a>ListTagsForCertificate</a> action. </p>
532
522
*/
@@ -561,8 +551,8 @@ export class ACM extends ACMClient {
561
551
562
552
/**
563
553
* <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
566
556
* 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>
567
557
* in the ACM User Guide.</p>
568
558
*/
@@ -605,12 +595,13 @@ export class ACM extends ACMClient {
605
595
* 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>.
606
596
* We recommend that you use DNS validation. ACM issues public certificates after receiving
607
597
* approval from the domain owner. </p>
608
-
*
609
598
* <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>
613
602
* </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>
* <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>
* <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
32
32
* ACM. Note that <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-services.html">integrated
33
33
* services</a> allow only certificate types and keys they support to be associated with
34
34
* their resources. Further, their support differs depending on whether the certificate is
35
35
* imported into IAM or into ACM. For more information, see the documentation for each
36
36
* 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>
39
38
* <note>
40
39
* <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>
41
40
* </note>
42
-
*
43
41
* <p>Note the following guidelines when importing third party certificates:</p>
44
-
*
45
-
*
46
42
* <ul>
47
43
* <li>
48
44
* <p>You must enter the private key that matches the certificate you are importing.</p>
* <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
29
29
* 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>
* 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>.
38
38
* We recommend that you use DNS validation. ACM issues public certificates after receiving
39
39
* approval from the domain owner. </p>
40
-
*
41
40
* <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>
45
44
* </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>
46
47
* @example
47
48
* Use a bare-bones client and the command you need to make an API call.
0 commit comments