@aws-sdk/client-acm 3.179.0 → 3.181.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -16,9 +16,9 @@ import { RequestCertificateCommandInput, RequestCertificateCommandOutput } from
16
16
  import { ResendValidationEmailCommandInput, ResendValidationEmailCommandOutput } from "./commands/ResendValidationEmailCommand";
17
17
  import { UpdateCertificateOptionsCommandInput, UpdateCertificateOptionsCommandOutput } from "./commands/UpdateCertificateOptionsCommand";
18
18
  /**
19
- * <fullname>Amazon Web Services Certificate Manager</fullname>
20
- * <p>You can use Amazon Web Services Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites
21
- * 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>
19
+ * <fullname>Certificate Manager</fullname>
20
+ * <p>You can use Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites
21
+ * 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>
22
22
  */
23
23
  export declare class ACM extends ACMClient {
24
24
  /**
@@ -26,7 +26,6 @@ export declare class ACM extends ACMClient {
26
26
  * identify and organize your Amazon Web Services resources. Each tag consists of a <code>key</code> and an
27
27
  * optional <code>value</code>. You specify the certificate on input by its Amazon Resource Name
28
28
  * (ARN). You specify the tag by using a key-value pair. </p>
29
- *
30
29
  * <p>You can apply a tag to just one certificate if you want to identify a specific
31
30
  * characteristic of that certificate, or you can apply the same tag to multiple certificates if
32
31
  * you want to filter for a common relationship among those certificates. Similarly, you can
@@ -35,7 +34,6 @@ export declare class ACM extends ACMClient {
35
34
  * Balancing load balancer to indicate that they are both used by the same website. For more
36
35
  * information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/tags.html">Tagging ACM
37
36
  * certificates</a>. </p>
38
- *
39
37
  * <p>To remove one or more tags, use the <a>RemoveTagsFromCertificate</a> action. To
40
38
  * view all of the tags that have been applied to the certificate, use the <a>ListTagsForCertificate</a> action. </p>
41
39
  */
@@ -57,6 +55,8 @@ export declare class ACM extends ACMClient {
57
55
  deleteCertificate(args: DeleteCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCertificateCommandOutput) => void): void;
58
56
  /**
59
57
  * <p>Returns detailed metadata about the specified ACM certificate.</p>
58
+ * <p>If you have just created a certificate using the <code>RequestCertificate</code> action,
59
+ * there is a delay of several seconds before you can retrieve information about it.</p>
60
60
  */
61
61
  describeCertificate(args: DescribeCertificateCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCertificateCommandOutput>;
62
62
  describeCertificate(args: DescribeCertificateCommandInput, cb: (err: any, data?: DescribeCertificateCommandOutput) => void): void;
@@ -74,8 +74,7 @@ export declare class ACM extends ACMClient {
74
74
  exportCertificate(args: ExportCertificateCommandInput, cb: (err: any, data?: ExportCertificateCommandOutput) => void): void;
75
75
  exportCertificate(args: ExportCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportCertificateCommandOutput) => void): void;
76
76
  /**
77
- * <p>Returns the account
78
- * configuration options associated with an Amazon Web Services account.</p>
77
+ * <p>Returns the account configuration options associated with an Amazon Web Services account.</p>
79
78
  */
80
79
  getAccountConfiguration(args: GetAccountConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<GetAccountConfigurationCommandOutput>;
81
80
  getAccountConfiguration(args: GetAccountConfigurationCommandInput, cb: (err: any, data?: GetAccountConfigurationCommandOutput) => void): void;
@@ -90,21 +89,17 @@ export declare class ACM extends ACMClient {
90
89
  getCertificate(args: GetCertificateCommandInput, cb: (err: any, data?: GetCertificateCommandOutput) => void): void;
91
90
  getCertificate(args: GetCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCertificateCommandOutput) => void): void;
92
91
  /**
93
- * <p>Imports a certificate into Amazon Web Services Certificate Manager (ACM) to use with services that are integrated with
92
+ * <p>Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with
94
93
  * ACM. Note that <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-services.html">integrated
95
94
  * services</a> allow only certificate types and keys they support to be associated with
96
95
  * their resources. Further, their support differs depending on whether the certificate is
97
96
  * imported into IAM or into ACM. For more information, see the documentation for each
98
97
  * service. For more information about importing certificates into ACM, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing
99
- * Certificates</a> in the <i>Amazon Web Services Certificate Manager User Guide</i>. </p>
100
- *
98
+ * Certificates</a> in the <i>Certificate Manager User Guide</i>. </p>
101
99
  * <note>
102
100
  * <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>
103
101
  * </note>
104
- *
105
102
  * <p>Note the following guidelines when importing third party certificates:</p>
106
- *
107
- *
108
103
  * <ul>
109
104
  * <li>
110
105
  * <p>You must enter the private key that matches the certificate you are importing.</p>
@@ -160,7 +155,6 @@ export declare class ACM extends ACMClient {
160
155
  * must also be RSA.</p>
161
156
  * </li>
162
157
  * </ul>
163
- *
164
158
  * <p>This operation returns the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
165
159
  * Resource Name (ARN)</a> of the imported certificate.</p>
166
160
  */
@@ -185,12 +179,9 @@ export declare class ACM extends ACMClient {
185
179
  listTagsForCertificate(args: ListTagsForCertificateCommandInput, cb: (err: any, data?: ListTagsForCertificateCommandOutput) => void): void;
186
180
  listTagsForCertificate(args: ListTagsForCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForCertificateCommandOutput) => void): void;
187
181
  /**
188
- * <p>Adds or modifies
189
- * account-level configurations in ACM.
190
- * </p>
191
- * <p>The
192
- * supported configuration option is <code>DaysBeforeExpiry</code>. This option specifies the
193
- * number of days prior to certificate expiration when ACM starts generating
182
+ * <p>Adds or modifies account-level configurations in ACM. </p>
183
+ * <p>The supported configuration option is <code>DaysBeforeExpiry</code>. This option specifies
184
+ * the number of days prior to certificate expiration when ACM starts generating
194
185
  * <code>EventBridge</code> events. ACM sends one event per day per certificate until the
195
186
  * certificate expires. By default, accounts receive events starting 45 days before certificate
196
187
  * expiration.</p>
@@ -203,7 +194,6 @@ export declare class ACM extends ACMClient {
203
194
  * you do not specify the value portion of the tag when calling this function, the tag will be
204
195
  * removed regardless of value. If you specify a value, the tag is removed only if it is
205
196
  * associated with the specified value. </p>
206
- *
207
197
  * <p>To add tags to a certificate, use the <a>AddTagsToCertificate</a> action. To
208
198
  * view all of the tags that have been applied to a specific ACM certificate, use the <a>ListTagsForCertificate</a> action. </p>
209
199
  */
@@ -212,8 +202,8 @@ export declare class ACM extends ACMClient {
212
202
  removeTagsFromCertificate(args: RemoveTagsFromCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsFromCertificateCommandOutput) => void): void;
213
203
  /**
214
204
  * <p>Renews an eligible ACM certificate. At this time, only exported private certificates can
215
- * be renewed with this operation. In order to renew your ACM PCA certificates with ACM, you must
216
- * first <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaPermissions.html">grant the ACM
205
+ * be renewed with this operation. In order to renew your ACM Private CA certificates with ACM, you
206
+ * must first <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaPermissions.html">grant the ACM
217
207
  * 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>
218
208
  * in the ACM User Guide.</p>
219
209
  */
@@ -230,12 +220,13 @@ export declare class ACM extends ACMClient {
230
220
  * 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>.
231
221
  * We recommend that you use DNS validation. ACM issues public certificates after receiving
232
222
  * approval from the domain owner. </p>
233
- *
234
223
  * <note>
235
- * <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
236
- * certificate validation process. first checks for a subject alternative name, and, if it
237
- * finds one, ignores the common name (CN)</p>
224
+ * <p>ACM behavior differs from the <a href="https://datatracker.ietf.org/doc/html/rfc6125#appendix-B.2">RFC 6125</a>
225
+ * specification of the certificate validation process. ACM first checks for a Subject
226
+ * Alternative Name, and, if it finds one, ignores the common name (CN).</p>
238
227
  * </note>
228
+ * <p>After successful completion of the <code>RequestCertificate</code> action, there is a
229
+ * delay of several seconds before you can retrieve information about the new certificate.</p>
239
230
  */
240
231
  requestCertificate(args: RequestCertificateCommandInput, options?: __HttpHandlerOptions): Promise<RequestCertificateCommandOutput>;
241
232
  requestCertificate(args: RequestCertificateCommandInput, cb: (err: any, data?: RequestCertificateCommandOutput) => void): void;
@@ -141,9 +141,9 @@ declare type ACMClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpH
141
141
  export interface ACMClientResolvedConfig extends ACMClientResolvedConfigType {
142
142
  }
143
143
  /**
144
- * <fullname>Amazon Web Services Certificate Manager</fullname>
145
- * <p>You can use Amazon Web Services Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites
146
- * 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>
144
+ * <fullname>Certificate Manager</fullname>
145
+ * <p>You can use Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites
146
+ * 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>
147
147
  */
148
148
  export declare class ACMClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ACMClientResolvedConfig> {
149
149
  /**
@@ -11,7 +11,6 @@ export interface AddTagsToCertificateCommandOutput extends __MetadataBearer {
11
11
  * identify and organize your Amazon Web Services resources. Each tag consists of a <code>key</code> and an
12
12
  * optional <code>value</code>. You specify the certificate on input by its Amazon Resource Name
13
13
  * (ARN). You specify the tag by using a key-value pair. </p>
14
- *
15
14
  * <p>You can apply a tag to just one certificate if you want to identify a specific
16
15
  * characteristic of that certificate, or you can apply the same tag to multiple certificates if
17
16
  * you want to filter for a common relationship among those certificates. Similarly, you can
@@ -20,7 +19,6 @@ export interface AddTagsToCertificateCommandOutput extends __MetadataBearer {
20
19
  * Balancing load balancer to indicate that they are both used by the same website. For more
21
20
  * information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/tags.html">Tagging ACM
22
21
  * certificates</a>. </p>
23
- *
24
22
  * <p>To remove one or more tags, use the <a>RemoveTagsFromCertificate</a> action. To
25
23
  * view all of the tags that have been applied to the certificate, use the <a>ListTagsForCertificate</a> action. </p>
26
24
  * @example
@@ -8,6 +8,8 @@ export interface DescribeCertificateCommandOutput extends DescribeCertificateRes
8
8
  }
9
9
  /**
10
10
  * <p>Returns detailed metadata about the specified ACM certificate.</p>
11
+ * <p>If you have just created a certificate using the <code>RequestCertificate</code> action,
12
+ * there is a delay of several seconds before you can retrieve information about it.</p>
11
13
  * @example
12
14
  * Use a bare-bones client and the command you need to make an API call.
13
15
  * ```javascript
@@ -7,8 +7,7 @@ export interface GetAccountConfigurationCommandInput {
7
7
  export interface GetAccountConfigurationCommandOutput extends GetAccountConfigurationResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Returns the account
11
- * configuration options associated with an Amazon Web Services account.</p>
10
+ * <p>Returns the account configuration options associated with an Amazon Web Services account.</p>
12
11
  * @example
13
12
  * Use a bare-bones client and the command you need to make an API call.
14
13
  * ```javascript
@@ -7,21 +7,17 @@ export interface ImportCertificateCommandInput extends ImportCertificateRequest
7
7
  export interface ImportCertificateCommandOutput extends ImportCertificateResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Imports a certificate into Amazon Web Services Certificate Manager (ACM) to use with services that are integrated with
10
+ * <p>Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with
11
11
  * ACM. Note that <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-services.html">integrated
12
12
  * services</a> allow only certificate types and keys they support to be associated with
13
13
  * their resources. Further, their support differs depending on whether the certificate is
14
14
  * imported into IAM or into ACM. For more information, see the documentation for each
15
15
  * service. For more information about importing certificates into ACM, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing
16
- * Certificates</a> in the <i>Amazon Web Services Certificate Manager User Guide</i>. </p>
17
- *
16
+ * Certificates</a> in the <i>Certificate Manager User Guide</i>. </p>
18
17
  * <note>
19
18
  * <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>
20
19
  * </note>
21
- *
22
20
  * <p>Note the following guidelines when importing third party certificates:</p>
23
- *
24
- *
25
21
  * <ul>
26
22
  * <li>
27
23
  * <p>You must enter the private key that matches the certificate you are importing.</p>
@@ -77,7 +73,6 @@ export interface ImportCertificateCommandOutput extends ImportCertificateRespons
77
73
  * must also be RSA.</p>
78
74
  * </li>
79
75
  * </ul>
80
- *
81
76
  * <p>This operation returns the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
82
77
  * Resource Name (ARN)</a> of the imported certificate.</p>
83
78
  * @example
@@ -7,12 +7,9 @@ export interface PutAccountConfigurationCommandInput extends PutAccountConfigura
7
7
  export interface PutAccountConfigurationCommandOutput extends __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Adds or modifies
11
- * account-level configurations in ACM.
12
- * </p>
13
- * <p>The
14
- * supported configuration option is <code>DaysBeforeExpiry</code>. This option specifies the
15
- * number of days prior to certificate expiration when ACM starts generating
10
+ * <p>Adds or modifies account-level configurations in ACM. </p>
11
+ * <p>The supported configuration option is <code>DaysBeforeExpiry</code>. This option specifies
12
+ * the number of days prior to certificate expiration when ACM starts generating
16
13
  * <code>EventBridge</code> events. ACM sends one event per day per certificate until the
17
14
  * certificate expires. By default, accounts receive events starting 45 days before certificate
18
15
  * expiration.</p>
@@ -11,7 +11,6 @@ export interface RemoveTagsFromCertificateCommandOutput extends __MetadataBearer
11
11
  * you do not specify the value portion of the tag when calling this function, the tag will be
12
12
  * removed regardless of value. If you specify a value, the tag is removed only if it is
13
13
  * associated with the specified value. </p>
14
- *
15
14
  * <p>To add tags to a certificate, use the <a>AddTagsToCertificate</a> action. To
16
15
  * view all of the tags that have been applied to a specific ACM certificate, use the <a>ListTagsForCertificate</a> action. </p>
17
16
  * @example
@@ -8,8 +8,8 @@ export interface RenewCertificateCommandOutput extends __MetadataBearer {
8
8
  }
9
9
  /**
10
10
  * <p>Renews an eligible ACM certificate. At this time, only exported private certificates can
11
- * be renewed with this operation. In order to renew your ACM PCA certificates with ACM, you must
12
- * first <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaPermissions.html">grant the ACM
11
+ * be renewed with this operation. In order to renew your ACM Private CA certificates with ACM, you
12
+ * must first <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaPermissions.html">grant the ACM
13
13
  * 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>
14
14
  * in the ACM User Guide.</p>
15
15
  * @example
@@ -16,12 +16,13 @@ export interface RequestCertificateCommandOutput extends RequestCertificateRespo
16
16
  * 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>.
17
17
  * We recommend that you use DNS validation. ACM issues public certificates after receiving
18
18
  * approval from the domain owner. </p>
19
- *
20
19
  * <note>
21
- * <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
22
- * certificate validation process. first checks for a subject alternative name, and, if it
23
- * finds one, ignores the common name (CN)</p>
20
+ * <p>ACM behavior differs from the <a href="https://datatracker.ietf.org/doc/html/rfc6125#appendix-B.2">RFC 6125</a>
21
+ * specification of the certificate validation process. ACM first checks for a Subject
22
+ * Alternative Name, and, if it finds one, ignores the common name (CN).</p>
24
23
  * </note>
24
+ * <p>After successful completion of the <code>RequestCertificate</code> action, there is a
25
+ * delay of several seconds before you can retrieve information about the new certificate.</p>
25
26
  * @example
26
27
  * Use a bare-bones client and the command you need to make an API call.
27
28
  * ```javascript