@aws-sdk/client-acm 3.295.0 → 3.297.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.
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ACMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ACMClient";
5
5
  import { PutAccountConfigurationRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutAccountConfigurationCommand}.
8
10
  */
9
11
  export interface PutAccountConfigurationCommandInput extends PutAccountConfigurationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutAccountConfigurationCommand}.
13
17
  */
14
18
  export interface PutAccountConfigurationCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds or modifies account-level configurations in ACM. </p>
18
23
  * <p>The supported configuration option is <code>DaysBeforeExpiry</code>. This option specifies
19
24
  * the number of days prior to certificate expiration when ACM starts generating
@@ -30,6 +35,8 @@ export interface PutAccountConfigurationCommandOutput extends __MetadataBearer {
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param PutAccountConfigurationCommandInput - {@link PutAccountConfigurationCommandInput}
39
+ * @returns {@link PutAccountConfigurationCommandOutput}
33
40
  * @see {@link PutAccountConfigurationCommandInput} for command's `input` shape.
34
41
  * @see {@link PutAccountConfigurationCommandOutput} for command's `response` shape.
35
42
  * @see {@link ACMClientResolvedConfig | config} for ACMClient's `config` shape.
@@ -52,11 +59,20 @@ export interface PutAccountConfigurationCommandOutput extends __MetadataBearer {
52
59
  export declare class PutAccountConfigurationCommand extends $Command<PutAccountConfigurationCommandInput, PutAccountConfigurationCommandOutput, ACMClientResolvedConfig> {
53
60
  readonly input: PutAccountConfigurationCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: PutAccountConfigurationCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ACMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutAccountConfigurationCommandInput, PutAccountConfigurationCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ACMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ACMClient";
5
5
  import { RemoveTagsFromCertificateRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RemoveTagsFromCertificateCommand}.
8
10
  */
9
11
  export interface RemoveTagsFromCertificateCommandInput extends RemoveTagsFromCertificateRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RemoveTagsFromCertificateCommand}.
13
17
  */
14
18
  export interface RemoveTagsFromCertificateCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If
18
23
  * you do not specify the value portion of the tag when calling this function, the tag will be
19
24
  * removed regardless of value. If you specify a value, the tag is removed only if it is
@@ -30,6 +35,8 @@ export interface RemoveTagsFromCertificateCommandOutput extends __MetadataBearer
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param RemoveTagsFromCertificateCommandInput - {@link RemoveTagsFromCertificateCommandInput}
39
+ * @returns {@link RemoveTagsFromCertificateCommandOutput}
33
40
  * @see {@link RemoveTagsFromCertificateCommandInput} for command's `input` shape.
34
41
  * @see {@link RemoveTagsFromCertificateCommandOutput} for command's `response` shape.
35
42
  * @see {@link ACMClientResolvedConfig | config} for ACMClient's `config` shape.
@@ -59,11 +66,20 @@ export interface RemoveTagsFromCertificateCommandOutput extends __MetadataBearer
59
66
  export declare class RemoveTagsFromCertificateCommand extends $Command<RemoveTagsFromCertificateCommandInput, RemoveTagsFromCertificateCommandOutput, ACMClientResolvedConfig> {
60
67
  readonly input: RemoveTagsFromCertificateCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: RemoveTagsFromCertificateCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ACMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RemoveTagsFromCertificateCommandInput, RemoveTagsFromCertificateCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ACMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ACMClient";
5
5
  import { RenewCertificateRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RenewCertificateCommand}.
8
10
  */
9
11
  export interface RenewCertificateCommandInput extends RenewCertificateRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RenewCertificateCommand}.
13
17
  */
14
18
  export interface RenewCertificateCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Renews an eligible ACM certificate. At this time, only exported private certificates can
18
23
  * be renewed with this operation. In order to renew your Amazon Web Services Private CA certificates with ACM, you
19
24
  * must first <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaPermissions.html">grant the ACM
@@ -29,6 +34,8 @@ export interface RenewCertificateCommandOutput extends __MetadataBearer {
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param RenewCertificateCommandInput - {@link RenewCertificateCommandInput}
38
+ * @returns {@link RenewCertificateCommandOutput}
32
39
  * @see {@link RenewCertificateCommandInput} for command's `input` shape.
33
40
  * @see {@link RenewCertificateCommandOutput} for command's `response` shape.
34
41
  * @see {@link ACMClientResolvedConfig | config} for ACMClient's `config` shape.
@@ -45,11 +52,20 @@ export interface RenewCertificateCommandOutput extends __MetadataBearer {
45
52
  export declare class RenewCertificateCommand extends $Command<RenewCertificateCommandInput, RenewCertificateCommandOutput, ACMClientResolvedConfig> {
46
53
  readonly input: RenewCertificateCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: RenewCertificateCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ACMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RenewCertificateCommandInput, RenewCertificateCommandOutput>;
63
+ /**
64
+ * @internal
65
+ */
53
66
  private serialize;
67
+ /**
68
+ * @internal
69
+ */
54
70
  private deserialize;
55
71
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ACMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ACMClient";
5
5
  import { RequestCertificateRequest, RequestCertificateResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RequestCertificateCommand}.
8
10
  */
9
11
  export interface RequestCertificateCommandInput extends RequestCertificateRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RequestCertificateCommand}.
13
17
  */
14
18
  export interface RequestCertificateCommandOutput extends RequestCertificateResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Requests an ACM certificate for use with other Amazon Web Services services. To request an ACM
18
23
  * certificate, you must specify a fully qualified domain name (FQDN) in the
19
24
  * <code>DomainName</code> parameter. You can also specify additional FQDNs in the
@@ -40,6 +45,8 @@ export interface RequestCertificateCommandOutput extends RequestCertificateRespo
40
45
  * const response = await client.send(command);
41
46
  * ```
42
47
  *
48
+ * @param RequestCertificateCommandInput - {@link RequestCertificateCommandInput}
49
+ * @returns {@link RequestCertificateCommandOutput}
43
50
  * @see {@link RequestCertificateCommandInput} for command's `input` shape.
44
51
  * @see {@link RequestCertificateCommandOutput} for command's `response` shape.
45
52
  * @see {@link ACMClientResolvedConfig | config} for ACMClient's `config` shape.
@@ -72,11 +79,20 @@ export interface RequestCertificateCommandOutput extends RequestCertificateRespo
72
79
  export declare class RequestCertificateCommand extends $Command<RequestCertificateCommandInput, RequestCertificateCommandOutput, ACMClientResolvedConfig> {
73
80
  readonly input: RequestCertificateCommandInput;
74
81
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
82
+ /**
83
+ * @public
84
+ */
75
85
  constructor(input: RequestCertificateCommandInput);
76
86
  /**
77
87
  * @internal
78
88
  */
79
89
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ACMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RequestCertificateCommandInput, RequestCertificateCommandOutput>;
90
+ /**
91
+ * @internal
92
+ */
80
93
  private serialize;
94
+ /**
95
+ * @internal
96
+ */
81
97
  private deserialize;
82
98
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ACMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ACMClient";
5
5
  import { ResendValidationEmailRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ResendValidationEmailCommand}.
8
10
  */
9
11
  export interface ResendValidationEmailCommandInput extends ResendValidationEmailRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ResendValidationEmailCommand}.
13
17
  */
14
18
  export interface ResendValidationEmailCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Resends the email that requests domain ownership validation. The domain owner or an
18
23
  * authorized representative must approve the ACM certificate before it can be issued. The
19
24
  * certificate can be approved by clicking a link in the mail to navigate to the Amazon
@@ -33,6 +38,8 @@ export interface ResendValidationEmailCommandOutput extends __MetadataBearer {
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param ResendValidationEmailCommandInput - {@link ResendValidationEmailCommandInput}
42
+ * @returns {@link ResendValidationEmailCommandOutput}
36
43
  * @see {@link ResendValidationEmailCommandInput} for command's `input` shape.
37
44
  * @see {@link ResendValidationEmailCommandOutput} for command's `response` shape.
38
45
  * @see {@link ACMClientResolvedConfig | config} for ACMClient's `config` shape.
@@ -56,11 +63,20 @@ export interface ResendValidationEmailCommandOutput extends __MetadataBearer {
56
63
  export declare class ResendValidationEmailCommand extends $Command<ResendValidationEmailCommandInput, ResendValidationEmailCommandOutput, ACMClientResolvedConfig> {
57
64
  readonly input: ResendValidationEmailCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: ResendValidationEmailCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ACMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ResendValidationEmailCommandInput, ResendValidationEmailCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ACMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ACMClient";
5
5
  import { UpdateCertificateOptionsRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateCertificateOptionsCommand}.
8
10
  */
9
11
  export interface UpdateCertificateOptionsCommandInput extends UpdateCertificateOptionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateCertificateOptionsCommand}.
13
17
  */
14
18
  export interface UpdateCertificateOptionsCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates a certificate. Currently, you can use this function to specify whether to opt in
18
23
  * to or out of recording your certificate in a certificate transparency log. For more
19
24
  * information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency"> Opting Out of
@@ -28,6 +33,8 @@ export interface UpdateCertificateOptionsCommandOutput extends __MetadataBearer
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param UpdateCertificateOptionsCommandInput - {@link UpdateCertificateOptionsCommandInput}
37
+ * @returns {@link UpdateCertificateOptionsCommandOutput}
31
38
  * @see {@link UpdateCertificateOptionsCommandInput} for command's `input` shape.
32
39
  * @see {@link UpdateCertificateOptionsCommandOutput} for command's `response` shape.
33
40
  * @see {@link ACMClientResolvedConfig | config} for ACMClient's `config` shape.
@@ -50,11 +57,20 @@ export interface UpdateCertificateOptionsCommandOutput extends __MetadataBearer
50
57
  export declare class UpdateCertificateOptionsCommand extends $Command<UpdateCertificateOptionsCommandInput, UpdateCertificateOptionsCommandOutput, ACMClientResolvedConfig> {
51
58
  readonly input: UpdateCertificateOptionsCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: UpdateCertificateOptionsCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ACMClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateCertificateOptionsCommandInput, UpdateCertificateOptionsCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from ACM service.
4
6
  */
5
7
  export declare class ACMServiceException extends __ServiceException {