@aws-sdk/client-acm-pca 3.379.1 → 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.
@@ -6,11 +6,13 @@ import { ACMPCAServiceException as __BaseException } from "./ACMPCAServiceExcept
6
6
  */
7
7
  export interface CustomAttribute {
8
8
  /**
9
+ * @public
9
10
  * <p>Specifies the object identifier (OID) of the attribute type of the relative
10
11
  * distinguished name (RDN).</p>
11
12
  */
12
13
  ObjectIdentifier: string | undefined;
13
14
  /**
15
+ * @public
14
16
  * <p></p>
15
17
  * <p>Specifies the attribute value of relative distinguished name (RDN).</p>
16
18
  */
@@ -26,29 +28,35 @@ export interface CustomAttribute {
26
28
  */
27
29
  export interface ASN1Subject {
28
30
  /**
31
+ * @public
29
32
  * <p>Two-digit code that specifies the country in which the certificate subject
30
33
  * located.</p>
31
34
  */
32
35
  Country?: string;
33
36
  /**
37
+ * @public
34
38
  * <p>Legal name of the organization with which the certificate subject is affiliated.
35
39
  * </p>
36
40
  */
37
41
  Organization?: string;
38
42
  /**
43
+ * @public
39
44
  * <p>A subdivision or unit of the organization (such as sales or finance) with which the
40
45
  * certificate subject is affiliated.</p>
41
46
  */
42
47
  OrganizationalUnit?: string;
43
48
  /**
49
+ * @public
44
50
  * <p>Disambiguating information for the certificate subject.</p>
45
51
  */
46
52
  DistinguishedNameQualifier?: string;
47
53
  /**
54
+ * @public
48
55
  * <p>State in which the subject of the certificate is located.</p>
49
56
  */
50
57
  State?: string;
51
58
  /**
59
+ * @public
52
60
  * <p>For CA and end-entity certificates in a private PKI, the common name (CN) can be any
53
61
  * string within the length limit. </p>
54
62
  * <p>Note: In publicly trusted certificates, the common name must be a fully qualified
@@ -56,45 +64,54 @@ export interface ASN1Subject {
56
64
  */
57
65
  CommonName?: string;
58
66
  /**
67
+ * @public
59
68
  * <p>The certificate serial number.</p>
60
69
  */
61
70
  SerialNumber?: string;
62
71
  /**
72
+ * @public
63
73
  * <p>The locality (such as a city or town) in which the certificate subject is
64
74
  * located.</p>
65
75
  */
66
76
  Locality?: string;
67
77
  /**
78
+ * @public
68
79
  * <p>A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the
69
80
  * certificate subject.</p>
70
81
  */
71
82
  Title?: string;
72
83
  /**
84
+ * @public
73
85
  * <p>Family name. In the US and the UK, for example, the surname of an individual is
74
86
  * ordered last. In Asian cultures the surname is typically ordered first.</p>
75
87
  */
76
88
  Surname?: string;
77
89
  /**
90
+ * @public
78
91
  * <p>First name.</p>
79
92
  */
80
93
  GivenName?: string;
81
94
  /**
95
+ * @public
82
96
  * <p>Concatenation that typically contains the first letter of the <b>GivenName</b>, the first letter of the middle name if one exists, and the
83
97
  * first letter of the <b>Surname</b>.</p>
84
98
  */
85
99
  Initials?: string;
86
100
  /**
101
+ * @public
87
102
  * <p>Typically a shortened version of a longer <b>GivenName</b>.
88
103
  * For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth,
89
104
  * Liz, or Eliza.</p>
90
105
  */
91
106
  Pseudonym?: string;
92
107
  /**
108
+ * @public
93
109
  * <p>Typically a qualifier appended to the name of an individual. Examples include Jr. for
94
110
  * junior, Sr. for senior, and III for third.</p>
95
111
  */
96
112
  GenerationQualifier?: string;
97
113
  /**
114
+ * @public
98
115
  * <p></p>
99
116
  * <p>Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of
100
117
  * which consists of an object identifier (OID) and a value. For more information, see
@@ -113,10 +130,12 @@ export interface ASN1Subject {
113
130
  */
114
131
  export interface EdiPartyName {
115
132
  /**
133
+ * @public
116
134
  * <p>Specifies the party name.</p>
117
135
  */
118
136
  PartyName: string | undefined;
119
137
  /**
138
+ * @public
120
139
  * <p>Specifies the name assigner.</p>
121
140
  */
122
141
  NameAssigner?: string;
@@ -130,10 +149,12 @@ export interface EdiPartyName {
130
149
  */
131
150
  export interface OtherName {
132
151
  /**
152
+ * @public
133
153
  * <p>Specifies an OID. </p>
134
154
  */
135
155
  TypeId: string | undefined;
136
156
  /**
157
+ * @public
137
158
  * <p>Specifies an OID value.</p>
138
159
  */
139
160
  Value: string | undefined;
@@ -146,19 +167,23 @@ export interface OtherName {
146
167
  */
147
168
  export interface GeneralName {
148
169
  /**
170
+ * @public
149
171
  * <p>Represents <code>GeneralName</code> using an <code>OtherName</code> object.</p>
150
172
  */
151
173
  OtherName?: OtherName;
152
174
  /**
175
+ * @public
153
176
  * <p>Represents <code>GeneralName</code> as an <a href="https://datatracker.ietf.org/doc/html/rfc822">RFC 822</a> email
154
177
  * address.</p>
155
178
  */
156
179
  Rfc822Name?: string;
157
180
  /**
181
+ * @public
158
182
  * <p>Represents <code>GeneralName</code> as a DNS name.</p>
159
183
  */
160
184
  DnsName?: string;
161
185
  /**
186
+ * @public
162
187
  * <p>Contains information about the certificate subject. The <code>Subject</code> field in
163
188
  * the certificate identifies the entity that owns or controls the public key in the
164
189
  * certificate. The entity can be a user, computer, device, or service. The <code>Subject
@@ -167,18 +192,22 @@ export interface GeneralName {
167
192
  */
168
193
  DirectoryName?: ASN1Subject;
169
194
  /**
195
+ * @public
170
196
  * <p>Represents <code>GeneralName</code> as an <code>EdiPartyName</code> object.</p>
171
197
  */
172
198
  EdiPartyName?: EdiPartyName;
173
199
  /**
200
+ * @public
174
201
  * <p>Represents <code>GeneralName</code> as a URI.</p>
175
202
  */
176
203
  UniformResourceIdentifier?: string;
177
204
  /**
205
+ * @public
178
206
  * <p>Represents <code>GeneralName</code> as an IPv4 or IPv6 address.</p>
179
207
  */
180
208
  IpAddress?: string;
181
209
  /**
210
+ * @public
182
211
  * <p> Represents <code>GeneralName</code> as an object identifier (OID).</p>
183
212
  */
184
213
  RegisteredId?: string;
@@ -204,6 +233,7 @@ export type AccessMethodType = (typeof AccessMethodType)[keyof typeof AccessMeth
204
233
  */
205
234
  export interface AccessMethod {
206
235
  /**
236
+ * @public
207
237
  * <p>An object identifier (OID) specifying the <code>AccessMethod</code>. The OID must
208
238
  * satisfy the regular expression shown below. For more information, see NIST's definition
209
239
  * of <a href="https://csrc.nist.gov/glossary/term/Object_Identifier">Object Identifier
@@ -211,6 +241,7 @@ export interface AccessMethod {
211
241
  */
212
242
  CustomObjectIdentifier?: string;
213
243
  /**
244
+ * @public
214
245
  * <p>Specifies the <code>AccessMethod</code>.</p>
215
246
  */
216
247
  AccessMethodType?: AccessMethodType | string;
@@ -222,10 +253,12 @@ export interface AccessMethod {
222
253
  */
223
254
  export interface AccessDescription {
224
255
  /**
256
+ * @public
225
257
  * <p>The type and format of <code>AccessDescription</code> information.</p>
226
258
  */
227
259
  AccessMethod: AccessMethod | undefined;
228
260
  /**
261
+ * @public
229
262
  * <p>The location of <code>AccessDescription</code> information.</p>
230
263
  */
231
264
  AccessLocation: GeneralName | undefined;
@@ -237,38 +270,47 @@ export interface AccessDescription {
237
270
  */
238
271
  export interface KeyUsage {
239
272
  /**
273
+ * @public
240
274
  * <p> Key can be used for digital signing.</p>
241
275
  */
242
276
  DigitalSignature?: boolean;
243
277
  /**
278
+ * @public
244
279
  * <p>Key can be used for non-repudiation.</p>
245
280
  */
246
281
  NonRepudiation?: boolean;
247
282
  /**
283
+ * @public
248
284
  * <p>Key can be used to encipher data.</p>
249
285
  */
250
286
  KeyEncipherment?: boolean;
251
287
  /**
288
+ * @public
252
289
  * <p>Key can be used to decipher data.</p>
253
290
  */
254
291
  DataEncipherment?: boolean;
255
292
  /**
293
+ * @public
256
294
  * <p>Key can be used in a key-agreement protocol.</p>
257
295
  */
258
296
  KeyAgreement?: boolean;
259
297
  /**
298
+ * @public
260
299
  * <p>Key can be used to sign certificates.</p>
261
300
  */
262
301
  KeyCertSign?: boolean;
263
302
  /**
303
+ * @public
264
304
  * <p>Key can be used to sign CRLs.</p>
265
305
  */
266
306
  CRLSign?: boolean;
267
307
  /**
308
+ * @public
268
309
  * <p>Key can be used only to encipher data.</p>
269
310
  */
270
311
  EncipherOnly?: boolean;
271
312
  /**
313
+ * @public
272
314
  * <p>Key can be used only to decipher data.</p>
273
315
  */
274
316
  DecipherOnly?: boolean;
@@ -280,11 +322,13 @@ export interface KeyUsage {
280
322
  */
281
323
  export interface CsrExtensions {
282
324
  /**
325
+ * @public
283
326
  * <p>Indicates the purpose of the certificate and of the key contained in the
284
327
  * certificate.</p>
285
328
  */
286
329
  KeyUsage?: KeyUsage;
287
330
  /**
331
+ * @public
288
332
  * <p>For CA certificates, provides a path to additional information pertaining to the CA,
289
333
  * such as revocation and policy. For more information, see <a href="https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.2.2">Subject
290
334
  * Information Access</a> in RFC 5280.</p>
@@ -331,23 +375,27 @@ export type SigningAlgorithm = (typeof SigningAlgorithm)[keyof typeof SigningAlg
331
375
  */
332
376
  export interface CertificateAuthorityConfiguration {
333
377
  /**
378
+ * @public
334
379
  * <p>Type of the public key algorithm and size, in bits, of the key pair that your CA
335
380
  * creates when it issues a certificate. When you create a subordinate CA, you must use a
336
381
  * key algorithm supported by the parent CA.</p>
337
382
  */
338
383
  KeyAlgorithm: KeyAlgorithm | string | undefined;
339
384
  /**
385
+ * @public
340
386
  * <p>Name of the algorithm your private CA uses to sign certificate requests.</p>
341
387
  * <p>This parameter should not be confused with the <code>SigningAlgorithm</code> parameter
342
388
  * used to sign certificates when they are issued.</p>
343
389
  */
344
390
  SigningAlgorithm: SigningAlgorithm | string | undefined;
345
391
  /**
392
+ * @public
346
393
  * <p>Structure that contains X.500 distinguished name information for your private
347
394
  * CA.</p>
348
395
  */
349
396
  Subject: ASN1Subject | undefined;
350
397
  /**
398
+ * @public
351
399
  * <p>Specifies information to be added to the extension section of the certificate signing
352
400
  * request (CSR).</p>
353
401
  */
@@ -506,6 +554,7 @@ export type S3ObjectAcl = (typeof S3ObjectAcl)[keyof typeof S3ObjectAcl];
506
554
  */
507
555
  export interface CrlConfiguration {
508
556
  /**
557
+ * @public
509
558
  * <p>Boolean value that specifies whether certificate revocation lists (CRLs) are enabled.
510
559
  * You can use this value to enable certificate revocation for a new CA when you call the
511
560
  * <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action or for an existing CA when you call the
@@ -513,10 +562,12 @@ export interface CrlConfiguration {
513
562
  */
514
563
  Enabled: boolean | undefined;
515
564
  /**
565
+ * @public
516
566
  * <p>Validity period of the CRL in days.</p>
517
567
  */
518
568
  ExpirationInDays?: number;
519
569
  /**
570
+ * @public
520
571
  * <p>Name inserted into the certificate <b>CRL Distribution
521
572
  * Points</b> extension that enables the use of an alias for the CRL
522
573
  * distribution point. Use this value if you don't want the name of your S3 bucket to be
@@ -529,6 +580,7 @@ export interface CrlConfiguration {
529
580
  */
530
581
  CustomCname?: string;
531
582
  /**
583
+ * @public
532
584
  * <p>Name of the S3 bucket that contains the CRL. If you do not provide a value for the
533
585
  * <b>CustomCname</b> argument, the name of your S3 bucket
534
586
  * is placed into the <b>CRL Distribution Points</b> extension of
@@ -541,6 +593,7 @@ export interface CrlConfiguration {
541
593
  */
542
594
  S3BucketName?: string;
543
595
  /**
596
+ * @public
544
597
  * <p>Determines whether the CRL will be publicly readable or privately held in the CRL
545
598
  * Amazon S3 bucket. If you choose PUBLIC_READ, the CRL will be accessible over the public
546
599
  * internet. If you choose BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket
@@ -568,11 +621,13 @@ export interface CrlConfiguration {
568
621
  */
569
622
  export interface OcspConfiguration {
570
623
  /**
624
+ * @public
571
625
  * <p>Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating
572
626
  * certificate revocation status.</p>
573
627
  */
574
628
  Enabled: boolean | undefined;
575
629
  /**
630
+ * @public
576
631
  * <p>By default, Amazon Web Services Private CA injects an Amazon Web Services domain into certificates being validated by
577
632
  * the Online Certificate Status Protocol (OCSP). A customer can alternatively use this
578
633
  * object to define a CNAME specifying a customized OCSP domain.</p>
@@ -598,6 +653,7 @@ export interface OcspConfiguration {
598
653
  */
599
654
  export interface RevocationConfiguration {
600
655
  /**
656
+ * @public
601
657
  * <p>Configuration of the certificate revocation list (CRL), if any, maintained by your
602
658
  * private CA. A CRL is typically updated approximately 30 minutes after a certificate
603
659
  * is revoked. If for any reason a CRL update fails, Amazon Web Services Private CA makes further attempts
@@ -605,6 +661,7 @@ export interface RevocationConfiguration {
605
661
  */
606
662
  CrlConfiguration?: CrlConfiguration;
607
663
  /**
664
+ * @public
608
665
  * <p>Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained
609
666
  * by your private CA. When you revoke a certificate, OCSP responses may take up to 60 minutes
610
667
  * to reflect the new status.</p>
@@ -620,10 +677,12 @@ export interface RevocationConfiguration {
620
677
  */
621
678
  export interface Tag {
622
679
  /**
680
+ * @public
623
681
  * <p>Key (name) of the tag.</p>
624
682
  */
625
683
  Key: string | undefined;
626
684
  /**
685
+ * @public
627
686
  * <p>Value of the tag.</p>
628
687
  */
629
688
  Value?: string;
@@ -645,11 +704,13 @@ export type CertificateAuthorityUsageMode = (typeof CertificateAuthorityUsageMod
645
704
  */
646
705
  export interface CreateCertificateAuthorityRequest {
647
706
  /**
707
+ * @public
648
708
  * <p>Name and bit size of the private key algorithm, the name of the signing algorithm, and
649
709
  * X.500 certificate subject information.</p>
650
710
  */
651
711
  CertificateAuthorityConfiguration: CertificateAuthorityConfiguration | undefined;
652
712
  /**
713
+ * @public
653
714
  * <p>Contains information to enable Online Certificate Status Protocol (OCSP) support, to
654
715
  * enable a certificate revocation list (CRL), to enable both, or to enable neither. The
655
716
  * default is for both certificate validation mechanisms to be disabled. </p>
@@ -682,10 +743,12 @@ export interface CreateCertificateAuthorityRequest {
682
743
  */
683
744
  RevocationConfiguration?: RevocationConfiguration;
684
745
  /**
746
+ * @public
685
747
  * <p>The type of the certificate authority.</p>
686
748
  */
687
749
  CertificateAuthorityType: CertificateAuthorityType | string | undefined;
688
750
  /**
751
+ * @public
689
752
  * <p>Custom string that can be used to distinguish between calls to the <b>CreateCertificateAuthority</b> action. Idempotency tokens for
690
753
  * <b>CreateCertificateAuthority</b> time out after five
691
754
  * minutes. Therefore, if you call <b>CreateCertificateAuthority</b> multiple times with the same idempotency
@@ -696,6 +759,7 @@ export interface CreateCertificateAuthorityRequest {
696
759
  */
697
760
  IdempotencyToken?: string;
698
761
  /**
762
+ * @public
699
763
  * <p>Specifies a cryptographic key management compliance standard used for handling CA
700
764
  * keys.</p>
701
765
  * <p>Default: FIPS_140_2_LEVEL_3_OR_HIGHER</p>
@@ -711,12 +775,14 @@ export interface CreateCertificateAuthorityRequest {
711
775
  */
712
776
  KeyStorageSecurityStandard?: KeyStorageSecurityStandard | string;
713
777
  /**
778
+ * @public
714
779
  * <p>Key-value pairs that will be attached to the new private CA. You can associate up to
715
780
  * 50 tags with a private CA. For information using tags with IAM to manage permissions,
716
781
  * see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html">Controlling Access Using IAM Tags</a>.</p>
717
782
  */
718
783
  Tags?: Tag[];
719
784
  /**
785
+ * @public
720
786
  * <p>Specifies whether the CA issues general-purpose certificates that typically require a
721
787
  * revocation mechanism, or short-lived certificates that may optionally omit revocation
722
788
  * because they expire quickly. Short-lived certificate validity is limited to seven
@@ -730,6 +796,7 @@ export interface CreateCertificateAuthorityRequest {
730
796
  */
731
797
  export interface CreateCertificateAuthorityResponse {
732
798
  /**
799
+ * @public
733
800
  * <p>If successful, the Amazon Resource Name (ARN) of the certificate authority (CA). This
734
801
  * is of the form: </p>
735
802
  * <p>
@@ -807,6 +874,7 @@ export type AuditReportResponseFormat = (typeof AuditReportResponseFormat)[keyof
807
874
  */
808
875
  export interface CreateCertificateAuthorityAuditReportRequest {
809
876
  /**
877
+ * @public
810
878
  * <p>The Amazon Resource Name (ARN) of the CA to be audited. This is of the form:</p>
811
879
  * <p>
812
880
  * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
@@ -814,10 +882,12 @@ export interface CreateCertificateAuthorityAuditReportRequest {
814
882
  */
815
883
  CertificateAuthorityArn: string | undefined;
816
884
  /**
885
+ * @public
817
886
  * <p>The name of the S3 bucket that will contain the audit report.</p>
818
887
  */
819
888
  S3BucketName: string | undefined;
820
889
  /**
890
+ * @public
821
891
  * <p>The format in which to create the report. This can be either <b>JSON</b> or <b>CSV</b>.</p>
822
892
  */
823
893
  AuditReportResponseFormat: AuditReportResponseFormat | string | undefined;
@@ -827,10 +897,12 @@ export interface CreateCertificateAuthorityAuditReportRequest {
827
897
  */
828
898
  export interface CreateCertificateAuthorityAuditReportResponse {
829
899
  /**
900
+ * @public
830
901
  * <p>An alphanumeric string that contains a report identifier.</p>
831
902
  */
832
903
  AuditReportId?: string;
833
904
  /**
905
+ * @public
834
906
  * <p>The <b>key</b> that uniquely identifies the report file in
835
907
  * your S3 bucket.</p>
836
908
  */
@@ -916,6 +988,7 @@ export type ActionType = (typeof ActionType)[keyof typeof ActionType];
916
988
  */
917
989
  export interface CreatePermissionRequest {
918
990
  /**
991
+ * @public
919
992
  * <p>The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the
920
993
  * ARN by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action. This must have the following form: </p>
921
994
  * <p>
@@ -925,15 +998,18 @@ export interface CreatePermissionRequest {
925
998
  */
926
999
  CertificateAuthorityArn: string | undefined;
927
1000
  /**
1001
+ * @public
928
1002
  * <p>The Amazon Web Services service or identity that receives the permission. At this time, the only
929
1003
  * valid principal is <code>acm.amazonaws.com</code>.</p>
930
1004
  */
931
1005
  Principal: string | undefined;
932
1006
  /**
1007
+ * @public
933
1008
  * <p>The ID of the calling account.</p>
934
1009
  */
935
1010
  SourceAccount?: string;
936
1011
  /**
1012
+ * @public
937
1013
  * <p>The actions that the specified Amazon Web Services service principal can use. These include
938
1014
  * <code>IssueCertificate</code>, <code>GetCertificate</code>, and
939
1015
  * <code>ListPermissions</code>.</p>
@@ -969,6 +1045,7 @@ export declare class ConcurrentModificationException extends __BaseException {
969
1045
  */
970
1046
  export interface DeleteCertificateAuthorityRequest {
971
1047
  /**
1048
+ * @public
972
1049
  * <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>. This must have the following form: </p>
973
1050
  * <p>
974
1051
  * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
@@ -977,6 +1054,7 @@ export interface DeleteCertificateAuthorityRequest {
977
1054
  */
978
1055
  CertificateAuthorityArn: string | undefined;
979
1056
  /**
1057
+ * @public
980
1058
  * <p>The number of days to make a CA restorable after it has been deleted. This can be
981
1059
  * anywhere from 7 to 30 days, with 30 being the default.</p>
982
1060
  */
@@ -987,6 +1065,7 @@ export interface DeleteCertificateAuthorityRequest {
987
1065
  */
988
1066
  export interface DeletePermissionRequest {
989
1067
  /**
1068
+ * @public
990
1069
  * <p>The Amazon Resource Number (ARN) of the private CA that issued the permissions. You
991
1070
  * can find the CA's ARN by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action. This must have the following form: </p>
992
1071
  * <p>
@@ -996,12 +1075,14 @@ export interface DeletePermissionRequest {
996
1075
  */
997
1076
  CertificateAuthorityArn: string | undefined;
998
1077
  /**
1078
+ * @public
999
1079
  * <p>The Amazon Web Services service or identity that will have its CA permissions revoked. At this time,
1000
1080
  * the only valid service principal is <code>acm.amazonaws.com</code>
1001
1081
  * </p>
1002
1082
  */
1003
1083
  Principal: string | undefined;
1004
1084
  /**
1085
+ * @public
1005
1086
  * <p>The Amazon Web Services account that calls this action.</p>
1006
1087
  */
1007
1088
  SourceAccount?: string;
@@ -1011,6 +1092,7 @@ export interface DeletePermissionRequest {
1011
1092
  */
1012
1093
  export interface DeletePolicyRequest {
1013
1094
  /**
1095
+ * @public
1014
1096
  * <p>The Amazon Resource Number (ARN) of the private CA that will have its policy deleted.
1015
1097
  * You can find the CA's ARN by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action. The ARN value must have the form
1016
1098
  * <code>arn:aws:acm-pca:region:account:certificate-authority/01234567-89ab-cdef-0123-0123456789ab</code>.
@@ -1037,6 +1119,7 @@ export declare class LockoutPreventedException extends __BaseException {
1037
1119
  */
1038
1120
  export interface DescribeCertificateAuthorityRequest {
1039
1121
  /**
1122
+ * @public
1040
1123
  * <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>. This must be of the form: </p>
1041
1124
  * <p>
1042
1125
  * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
@@ -1089,6 +1172,7 @@ export type CertificateAuthorityStatus = (typeof CertificateAuthorityStatus)[key
1089
1172
  */
1090
1173
  export interface CertificateAuthority {
1091
1174
  /**
1175
+ * @public
1092
1176
  * <p>Amazon Resource Name (ARN) for your private certificate authority (CA). The format is
1093
1177
  * <code>
1094
1178
  * <i>12345678-1234-1234-1234-123456789012</i>
@@ -1096,56 +1180,69 @@ export interface CertificateAuthority {
1096
1180
  */
1097
1181
  Arn?: string;
1098
1182
  /**
1183
+ * @public
1099
1184
  * <p>The Amazon Web Services account ID that owns the certificate authority.</p>
1100
1185
  */
1101
1186
  OwnerAccount?: string;
1102
1187
  /**
1188
+ * @public
1103
1189
  * <p>Date and time at which your private CA was created.</p>
1104
1190
  */
1105
1191
  CreatedAt?: Date;
1106
1192
  /**
1193
+ * @public
1107
1194
  * <p>Date and time at which your private CA was last updated.</p>
1108
1195
  */
1109
1196
  LastStateChangeAt?: Date;
1110
1197
  /**
1198
+ * @public
1111
1199
  * <p>Type of your private CA.</p>
1112
1200
  */
1113
1201
  Type?: CertificateAuthorityType | string;
1114
1202
  /**
1203
+ * @public
1115
1204
  * <p>Serial number of your private CA.</p>
1116
1205
  */
1117
1206
  Serial?: string;
1118
1207
  /**
1208
+ * @public
1119
1209
  * <p>Status of your private CA.</p>
1120
1210
  */
1121
1211
  Status?: CertificateAuthorityStatus | string;
1122
1212
  /**
1213
+ * @public
1123
1214
  * <p>Date and time before which your private CA certificate is not valid.</p>
1124
1215
  */
1125
1216
  NotBefore?: Date;
1126
1217
  /**
1218
+ * @public
1127
1219
  * <p>Date and time after which your private CA certificate is not valid.</p>
1128
1220
  */
1129
1221
  NotAfter?: Date;
1130
1222
  /**
1223
+ * @public
1131
1224
  * <p>Reason the request to create your private CA failed.</p>
1132
1225
  */
1133
1226
  FailureReason?: FailureReason | string;
1134
1227
  /**
1228
+ * @public
1135
1229
  * <p>Your private CA configuration.</p>
1136
1230
  */
1137
1231
  CertificateAuthorityConfiguration?: CertificateAuthorityConfiguration;
1138
1232
  /**
1233
+ * @public
1139
1234
  * <p>Information about the Online Certificate Status Protocol (OCSP) configuration or
1140
1235
  * certificate revocation list (CRL) created and maintained by your private CA. </p>
1141
1236
  */
1142
1237
  RevocationConfiguration?: RevocationConfiguration;
1143
1238
  /**
1239
+ * @public
1144
1240
  * <p>The period during which a deleted CA can be restored. For more information, see the
1145
1241
  * <code>PermanentDeletionTimeInDays</code> parameter of the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthorityRequest.html">DeleteCertificateAuthorityRequest</a> action. </p>
1146
1242
  */
1147
1243
  RestorableUntil?: Date;
1148
1244
  /**
1245
+ * @public
1149
1246
  * <p>Defines a cryptographic key management compliance standard used for handling CA keys. </p>
1150
1247
  * <p>Default: FIPS_140_2_LEVEL_3_OR_HIGHER</p>
1151
1248
  * <p>Note: Amazon Web Services Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must
@@ -1156,6 +1253,7 @@ export interface CertificateAuthority {
1156
1253
  */
1157
1254
  KeyStorageSecurityStandard?: KeyStorageSecurityStandard | string;
1158
1255
  /**
1256
+ * @public
1159
1257
  * <p>Specifies whether the CA issues general-purpose certificates that typically require a
1160
1258
  * revocation mechanism, or short-lived certificates that may optionally omit revocation
1161
1259
  * because they expire quickly. Short-lived certificate validity is limited to seven
@@ -1169,6 +1267,7 @@ export interface CertificateAuthority {
1169
1267
  */
1170
1268
  export interface DescribeCertificateAuthorityResponse {
1171
1269
  /**
1270
+ * @public
1172
1271
  * <p>A <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CertificateAuthority.html">CertificateAuthority</a> structure that contains information about your private
1173
1272
  * CA.</p>
1174
1273
  */
@@ -1179,6 +1278,7 @@ export interface DescribeCertificateAuthorityResponse {
1179
1278
  */
1180
1279
  export interface DescribeCertificateAuthorityAuditReportRequest {
1181
1280
  /**
1281
+ * @public
1182
1282
  * <p>The Amazon Resource Name (ARN) of the private CA. This must be of the form:</p>
1183
1283
  * <p>
1184
1284
  * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
@@ -1187,6 +1287,7 @@ export interface DescribeCertificateAuthorityAuditReportRequest {
1187
1287
  */
1188
1288
  CertificateAuthorityArn: string | undefined;
1189
1289
  /**
1290
+ * @public
1190
1291
  * <p>The report ID returned by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a> action.</p>
1191
1292
  */
1192
1293
  AuditReportId: string | undefined;
@@ -1209,19 +1310,23 @@ export type AuditReportStatus = (typeof AuditReportStatus)[keyof typeof AuditRep
1209
1310
  */
1210
1311
  export interface DescribeCertificateAuthorityAuditReportResponse {
1211
1312
  /**
1313
+ * @public
1212
1314
  * <p>Specifies whether report creation is in progress, has succeeded, or has failed.</p>
1213
1315
  */
1214
1316
  AuditReportStatus?: AuditReportStatus | string;
1215
1317
  /**
1318
+ * @public
1216
1319
  * <p>Name of the S3 bucket that contains the report.</p>
1217
1320
  */
1218
1321
  S3BucketName?: string;
1219
1322
  /**
1323
+ * @public
1220
1324
  * <p>S3 <b>key</b> that uniquely identifies the report file in
1221
1325
  * your S3 bucket.</p>
1222
1326
  */
1223
1327
  S3Key?: string;
1224
1328
  /**
1329
+ * @public
1225
1330
  * <p>The date and time at which the report was created.</p>
1226
1331
  */
1227
1332
  CreatedAt?: Date;
@@ -1231,6 +1336,7 @@ export interface DescribeCertificateAuthorityAuditReportResponse {
1231
1336
  */
1232
1337
  export interface GetCertificateRequest {
1233
1338
  /**
1339
+ * @public
1234
1340
  * <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>. This must be of the form: </p>
1235
1341
  * <p>
1236
1342
  * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
@@ -1239,6 +1345,7 @@ export interface GetCertificateRequest {
1239
1345
  */
1240
1346
  CertificateAuthorityArn: string | undefined;
1241
1347
  /**
1348
+ * @public
1242
1349
  * <p>The ARN of the issued certificate. The ARN contains the certificate serial number and
1243
1350
  * must be in the following form: </p>
1244
1351
  * <p>
@@ -1253,11 +1360,13 @@ export interface GetCertificateRequest {
1253
1360
  */
1254
1361
  export interface GetCertificateResponse {
1255
1362
  /**
1363
+ * @public
1256
1364
  * <p>The base64 PEM-encoded certificate specified by the <code>CertificateArn</code>
1257
1365
  * parameter.</p>
1258
1366
  */
1259
1367
  Certificate?: string;
1260
1368
  /**
1369
+ * @public
1261
1370
  * <p>The base64 PEM-encoded certificate chain that chains up to the root CA certificate
1262
1371
  * that you used to sign your private CA certificate. </p>
1263
1372
  */
@@ -1268,6 +1377,7 @@ export interface GetCertificateResponse {
1268
1377
  */
1269
1378
  export interface GetCertificateAuthorityCertificateRequest {
1270
1379
  /**
1380
+ * @public
1271
1381
  * <p>The Amazon Resource Name (ARN) of your private CA. This is of the form:</p>
1272
1382
  * <p>
1273
1383
  * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
@@ -1281,10 +1391,12 @@ export interface GetCertificateAuthorityCertificateRequest {
1281
1391
  */
1282
1392
  export interface GetCertificateAuthorityCertificateResponse {
1283
1393
  /**
1394
+ * @public
1284
1395
  * <p>Base64-encoded certificate authority (CA) certificate.</p>
1285
1396
  */
1286
1397
  Certificate?: string;
1287
1398
  /**
1399
+ * @public
1288
1400
  * <p>Base64-encoded certificate chain that includes any intermediate certificates and
1289
1401
  * chains up to root certificate that you used to sign your private CA certificate. The
1290
1402
  * chain does not include your private CA certificate. If this is a root CA, the value will
@@ -1297,6 +1409,7 @@ export interface GetCertificateAuthorityCertificateResponse {
1297
1409
  */
1298
1410
  export interface GetCertificateAuthorityCsrRequest {
1299
1411
  /**
1412
+ * @public
1300
1413
  * <p>The Amazon Resource Name (ARN) that was returned when you called the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action. This must be of the form: </p>
1301
1414
  * <p>
1302
1415
  * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
@@ -1310,6 +1423,7 @@ export interface GetCertificateAuthorityCsrRequest {
1310
1423
  */
1311
1424
  export interface GetCertificateAuthorityCsrResponse {
1312
1425
  /**
1426
+ * @public
1313
1427
  * <p>The base64 PEM-encoded certificate signing request (CSR) for your private CA
1314
1428
  * certificate.</p>
1315
1429
  */
@@ -1320,6 +1434,7 @@ export interface GetCertificateAuthorityCsrResponse {
1320
1434
  */
1321
1435
  export interface GetPolicyRequest {
1322
1436
  /**
1437
+ * @public
1323
1438
  * <p>The Amazon Resource Number (ARN) of the private CA that will have its policy
1324
1439
  * retrieved. You can find the CA's ARN by calling the ListCertificateAuthorities action.
1325
1440
  *
@@ -1332,6 +1447,7 @@ export interface GetPolicyRequest {
1332
1447
  */
1333
1448
  export interface GetPolicyResponse {
1334
1449
  /**
1450
+ * @public
1335
1451
  * <p>The policy attached to the private CA as a JSON document.</p>
1336
1452
  */
1337
1453
  Policy?: string;
@@ -1354,6 +1470,7 @@ export declare class CertificateMismatchException extends __BaseException {
1354
1470
  */
1355
1471
  export interface ImportCertificateAuthorityCertificateRequest {
1356
1472
  /**
1473
+ * @public
1357
1474
  * <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>. This must be of the form: </p>
1358
1475
  * <p>
1359
1476
  * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
@@ -1362,11 +1479,13 @@ export interface ImportCertificateAuthorityCertificateRequest {
1362
1479
  */
1363
1480
  CertificateAuthorityArn: string | undefined;
1364
1481
  /**
1482
+ * @public
1365
1483
  * <p>The PEM-encoded certificate for a private CA. This may be a self-signed certificate in
1366
1484
  * the case of a root CA, or it may be signed by another CA that you control.</p>
1367
1485
  */
1368
1486
  Certificate: Uint8Array | undefined;
1369
1487
  /**
1488
+ * @public
1370
1489
  * <p>A PEM-encoded file that contains all of your certificates, other than the certificate
1371
1490
  * you're importing, chaining up to your root CA. Your Amazon Web Services Private CA-hosted or on-premises
1372
1491
  * root certificate is the last in the chain, and each certificate in the chain signs the
@@ -1418,6 +1537,7 @@ export type PolicyQualifierId = (typeof PolicyQualifierId)[keyof typeof PolicyQu
1418
1537
  */
1419
1538
  export interface Qualifier {
1420
1539
  /**
1540
+ * @public
1421
1541
  * <p>Contains a pointer to a certification practice statement (CPS) published by the
1422
1542
  * CA.</p>
1423
1543
  */
@@ -1431,10 +1551,12 @@ export interface Qualifier {
1431
1551
  */
1432
1552
  export interface PolicyQualifierInfo {
1433
1553
  /**
1554
+ * @public
1434
1555
  * <p>Identifies the qualifier modifying a <code>CertPolicyId</code>.</p>
1435
1556
  */
1436
1557
  PolicyQualifierId: PolicyQualifierId | string | undefined;
1437
1558
  /**
1559
+ * @public
1438
1560
  * <p>Defines the qualifier type. Amazon Web Services Private CA supports the use of a URI for a CPS qualifier
1439
1561
  * in this field.</p>
1440
1562
  */
@@ -1446,12 +1568,14 @@ export interface PolicyQualifierInfo {
1446
1568
  */
1447
1569
  export interface PolicyInformation {
1448
1570
  /**
1571
+ * @public
1449
1572
  * <p>Specifies the object identifier (OID) of the certificate policy under which the
1450
1573
  * certificate was issued. For more information, see NIST's definition of <a href="https://csrc.nist.gov/glossary/term/Object_Identifier">Object Identifier
1451
1574
  * (OID)</a>.</p>
1452
1575
  */
1453
1576
  CertPolicyId: string | undefined;
1454
1577
  /**
1578
+ * @public
1455
1579
  * <p>Modifies the given <code>CertPolicyId</code> with a qualifier. Amazon Web Services Private CA supports the
1456
1580
  * certification practice statement (CPS) qualifier.</p>
1457
1581
  */
@@ -1468,6 +1592,7 @@ export interface PolicyInformation {
1468
1592
  */
1469
1593
  export interface CustomExtension {
1470
1594
  /**
1595
+ * @public
1471
1596
  * <p></p>
1472
1597
  * <p>Specifies the object identifier (OID) of the X.509 extension. For more information,
1473
1598
  * see the <a href="https://oidref.com/2.5.29">Global OID reference database.</a>
@@ -1475,11 +1600,13 @@ export interface CustomExtension {
1475
1600
  */
1476
1601
  ObjectIdentifier: string | undefined;
1477
1602
  /**
1603
+ * @public
1478
1604
  * <p></p>
1479
1605
  * <p>Specifies the base64-encoded value of the X.509 extension.</p>
1480
1606
  */
1481
1607
  Value: string | undefined;
1482
1608
  /**
1609
+ * @public
1483
1610
  * <p></p>
1484
1611
  * <p>Specifies the critical flag of the X.509 extension.</p>
1485
1612
  */
@@ -1511,11 +1638,13 @@ export type ExtendedKeyUsageType = (typeof ExtendedKeyUsageType)[keyof typeof Ex
1511
1638
  */
1512
1639
  export interface ExtendedKeyUsage {
1513
1640
  /**
1641
+ * @public
1514
1642
  * <p>Specifies a standard <code>ExtendedKeyUsage</code> as defined as in <a href="https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.12">RFC
1515
1643
  * 5280</a>.</p>
1516
1644
  */
1517
1645
  ExtendedKeyUsageType?: ExtendedKeyUsageType | string;
1518
1646
  /**
1647
+ * @public
1519
1648
  * <p>Specifies a custom <code>ExtendedKeyUsage</code> with an object identifier
1520
1649
  * (OID).</p>
1521
1650
  */
@@ -1527,6 +1656,7 @@ export interface ExtendedKeyUsage {
1527
1656
  */
1528
1657
  export interface Extensions {
1529
1658
  /**
1659
+ * @public
1530
1660
  * <p>Contains a sequence of one or more policy information terms, each of which consists of
1531
1661
  * an object identifier (OID) and optional qualifiers. For more information, see NIST's
1532
1662
  * definition of <a href="https://csrc.nist.gov/glossary/term/Object_Identifier">Object
@@ -1538,22 +1668,26 @@ export interface Extensions {
1538
1668
  */
1539
1669
  CertificatePolicies?: PolicyInformation[];
1540
1670
  /**
1671
+ * @public
1541
1672
  * <p>Specifies additional purposes for which the certified public key may be used other
1542
1673
  * than basic purposes indicated in the <code>KeyUsage</code> extension.</p>
1543
1674
  */
1544
1675
  ExtendedKeyUsage?: ExtendedKeyUsage[];
1545
1676
  /**
1677
+ * @public
1546
1678
  * <p>Defines one or more purposes for which the key contained in the certificate can be
1547
1679
  * used. Default value for each option is false.</p>
1548
1680
  */
1549
1681
  KeyUsage?: KeyUsage;
1550
1682
  /**
1683
+ * @public
1551
1684
  * <p>The subject alternative name extension allows identities to be bound to the subject of
1552
1685
  * the certificate. These identities may be included in addition to or in place of the
1553
1686
  * identity in the subject field of the certificate.</p>
1554
1687
  */
1555
1688
  SubjectAlternativeNames?: GeneralName[];
1556
1689
  /**
1690
+ * @public
1557
1691
  * <p></p>
1558
1692
  * <p>Contains a sequence of one or more X.509 extensions, each of which consists of an
1559
1693
  * object identifier (OID), a base64-encoded value, and the critical flag. For more
@@ -1574,10 +1708,12 @@ export interface Extensions {
1574
1708
  */
1575
1709
  export interface ApiPassthrough {
1576
1710
  /**
1711
+ * @public
1577
1712
  * <p>Specifies X.509 extension information for a certificate.</p>
1578
1713
  */
1579
1714
  Extensions?: Extensions;
1580
1715
  /**
1716
+ * @public
1581
1717
  * <p>Contains information about the certificate subject. The <code>Subject</code> field in
1582
1718
  * the certificate identifies the entity that owns or controls the public key in the
1583
1719
  * certificate. The entity can be a user, computer, device, or service. The <code>Subject
@@ -1616,10 +1752,12 @@ export type ValidityPeriodType = (typeof ValidityPeriodType)[keyof typeof Validi
1616
1752
  */
1617
1753
  export interface Validity {
1618
1754
  /**
1755
+ * @public
1619
1756
  * <p>A long integer interpreted according to the value of <code>Type</code>, below.</p>
1620
1757
  */
1621
1758
  Value: number | undefined;
1622
1759
  /**
1760
+ * @public
1623
1761
  * <p>Determines how <i>Amazon Web Services Private CA</i> interprets the <code>Value</code>
1624
1762
  * parameter, an integer. Supported validity types include those listed below. Type
1625
1763
  * definitions with values include a sample input value and the resulting output. </p>
@@ -1672,6 +1810,7 @@ export interface Validity {
1672
1810
  */
1673
1811
  export interface IssueCertificateRequest {
1674
1812
  /**
1813
+ * @public
1675
1814
  * <p>Specifies X.509 certificate information to be included in the issued certificate. An
1676
1815
  * <code>APIPassthrough</code> or <code>APICSRPassthrough</code> template variant must
1677
1816
  * be selected, or else this parameter is ignored. For more information about using these
@@ -1682,6 +1821,7 @@ export interface IssueCertificateRequest {
1682
1821
  */
1683
1822
  ApiPassthrough?: ApiPassthrough;
1684
1823
  /**
1824
+ * @public
1685
1825
  * <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>. This must be of the form:</p>
1686
1826
  * <p>
1687
1827
  * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
@@ -1690,6 +1830,7 @@ export interface IssueCertificateRequest {
1690
1830
  */
1691
1831
  CertificateAuthorityArn: string | undefined;
1692
1832
  /**
1833
+ * @public
1693
1834
  * <p>The certificate signing request (CSR) for the certificate you want to issue. As an
1694
1835
  * example, you can use the following OpenSSL command to create the CSR and a 2048 bit RSA
1695
1836
  * private key. </p>
@@ -1711,6 +1852,7 @@ export interface IssueCertificateRequest {
1711
1852
  */
1712
1853
  Csr: Uint8Array | undefined;
1713
1854
  /**
1855
+ * @public
1714
1856
  * <p>The name of the algorithm that will be used to sign the certificate to be issued. </p>
1715
1857
  * <p>This parameter should not be confused with the <code>SigningAlgorithm</code> parameter
1716
1858
  * used to sign a CSR in the <code>CreateCertificateAuthority</code> action.</p>
@@ -1721,6 +1863,7 @@ export interface IssueCertificateRequest {
1721
1863
  */
1722
1864
  SigningAlgorithm: SigningAlgorithm | string | undefined;
1723
1865
  /**
1866
+ * @public
1724
1867
  * <p>Specifies a custom configuration template to use when issuing a certificate. If this
1725
1868
  * parameter is not provided, Amazon Web Services Private CA defaults to the
1726
1869
  * <code>EndEntityCertificate/V1</code> template. For CA certificates, you should
@@ -1735,6 +1878,7 @@ export interface IssueCertificateRequest {
1735
1878
  */
1736
1879
  TemplateArn?: string;
1737
1880
  /**
1881
+ * @public
1738
1882
  * <p>Information describing the end of the validity period of the certificate. This
1739
1883
  * parameter sets the “Not After” date for the certificate.</p>
1740
1884
  * <p>Certificate validity is the period of time during which a certificate is valid.
@@ -1751,6 +1895,7 @@ export interface IssueCertificateRequest {
1751
1895
  */
1752
1896
  Validity: Validity | undefined;
1753
1897
  /**
1898
+ * @public
1754
1899
  * <p>Information describing the start of the validity period of the certificate. This
1755
1900
  * parameter sets the “Not Before" date for the certificate.</p>
1756
1901
  * <p>By default, when issuing a certificate, Amazon Web Services Private CA sets the "Not Before" date to the
@@ -1767,6 +1912,7 @@ export interface IssueCertificateRequest {
1767
1912
  */
1768
1913
  ValidityNotBefore?: Validity;
1769
1914
  /**
1915
+ * @public
1770
1916
  * <p>Alphanumeric string that can be used to distinguish between calls to the <b>IssueCertificate</b> action. Idempotency tokens for <b>IssueCertificate</b> time out after one minute. Therefore, if you
1771
1917
  * call <b>IssueCertificate</b> multiple times with the same
1772
1918
  * idempotency token within one minute, Amazon Web Services Private CA recognizes that you are requesting only
@@ -1780,6 +1926,7 @@ export interface IssueCertificateRequest {
1780
1926
  */
1781
1927
  export interface IssueCertificateResponse {
1782
1928
  /**
1929
+ * @public
1783
1930
  * <p>The Amazon Resource Name (ARN) of the issued certificate and the certificate serial
1784
1931
  * number. This is of the form:</p>
1785
1932
  * <p>
@@ -1831,12 +1978,14 @@ export type ResourceOwner = (typeof ResourceOwner)[keyof typeof ResourceOwner];
1831
1978
  */
1832
1979
  export interface ListCertificateAuthoritiesRequest {
1833
1980
  /**
1981
+ * @public
1834
1982
  * <p>Use this parameter when paginating results in a subsequent request after you receive a
1835
1983
  * response with truncated results. Set it to the value of the <code>NextToken</code>
1836
1984
  * parameter from the response you just received.</p>
1837
1985
  */
1838
1986
  NextToken?: string;
1839
1987
  /**
1988
+ * @public
1840
1989
  * <p>Use this parameter when paginating results to specify the maximum number of items to
1841
1990
  * return in the response on each page. If additional items exist beyond the number you
1842
1991
  * specify, the <code>NextToken</code> element is sent in the response. Use this
@@ -1845,6 +1994,7 @@ export interface ListCertificateAuthoritiesRequest {
1845
1994
  */
1846
1995
  MaxResults?: number;
1847
1996
  /**
1997
+ * @public
1848
1998
  * <p>Use this parameter to filter the returned set of certificate authorities based on
1849
1999
  * their owner. The default is SELF.</p>
1850
2000
  */
@@ -1855,10 +2005,12 @@ export interface ListCertificateAuthoritiesRequest {
1855
2005
  */
1856
2006
  export interface ListCertificateAuthoritiesResponse {
1857
2007
  /**
2008
+ * @public
1858
2009
  * <p>Summary information about each certificate authority you have created.</p>
1859
2010
  */
1860
2011
  CertificateAuthorities?: CertificateAuthority[];
1861
2012
  /**
2013
+ * @public
1862
2014
  * <p>When the list is truncated, this value is present and should be used for the
1863
2015
  * <code>NextToken</code> parameter in a subsequent pagination request.</p>
1864
2016
  */
@@ -1869,6 +2021,7 @@ export interface ListCertificateAuthoritiesResponse {
1869
2021
  */
1870
2022
  export interface ListPermissionsRequest {
1871
2023
  /**
2024
+ * @public
1872
2025
  * <p>The Amazon Resource Number (ARN) of the private CA to inspect. You can find the ARN by
1873
2026
  * calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action. This must be of the form:
1874
2027
  * <code>arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012</code>
@@ -1876,11 +2029,13 @@ export interface ListPermissionsRequest {
1876
2029
  */
1877
2030
  CertificateAuthorityArn: string | undefined;
1878
2031
  /**
2032
+ * @public
1879
2033
  * <p>When paginating results, use this parameter in a subsequent request after you receive
1880
2034
  * a response with truncated results. Set it to the value of <b>NextToken</b> from the response you just received.</p>
1881
2035
  */
1882
2036
  NextToken?: string;
1883
2037
  /**
2038
+ * @public
1884
2039
  * <p>When paginating results, use this parameter to specify the maximum number of items to
1885
2040
  * return in the response. If additional items exist beyond the number you specify, the
1886
2041
  * <b>NextToken</b> element is sent in the response. Use this
@@ -1901,28 +2056,34 @@ export interface ListPermissionsRequest {
1901
2056
  */
1902
2057
  export interface Permission {
1903
2058
  /**
2059
+ * @public
1904
2060
  * <p>The Amazon Resource Number (ARN) of the private CA from which the permission was
1905
2061
  * issued.</p>
1906
2062
  */
1907
2063
  CertificateAuthorityArn?: string;
1908
2064
  /**
2065
+ * @public
1909
2066
  * <p>The time at which the permission was created.</p>
1910
2067
  */
1911
2068
  CreatedAt?: Date;
1912
2069
  /**
2070
+ * @public
1913
2071
  * <p>The Amazon Web Services service or entity that holds the permission. At this time, the only valid
1914
2072
  * principal is <code>acm.amazonaws.com</code>.</p>
1915
2073
  */
1916
2074
  Principal?: string;
1917
2075
  /**
2076
+ * @public
1918
2077
  * <p>The ID of the account that assigned the permission.</p>
1919
2078
  */
1920
2079
  SourceAccount?: string;
1921
2080
  /**
2081
+ * @public
1922
2082
  * <p>The private CA actions that can be performed by the designated Amazon Web Services service.</p>
1923
2083
  */
1924
2084
  Actions?: (ActionType | string)[];
1925
2085
  /**
2086
+ * @public
1926
2087
  * <p>The name of the policy that is associated with the permission.</p>
1927
2088
  */
1928
2089
  Policy?: string;
@@ -1932,11 +2093,13 @@ export interface Permission {
1932
2093
  */
1933
2094
  export interface ListPermissionsResponse {
1934
2095
  /**
2096
+ * @public
1935
2097
  * <p>Summary information about each permission assigned by the specified private CA,
1936
2098
  * including the action enabled, the policy provided, and the time of creation.</p>
1937
2099
  */
1938
2100
  Permissions?: Permission[];
1939
2101
  /**
2102
+ * @public
1940
2103
  * <p>When the list is truncated, this value is present and should be used for the <b>NextToken</b> parameter in a subsequent pagination request.
1941
2104
  * </p>
1942
2105
  */
@@ -1947,6 +2110,7 @@ export interface ListPermissionsResponse {
1947
2110
  */
1948
2111
  export interface ListTagsRequest {
1949
2112
  /**
2113
+ * @public
1950
2114
  * <p>The Amazon Resource Name (ARN) that was returned when you called the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action. This must be of the form: </p>
1951
2115
  * <p>
1952
2116
  * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
@@ -1955,11 +2119,13 @@ export interface ListTagsRequest {
1955
2119
  */
1956
2120
  CertificateAuthorityArn: string | undefined;
1957
2121
  /**
2122
+ * @public
1958
2123
  * <p>Use this parameter when paginating results in a subsequent request after you receive a
1959
2124
  * response with truncated results. Set it to the value of <b>NextToken</b> from the response you just received.</p>
1960
2125
  */
1961
2126
  NextToken?: string;
1962
2127
  /**
2128
+ * @public
1963
2129
  * <p>Use this parameter when paginating results to specify the maximum number of items to
1964
2130
  * return in the response. If additional items exist beyond the number you specify, the
1965
2131
  * <b>NextToken</b> element is sent in the response. Use this
@@ -1973,10 +2139,12 @@ export interface ListTagsRequest {
1973
2139
  */
1974
2140
  export interface ListTagsResponse {
1975
2141
  /**
2142
+ * @public
1976
2143
  * <p>The tags associated with your private CA.</p>
1977
2144
  */
1978
2145
  Tags?: Tag[];
1979
2146
  /**
2147
+ * @public
1980
2148
  * <p>When the list is truncated, this value is present and should be used for the <b>NextToken</b> parameter in a subsequent pagination request.
1981
2149
  * </p>
1982
2150
  */
@@ -1987,12 +2155,14 @@ export interface ListTagsResponse {
1987
2155
  */
1988
2156
  export interface PutPolicyRequest {
1989
2157
  /**
2158
+ * @public
1990
2159
  * <p>The Amazon Resource Number (ARN) of the private CA to associate with the policy. The
1991
2160
  * ARN of the CA can be found by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action.</p>
1992
2161
  * <p></p>
1993
2162
  */
1994
2163
  ResourceArn: string | undefined;
1995
2164
  /**
2165
+ * @public
1996
2166
  * <p>The path and file name of a JSON-formatted IAM policy to attach to the specified
1997
2167
  * private CA resource. If this policy does not contain all required statements or if it
1998
2168
  * includes any statement that is not allowed, the <code>PutPolicy</code> action returns an
@@ -2006,6 +2176,7 @@ export interface PutPolicyRequest {
2006
2176
  */
2007
2177
  export interface RestoreCertificateAuthorityRequest {
2008
2178
  /**
2179
+ * @public
2009
2180
  * <p>The Amazon Resource Name (ARN) that was returned when you called the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action. This must be of the form: </p>
2010
2181
  * <p>
2011
2182
  * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
@@ -2049,6 +2220,7 @@ export type RevocationReason = (typeof RevocationReason)[keyof typeof Revocation
2049
2220
  */
2050
2221
  export interface RevokeCertificateRequest {
2051
2222
  /**
2223
+ * @public
2052
2224
  * <p>Amazon Resource Name (ARN) of the private CA that issued the certificate to be
2053
2225
  * revoked. This must be of the form:</p>
2054
2226
  * <p>
@@ -2058,6 +2230,7 @@ export interface RevokeCertificateRequest {
2058
2230
  */
2059
2231
  CertificateAuthorityArn: string | undefined;
2060
2232
  /**
2233
+ * @public
2061
2234
  * <p>Serial number of the certificate to be revoked. This must be in hexadecimal format.
2062
2235
  * You can retrieve the serial number by calling <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html">GetCertificate</a> with the Amazon
2063
2236
  * Resource Name (ARN) of the certificate you want and the ARN of your private CA. The
@@ -2072,6 +2245,7 @@ export interface RevokeCertificateRequest {
2072
2245
  */
2073
2246
  CertificateSerial: string | undefined;
2074
2247
  /**
2248
+ * @public
2075
2249
  * <p>Specifies why you revoked the certificate.</p>
2076
2250
  */
2077
2251
  RevocationReason: RevocationReason | string | undefined;
@@ -2081,6 +2255,7 @@ export interface RevokeCertificateRequest {
2081
2255
  */
2082
2256
  export interface TagCertificateAuthorityRequest {
2083
2257
  /**
2258
+ * @public
2084
2259
  * <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>. This must be of the form: </p>
2085
2260
  * <p>
2086
2261
  * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
@@ -2089,6 +2264,7 @@ export interface TagCertificateAuthorityRequest {
2089
2264
  */
2090
2265
  CertificateAuthorityArn: string | undefined;
2091
2266
  /**
2267
+ * @public
2092
2268
  * <p>List of tags to be associated with the CA.</p>
2093
2269
  */
2094
2270
  Tags: Tag[] | undefined;
@@ -2111,6 +2287,7 @@ export declare class TooManyTagsException extends __BaseException {
2111
2287
  */
2112
2288
  export interface UntagCertificateAuthorityRequest {
2113
2289
  /**
2290
+ * @public
2114
2291
  * <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>. This must be of the form: </p>
2115
2292
  * <p>
2116
2293
  * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
@@ -2119,6 +2296,7 @@ export interface UntagCertificateAuthorityRequest {
2119
2296
  */
2120
2297
  CertificateAuthorityArn: string | undefined;
2121
2298
  /**
2299
+ * @public
2122
2300
  * <p>List of tags to be removed from the CA.</p>
2123
2301
  */
2124
2302
  Tags: Tag[] | undefined;
@@ -2128,6 +2306,7 @@ export interface UntagCertificateAuthorityRequest {
2128
2306
  */
2129
2307
  export interface UpdateCertificateAuthorityRequest {
2130
2308
  /**
2309
+ * @public
2131
2310
  * <p>Amazon Resource Name (ARN) of the private CA that issued the certificate to be
2132
2311
  * revoked. This must be of the form:</p>
2133
2312
  * <p>
@@ -2137,6 +2316,7 @@ export interface UpdateCertificateAuthorityRequest {
2137
2316
  */
2138
2317
  CertificateAuthorityArn: string | undefined;
2139
2318
  /**
2319
+ * @public
2140
2320
  * <p>Contains information to enable Online Certificate Status Protocol (OCSP) support, to
2141
2321
  * enable a certificate revocation list (CRL), to enable both, or to enable neither. If
2142
2322
  * this parameter is not supplied, existing capibilites remain unchanged. For more
@@ -2168,6 +2348,7 @@ export interface UpdateCertificateAuthorityRequest {
2168
2348
  */
2169
2349
  RevocationConfiguration?: RevocationConfiguration;
2170
2350
  /**
2351
+ * @public
2171
2352
  * <p>Status of your private CA.</p>
2172
2353
  */
2173
2354
  Status?: CertificateAuthorityStatus | string;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-acm-pca",
3
3
  "description": "AWS SDK for JavaScript Acm Pca Client for Node.js, Browser and React Native",
4
- "version": "3.379.1",
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.379.1",
25
- "@aws-sdk/credential-provider-node": "3.379.1",
24
+ "@aws-sdk/client-sts": "3.382.0",
25
+ "@aws-sdk/credential-provider-node": "3.382.0",
26
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
29
  "@aws-sdk/middleware-signing": "3.379.1",
30
- "@aws-sdk/middleware-user-agent": "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",