@aws-sdk/client-acm 3.378.0 → 3.382.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.
@@ -1,4 +1,7 @@
1
1
  import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
2
+ /**
3
+ * @public
4
+ */
2
5
  export interface ClientInputEndpointParameters {
3
6
  region?: string | Provider<string>;
4
7
  useDualstackEndpoint?: boolean | Provider<boolean>;
@@ -7,6 +7,7 @@
7
7
  */
8
8
  export * from "./ACMClient";
9
9
  export * from "./ACM";
10
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
10
11
  export * from "./commands";
11
12
  export * from "./pagination";
12
13
  export * from "./waiters";
@@ -19,10 +19,12 @@ export declare class AccessDeniedException extends __BaseException {
19
19
  */
20
20
  export interface Tag {
21
21
  /**
22
+ * @public
22
23
  * <p>The key of the tag.</p>
23
24
  */
24
25
  Key: string | undefined;
25
26
  /**
27
+ * @public
26
28
  * <p>The value of the tag.</p>
27
29
  */
28
30
  Value?: string;
@@ -32,6 +34,7 @@ export interface Tag {
32
34
  */
33
35
  export interface AddTagsToCertificateRequest {
34
36
  /**
37
+ * @public
35
38
  * <p>String that contains the ARN of the ACM certificate to which the tag is to be applied.
36
39
  * This must be of the form:</p>
37
40
  * <p>
@@ -41,6 +44,7 @@ export interface AddTagsToCertificateRequest {
41
44
  */
42
45
  CertificateArn: string | undefined;
43
46
  /**
47
+ * @public
44
48
  * <p>The key-value pair that defines the tag. The tag value is optional.</p>
45
49
  */
46
50
  Tags: Tag[] | undefined;
@@ -149,14 +153,17 @@ export type RecordType = (typeof RecordType)[keyof typeof RecordType];
149
153
  */
150
154
  export interface ResourceRecord {
151
155
  /**
156
+ * @public
152
157
  * <p>The name of the DNS record to create in your domain. This is supplied by ACM.</p>
153
158
  */
154
159
  Name: string | undefined;
155
160
  /**
161
+ * @public
156
162
  * <p>The type of DNS record. Currently this can be <code>CNAME</code>.</p>
157
163
  */
158
164
  Type: RecordType | string | undefined;
159
165
  /**
166
+ * @public
160
167
  * <p>The value of the CNAME record to add to your DNS database. This is supplied by
161
168
  * ACM.</p>
162
169
  */
@@ -193,19 +200,23 @@ export type DomainStatus = (typeof DomainStatus)[keyof typeof DomainStatus];
193
200
  */
194
201
  export interface DomainValidation {
195
202
  /**
203
+ * @public
196
204
  * <p>A fully qualified domain name (FQDN) in the certificate. For example,
197
205
  * <code>www.example.com</code> or <code>example.com</code>. </p>
198
206
  */
199
207
  DomainName: string | undefined;
200
208
  /**
209
+ * @public
201
210
  * <p>A list of email addresses that ACM used to send domain validation emails.</p>
202
211
  */
203
212
  ValidationEmails?: string[];
204
213
  /**
214
+ * @public
205
215
  * <p>The domain name that ACM used to send domain validation emails.</p>
206
216
  */
207
217
  ValidationDomain?: string;
208
218
  /**
219
+ * @public
209
220
  * <p>The validation status of the domain name. This can be one of the following values:</p>
210
221
  * <ul>
211
222
  * <li>
@@ -225,6 +236,7 @@ export interface DomainValidation {
225
236
  */
226
237
  ValidationStatus?: DomainStatus | string;
227
238
  /**
239
+ * @public
228
240
  * <p>Contains the CNAME record that you add to your DNS database for domain validation. For
229
241
  * more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html">Use DNS to Validate Domain Ownership</a>.</p>
230
242
  * <p>Note: The CNAME information that you need does not include the name of your domain. If you
@@ -236,6 +248,7 @@ export interface DomainValidation {
236
248
  */
237
249
  ResourceRecord?: ResourceRecord;
238
250
  /**
251
+ * @public
239
252
  * <p>Specifies the domain validation method.</p>
240
253
  */
241
254
  ValidationMethod?: ValidationMethod | string;
@@ -270,10 +283,12 @@ export type ExtendedKeyUsageName = (typeof ExtendedKeyUsageName)[keyof typeof Ex
270
283
  */
271
284
  export interface ExtendedKeyUsage {
272
285
  /**
286
+ * @public
273
287
  * <p>The name of an Extended Key Usage value.</p>
274
288
  */
275
289
  Name?: ExtendedKeyUsageName | string;
276
290
  /**
291
+ * @public
277
292
  * <p>An object identifier (OID) for the extension value. OIDs are strings of numbers separated
278
293
  * by periods. The following OIDs are defined in RFC 3280 and RFC 5280. </p>
279
294
  * <ul>
@@ -398,6 +413,7 @@ export type KeyUsageName = (typeof KeyUsageName)[keyof typeof KeyUsageName];
398
413
  */
399
414
  export interface KeyUsage {
400
415
  /**
416
+ * @public
401
417
  * <p>A string value that contains a Key Usage extension name.</p>
402
418
  */
403
419
  Name?: KeyUsageName | string;
@@ -426,6 +442,7 @@ export type CertificateTransparencyLoggingPreference = (typeof CertificateTransp
426
442
  */
427
443
  export interface CertificateOptions {
428
444
  /**
445
+ * @public
429
446
  * <p>You can opt out of certificate transparency logging by specifying the
430
447
  * <code>DISABLED</code> option. Opt in by specifying <code>ENABLED</code>. </p>
431
448
  */
@@ -464,10 +481,12 @@ export type RenewalStatus = (typeof RenewalStatus)[keyof typeof RenewalStatus];
464
481
  */
465
482
  export interface RenewalSummary {
466
483
  /**
484
+ * @public
467
485
  * <p>The status of ACM's <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html">managed renewal</a> of the certificate.</p>
468
486
  */
469
487
  RenewalStatus: RenewalStatus | string | undefined;
470
488
  /**
489
+ * @public
471
490
  * <p>Contains information about the validation of each domain name in the certificate, as it
472
491
  * pertains to ACM's <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html">managed
473
492
  * renewal</a>. This is different from the initial validation that occurs as a result of
@@ -476,10 +495,12 @@ export interface RenewalSummary {
476
495
  */
477
496
  DomainValidationOptions: DomainValidation[] | undefined;
478
497
  /**
498
+ * @public
479
499
  * <p>The reason that a renewal request was unsuccessful.</p>
480
500
  */
481
501
  RenewalStatusReason?: FailureReason | string;
482
502
  /**
503
+ * @public
483
504
  * <p>The time at which the renewal summary was last updated.</p>
484
505
  */
485
506
  UpdatedAt: Date | undefined;
@@ -541,17 +562,20 @@ export type CertificateType = (typeof CertificateType)[keyof typeof CertificateT
541
562
  */
542
563
  export interface CertificateDetail {
543
564
  /**
565
+ * @public
544
566
  * <p>The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see
545
567
  * <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in
546
568
  * the <i>Amazon Web Services General Reference</i>.</p>
547
569
  */
548
570
  CertificateArn?: string;
549
571
  /**
572
+ * @public
550
573
  * <p>The fully qualified domain name for the certificate, such as www.example.com or
551
574
  * example.com.</p>
552
575
  */
553
576
  DomainName?: string;
554
577
  /**
578
+ * @public
555
579
  * <p>One or more domain names (subject alternative names)
556
580
  * included in the certificate. This
557
581
  * list contains the domain names that are bound to the public key that is contained in the
@@ -560,39 +584,47 @@ export interface CertificateDetail {
560
584
  */
561
585
  SubjectAlternativeNames?: string[];
562
586
  /**
587
+ * @public
563
588
  * <p>Contains information about the initial validation of each domain name that occurs as a
564
589
  * result of the <a>RequestCertificate</a> request. This field exists only when the
565
590
  * certificate type is <code>AMAZON_ISSUED</code>. </p>
566
591
  */
567
592
  DomainValidationOptions?: DomainValidation[];
568
593
  /**
594
+ * @public
569
595
  * <p>The serial number of the certificate.</p>
570
596
  */
571
597
  Serial?: string;
572
598
  /**
599
+ * @public
573
600
  * <p>The name of the entity that is associated with the public key contained in the
574
601
  * certificate.</p>
575
602
  */
576
603
  Subject?: string;
577
604
  /**
605
+ * @public
578
606
  * <p>The name of the certificate authority that issued and signed the certificate.</p>
579
607
  */
580
608
  Issuer?: string;
581
609
  /**
610
+ * @public
582
611
  * <p>The time at which the certificate was requested.</p>
583
612
  */
584
613
  CreatedAt?: Date;
585
614
  /**
615
+ * @public
586
616
  * <p>The time at which the certificate was issued. This value exists only when the certificate
587
617
  * type is <code>AMAZON_ISSUED</code>. </p>
588
618
  */
589
619
  IssuedAt?: Date;
590
620
  /**
621
+ * @public
591
622
  * <p>The date and time when the certificate was imported. This value exists only when the
592
623
  * certificate type is <code>IMPORTED</code>. </p>
593
624
  */
594
625
  ImportedAt?: Date;
595
626
  /**
627
+ * @public
596
628
  * <p>The status of the certificate.</p>
597
629
  * <p>A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for
598
630
  * any of the reasons given in the troubleshooting topic <a href="https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting-failed.html">Certificate request fails</a>. ACM makes
@@ -602,43 +634,52 @@ export interface CertificateDetail {
602
634
  */
603
635
  Status?: CertificateStatus | string;
604
636
  /**
637
+ * @public
605
638
  * <p>The time at which the certificate was revoked. This value exists only when the certificate
606
639
  * status is <code>REVOKED</code>. </p>
607
640
  */
608
641
  RevokedAt?: Date;
609
642
  /**
643
+ * @public
610
644
  * <p>The reason the certificate was revoked. This value exists only when the certificate status
611
645
  * is <code>REVOKED</code>. </p>
612
646
  */
613
647
  RevocationReason?: RevocationReason | string;
614
648
  /**
649
+ * @public
615
650
  * <p>The time before which the certificate is not valid.</p>
616
651
  */
617
652
  NotBefore?: Date;
618
653
  /**
654
+ * @public
619
655
  * <p>The time after which the certificate is not valid.</p>
620
656
  */
621
657
  NotAfter?: Date;
622
658
  /**
659
+ * @public
623
660
  * <p>The algorithm that was used to generate the public-private key pair.</p>
624
661
  */
625
662
  KeyAlgorithm?: KeyAlgorithm | string;
626
663
  /**
664
+ * @public
627
665
  * <p>The algorithm that was used to sign the certificate.</p>
628
666
  */
629
667
  SignatureAlgorithm?: string;
630
668
  /**
669
+ * @public
631
670
  * <p>A list of ARNs for the Amazon Web Services resources that are using the certificate. A certificate can
632
671
  * be used by multiple Amazon Web Services resources. </p>
633
672
  */
634
673
  InUseBy?: string[];
635
674
  /**
675
+ * @public
636
676
  * <p>The reason the certificate request failed. This value exists only when the certificate
637
677
  * status is <code>FAILED</code>. For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting.html#troubleshooting-failed">Certificate Request
638
678
  * Failed</a> in the <i>Certificate Manager User Guide</i>. </p>
639
679
  */
640
680
  FailureReason?: FailureReason | string;
641
681
  /**
682
+ * @public
642
683
  * <p>The source of the certificate. For certificates provided by ACM, this value is
643
684
  * <code>AMAZON_ISSUED</code>. For certificates that you imported with <a>ImportCertificate</a>, this value is <code>IMPORTED</code>. ACM does not provide
644
685
  * <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html">managed renewal</a> for
@@ -648,23 +689,27 @@ export interface CertificateDetail {
648
689
  */
649
690
  Type?: CertificateType | string;
650
691
  /**
692
+ * @public
651
693
  * <p>Contains information about the status of ACM's <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html">managed renewal</a> for the certificate. This field
652
694
  * exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>
653
695
  */
654
696
  RenewalSummary?: RenewalSummary;
655
697
  /**
698
+ * @public
656
699
  * <p>A list of Key Usage X.509 v3 extension objects. Each object is a string value that
657
700
  * identifies the purpose of the public key contained in the certificate. Possible extension
658
701
  * values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.</p>
659
702
  */
660
703
  KeyUsages?: KeyUsage[];
661
704
  /**
705
+ * @public
662
706
  * <p>Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a
663
707
  * purpose for which the certificate public key can be used and consists of a name and an object
664
708
  * identifier (OID). </p>
665
709
  */
666
710
  ExtendedKeyUsages?: ExtendedKeyUsage[];
667
711
  /**
712
+ * @public
668
713
  * <p>The Amazon Resource Name (ARN) of the private certificate authority (CA) that issued the
669
714
  * certificate. This has the following format: </p>
670
715
  * <p>
@@ -673,12 +718,14 @@ export interface CertificateDetail {
673
718
  */
674
719
  CertificateAuthorityArn?: string;
675
720
  /**
721
+ * @public
676
722
  * <p>Specifies whether the certificate is eligible for renewal. At this time, only exported
677
723
  * private certificates can be renewed with the <a>RenewCertificate</a>
678
724
  * command.</p>
679
725
  */
680
726
  RenewalEligibility?: RenewalEligibility | string;
681
727
  /**
728
+ * @public
682
729
  * <p>Value that specifies whether to add the certificate to a transparency log. Certificate
683
730
  * transparency makes it possible to detect SSL certificates that have been mistakenly or
684
731
  * maliciously issued. A browser might respond to certificate that has not been logged by showing
@@ -704,6 +751,7 @@ export declare class ConflictException extends __BaseException {
704
751
  */
705
752
  export interface DeleteCertificateRequest {
706
753
  /**
754
+ * @public
707
755
  * <p>String that contains the ARN of the ACM certificate to be deleted. This must be of the
708
756
  * form:</p>
709
757
  * <p>
@@ -731,6 +779,7 @@ export declare class ResourceInUseException extends __BaseException {
731
779
  */
732
780
  export interface DescribeCertificateRequest {
733
781
  /**
782
+ * @public
734
783
  * <p>The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the following
735
784
  * form:</p>
736
785
  * <p>
@@ -745,6 +794,7 @@ export interface DescribeCertificateRequest {
745
794
  */
746
795
  export interface DescribeCertificateResponse {
747
796
  /**
797
+ * @public
748
798
  * <p>Metadata about an ACM certificate.</p>
749
799
  */
750
800
  Certificate?: CertificateDetail;
@@ -754,6 +804,7 @@ export interface DescribeCertificateResponse {
754
804
  */
755
805
  export interface ExportCertificateRequest {
756
806
  /**
807
+ * @public
757
808
  * <p>An Amazon Resource Name (ARN) of the issued certificate. This must be of the form:</p>
758
809
  * <p>
759
810
  * <code>arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012</code>
@@ -761,6 +812,7 @@ export interface ExportCertificateRequest {
761
812
  */
762
813
  CertificateArn: string | undefined;
763
814
  /**
815
+ * @public
764
816
  * <p>Passphrase to associate with the encrypted exported private key. </p>
765
817
  * <note>
766
818
  * <p>When creating your passphrase, you can use any ASCII character except #, $, or %.</p>
@@ -779,15 +831,18 @@ export interface ExportCertificateRequest {
779
831
  */
780
832
  export interface ExportCertificateResponse {
781
833
  /**
834
+ * @public
782
835
  * <p>The base64 PEM-encoded certificate.</p>
783
836
  */
784
837
  Certificate?: string;
785
838
  /**
839
+ * @public
786
840
  * <p>The base64 PEM-encoded certificate chain. This does not include the certificate that you
787
841
  * are exporting.</p>
788
842
  */
789
843
  CertificateChain?: string;
790
844
  /**
845
+ * @public
791
846
  * <p>The encrypted private key associated with the public key in the certificate. The key is
792
847
  * output in PKCS #8 format and is base64 PEM-encoded. </p>
793
848
  */
@@ -812,6 +867,7 @@ export declare class RequestInProgressException extends __BaseException {
812
867
  */
813
868
  export interface ExpiryEventsConfiguration {
814
869
  /**
870
+ * @public
815
871
  * <p>Specifies the number of days prior to certificate expiration when ACM starts generating
816
872
  * <code>EventBridge</code> events. ACM sends one event per day per certificate until the
817
873
  * certificate expires. By default, accounts receive events starting 45 days before certificate
@@ -824,6 +880,7 @@ export interface ExpiryEventsConfiguration {
824
880
  */
825
881
  export interface GetAccountConfigurationResponse {
826
882
  /**
883
+ * @public
827
884
  * <p>Expiration events configuration options associated with the Amazon Web Services account.</p>
828
885
  */
829
886
  ExpiryEvents?: ExpiryEventsConfiguration;
@@ -833,6 +890,7 @@ export interface GetAccountConfigurationResponse {
833
890
  */
834
891
  export interface GetCertificateRequest {
835
892
  /**
893
+ * @public
836
894
  * <p>String that contains a certificate ARN in the following format:</p>
837
895
  * <p>
838
896
  * <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code>
@@ -846,10 +904,12 @@ export interface GetCertificateRequest {
846
904
  */
847
905
  export interface GetCertificateResponse {
848
906
  /**
907
+ * @public
849
908
  * <p>The ACM-issued certificate corresponding to the ARN specified as input.</p>
850
909
  */
851
910
  Certificate?: string;
852
911
  /**
912
+ * @public
853
913
  * <p>Certificates forming the requested certificate's chain of trust. The chain consists of the
854
914
  * certificate of the issuing CA and the intermediate certificates of any other subordinate CAs.
855
915
  * </p>
@@ -861,24 +921,29 @@ export interface GetCertificateResponse {
861
921
  */
862
922
  export interface ImportCertificateRequest {
863
923
  /**
924
+ * @public
864
925
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name
865
926
  * (ARN)</a> of an imported certificate to replace. To import a new certificate, omit this
866
927
  * field. </p>
867
928
  */
868
929
  CertificateArn?: string;
869
930
  /**
931
+ * @public
870
932
  * <p>The certificate to import.</p>
871
933
  */
872
934
  Certificate: Uint8Array | undefined;
873
935
  /**
936
+ * @public
874
937
  * <p>The private key that matches the public key in the certificate.</p>
875
938
  */
876
939
  PrivateKey: Uint8Array | undefined;
877
940
  /**
941
+ * @public
878
942
  * <p>The PEM encoded certificate chain.</p>
879
943
  */
880
944
  CertificateChain?: Uint8Array;
881
945
  /**
946
+ * @public
882
947
  * <p>One or more resource tags to associate with the imported certificate. </p>
883
948
  * <p>Note: You cannot apply tags when reimporting a certificate.</p>
884
949
  */
@@ -889,6 +954,7 @@ export interface ImportCertificateRequest {
889
954
  */
890
955
  export interface ImportCertificateResponse {
891
956
  /**
957
+ * @public
892
958
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name
893
959
  * (ARN)</a> of the imported certificate.</p>
894
960
  */
@@ -925,14 +991,17 @@ export declare class InvalidArgsException extends __BaseException {
925
991
  */
926
992
  export interface Filters {
927
993
  /**
994
+ * @public
928
995
  * <p>Specify one or more <a>ExtendedKeyUsage</a> extension values.</p>
929
996
  */
930
997
  extendedKeyUsage?: (ExtendedKeyUsageName | string)[];
931
998
  /**
999
+ * @public
932
1000
  * <p>Specify one or more <a>KeyUsage</a> extension values.</p>
933
1001
  */
934
1002
  keyUsage?: (KeyUsageName | string)[];
935
1003
  /**
1004
+ * @public
936
1005
  * <p>Specify one or more algorithms that can be used to generate key pairs.</p>
937
1006
  * <p>Default filtering returns only <code>RSA_1024</code> and <code>RSA_2048</code>
938
1007
  * certificates that have at least one domain. To return other certificate types, provide the
@@ -970,21 +1039,25 @@ export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
970
1039
  */
971
1040
  export interface ListCertificatesRequest {
972
1041
  /**
1042
+ * @public
973
1043
  * <p>Filter the certificate list by status value.</p>
974
1044
  */
975
1045
  CertificateStatuses?: (CertificateStatus | string)[];
976
1046
  /**
1047
+ * @public
977
1048
  * <p>Filter the certificate list. For more information, see the <a>Filters</a>
978
1049
  * structure.</p>
979
1050
  */
980
1051
  Includes?: Filters;
981
1052
  /**
1053
+ * @public
982
1054
  * <p>Use this parameter only when paginating results and only in a subsequent request after you
983
1055
  * receive a response with truncated results. Set it to the value of <code>NextToken</code> from
984
1056
  * the response you just received.</p>
985
1057
  */
986
1058
  NextToken?: string;
987
1059
  /**
1060
+ * @public
988
1061
  * <p>Use this parameter when paginating results to specify the maximum number of items to
989
1062
  * return in the response. If additional items exist beyond the number you specify, the
990
1063
  * <code>NextToken</code> element is sent in the response. Use this <code>NextToken</code>
@@ -992,11 +1065,13 @@ export interface ListCertificatesRequest {
992
1065
  */
993
1066
  MaxItems?: number;
994
1067
  /**
1068
+ * @public
995
1069
  * <p>Specifies the field to sort results by. If you specify <code>SortBy</code>, you must also
996
1070
  * specify <code>SortOrder</code>.</p>
997
1071
  */
998
1072
  SortBy?: SortBy | string;
999
1073
  /**
1074
+ * @public
1000
1075
  * <p>Specifies the order of sorted results. If you specify <code>SortOrder</code>, you must
1001
1076
  * also specify <code>SortBy</code>.</p>
1002
1077
  */
@@ -1009,6 +1084,7 @@ export interface ListCertificatesRequest {
1009
1084
  */
1010
1085
  export interface CertificateSummary {
1011
1086
  /**
1087
+ * @public
1012
1088
  * <p>Amazon Resource Name (ARN) of the certificate. This is of the form:</p>
1013
1089
  * <p>
1014
1090
  * <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code>
@@ -1017,11 +1093,13 @@ export interface CertificateSummary {
1017
1093
  */
1018
1094
  CertificateArn?: string;
1019
1095
  /**
1096
+ * @public
1020
1097
  * <p>Fully qualified domain name (FQDN), such as www.example.com or example.com, for the
1021
1098
  * certificate.</p>
1022
1099
  */
1023
1100
  DomainName?: string;
1024
1101
  /**
1102
+ * @public
1025
1103
  * <p>One or more domain names (subject alternative names)
1026
1104
  * included in the certificate. This
1027
1105
  * list contains the domain names that are bound to the public key that is contained in the
@@ -1033,6 +1111,7 @@ export interface CertificateSummary {
1033
1111
  */
1034
1112
  SubjectAlternativeNameSummaries?: string[];
1035
1113
  /**
1114
+ * @public
1036
1115
  * <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
1037
1116
  * been included in the response. If false, the response includes all of the subject alternative
1038
1117
  * names included in the certificate. If true, the response only includes the first 100 subject
@@ -1041,6 +1120,7 @@ export interface CertificateSummary {
1041
1120
  */
1042
1121
  HasAdditionalSubjectAlternativeNames?: boolean;
1043
1122
  /**
1123
+ * @public
1044
1124
  * <p>The status of the certificate.</p>
1045
1125
  * <p>A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for
1046
1126
  * any of the reasons given in the troubleshooting topic <a href="https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting-failed.html">Certificate request fails</a>. ACM makes
@@ -1050,6 +1130,7 @@ export interface CertificateSummary {
1050
1130
  */
1051
1131
  Status?: CertificateStatus | string;
1052
1132
  /**
1133
+ * @public
1053
1134
  * <p>The source of the certificate. For certificates provided by ACM, this value is
1054
1135
  * <code>AMAZON_ISSUED</code>. For certificates that you imported with <a>ImportCertificate</a>, this value is <code>IMPORTED</code>. ACM does not provide
1055
1136
  * <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html">managed renewal</a> for
@@ -1059,59 +1140,71 @@ export interface CertificateSummary {
1059
1140
  */
1060
1141
  Type?: CertificateType | string;
1061
1142
  /**
1143
+ * @public
1062
1144
  * <p>The algorithm that was used to generate the public-private key pair.</p>
1063
1145
  */
1064
1146
  KeyAlgorithm?: KeyAlgorithm | string;
1065
1147
  /**
1148
+ * @public
1066
1149
  * <p>A list of Key Usage X.509 v3 extension objects. Each object is a string value that
1067
1150
  * identifies the purpose of the public key contained in the certificate. Possible extension
1068
1151
  * values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.</p>
1069
1152
  */
1070
1153
  KeyUsages?: (KeyUsageName | string)[];
1071
1154
  /**
1155
+ * @public
1072
1156
  * <p>Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a
1073
1157
  * purpose for which the certificate public key can be used and consists of a name and an object
1074
1158
  * identifier (OID). </p>
1075
1159
  */
1076
1160
  ExtendedKeyUsages?: (ExtendedKeyUsageName | string)[];
1077
1161
  /**
1162
+ * @public
1078
1163
  * <p>Indicates whether the certificate is currently in use by any Amazon Web Services resources.</p>
1079
1164
  */
1080
1165
  InUse?: boolean;
1081
1166
  /**
1167
+ * @public
1082
1168
  * <p>Indicates whether the certificate has been exported. This value exists only when the
1083
1169
  * certificate type is <code>PRIVATE</code>.</p>
1084
1170
  */
1085
1171
  Exported?: boolean;
1086
1172
  /**
1173
+ * @public
1087
1174
  * <p>Specifies whether the certificate is eligible for renewal. At this time, only exported
1088
1175
  * private certificates can be renewed with the <a>RenewCertificate</a>
1089
1176
  * command.</p>
1090
1177
  */
1091
1178
  RenewalEligibility?: RenewalEligibility | string;
1092
1179
  /**
1180
+ * @public
1093
1181
  * <p>The time before which the certificate is not valid.</p>
1094
1182
  */
1095
1183
  NotBefore?: Date;
1096
1184
  /**
1185
+ * @public
1097
1186
  * <p>The time after which the certificate is not valid.</p>
1098
1187
  */
1099
1188
  NotAfter?: Date;
1100
1189
  /**
1190
+ * @public
1101
1191
  * <p>The time at which the certificate was requested.</p>
1102
1192
  */
1103
1193
  CreatedAt?: Date;
1104
1194
  /**
1195
+ * @public
1105
1196
  * <p>The time at which the certificate was issued. This value exists only when the certificate
1106
1197
  * type is <code>AMAZON_ISSUED</code>. </p>
1107
1198
  */
1108
1199
  IssuedAt?: Date;
1109
1200
  /**
1201
+ * @public
1110
1202
  * <p>The date and time when the certificate was imported. This value exists only when the
1111
1203
  * certificate type is <code>IMPORTED</code>. </p>
1112
1204
  */
1113
1205
  ImportedAt?: Date;
1114
1206
  /**
1207
+ * @public
1115
1208
  * <p>The time at which the certificate was revoked. This value exists only when the certificate
1116
1209
  * status is <code>REVOKED</code>. </p>
1117
1210
  */
@@ -1122,11 +1215,13 @@ export interface CertificateSummary {
1122
1215
  */
1123
1216
  export interface ListCertificatesResponse {
1124
1217
  /**
1218
+ * @public
1125
1219
  * <p>When the list is truncated, this value is present and contains the value to use for the
1126
1220
  * <code>NextToken</code> parameter in a subsequent pagination request.</p>
1127
1221
  */
1128
1222
  NextToken?: string;
1129
1223
  /**
1224
+ * @public
1130
1225
  * <p>A list of ACM certificates.</p>
1131
1226
  */
1132
1227
  CertificateSummaryList?: CertificateSummary[];
@@ -1148,6 +1243,7 @@ export declare class ValidationException extends __BaseException {
1148
1243
  */
1149
1244
  export interface ListTagsForCertificateRequest {
1150
1245
  /**
1246
+ * @public
1151
1247
  * <p>String that contains the ARN of the ACM certificate for which you want to list the tags.
1152
1248
  * This must have the following form:</p>
1153
1249
  * <p>
@@ -1162,6 +1258,7 @@ export interface ListTagsForCertificateRequest {
1162
1258
  */
1163
1259
  export interface ListTagsForCertificateResponse {
1164
1260
  /**
1261
+ * @public
1165
1262
  * <p>The key-value pairs that define the applied tags.</p>
1166
1263
  */
1167
1264
  Tags?: Tag[];
@@ -1171,10 +1268,12 @@ export interface ListTagsForCertificateResponse {
1171
1268
  */
1172
1269
  export interface PutAccountConfigurationRequest {
1173
1270
  /**
1271
+ * @public
1174
1272
  * <p>Specifies expiration events associated with an account.</p>
1175
1273
  */
1176
1274
  ExpiryEvents?: ExpiryEventsConfiguration;
1177
1275
  /**
1276
+ * @public
1178
1277
  * <p>Customer-chosen string used to distinguish between calls to
1179
1278
  * <code>PutAccountConfiguration</code>. Idempotency tokens time out after one hour. If you
1180
1279
  * call <code>PutAccountConfiguration</code> multiple times with the same unexpired idempotency
@@ -1188,6 +1287,7 @@ export interface PutAccountConfigurationRequest {
1188
1287
  */
1189
1288
  export interface RemoveTagsFromCertificateRequest {
1190
1289
  /**
1290
+ * @public
1191
1291
  * <p>String that contains the ARN of the ACM Certificate with one or more tags that you want
1192
1292
  * to remove. This must be of the form:</p>
1193
1293
  * <p>
@@ -1197,6 +1297,7 @@ export interface RemoveTagsFromCertificateRequest {
1197
1297
  */
1198
1298
  CertificateArn: string | undefined;
1199
1299
  /**
1300
+ * @public
1200
1301
  * <p>The key-value pair that defines the tag to remove.</p>
1201
1302
  */
1202
1303
  Tags: Tag[] | undefined;
@@ -1206,6 +1307,7 @@ export interface RemoveTagsFromCertificateRequest {
1206
1307
  */
1207
1308
  export interface RenewCertificateRequest {
1208
1309
  /**
1310
+ * @public
1209
1311
  * <p>String that contains the ARN of the ACM certificate to be renewed. This must be of the
1210
1312
  * form:</p>
1211
1313
  * <p>
@@ -1235,10 +1337,12 @@ export declare class InvalidDomainValidationOptionsException extends __BaseExcep
1235
1337
  */
1236
1338
  export interface DomainValidationOption {
1237
1339
  /**
1340
+ * @public
1238
1341
  * <p>A fully qualified domain name (FQDN) in the certificate request.</p>
1239
1342
  */
1240
1343
  DomainName: string | undefined;
1241
1344
  /**
1345
+ * @public
1242
1346
  * <p>The domain name that you want ACM to use to send you validation emails. This domain name
1243
1347
  * is the suffix of the email addresses that you want ACM to use. This must be the same as the
1244
1348
  * <code>DomainName</code> value or a superdomain of the <code>DomainName</code> value. For
@@ -1270,6 +1374,7 @@ export interface DomainValidationOption {
1270
1374
  */
1271
1375
  export interface RequestCertificateRequest {
1272
1376
  /**
1377
+ * @public
1273
1378
  * <p>Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with
1274
1379
  * an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects
1275
1380
  * several sites in the same domain. For example, *.example.com protects www.example.com,
@@ -1281,12 +1386,14 @@ export interface RequestCertificateRequest {
1281
1386
  */
1282
1387
  DomainName: string | undefined;
1283
1388
  /**
1389
+ * @public
1284
1390
  * <p>The method you want to use if you are requesting a public certificate to validate that you
1285
1391
  * own or control domain. You can <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html">validate with DNS</a> or <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html">validate with
1286
1392
  * email</a>. We recommend that you use DNS validation. </p>
1287
1393
  */
1288
1394
  ValidationMethod?: ValidationMethod | string;
1289
1395
  /**
1396
+ * @public
1290
1397
  * <p>Additional FQDNs to be included in the Subject Alternative Name extension of the ACM
1291
1398
  * certificate. For example, add the name www.example.net to a certificate for which the
1292
1399
  * <code>DomainName</code> field is www.example.com if users can reach your site by using
@@ -1317,6 +1424,7 @@ export interface RequestCertificateRequest {
1317
1424
  */
1318
1425
  SubjectAlternativeNames?: string[];
1319
1426
  /**
1427
+ * @public
1320
1428
  * <p>Customer chosen string that can be used to distinguish between calls to
1321
1429
  * <code>RequestCertificate</code>. Idempotency tokens time out after one hour. Therefore, if
1322
1430
  * you call <code>RequestCertificate</code> multiple times with the same idempotency token within
@@ -1326,11 +1434,13 @@ export interface RequestCertificateRequest {
1326
1434
  */
1327
1435
  IdempotencyToken?: string;
1328
1436
  /**
1437
+ * @public
1329
1438
  * <p>The domain name that you want ACM to use to send you emails so that you can validate
1330
1439
  * domain ownership.</p>
1331
1440
  */
1332
1441
  DomainValidationOptions?: DomainValidationOption[];
1333
1442
  /**
1443
+ * @public
1334
1444
  * <p>Currently, you can use this parameter to specify whether to add the certificate to a
1335
1445
  * certificate transparency log. Certificate transparency makes it possible to detect SSL/TLS
1336
1446
  * certificates that have been mistakenly or maliciously issued. Certificates that have not been
@@ -1338,6 +1448,7 @@ export interface RequestCertificateRequest {
1338
1448
  */
1339
1449
  Options?: CertificateOptions;
1340
1450
  /**
1451
+ * @public
1341
1452
  * <p>The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used
1342
1453
  * to issue the certificate. If you do not provide an ARN and you are trying to request a private
1343
1454
  * certificate, ACM will attempt to issue a public certificate. For more information about
@@ -1348,10 +1459,12 @@ export interface RequestCertificateRequest {
1348
1459
  */
1349
1460
  CertificateAuthorityArn?: string;
1350
1461
  /**
1462
+ * @public
1351
1463
  * <p>One or more resource tags to associate with the certificate.</p>
1352
1464
  */
1353
1465
  Tags?: Tag[];
1354
1466
  /**
1467
+ * @public
1355
1468
  * <p>Specifies the algorithm of the public and private key pair that your certificate uses to
1356
1469
  * encrypt data. RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital
1357
1470
  * Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but
@@ -1368,6 +1481,7 @@ export interface RequestCertificateRequest {
1368
1481
  */
1369
1482
  export interface RequestCertificateResponse {
1370
1483
  /**
1484
+ * @public
1371
1485
  * <p>String that contains the ARN of the issued certificate. This must be of the form:</p>
1372
1486
  * <p>
1373
1487
  * <code>arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012</code>
@@ -1392,6 +1506,7 @@ export declare class InvalidStateException extends __BaseException {
1392
1506
  */
1393
1507
  export interface ResendValidationEmailRequest {
1394
1508
  /**
1509
+ * @public
1395
1510
  * <p>String that contains the ARN of the requested certificate. The certificate ARN is
1396
1511
  * generated and returned by the <a>RequestCertificate</a> action as soon as the
1397
1512
  * request is made. By default, using this parameter causes email to be sent to all top-level
@@ -1402,11 +1517,13 @@ export interface ResendValidationEmailRequest {
1402
1517
  */
1403
1518
  CertificateArn: string | undefined;
1404
1519
  /**
1520
+ * @public
1405
1521
  * <p>The fully qualified domain name (FQDN) of the certificate that needs to be
1406
1522
  * validated.</p>
1407
1523
  */
1408
1524
  Domain: string | undefined;
1409
1525
  /**
1526
+ * @public
1410
1527
  * <p>The base validation domain that will act as the suffix of the email addresses that are
1411
1528
  * used to send the emails. This must be the same as the <code>Domain</code> value or a
1412
1529
  * superdomain of the <code>Domain</code> value. For example, if you requested a certificate for
@@ -1438,6 +1555,7 @@ export interface ResendValidationEmailRequest {
1438
1555
  */
1439
1556
  export interface UpdateCertificateOptionsRequest {
1440
1557
  /**
1558
+ * @public
1441
1559
  * <p>ARN of the requested certificate to update. This must be of the form:</p>
1442
1560
  * <p>
1443
1561
  * <code>arn:aws:acm:us-east-1:<i>account</i>:certificate/<i>12345678-1234-1234-1234-123456789012</i>
@@ -1446,6 +1564,7 @@ export interface UpdateCertificateOptionsRequest {
1446
1564
  */
1447
1565
  CertificateArn: string | undefined;
1448
1566
  /**
1567
+ * @public
1449
1568
  * <p>Use to update the options for your certificate. Currently, you can specify whether to add
1450
1569
  * your certificate to a transparency log. Certificate transparency makes it possible to detect
1451
1570
  * SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have
@@ -1,5 +1,6 @@
1
1
  export * from "./ACMClient";
2
2
  export * from "./ACM";
3
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
3
4
  export * from "./commands";
4
5
  export * from "./pagination";
5
6
  export * from "./waiters";
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-acm",
3
3
  "description": "AWS SDK for JavaScript Acm Client for Node.js, Browser and React Native",
4
- "version": "3.378.0",
4
+ "version": "3.382.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.378.0",
25
- "@aws-sdk/credential-provider-node": "3.378.0",
26
- "@aws-sdk/middleware-host-header": "3.378.0",
24
+ "@aws-sdk/client-sts": "3.382.0",
25
+ "@aws-sdk/credential-provider-node": "3.382.0",
26
+ "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
- "@aws-sdk/middleware-signing": "3.378.0",
30
- "@aws-sdk/middleware-user-agent": "3.378.0",
29
+ "@aws-sdk/middleware-signing": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",