@aws-sdk/client-acm-pca 3.35.0 → 3.36.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.
Files changed (211) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/dist-cjs/ACMPCA.js +0 -1
  3. package/dist-cjs/ACMPCAClient.js +0 -1
  4. package/dist-cjs/commands/CreateCertificateAuthorityAuditReportCommand.js +0 -1
  5. package/dist-cjs/commands/CreateCertificateAuthorityCommand.js +0 -1
  6. package/dist-cjs/commands/CreatePermissionCommand.js +0 -1
  7. package/dist-cjs/commands/DeleteCertificateAuthorityCommand.js +0 -1
  8. package/dist-cjs/commands/DeletePermissionCommand.js +0 -1
  9. package/dist-cjs/commands/DeletePolicyCommand.js +0 -1
  10. package/dist-cjs/commands/DescribeCertificateAuthorityAuditReportCommand.js +0 -1
  11. package/dist-cjs/commands/DescribeCertificateAuthorityCommand.js +0 -1
  12. package/dist-cjs/commands/GetCertificateAuthorityCertificateCommand.js +0 -1
  13. package/dist-cjs/commands/GetCertificateAuthorityCsrCommand.js +0 -1
  14. package/dist-cjs/commands/GetCertificateCommand.js +0 -1
  15. package/dist-cjs/commands/GetPolicyCommand.js +0 -1
  16. package/dist-cjs/commands/ImportCertificateAuthorityCertificateCommand.js +0 -1
  17. package/dist-cjs/commands/IssueCertificateCommand.js +0 -1
  18. package/dist-cjs/commands/ListCertificateAuthoritiesCommand.js +0 -1
  19. package/dist-cjs/commands/ListPermissionsCommand.js +0 -1
  20. package/dist-cjs/commands/ListTagsCommand.js +0 -1
  21. package/dist-cjs/commands/PutPolicyCommand.js +0 -1
  22. package/dist-cjs/commands/RestoreCertificateAuthorityCommand.js +0 -1
  23. package/dist-cjs/commands/RevokeCertificateCommand.js +0 -1
  24. package/dist-cjs/commands/TagCertificateAuthorityCommand.js +0 -1
  25. package/dist-cjs/commands/UntagCertificateAuthorityCommand.js +0 -1
  26. package/dist-cjs/commands/UpdateCertificateAuthorityCommand.js +0 -1
  27. package/dist-cjs/endpoints.js +0 -1
  28. package/dist-cjs/index.js +0 -1
  29. package/dist-cjs/models/index.js +0 -1
  30. package/dist-cjs/models/models_0.js +0 -1
  31. package/dist-cjs/pagination/Interfaces.js +0 -1
  32. package/dist-cjs/pagination/ListCertificateAuthoritiesPaginator.js +0 -1
  33. package/dist-cjs/pagination/ListPermissionsPaginator.js +0 -1
  34. package/dist-cjs/pagination/ListTagsPaginator.js +0 -1
  35. package/dist-cjs/protocols/Aws_json1_1.js +0 -1
  36. package/dist-cjs/runtimeConfig.browser.js +2 -3
  37. package/dist-cjs/runtimeConfig.js +3 -4
  38. package/dist-cjs/runtimeConfig.native.js +0 -1
  39. package/dist-cjs/runtimeConfig.shared.js +0 -1
  40. package/dist-cjs/waiters/waitForAuditReportCreated.js +0 -1
  41. package/dist-cjs/waiters/waitForCertificateAuthorityCSRCreated.js +0 -1
  42. package/dist-cjs/waiters/waitForCertificateIssued.js +0 -1
  43. package/dist-es/ACMPCA.js +0 -1
  44. package/dist-es/ACMPCAClient.js +0 -1
  45. package/dist-es/commands/CreateCertificateAuthorityAuditReportCommand.js +0 -1
  46. package/dist-es/commands/CreateCertificateAuthorityCommand.js +0 -1
  47. package/dist-es/commands/CreatePermissionCommand.js +0 -1
  48. package/dist-es/commands/DeleteCertificateAuthorityCommand.js +0 -1
  49. package/dist-es/commands/DeletePermissionCommand.js +0 -1
  50. package/dist-es/commands/DeletePolicyCommand.js +0 -1
  51. package/dist-es/commands/DescribeCertificateAuthorityAuditReportCommand.js +0 -1
  52. package/dist-es/commands/DescribeCertificateAuthorityCommand.js +0 -1
  53. package/dist-es/commands/GetCertificateAuthorityCertificateCommand.js +0 -1
  54. package/dist-es/commands/GetCertificateAuthorityCsrCommand.js +0 -1
  55. package/dist-es/commands/GetCertificateCommand.js +0 -1
  56. package/dist-es/commands/GetPolicyCommand.js +0 -1
  57. package/dist-es/commands/ImportCertificateAuthorityCertificateCommand.js +0 -1
  58. package/dist-es/commands/IssueCertificateCommand.js +0 -1
  59. package/dist-es/commands/ListCertificateAuthoritiesCommand.js +0 -1
  60. package/dist-es/commands/ListPermissionsCommand.js +0 -1
  61. package/dist-es/commands/ListTagsCommand.js +0 -1
  62. package/dist-es/commands/PutPolicyCommand.js +0 -1
  63. package/dist-es/commands/RestoreCertificateAuthorityCommand.js +0 -1
  64. package/dist-es/commands/RevokeCertificateCommand.js +0 -1
  65. package/dist-es/commands/TagCertificateAuthorityCommand.js +0 -1
  66. package/dist-es/commands/UntagCertificateAuthorityCommand.js +0 -1
  67. package/dist-es/commands/UpdateCertificateAuthorityCommand.js +0 -1
  68. package/dist-es/endpoints.js +0 -1
  69. package/dist-es/index.js +0 -1
  70. package/dist-es/models/index.js +0 -1
  71. package/dist-es/models/models_0.js +0 -1
  72. package/dist-es/pagination/Interfaces.js +0 -1
  73. package/dist-es/pagination/ListCertificateAuthoritiesPaginator.js +0 -1
  74. package/dist-es/pagination/ListPermissionsPaginator.js +0 -1
  75. package/dist-es/pagination/ListTagsPaginator.js +0 -1
  76. package/dist-es/protocols/Aws_json1_1.js +0 -1
  77. package/dist-es/runtimeConfig.browser.js +1 -2
  78. package/dist-es/runtimeConfig.js +2 -3
  79. package/dist-es/runtimeConfig.native.js +0 -1
  80. package/dist-es/runtimeConfig.shared.js +0 -1
  81. package/dist-es/waiters/waitForAuditReportCreated.js +0 -1
  82. package/dist-es/waiters/waitForCertificateAuthorityCSRCreated.js +0 -1
  83. package/dist-es/waiters/waitForCertificateIssued.js +0 -1
  84. package/package.json +34 -31
  85. package/dist-cjs/ACMPCA.js.map +0 -1
  86. package/dist-cjs/ACMPCAClient.js.map +0 -1
  87. package/dist-cjs/commands/CreateCertificateAuthorityAuditReportCommand.js.map +0 -1
  88. package/dist-cjs/commands/CreateCertificateAuthorityCommand.js.map +0 -1
  89. package/dist-cjs/commands/CreatePermissionCommand.js.map +0 -1
  90. package/dist-cjs/commands/DeleteCertificateAuthorityCommand.js.map +0 -1
  91. package/dist-cjs/commands/DeletePermissionCommand.js.map +0 -1
  92. package/dist-cjs/commands/DeletePolicyCommand.js.map +0 -1
  93. package/dist-cjs/commands/DescribeCertificateAuthorityAuditReportCommand.js.map +0 -1
  94. package/dist-cjs/commands/DescribeCertificateAuthorityCommand.js.map +0 -1
  95. package/dist-cjs/commands/GetCertificateAuthorityCertificateCommand.js.map +0 -1
  96. package/dist-cjs/commands/GetCertificateAuthorityCsrCommand.js.map +0 -1
  97. package/dist-cjs/commands/GetCertificateCommand.js.map +0 -1
  98. package/dist-cjs/commands/GetPolicyCommand.js.map +0 -1
  99. package/dist-cjs/commands/ImportCertificateAuthorityCertificateCommand.js.map +0 -1
  100. package/dist-cjs/commands/IssueCertificateCommand.js.map +0 -1
  101. package/dist-cjs/commands/ListCertificateAuthoritiesCommand.js.map +0 -1
  102. package/dist-cjs/commands/ListPermissionsCommand.js.map +0 -1
  103. package/dist-cjs/commands/ListTagsCommand.js.map +0 -1
  104. package/dist-cjs/commands/PutPolicyCommand.js.map +0 -1
  105. package/dist-cjs/commands/RestoreCertificateAuthorityCommand.js.map +0 -1
  106. package/dist-cjs/commands/RevokeCertificateCommand.js.map +0 -1
  107. package/dist-cjs/commands/TagCertificateAuthorityCommand.js.map +0 -1
  108. package/dist-cjs/commands/UntagCertificateAuthorityCommand.js.map +0 -1
  109. package/dist-cjs/commands/UpdateCertificateAuthorityCommand.js.map +0 -1
  110. package/dist-cjs/endpoints.js.map +0 -1
  111. package/dist-cjs/index.js.map +0 -1
  112. package/dist-cjs/models/index.js.map +0 -1
  113. package/dist-cjs/models/models_0.js.map +0 -1
  114. package/dist-cjs/pagination/Interfaces.js.map +0 -1
  115. package/dist-cjs/pagination/ListCertificateAuthoritiesPaginator.js.map +0 -1
  116. package/dist-cjs/pagination/ListPermissionsPaginator.js.map +0 -1
  117. package/dist-cjs/pagination/ListTagsPaginator.js.map +0 -1
  118. package/dist-cjs/protocols/Aws_json1_1.js.map +0 -1
  119. package/dist-cjs/runtimeConfig.browser.js.map +0 -1
  120. package/dist-cjs/runtimeConfig.js.map +0 -1
  121. package/dist-cjs/runtimeConfig.native.js.map +0 -1
  122. package/dist-cjs/runtimeConfig.shared.js.map +0 -1
  123. package/dist-cjs/waiters/waitForAuditReportCreated.js.map +0 -1
  124. package/dist-cjs/waiters/waitForCertificateAuthorityCSRCreated.js.map +0 -1
  125. package/dist-cjs/waiters/waitForCertificateIssued.js.map +0 -1
  126. package/dist-es/ACMPCA.js.map +0 -1
  127. package/dist-es/ACMPCAClient.js.map +0 -1
  128. package/dist-es/commands/CreateCertificateAuthorityAuditReportCommand.js.map +0 -1
  129. package/dist-es/commands/CreateCertificateAuthorityCommand.js.map +0 -1
  130. package/dist-es/commands/CreatePermissionCommand.js.map +0 -1
  131. package/dist-es/commands/DeleteCertificateAuthorityCommand.js.map +0 -1
  132. package/dist-es/commands/DeletePermissionCommand.js.map +0 -1
  133. package/dist-es/commands/DeletePolicyCommand.js.map +0 -1
  134. package/dist-es/commands/DescribeCertificateAuthorityAuditReportCommand.js.map +0 -1
  135. package/dist-es/commands/DescribeCertificateAuthorityCommand.js.map +0 -1
  136. package/dist-es/commands/GetCertificateAuthorityCertificateCommand.js.map +0 -1
  137. package/dist-es/commands/GetCertificateAuthorityCsrCommand.js.map +0 -1
  138. package/dist-es/commands/GetCertificateCommand.js.map +0 -1
  139. package/dist-es/commands/GetPolicyCommand.js.map +0 -1
  140. package/dist-es/commands/ImportCertificateAuthorityCertificateCommand.js.map +0 -1
  141. package/dist-es/commands/IssueCertificateCommand.js.map +0 -1
  142. package/dist-es/commands/ListCertificateAuthoritiesCommand.js.map +0 -1
  143. package/dist-es/commands/ListPermissionsCommand.js.map +0 -1
  144. package/dist-es/commands/ListTagsCommand.js.map +0 -1
  145. package/dist-es/commands/PutPolicyCommand.js.map +0 -1
  146. package/dist-es/commands/RestoreCertificateAuthorityCommand.js.map +0 -1
  147. package/dist-es/commands/RevokeCertificateCommand.js.map +0 -1
  148. package/dist-es/commands/TagCertificateAuthorityCommand.js.map +0 -1
  149. package/dist-es/commands/UntagCertificateAuthorityCommand.js.map +0 -1
  150. package/dist-es/commands/UpdateCertificateAuthorityCommand.js.map +0 -1
  151. package/dist-es/endpoints.js.map +0 -1
  152. package/dist-es/index.js.map +0 -1
  153. package/dist-es/models/index.js.map +0 -1
  154. package/dist-es/models/models_0.js.map +0 -1
  155. package/dist-es/pagination/Interfaces.js.map +0 -1
  156. package/dist-es/pagination/ListCertificateAuthoritiesPaginator.js.map +0 -1
  157. package/dist-es/pagination/ListPermissionsPaginator.js.map +0 -1
  158. package/dist-es/pagination/ListTagsPaginator.js.map +0 -1
  159. package/dist-es/protocols/Aws_json1_1.js.map +0 -1
  160. package/dist-es/runtimeConfig.browser.js.map +0 -1
  161. package/dist-es/runtimeConfig.js.map +0 -1
  162. package/dist-es/runtimeConfig.native.js.map +0 -1
  163. package/dist-es/runtimeConfig.shared.js.map +0 -1
  164. package/dist-es/waiters/waitForAuditReportCreated.js.map +0 -1
  165. package/dist-es/waiters/waitForCertificateAuthorityCSRCreated.js.map +0 -1
  166. package/dist-es/waiters/waitForCertificateIssued.js.map +0 -1
  167. package/jest.config.js +0 -4
  168. package/src/ACMPCA.ts +0 -1323
  169. package/src/ACMPCAClient.ts +0 -361
  170. package/src/commands/CreateCertificateAuthorityAuditReportCommand.ts +0 -122
  171. package/src/commands/CreateCertificateAuthorityCommand.ts +0 -118
  172. package/src/commands/CreatePermissionCommand.ts +0 -121
  173. package/src/commands/DeleteCertificateAuthorityCommand.ts +0 -117
  174. package/src/commands/DeletePermissionCommand.ts +0 -123
  175. package/src/commands/DeletePolicyCommand.ts +0 -129
  176. package/src/commands/DescribeCertificateAuthorityAuditReportCommand.ts +0 -113
  177. package/src/commands/DescribeCertificateAuthorityCommand.ts +0 -140
  178. package/src/commands/GetCertificateAuthorityCertificateCommand.ts +0 -109
  179. package/src/commands/GetCertificateAuthorityCsrCommand.ts +0 -102
  180. package/src/commands/GetCertificateCommand.ts +0 -102
  181. package/src/commands/GetPolicyCommand.ts +0 -122
  182. package/src/commands/ImportCertificateAuthorityCertificateCommand.ts +0 -229
  183. package/src/commands/IssueCertificateCommand.ts +0 -102
  184. package/src/commands/ListCertificateAuthoritiesCommand.ts +0 -98
  185. package/src/commands/ListPermissionsCommand.ts +0 -122
  186. package/src/commands/ListTagsCommand.ts +0 -91
  187. package/src/commands/PutPolicyCommand.ts +0 -123
  188. package/src/commands/RestoreCertificateAuthorityCommand.ts +0 -108
  189. package/src/commands/RevokeCertificateCommand.ts +0 -114
  190. package/src/commands/TagCertificateAuthorityCommand.ts +0 -102
  191. package/src/commands/UntagCertificateAuthorityCommand.ts +0 -102
  192. package/src/commands/UpdateCertificateAuthorityCommand.ts +0 -108
  193. package/src/endpoints.ts +0 -91
  194. package/src/index.ts +0 -33
  195. package/src/models/index.ts +0 -1
  196. package/src/models/models_0.ts +0 -2571
  197. package/src/pagination/Interfaces.ts +0 -8
  198. package/src/pagination/ListCertificateAuthoritiesPaginator.ts +0 -59
  199. package/src/pagination/ListPermissionsPaginator.ts +0 -59
  200. package/src/pagination/ListTagsPaginator.ts +0 -55
  201. package/src/protocols/Aws_json1_1.ts +0 -3845
  202. package/src/runtimeConfig.browser.ts +0 -41
  203. package/src/runtimeConfig.native.ts +0 -17
  204. package/src/runtimeConfig.shared.ts +0 -17
  205. package/src/runtimeConfig.ts +0 -46
  206. package/src/waiters/waitForAuditReportCreated.ts +0 -61
  207. package/src/waiters/waitForCertificateAuthorityCSRCreated.ts +0 -49
  208. package/src/waiters/waitForCertificateIssued.ts +0 -43
  209. package/tsconfig.es.json +0 -10
  210. package/tsconfig.json +0 -33
  211. package/tsconfig.types.json +0 -9
@@ -1,2571 +0,0 @@
1
- import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
-
3
- /**
4
- * <p>Contains information about the certificate subject. The <code>Subject</code> field in
5
- * the certificate identifies the entity that owns or controls the public key in the
6
- * certificate. The entity can be a user, computer, device, or service. The <code>Subject
7
- * </code>must contain an X.500 distinguished name (DN). A DN is a sequence of relative
8
- * distinguished names (RDNs). The RDNs are separated by commas in the certificate.</p>
9
- */
10
- export interface ASN1Subject {
11
- /**
12
- * <p>Two-digit code that specifies the country in which the certificate subject
13
- * located.</p>
14
- */
15
- Country?: string;
16
-
17
- /**
18
- * <p>Legal name of the organization with which the certificate subject is affiliated.
19
- * </p>
20
- */
21
- Organization?: string;
22
-
23
- /**
24
- * <p>A subdivision or unit of the organization (such as sales or finance) with which the
25
- * certificate subject is affiliated.</p>
26
- */
27
- OrganizationalUnit?: string;
28
-
29
- /**
30
- * <p>Disambiguating information for the certificate subject.</p>
31
- */
32
- DistinguishedNameQualifier?: string;
33
-
34
- /**
35
- * <p>State in which the subject of the certificate is located.</p>
36
- */
37
- State?: string;
38
-
39
- /**
40
- * <p>For CA and end-entity certificates in a private PKI, the common name (CN) can be any
41
- * string within the length limit. </p>
42
- * <p>Note: In publicly trusted certificates, the common name must be a fully qualified
43
- * domain name (FQDN) associated with the certificate subject.</p>
44
- */
45
- CommonName?: string;
46
-
47
- /**
48
- * <p>The certificate serial number.</p>
49
- */
50
- SerialNumber?: string;
51
-
52
- /**
53
- * <p>The locality (such as a city or town) in which the certificate subject is
54
- * located.</p>
55
- */
56
- Locality?: string;
57
-
58
- /**
59
- * <p>A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the
60
- * certificate subject.</p>
61
- */
62
- Title?: string;
63
-
64
- /**
65
- * <p>Family name. In the US and the UK, for example, the surname of an individual is
66
- * ordered last. In Asian cultures the surname is typically ordered first.</p>
67
- */
68
- Surname?: string;
69
-
70
- /**
71
- * <p>First name.</p>
72
- */
73
- GivenName?: string;
74
-
75
- /**
76
- * <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
77
- * first letter of the <b>Surname</b>.</p>
78
- */
79
- Initials?: string;
80
-
81
- /**
82
- * <p>Typically a shortened version of a longer <b>GivenName</b>.
83
- * For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth,
84
- * Liz, or Eliza.</p>
85
- */
86
- Pseudonym?: string;
87
-
88
- /**
89
- * <p>Typically a qualifier appended to the name of an individual. Examples include Jr. for
90
- * junior, Sr. for senior, and III for third.</p>
91
- */
92
- GenerationQualifier?: string;
93
- }
94
-
95
- export namespace ASN1Subject {
96
- /**
97
- * @internal
98
- */
99
- export const filterSensitiveLog = (obj: ASN1Subject): any => ({
100
- ...obj,
101
- });
102
- }
103
-
104
- /**
105
- * <p>Describes an Electronic Data Interchange (EDI) entity as described in as defined in
106
- * <a href="https://tools.ietf.org/html/rfc5280">Subject Alternative Name</a> in
107
- * RFC 5280.</p>
108
- */
109
- export interface EdiPartyName {
110
- /**
111
- * <p>Specifies the party name.</p>
112
- */
113
- PartyName: string | undefined;
114
-
115
- /**
116
- * <p>Specifies the name assigner.</p>
117
- */
118
- NameAssigner?: string;
119
- }
120
-
121
- export namespace EdiPartyName {
122
- /**
123
- * @internal
124
- */
125
- export const filterSensitiveLog = (obj: EdiPartyName): any => ({
126
- ...obj,
127
- });
128
- }
129
-
130
- /**
131
- * <p>Defines a custom ASN.1 X.400 <code>GeneralName</code> using an object identifier (OID)
132
- * and value. The OID must satisfy the regular expression shown below. For more
133
- * information, see NIST's definition of <a href="https://csrc.nist.gov/glossary/term/Object_Identifier">Object Identifier
134
- * (OID)</a>.</p>
135
- */
136
- export interface OtherName {
137
- /**
138
- * <p>Specifies an OID. </p>
139
- */
140
- TypeId: string | undefined;
141
-
142
- /**
143
- * <p>Specifies an OID value.</p>
144
- */
145
- Value: string | undefined;
146
- }
147
-
148
- export namespace OtherName {
149
- /**
150
- * @internal
151
- */
152
- export const filterSensitiveLog = (obj: OtherName): any => ({
153
- ...obj,
154
- });
155
- }
156
-
157
- /**
158
- * <p>Describes an ASN.1 X.400 <code>GeneralName</code> as defined in <a href="https://tools.ietf.org/html/rfc5280">RFC 5280</a>. Only one of the
159
- * following naming options should be provided. Providing more than one option results in
160
- * an <code>InvalidArgsException</code> error.</p>
161
- */
162
- export interface GeneralName {
163
- /**
164
- * <p>Represents <code>GeneralName</code> using an <code>OtherName</code> object.</p>
165
- */
166
- OtherName?: OtherName;
167
-
168
- /**
169
- * <p>Represents <code>GeneralName</code> as an <a href="https://tools.ietf.org/html/rfc822">RFC 822</a> email address.</p>
170
- */
171
- Rfc822Name?: string;
172
-
173
- /**
174
- * <p>Represents <code>GeneralName</code> as a DNS name.</p>
175
- */
176
- DnsName?: string;
177
-
178
- /**
179
- * <p>Contains information about the certificate subject. The <code>Subject</code> field in
180
- * the certificate identifies the entity that owns or controls the public key in the
181
- * certificate. The entity can be a user, computer, device, or service. The <code>Subject
182
- * </code>must contain an X.500 distinguished name (DN). A DN is a sequence of relative
183
- * distinguished names (RDNs). The RDNs are separated by commas in the certificate.</p>
184
- */
185
- DirectoryName?: ASN1Subject;
186
-
187
- /**
188
- * <p>Represents <code>GeneralName</code> as an <code>EdiPartyName</code> object.</p>
189
- */
190
- EdiPartyName?: EdiPartyName;
191
-
192
- /**
193
- * <p>Represents <code>GeneralName</code> as a URI.</p>
194
- */
195
- UniformResourceIdentifier?: string;
196
-
197
- /**
198
- * <p>Represents <code>GeneralName</code> as an IPv4 or IPv6 address.</p>
199
- */
200
- IpAddress?: string;
201
-
202
- /**
203
- * <p> Represents <code>GeneralName</code> as an object identifier (OID).</p>
204
- */
205
- RegisteredId?: string;
206
- }
207
-
208
- export namespace GeneralName {
209
- /**
210
- * @internal
211
- */
212
- export const filterSensitiveLog = (obj: GeneralName): any => ({
213
- ...obj,
214
- });
215
- }
216
-
217
- export enum AccessMethodType {
218
- CA_REPOSITORY = "CA_REPOSITORY",
219
- RESOURCE_PKI_MANIFEST = "RESOURCE_PKI_MANIFEST",
220
- RESOURCE_PKI_NOTIFY = "RESOURCE_PKI_NOTIFY",
221
- }
222
-
223
- /**
224
- * <p>Describes the type and format of extension access. Only one of
225
- * <code>CustomObjectIdentifier</code> or <code>AccessMethodType</code> may be
226
- * provided. Providing both results in <code>InvalidArgsException</code>.</p>
227
- */
228
- export interface AccessMethod {
229
- /**
230
- * <p>An object identifier (OID) specifying the <code>AccessMethod</code>. The OID must
231
- * satisfy the regular expression shown below. For more information, see NIST's definition
232
- * of <a href="https://csrc.nist.gov/glossary/term/Object_Identifier">Object Identifier
233
- * (OID)</a>.</p>
234
- */
235
- CustomObjectIdentifier?: string;
236
-
237
- /**
238
- * <p>Specifies the <code>AccessMethod</code>.</p>
239
- */
240
- AccessMethodType?: AccessMethodType | string;
241
- }
242
-
243
- export namespace AccessMethod {
244
- /**
245
- * @internal
246
- */
247
- export const filterSensitiveLog = (obj: AccessMethod): any => ({
248
- ...obj,
249
- });
250
- }
251
-
252
- /**
253
- * <p>Provides access information used by the <code>authorityInfoAccess</code> and
254
- * <code>subjectInfoAccess</code> extensions described in <a href="https://tools.ietf.org/html/rfc5280">RFC 5280</a>.</p>
255
- */
256
- export interface AccessDescription {
257
- /**
258
- * <p>The type and format of <code>AccessDescription</code> information.</p>
259
- */
260
- AccessMethod: AccessMethod | undefined;
261
-
262
- /**
263
- * <p>The location of <code>AccessDescription</code> information.</p>
264
- */
265
- AccessLocation: GeneralName | undefined;
266
- }
267
-
268
- export namespace AccessDescription {
269
- /**
270
- * @internal
271
- */
272
- export const filterSensitiveLog = (obj: AccessDescription): any => ({
273
- ...obj,
274
- });
275
- }
276
-
277
- /**
278
- * <p>Defines one or more purposes for which the key contained in the certificate can be
279
- * used. Default value for each option is false.</p>
280
- */
281
- export interface KeyUsage {
282
- /**
283
- * <p> Key can be used for digital signing.</p>
284
- */
285
- DigitalSignature?: boolean;
286
-
287
- /**
288
- * <p>Key can be used for non-repudiation.</p>
289
- */
290
- NonRepudiation?: boolean;
291
-
292
- /**
293
- * <p>Key can be used to encipher data.</p>
294
- */
295
- KeyEncipherment?: boolean;
296
-
297
- /**
298
- * <p>Key can be used to decipher data.</p>
299
- */
300
- DataEncipherment?: boolean;
301
-
302
- /**
303
- * <p>Key can be used in a key-agreement protocol.</p>
304
- */
305
- KeyAgreement?: boolean;
306
-
307
- /**
308
- * <p>Key can be used to sign certificates.</p>
309
- */
310
- KeyCertSign?: boolean;
311
-
312
- /**
313
- * <p>Key can be used to sign CRLs.</p>
314
- */
315
- CRLSign?: boolean;
316
-
317
- /**
318
- * <p>Key can be used only to encipher data.</p>
319
- */
320
- EncipherOnly?: boolean;
321
-
322
- /**
323
- * <p>Key can be used only to decipher data.</p>
324
- */
325
- DecipherOnly?: boolean;
326
- }
327
-
328
- export namespace KeyUsage {
329
- /**
330
- * @internal
331
- */
332
- export const filterSensitiveLog = (obj: KeyUsage): any => ({
333
- ...obj,
334
- });
335
- }
336
-
337
- /**
338
- * <p>Describes the certificate extensions to be added to the certificate signing request
339
- * (CSR).</p>
340
- */
341
- export interface CsrExtensions {
342
- /**
343
- * <p>Indicates the purpose of the certificate and of the key contained in the
344
- * certificate.</p>
345
- */
346
- KeyUsage?: KeyUsage;
347
-
348
- /**
349
- * <p>For CA certificates, provides a path to additional information pertaining to the CA,
350
- * such as revocation and policy. For more information, see <a href="https://tools.ietf.org/html/rfc5280#section-4.2.2.2">Subject Information
351
- * Access</a> in RFC 5280.</p>
352
- */
353
- SubjectInformationAccess?: AccessDescription[];
354
- }
355
-
356
- export namespace CsrExtensions {
357
- /**
358
- * @internal
359
- */
360
- export const filterSensitiveLog = (obj: CsrExtensions): any => ({
361
- ...obj,
362
- });
363
- }
364
-
365
- export enum KeyAlgorithm {
366
- EC_prime256v1 = "EC_prime256v1",
367
- EC_secp384r1 = "EC_secp384r1",
368
- RSA_2048 = "RSA_2048",
369
- RSA_4096 = "RSA_4096",
370
- }
371
-
372
- export enum SigningAlgorithm {
373
- SHA256WITHECDSA = "SHA256WITHECDSA",
374
- SHA256WITHRSA = "SHA256WITHRSA",
375
- SHA384WITHECDSA = "SHA384WITHECDSA",
376
- SHA384WITHRSA = "SHA384WITHRSA",
377
- SHA512WITHECDSA = "SHA512WITHECDSA",
378
- SHA512WITHRSA = "SHA512WITHRSA",
379
- }
380
-
381
- /**
382
- * <p>Contains configuration information for your private certificate authority (CA). This
383
- * includes information about the class of public key algorithm and the key pair that your
384
- * private CA creates when it issues a certificate. It also includes the signature
385
- * algorithm that it uses when issuing certificates, and its X.500 distinguished name. You
386
- * must specify this information when you call the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action. </p>
387
- */
388
- export interface CertificateAuthorityConfiguration {
389
- /**
390
- * <p>Type of the public key algorithm and size, in bits, of the key pair that your CA
391
- * creates when it issues a certificate. When you create a subordinate CA, you must use a
392
- * key algorithm supported by the parent CA.</p>
393
- */
394
- KeyAlgorithm: KeyAlgorithm | string | undefined;
395
-
396
- /**
397
- * <p>Name of the algorithm your private CA uses to sign certificate requests.</p>
398
- * <p>This parameter should not be confused with the <code>SigningAlgorithm</code> parameter
399
- * used to sign certificates when they are issued.</p>
400
- */
401
- SigningAlgorithm: SigningAlgorithm | string | undefined;
402
-
403
- /**
404
- * <p>Structure that contains X.500 distinguished name information for your private
405
- * CA.</p>
406
- */
407
- Subject: ASN1Subject | undefined;
408
-
409
- /**
410
- * <p>Specifies information to be added to the extension section of the certificate signing
411
- * request (CSR).</p>
412
- */
413
- CsrExtensions?: CsrExtensions;
414
- }
415
-
416
- export namespace CertificateAuthorityConfiguration {
417
- /**
418
- * @internal
419
- */
420
- export const filterSensitiveLog = (obj: CertificateAuthorityConfiguration): any => ({
421
- ...obj,
422
- });
423
- }
424
-
425
- export enum CertificateAuthorityType {
426
- ROOT = "ROOT",
427
- SUBORDINATE = "SUBORDINATE",
428
- }
429
-
430
- export enum KeyStorageSecurityStandard {
431
- FIPS_140_2_LEVEL_2_OR_HIGHER = "FIPS_140_2_LEVEL_2_OR_HIGHER",
432
- FIPS_140_2_LEVEL_3_OR_HIGHER = "FIPS_140_2_LEVEL_3_OR_HIGHER",
433
- }
434
-
435
- export enum S3ObjectAcl {
436
- BUCKET_OWNER_FULL_CONTROL = "BUCKET_OWNER_FULL_CONTROL",
437
- PUBLIC_READ = "PUBLIC_READ",
438
- }
439
-
440
- /**
441
- * <p>Contains configuration information for a certificate revocation list (CRL). Your
442
- * private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You
443
- * can enable CRLs for your new or an existing private CA by setting the <b>Enabled</b> parameter to <code>true</code>. Your private CA
444
- * writes CRLs to an S3 bucket that you specify in the <b>S3BucketName</b> parameter. You can hide the name of your bucket by
445
- * specifying a value for the <b>CustomCname</b> parameter. Your
446
- * private CA copies the CNAME or the S3 bucket name to the <b>CRL
447
- * Distribution Points</b> extension of each certificate it issues. Your S3
448
- * bucket policy must give write permission to ACM Private CA. </p>
449
- * <p>ACM Private CA assets that are stored in Amazon S3 can be protected with encryption.
450
- * For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#crl-encryption">Encrypting Your
451
- * CRLs</a>.</p>
452
- * <p>Your private CA uses the value in the <b>ExpirationInDays</b>
453
- * parameter to calculate the <b>nextUpdate</b> field in the CRL.
454
- * The CRL is refreshed at 1/2 the age of next update or when a certificate is revoked.
455
- * When a certificate is revoked, it is recorded in the next CRL that is generated and in
456
- * the next audit report. Only time valid certificates are listed in the CRL. Expired
457
- * certificates are not included.</p>
458
- *
459
- * <p>A CRL is typically updated approximately 30 minutes after a certificate
460
- * is revoked. If for any reason a CRL update fails, ACM Private CA makes further attempts
461
- * every 15 minutes.</p>
462
- *
463
- * <p>CRLs contain the following fields:</p>
464
- * <ul>
465
- * <li>
466
- * <p>
467
- * <b>Version</b>: The current version number defined
468
- * in RFC 5280 is V2. The integer value is 0x1. </p>
469
- * </li>
470
- * <li>
471
- * <p>
472
- * <b>Signature Algorithm</b>: The name of the
473
- * algorithm used to sign the CRL.</p>
474
- * </li>
475
- * <li>
476
- * <p>
477
- * <b>Issuer</b>: The X.500 distinguished name of your
478
- * private CA that issued the CRL.</p>
479
- * </li>
480
- * <li>
481
- * <p>
482
- * <b>Last Update</b>: The issue date and time of this
483
- * CRL.</p>
484
- * </li>
485
- * <li>
486
- * <p>
487
- * <b>Next Update</b>: The day and time by which the
488
- * next CRL will be issued.</p>
489
- * </li>
490
- * <li>
491
- * <p>
492
- * <b>Revoked Certificates</b>: List of revoked
493
- * certificates. Each list item contains the following information.</p>
494
- * <ul>
495
- * <li>
496
- * <p>
497
- * <b>Serial Number</b>: The serial number, in
498
- * hexadecimal format, of the revoked certificate.</p>
499
- * </li>
500
- * <li>
501
- * <p>
502
- * <b>Revocation Date</b>: Date and time the
503
- * certificate was revoked.</p>
504
- * </li>
505
- * <li>
506
- * <p>
507
- * <b>CRL Entry Extensions</b>: Optional
508
- * extensions for the CRL entry.</p>
509
- * <ul>
510
- * <li>
511
- * <p>
512
- * <b>X509v3 CRL Reason Code</b>:
513
- * Reason the certificate was revoked.</p>
514
- * </li>
515
- * </ul>
516
- * </li>
517
- * </ul>
518
- * </li>
519
- * <li>
520
- * <p>
521
- * <b>CRL Extensions</b>: Optional extensions for the
522
- * CRL.</p>
523
- * <ul>
524
- * <li>
525
- * <p>
526
- * <b>X509v3 Authority Key Identifier</b>:
527
- * Identifies the public key associated with the private key used to sign
528
- * the certificate.</p>
529
- * </li>
530
- * <li>
531
- * <p>
532
- * <b>X509v3 CRL Number:</b>: Decimal sequence
533
- * number for the CRL.</p>
534
- * </li>
535
- * </ul>
536
- * </li>
537
- * <li>
538
- * <p>
539
- * <b>Signature Algorithm</b>: Algorithm used by your
540
- * private CA to sign the CRL.</p>
541
- * </li>
542
- * <li>
543
- * <p>
544
- * <b>Signature Value</b>: Signature computed over the
545
- * CRL.</p>
546
- * </li>
547
- * </ul>
548
- * <p>Certificate revocation lists created by ACM Private CA are DER-encoded. You can use the
549
- * following OpenSSL command to list a CRL.</p>
550
- * <p>
551
- * <code>openssl crl -inform DER -text -in <i>crl_path</i>
552
- * -noout</code>
553
- * </p>
554
- * <p>For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/crl-planning.html">Planning a certificate revocation list (CRL)</a>
555
- * in the <i>AWS Certificate Manager Private Certificate Authority (PCA) User Guide</i>
556
- * </p>
557
- */
558
- export interface CrlConfiguration {
559
- /**
560
- * <p>Boolean value that specifies whether certificate revocation lists (CRLs) are enabled.
561
- * You can use this value to enable certificate revocation for a new CA when you call the
562
- * <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action or for an existing CA when you call the
563
- * <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a> action. </p>
564
- */
565
- Enabled: boolean | undefined;
566
-
567
- /**
568
- * <p>Validity period of the CRL in days.</p>
569
- */
570
- ExpirationInDays?: number;
571
-
572
- /**
573
- * <p>Name inserted into the certificate <b>CRL Distribution
574
- * Points</b> extension that enables the use of an alias for the CRL
575
- * distribution point. Use this value if you don't want the name of your S3 bucket to be
576
- * public.</p>
577
- */
578
- CustomCname?: string;
579
-
580
- /**
581
- * <p>Name of the S3 bucket that contains the CRL. If you do not provide a value for the
582
- * <b>CustomCname</b> argument, the name of your S3 bucket
583
- * is placed into the <b>CRL Distribution Points</b> extension of
584
- * the issued certificate. You can change the name of your bucket by calling the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a> operation. You must specify a <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#s3-policies">bucket
585
- * policy</a> that allows ACM Private CA to write the CRL to your bucket.</p>
586
- */
587
- S3BucketName?: string;
588
-
589
- /**
590
- * <p>Determines whether the CRL will be publicly readable or privately held in the CRL
591
- * Amazon S3 bucket. If you choose PUBLIC_READ, the CRL will be accessible over the public
592
- * internet. If you choose BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket
593
- * can access the CRL, and your PKI clients may need an alternative method of access. </p>
594
- * <p>If no value is specified, the default is <code>PUBLIC_READ</code>.</p>
595
- * <p>
596
- * <i>Note:</i> This default can cause CA creation to fail in some
597
- * circumstances. If you have have enabled the Block Public Access (BPA) feature in your S3
598
- * account, then you must specify the value of this parameter as
599
- * <code>BUCKET_OWNER_FULL_CONTROL</code>, and not doing so results in an error. If you
600
- * have disabled BPA in S3, then you can specify either
601
- * <code>BUCKET_OWNER_FULL_CONTROL</code> or <code>PUBLIC_READ</code> as the
602
- * value.</p>
603
- * <p>For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#s3-bpa">Blocking public access to the S3
604
- * bucket</a>.</p>
605
- */
606
- S3ObjectAcl?: S3ObjectAcl | string;
607
- }
608
-
609
- export namespace CrlConfiguration {
610
- /**
611
- * @internal
612
- */
613
- export const filterSensitiveLog = (obj: CrlConfiguration): any => ({
614
- ...obj,
615
- });
616
- }
617
-
618
- /**
619
- * <p>Contains information to enable and configure Online Certificate Status Protocol (OCSP) for
620
- * validating certificate revocation status.</p>
621
- * <p>When you revoke a certificate, OCSP responses may take up to 60 minutes
622
- * to reflect the new status.</p>
623
- */
624
- export interface OcspConfiguration {
625
- /**
626
- * <p>Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating
627
- * certificate revocation status.</p>
628
- */
629
- Enabled: boolean | undefined;
630
-
631
- /**
632
- * <p>By default, ACM Private CA injects an AWS domain into certificates being validated by the
633
- * Online Certificate Status Protocol (OCSP). A customer can alternatively use this object
634
- * to define a CNAME specifying a customized OCSP domain.</p>
635
- * <p>Note: The value of the CNAME must not include a protocol prefix such as "http://" or
636
- * "https://".</p>
637
- * <p>For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/ocsp-customize.html">Customizing Online Certificate
638
- * Status Protocol (OCSP) </a> in the <i>AWS Certificate Manager Private Certificate Authority (PCA) User
639
- * Guide</i>.</p>
640
- */
641
- OcspCustomCname?: string;
642
- }
643
-
644
- export namespace OcspConfiguration {
645
- /**
646
- * @internal
647
- */
648
- export const filterSensitiveLog = (obj: OcspConfiguration): any => ({
649
- ...obj,
650
- });
651
- }
652
-
653
- /**
654
- * <p>Certificate revocation information used by the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> and <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a> actions. Your private certificate authority (CA)
655
- * can configure Online Certificate Status Protocol (OCSP) support and/or maintain a
656
- * certificate revocation list (CRL). OCSP returns validation information about
657
- * certificates as requested by clients, and a CRL contains an updated list of certificates
658
- * revoked by your CA. For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a> and <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/revocation-setup.html">Setting up a
659
- * certificate revocation method</a> in the <i>AWS Certificate Manager Private Certificate Authority (PCA) User
660
- * Guide</i>.</p>
661
- */
662
- export interface RevocationConfiguration {
663
- /**
664
- * <p>Configuration of the certificate revocation list (CRL), if any, maintained by your private
665
- * CA. A CRL is typically updated approximately 30 minutes after a certificate
666
- * is revoked. If for any reason a CRL update fails, ACM Private CA makes further attempts
667
- * every 15 minutes.</p>
668
- */
669
- CrlConfiguration?: CrlConfiguration;
670
-
671
- /**
672
- * <p>Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by
673
- * your private CA. When you revoke a certificate, OCSP responses may take up to 60 minutes
674
- * to reflect the new status.</p>
675
- */
676
- OcspConfiguration?: OcspConfiguration;
677
- }
678
-
679
- export namespace RevocationConfiguration {
680
- /**
681
- * @internal
682
- */
683
- export const filterSensitiveLog = (obj: RevocationConfiguration): any => ({
684
- ...obj,
685
- });
686
- }
687
-
688
- /**
689
- * <p>Tags are labels that you can use to identify and organize your private CAs. Each tag
690
- * consists of a key and an optional value. You can associate up to 50 tags with a private
691
- * CA. To add one or more tags to a private CA, call the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_TagCertificateAuthority.html">TagCertificateAuthority</a>
692
- * action. To remove a tag, call the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UntagCertificateAuthority.html">UntagCertificateAuthority</a> action. </p>
693
- */
694
- export interface Tag {
695
- /**
696
- * <p>Key (name) of the tag.</p>
697
- */
698
- Key: string | undefined;
699
-
700
- /**
701
- * <p>Value of the tag.</p>
702
- */
703
- Value?: string;
704
- }
705
-
706
- export namespace Tag {
707
- /**
708
- * @internal
709
- */
710
- export const filterSensitiveLog = (obj: Tag): any => ({
711
- ...obj,
712
- });
713
- }
714
-
715
- export interface CreateCertificateAuthorityRequest {
716
- /**
717
- * <p>Name and bit size of the private key algorithm, the name of the signing algorithm, and
718
- * X.500 certificate subject information.</p>
719
- */
720
- CertificateAuthorityConfiguration: CertificateAuthorityConfiguration | undefined;
721
-
722
- /**
723
- * <p>Contains information to enable Online Certificate Status Protocol (OCSP) support,
724
- * to enable a certificate revocation list (CRL), to enable both, or to enable neither. The
725
- * default is for both certificate validation mechanisms to be disabled. For more
726
- * information, see the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_OcspConfiguration.html">OcspConfiguration</a> and <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CrlConfiguration.html">CrlConfiguration</a> types.</p>
727
- */
728
- RevocationConfiguration?: RevocationConfiguration;
729
-
730
- /**
731
- * <p>The type of the certificate authority.</p>
732
- */
733
- CertificateAuthorityType: CertificateAuthorityType | string | undefined;
734
-
735
- /**
736
- * <p>Custom string that can be used to distinguish between calls to the <b>CreateCertificateAuthority</b> action. Idempotency tokens for
737
- * <b>CreateCertificateAuthority</b> time out after five
738
- * minutes. Therefore, if you call <b>CreateCertificateAuthority</b> multiple times with the same idempotency
739
- * token within five minutes, ACM Private CA recognizes that you are requesting only certificate
740
- * authority and will issue only one. If you change the idempotency token for each call,
741
- * PCA recognizes that you are requesting multiple certificate authorities.</p>
742
- */
743
- IdempotencyToken?: string;
744
-
745
- /**
746
- * <p>Specifies a
747
- * cryptographic key management compliance standard used for handling CA keys.</p>
748
- * <p>Default: FIPS_140_2_LEVEL_3_OR_HIGHER</p>
749
- * <p>Note: <code>FIPS_140_2_LEVEL_3_OR_HIGHER</code> is not supported in Region
750
- * ap-northeast-3. When creating a CA in the ap-northeast-3, you must provide
751
- * <code>FIPS_140_2_LEVEL_2_OR_HIGHER</code> as the argument for
752
- * <code>KeyStorageSecurityStandard</code>. Failure to do this results in an
753
- * <code>InvalidArgsException</code> with the message, "A certificate authority cannot
754
- * be created in this region with the specified security standard."</p>
755
- */
756
- KeyStorageSecurityStandard?: KeyStorageSecurityStandard | string;
757
-
758
- /**
759
- * <p>Key-value pairs that will be attached to the new private CA. You can associate up to
760
- * 50 tags with a private CA. For information using tags with IAM to manage permissions,
761
- * see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html">Controlling Access Using IAM Tags</a>.</p>
762
- */
763
- Tags?: Tag[];
764
- }
765
-
766
- export namespace CreateCertificateAuthorityRequest {
767
- /**
768
- * @internal
769
- */
770
- export const filterSensitiveLog = (obj: CreateCertificateAuthorityRequest): any => ({
771
- ...obj,
772
- });
773
- }
774
-
775
- export interface CreateCertificateAuthorityResponse {
776
- /**
777
- * <p>If successful, the Amazon Resource Name (ARN) of the certificate authority (CA). This
778
- * is of the form: </p>
779
- * <p>
780
- * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
781
- * </code>.
782
- * </p>
783
- */
784
- CertificateAuthorityArn?: string;
785
- }
786
-
787
- export namespace CreateCertificateAuthorityResponse {
788
- /**
789
- * @internal
790
- */
791
- export const filterSensitiveLog = (obj: CreateCertificateAuthorityResponse): any => ({
792
- ...obj,
793
- });
794
- }
795
-
796
- /**
797
- * <p>One or more of the specified arguments was not valid.</p>
798
- */
799
- export interface InvalidArgsException extends __SmithyException, $MetadataBearer {
800
- name: "InvalidArgsException";
801
- $fault: "client";
802
- message?: string;
803
- }
804
-
805
- export namespace InvalidArgsException {
806
- /**
807
- * @internal
808
- */
809
- export const filterSensitiveLog = (obj: InvalidArgsException): any => ({
810
- ...obj,
811
- });
812
- }
813
-
814
- /**
815
- * <p>The resource policy is invalid or is missing a required statement. For general
816
- * information about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview of JSON Policies</a>.</p>
817
- */
818
- export interface InvalidPolicyException extends __SmithyException, $MetadataBearer {
819
- name: "InvalidPolicyException";
820
- $fault: "client";
821
- message?: string;
822
- }
823
-
824
- export namespace InvalidPolicyException {
825
- /**
826
- * @internal
827
- */
828
- export const filterSensitiveLog = (obj: InvalidPolicyException): any => ({
829
- ...obj,
830
- });
831
- }
832
-
833
- /**
834
- * <p>The tag associated with the CA is not valid. The invalid argument is contained in the
835
- * message field.</p>
836
- */
837
- export interface InvalidTagException extends __SmithyException, $MetadataBearer {
838
- name: "InvalidTagException";
839
- $fault: "client";
840
- message?: string;
841
- }
842
-
843
- export namespace InvalidTagException {
844
- /**
845
- * @internal
846
- */
847
- export const filterSensitiveLog = (obj: InvalidTagException): any => ({
848
- ...obj,
849
- });
850
- }
851
-
852
- /**
853
- * <p>An ACM Private CA quota has been exceeded. See the exception message returned to determine the
854
- * quota that was exceeded.</p>
855
- */
856
- export interface LimitExceededException extends __SmithyException, $MetadataBearer {
857
- name: "LimitExceededException";
858
- $fault: "client";
859
- message?: string;
860
- }
861
-
862
- export namespace LimitExceededException {
863
- /**
864
- * @internal
865
- */
866
- export const filterSensitiveLog = (obj: LimitExceededException): any => ({
867
- ...obj,
868
- });
869
- }
870
-
871
- export enum AuditReportResponseFormat {
872
- CSV = "CSV",
873
- JSON = "JSON",
874
- }
875
-
876
- export interface CreateCertificateAuthorityAuditReportRequest {
877
- /**
878
- * <p>The Amazon Resource Name (ARN) of the CA to be audited. This is of the form:</p>
879
- * <p>
880
- * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
881
- * </code>.</p>
882
- */
883
- CertificateAuthorityArn: string | undefined;
884
-
885
- /**
886
- * <p>The name of the S3 bucket that will contain the audit report.</p>
887
- */
888
- S3BucketName: string | undefined;
889
-
890
- /**
891
- * <p>The format in which to create the report. This can be either <b>JSON</b> or <b>CSV</b>.</p>
892
- */
893
- AuditReportResponseFormat: AuditReportResponseFormat | string | undefined;
894
- }
895
-
896
- export namespace CreateCertificateAuthorityAuditReportRequest {
897
- /**
898
- * @internal
899
- */
900
- export const filterSensitiveLog = (obj: CreateCertificateAuthorityAuditReportRequest): any => ({
901
- ...obj,
902
- });
903
- }
904
-
905
- export interface CreateCertificateAuthorityAuditReportResponse {
906
- /**
907
- * <p>An alphanumeric string that contains a report identifier.</p>
908
- */
909
- AuditReportId?: string;
910
-
911
- /**
912
- * <p>The <b>key</b> that uniquely identifies the report file in
913
- * your S3 bucket.</p>
914
- */
915
- S3Key?: string;
916
- }
917
-
918
- export namespace CreateCertificateAuthorityAuditReportResponse {
919
- /**
920
- * @internal
921
- */
922
- export const filterSensitiveLog = (obj: CreateCertificateAuthorityAuditReportResponse): any => ({
923
- ...obj,
924
- });
925
- }
926
-
927
- /**
928
- * <p>The requested Amazon Resource Name (ARN) does not refer to an existing
929
- * resource.</p>
930
- */
931
- export interface InvalidArnException extends __SmithyException, $MetadataBearer {
932
- name: "InvalidArnException";
933
- $fault: "client";
934
- message?: string;
935
- }
936
-
937
- export namespace InvalidArnException {
938
- /**
939
- * @internal
940
- */
941
- export const filterSensitiveLog = (obj: InvalidArnException): any => ({
942
- ...obj,
943
- });
944
- }
945
-
946
- /**
947
- * <p>The state of the private CA does not allow this action to occur.</p>
948
- */
949
- export interface InvalidStateException extends __SmithyException, $MetadataBearer {
950
- name: "InvalidStateException";
951
- $fault: "client";
952
- message?: string;
953
- }
954
-
955
- export namespace InvalidStateException {
956
- /**
957
- * @internal
958
- */
959
- export const filterSensitiveLog = (obj: InvalidStateException): any => ({
960
- ...obj,
961
- });
962
- }
963
-
964
- /**
965
- * <p>The request has failed for an unspecified reason.</p>
966
- */
967
- export interface RequestFailedException extends __SmithyException, $MetadataBearer {
968
- name: "RequestFailedException";
969
- $fault: "client";
970
- message?: string;
971
- }
972
-
973
- export namespace RequestFailedException {
974
- /**
975
- * @internal
976
- */
977
- export const filterSensitiveLog = (obj: RequestFailedException): any => ({
978
- ...obj,
979
- });
980
- }
981
-
982
- /**
983
- * <p>Your request is already in progress.</p>
984
- */
985
- export interface RequestInProgressException extends __SmithyException, $MetadataBearer {
986
- name: "RequestInProgressException";
987
- $fault: "client";
988
- message?: string;
989
- }
990
-
991
- export namespace RequestInProgressException {
992
- /**
993
- * @internal
994
- */
995
- export const filterSensitiveLog = (obj: RequestInProgressException): any => ({
996
- ...obj,
997
- });
998
- }
999
-
1000
- /**
1001
- * <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy
1002
- * cannot be found.</p>
1003
- */
1004
- export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
1005
- name: "ResourceNotFoundException";
1006
- $fault: "client";
1007
- message?: string;
1008
- }
1009
-
1010
- export namespace ResourceNotFoundException {
1011
- /**
1012
- * @internal
1013
- */
1014
- export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({
1015
- ...obj,
1016
- });
1017
- }
1018
-
1019
- export enum ActionType {
1020
- GetCertificate = "GetCertificate",
1021
- IssueCertificate = "IssueCertificate",
1022
- ListPermissions = "ListPermissions",
1023
- }
1024
-
1025
- export interface CreatePermissionRequest {
1026
- /**
1027
- * <p>The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the
1028
- * ARN by calling the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action. This must have the following form: </p>
1029
- * <p>
1030
- * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
1031
- * </code>.
1032
- * </p>
1033
- */
1034
- CertificateAuthorityArn: string | undefined;
1035
-
1036
- /**
1037
- * <p>The AWS service or identity that receives the permission. At this time, the only
1038
- * valid principal is <code>acm.amazonaws.com</code>.</p>
1039
- */
1040
- Principal: string | undefined;
1041
-
1042
- /**
1043
- * <p>The ID of the calling account.</p>
1044
- */
1045
- SourceAccount?: string;
1046
-
1047
- /**
1048
- * <p>The actions that the specified AWS service principal can use. These include
1049
- * <code>IssueCertificate</code>, <code>GetCertificate</code>, and
1050
- * <code>ListPermissions</code>.</p>
1051
- */
1052
- Actions: (ActionType | string)[] | undefined;
1053
- }
1054
-
1055
- export namespace CreatePermissionRequest {
1056
- /**
1057
- * @internal
1058
- */
1059
- export const filterSensitiveLog = (obj: CreatePermissionRequest): any => ({
1060
- ...obj,
1061
- });
1062
- }
1063
-
1064
- /**
1065
- * <p>The designated permission has already been given to the user.</p>
1066
- */
1067
- export interface PermissionAlreadyExistsException extends __SmithyException, $MetadataBearer {
1068
- name: "PermissionAlreadyExistsException";
1069
- $fault: "client";
1070
- message?: string;
1071
- }
1072
-
1073
- export namespace PermissionAlreadyExistsException {
1074
- /**
1075
- * @internal
1076
- */
1077
- export const filterSensitiveLog = (obj: PermissionAlreadyExistsException): any => ({
1078
- ...obj,
1079
- });
1080
- }
1081
-
1082
- /**
1083
- * <p>A previous update to your private CA is still ongoing.</p>
1084
- */
1085
- export interface ConcurrentModificationException extends __SmithyException, $MetadataBearer {
1086
- name: "ConcurrentModificationException";
1087
- $fault: "client";
1088
- message?: string;
1089
- }
1090
-
1091
- export namespace ConcurrentModificationException {
1092
- /**
1093
- * @internal
1094
- */
1095
- export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({
1096
- ...obj,
1097
- });
1098
- }
1099
-
1100
- export interface DeleteCertificateAuthorityRequest {
1101
- /**
1102
- * <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>. This must have the following form: </p>
1103
- * <p>
1104
- * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
1105
- * </code>.
1106
- * </p>
1107
- */
1108
- CertificateAuthorityArn: string | undefined;
1109
-
1110
- /**
1111
- * <p>The number of days to make a CA restorable after it has been deleted. This can be
1112
- * anywhere from 7 to 30 days, with 30 being the default.</p>
1113
- */
1114
- PermanentDeletionTimeInDays?: number;
1115
- }
1116
-
1117
- export namespace DeleteCertificateAuthorityRequest {
1118
- /**
1119
- * @internal
1120
- */
1121
- export const filterSensitiveLog = (obj: DeleteCertificateAuthorityRequest): any => ({
1122
- ...obj,
1123
- });
1124
- }
1125
-
1126
- export interface DeletePermissionRequest {
1127
- /**
1128
- * <p>The Amazon Resource Number (ARN) of the private CA that issued the permissions. You
1129
- * can find the CA's ARN by calling the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action. This must have the following form: </p>
1130
- * <p>
1131
- * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
1132
- * </code>.
1133
- * </p>
1134
- */
1135
- CertificateAuthorityArn: string | undefined;
1136
-
1137
- /**
1138
- * <p>The AWS service or identity that will have its CA permissions revoked. At this time,
1139
- * the only valid service principal is <code>acm.amazonaws.com</code>
1140
- * </p>
1141
- */
1142
- Principal: string | undefined;
1143
-
1144
- /**
1145
- * <p>The AWS account that calls this action.</p>
1146
- */
1147
- SourceAccount?: string;
1148
- }
1149
-
1150
- export namespace DeletePermissionRequest {
1151
- /**
1152
- * @internal
1153
- */
1154
- export const filterSensitiveLog = (obj: DeletePermissionRequest): any => ({
1155
- ...obj,
1156
- });
1157
- }
1158
-
1159
- export interface DeletePolicyRequest {
1160
- /**
1161
- * <p>The Amazon Resource Number (ARN) of the private CA that will have its policy deleted.
1162
- * You can find the CA's ARN by calling the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action. The ARN value must have the form
1163
- * <code>arn:aws:acm-pca:region:account:certificate-authority/01234567-89ab-cdef-0123-0123456789ab</code>.
1164
- * </p>
1165
- */
1166
- ResourceArn: string | undefined;
1167
- }
1168
-
1169
- export namespace DeletePolicyRequest {
1170
- /**
1171
- * @internal
1172
- */
1173
- export const filterSensitiveLog = (obj: DeletePolicyRequest): any => ({
1174
- ...obj,
1175
- });
1176
- }
1177
-
1178
- /**
1179
- * <p>The current action was prevented because it would lock the caller out from performing
1180
- * subsequent actions. Verify that the specified parameters would not result in the caller
1181
- * being denied access to the resource. </p>
1182
- */
1183
- export interface LockoutPreventedException extends __SmithyException, $MetadataBearer {
1184
- name: "LockoutPreventedException";
1185
- $fault: "client";
1186
- message?: string;
1187
- }
1188
-
1189
- export namespace LockoutPreventedException {
1190
- /**
1191
- * @internal
1192
- */
1193
- export const filterSensitiveLog = (obj: LockoutPreventedException): any => ({
1194
- ...obj,
1195
- });
1196
- }
1197
-
1198
- export interface DescribeCertificateAuthorityRequest {
1199
- /**
1200
- * <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>. This must be of the form: </p>
1201
- * <p>
1202
- * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
1203
- * </code>.
1204
- * </p>
1205
- */
1206
- CertificateAuthorityArn: string | undefined;
1207
- }
1208
-
1209
- export namespace DescribeCertificateAuthorityRequest {
1210
- /**
1211
- * @internal
1212
- */
1213
- export const filterSensitiveLog = (obj: DescribeCertificateAuthorityRequest): any => ({
1214
- ...obj,
1215
- });
1216
- }
1217
-
1218
- export enum FailureReason {
1219
- OTHER = "OTHER",
1220
- REQUEST_TIMED_OUT = "REQUEST_TIMED_OUT",
1221
- UNSUPPORTED_ALGORITHM = "UNSUPPORTED_ALGORITHM",
1222
- }
1223
-
1224
- export enum CertificateAuthorityStatus {
1225
- ACTIVE = "ACTIVE",
1226
- CREATING = "CREATING",
1227
- DELETED = "DELETED",
1228
- DISABLED = "DISABLED",
1229
- EXPIRED = "EXPIRED",
1230
- FAILED = "FAILED",
1231
- PENDING_CERTIFICATE = "PENDING_CERTIFICATE",
1232
- }
1233
-
1234
- /**
1235
- * <p>Contains information about your private certificate authority (CA). Your private CA
1236
- * can issue and revoke X.509 digital certificates. Digital certificates verify that the
1237
- * entity named in the certificate <b>Subject</b> field owns or
1238
- * controls the public key contained in the <b>Subject Public Key
1239
- * Info</b> field. Call the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action to create your private CA. You must then
1240
- * call the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_GetCertificateAuthorityCertificate.html">GetCertificateAuthorityCertificate</a> action to retrieve a private CA
1241
- * certificate signing request (CSR). Sign the CSR with your ACM Private CA-hosted or on-premises
1242
- * root or subordinate CA certificate. Call the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html">ImportCertificateAuthorityCertificate</a> action to import the signed
1243
- * certificate into AWS Certificate Manager (ACM). </p>
1244
- */
1245
- export interface CertificateAuthority {
1246
- /**
1247
- * <p>Amazon Resource Name (ARN) for your private certificate authority (CA). The format is
1248
- * <code>
1249
- * <i>12345678-1234-1234-1234-123456789012</i>
1250
- * </code>.</p>
1251
- */
1252
- Arn?: string;
1253
-
1254
- /**
1255
- * <p>The AWS account ID that owns the certificate authority.</p>
1256
- */
1257
- OwnerAccount?: string;
1258
-
1259
- /**
1260
- * <p>Date and time at which your private CA was created.</p>
1261
- */
1262
- CreatedAt?: Date;
1263
-
1264
- /**
1265
- * <p>Date and time at which your private CA was last updated.</p>
1266
- */
1267
- LastStateChangeAt?: Date;
1268
-
1269
- /**
1270
- * <p>Type of your private CA.</p>
1271
- */
1272
- Type?: CertificateAuthorityType | string;
1273
-
1274
- /**
1275
- * <p>Serial number of your private CA.</p>
1276
- */
1277
- Serial?: string;
1278
-
1279
- /**
1280
- * <p>Status of your private CA.</p>
1281
- */
1282
- Status?: CertificateAuthorityStatus | string;
1283
-
1284
- /**
1285
- * <p>Date and time before which your private CA certificate is not valid.</p>
1286
- */
1287
- NotBefore?: Date;
1288
-
1289
- /**
1290
- * <p>Date and time after which your private CA certificate is not valid.</p>
1291
- */
1292
- NotAfter?: Date;
1293
-
1294
- /**
1295
- * <p>Reason the request to create your private CA failed.</p>
1296
- */
1297
- FailureReason?: FailureReason | string;
1298
-
1299
- /**
1300
- * <p>Your private CA configuration.</p>
1301
- */
1302
- CertificateAuthorityConfiguration?: CertificateAuthorityConfiguration;
1303
-
1304
- /**
1305
- * <p>Information about the Online Certificate Status Protocol (OCSP) configuration or
1306
- * certificate revocation list (CRL) created and maintained by your private CA. </p>
1307
- */
1308
- RevocationConfiguration?: RevocationConfiguration;
1309
-
1310
- /**
1311
- * <p>The period during which a deleted CA can be restored. For more information, see the
1312
- * <code>PermanentDeletionTimeInDays</code> parameter of the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeleteCertificateAuthorityRequest.html">DeleteCertificateAuthorityRequest</a> action. </p>
1313
- */
1314
- RestorableUntil?: Date;
1315
-
1316
- /**
1317
- * <p>Defines a cryptographic key management compliance standard used for handling CA keys. </p>
1318
- * <p>Default: FIPS_140_2_LEVEL_3_OR_HIGHER</p>
1319
- * <p>Note: AWS Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must
1320
- * explicitly specify this parameter and value when creating a CA in that Region.
1321
- * Specifying a different value (or no value) results in an
1322
- * <code>InvalidArgsException</code> with the message "A certificate authority cannot
1323
- * be created in this region with the specified security standard."</p>
1324
- */
1325
- KeyStorageSecurityStandard?: KeyStorageSecurityStandard | string;
1326
- }
1327
-
1328
- export namespace CertificateAuthority {
1329
- /**
1330
- * @internal
1331
- */
1332
- export const filterSensitiveLog = (obj: CertificateAuthority): any => ({
1333
- ...obj,
1334
- });
1335
- }
1336
-
1337
- export interface DescribeCertificateAuthorityResponse {
1338
- /**
1339
- * <p>A <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CertificateAuthority.html">CertificateAuthority</a> structure that contains information about your private
1340
- * CA.</p>
1341
- */
1342
- CertificateAuthority?: CertificateAuthority;
1343
- }
1344
-
1345
- export namespace DescribeCertificateAuthorityResponse {
1346
- /**
1347
- * @internal
1348
- */
1349
- export const filterSensitiveLog = (obj: DescribeCertificateAuthorityResponse): any => ({
1350
- ...obj,
1351
- });
1352
- }
1353
-
1354
- export interface DescribeCertificateAuthorityAuditReportRequest {
1355
- /**
1356
- * <p>The Amazon Resource Name (ARN) of the private CA. This must be of the form:</p>
1357
- * <p>
1358
- * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
1359
- * </code>.
1360
- * </p>
1361
- */
1362
- CertificateAuthorityArn: string | undefined;
1363
-
1364
- /**
1365
- * <p>The report ID returned by calling the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a> action.</p>
1366
- */
1367
- AuditReportId: string | undefined;
1368
- }
1369
-
1370
- export namespace DescribeCertificateAuthorityAuditReportRequest {
1371
- /**
1372
- * @internal
1373
- */
1374
- export const filterSensitiveLog = (obj: DescribeCertificateAuthorityAuditReportRequest): any => ({
1375
- ...obj,
1376
- });
1377
- }
1378
-
1379
- export enum AuditReportStatus {
1380
- CREATING = "CREATING",
1381
- FAILED = "FAILED",
1382
- SUCCESS = "SUCCESS",
1383
- }
1384
-
1385
- export interface DescribeCertificateAuthorityAuditReportResponse {
1386
- /**
1387
- * <p>Specifies whether report creation is in progress, has succeeded, or has failed.</p>
1388
- */
1389
- AuditReportStatus?: AuditReportStatus | string;
1390
-
1391
- /**
1392
- * <p>Name of the S3 bucket that contains the report.</p>
1393
- */
1394
- S3BucketName?: string;
1395
-
1396
- /**
1397
- * <p>S3 <b>key</b> that uniquely identifies the report file in
1398
- * your S3 bucket.</p>
1399
- */
1400
- S3Key?: string;
1401
-
1402
- /**
1403
- * <p>The date and time at which the report was created.</p>
1404
- */
1405
- CreatedAt?: Date;
1406
- }
1407
-
1408
- export namespace DescribeCertificateAuthorityAuditReportResponse {
1409
- /**
1410
- * @internal
1411
- */
1412
- export const filterSensitiveLog = (obj: DescribeCertificateAuthorityAuditReportResponse): any => ({
1413
- ...obj,
1414
- });
1415
- }
1416
-
1417
- export interface GetCertificateRequest {
1418
- /**
1419
- * <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>. This must be of the form: </p>
1420
- * <p>
1421
- * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
1422
- * </code>.
1423
- * </p>
1424
- */
1425
- CertificateAuthorityArn: string | undefined;
1426
-
1427
- /**
1428
- * <p>The ARN of the issued certificate. The ARN contains the certificate serial number and
1429
- * must be in the following form: </p>
1430
- * <p>
1431
- * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>/certificate/<i>286535153982981100925020015808220737245</i>
1432
- * </code>
1433
- * </p>
1434
- */
1435
- CertificateArn: string | undefined;
1436
- }
1437
-
1438
- export namespace GetCertificateRequest {
1439
- /**
1440
- * @internal
1441
- */
1442
- export const filterSensitiveLog = (obj: GetCertificateRequest): any => ({
1443
- ...obj,
1444
- });
1445
- }
1446
-
1447
- export interface GetCertificateResponse {
1448
- /**
1449
- * <p>The base64 PEM-encoded certificate specified by the <code>CertificateArn</code>
1450
- * parameter.</p>
1451
- */
1452
- Certificate?: string;
1453
-
1454
- /**
1455
- * <p>The base64 PEM-encoded certificate chain that chains up to the root CA certificate
1456
- * that you used to sign your private CA certificate. </p>
1457
- */
1458
- CertificateChain?: string;
1459
- }
1460
-
1461
- export namespace GetCertificateResponse {
1462
- /**
1463
- * @internal
1464
- */
1465
- export const filterSensitiveLog = (obj: GetCertificateResponse): any => ({
1466
- ...obj,
1467
- });
1468
- }
1469
-
1470
- export interface GetCertificateAuthorityCertificateRequest {
1471
- /**
1472
- * <p>The Amazon Resource Name (ARN) of your private CA. This is of the form:</p>
1473
- * <p>
1474
- * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
1475
- * </code>.
1476
- * </p>
1477
- */
1478
- CertificateAuthorityArn: string | undefined;
1479
- }
1480
-
1481
- export namespace GetCertificateAuthorityCertificateRequest {
1482
- /**
1483
- * @internal
1484
- */
1485
- export const filterSensitiveLog = (obj: GetCertificateAuthorityCertificateRequest): any => ({
1486
- ...obj,
1487
- });
1488
- }
1489
-
1490
- export interface GetCertificateAuthorityCertificateResponse {
1491
- /**
1492
- * <p>Base64-encoded certificate authority (CA) certificate.</p>
1493
- */
1494
- Certificate?: string;
1495
-
1496
- /**
1497
- * <p>Base64-encoded certificate chain that includes any intermediate certificates and
1498
- * chains up to root certificate that you used to sign your private CA certificate. The
1499
- * chain does not include your private CA certificate. If this is a root CA, the value will
1500
- * be null.</p>
1501
- */
1502
- CertificateChain?: string;
1503
- }
1504
-
1505
- export namespace GetCertificateAuthorityCertificateResponse {
1506
- /**
1507
- * @internal
1508
- */
1509
- export const filterSensitiveLog = (obj: GetCertificateAuthorityCertificateResponse): any => ({
1510
- ...obj,
1511
- });
1512
- }
1513
-
1514
- export interface GetCertificateAuthorityCsrRequest {
1515
- /**
1516
- * <p>The Amazon Resource Name (ARN) that was returned when you called the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action. This must be of the form: </p>
1517
- * <p>
1518
- * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
1519
- * </code>
1520
- * </p>
1521
- */
1522
- CertificateAuthorityArn: string | undefined;
1523
- }
1524
-
1525
- export namespace GetCertificateAuthorityCsrRequest {
1526
- /**
1527
- * @internal
1528
- */
1529
- export const filterSensitiveLog = (obj: GetCertificateAuthorityCsrRequest): any => ({
1530
- ...obj,
1531
- });
1532
- }
1533
-
1534
- export interface GetCertificateAuthorityCsrResponse {
1535
- /**
1536
- * <p>The base64 PEM-encoded certificate signing request (CSR) for your private CA
1537
- * certificate.</p>
1538
- */
1539
- Csr?: string;
1540
- }
1541
-
1542
- export namespace GetCertificateAuthorityCsrResponse {
1543
- /**
1544
- * @internal
1545
- */
1546
- export const filterSensitiveLog = (obj: GetCertificateAuthorityCsrResponse): any => ({
1547
- ...obj,
1548
- });
1549
- }
1550
-
1551
- export interface GetPolicyRequest {
1552
- /**
1553
- * <p>The Amazon Resource Number (ARN) of the private CA that will have its policy
1554
- * retrieved. You can find the CA's ARN by calling the ListCertificateAuthorities action.
1555
- *
1556
- * </p>
1557
- */
1558
- ResourceArn: string | undefined;
1559
- }
1560
-
1561
- export namespace GetPolicyRequest {
1562
- /**
1563
- * @internal
1564
- */
1565
- export const filterSensitiveLog = (obj: GetPolicyRequest): any => ({
1566
- ...obj,
1567
- });
1568
- }
1569
-
1570
- export interface GetPolicyResponse {
1571
- /**
1572
- * <p>The policy attached to the private CA as a JSON document.</p>
1573
- */
1574
- Policy?: string;
1575
- }
1576
-
1577
- export namespace GetPolicyResponse {
1578
- /**
1579
- * @internal
1580
- */
1581
- export const filterSensitiveLog = (obj: GetPolicyResponse): any => ({
1582
- ...obj,
1583
- });
1584
- }
1585
-
1586
- /**
1587
- * <p>The certificate authority certificate you are importing does not comply with
1588
- * conditions specified in the certificate that signed it.</p>
1589
- */
1590
- export interface CertificateMismatchException extends __SmithyException, $MetadataBearer {
1591
- name: "CertificateMismatchException";
1592
- $fault: "client";
1593
- message?: string;
1594
- }
1595
-
1596
- export namespace CertificateMismatchException {
1597
- /**
1598
- * @internal
1599
- */
1600
- export const filterSensitiveLog = (obj: CertificateMismatchException): any => ({
1601
- ...obj,
1602
- });
1603
- }
1604
-
1605
- export interface ImportCertificateAuthorityCertificateRequest {
1606
- /**
1607
- * <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>. This must be of the form: </p>
1608
- * <p>
1609
- * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
1610
- * </code>
1611
- * </p>
1612
- */
1613
- CertificateAuthorityArn: string | undefined;
1614
-
1615
- /**
1616
- * <p>The PEM-encoded certificate for a private CA. This may be a self-signed certificate in
1617
- * the case of a root CA, or it may be signed by another CA that you control.</p>
1618
- */
1619
- Certificate: Uint8Array | undefined;
1620
-
1621
- /**
1622
- * <p>A PEM-encoded file that contains all of your certificates, other than the certificate
1623
- * you're importing, chaining up to your root CA. Your ACM Private CA-hosted or on-premises root
1624
- * certificate is the last in the chain, and each certificate in the chain signs the one
1625
- * preceding. </p>
1626
- * <p>This parameter must be supplied when you import a subordinate CA. When you import a
1627
- * root CA, there is no chain.</p>
1628
- */
1629
- CertificateChain?: Uint8Array;
1630
- }
1631
-
1632
- export namespace ImportCertificateAuthorityCertificateRequest {
1633
- /**
1634
- * @internal
1635
- */
1636
- export const filterSensitiveLog = (obj: ImportCertificateAuthorityCertificateRequest): any => ({
1637
- ...obj,
1638
- });
1639
- }
1640
-
1641
- /**
1642
- * <p>The request action cannot be performed or is prohibited.</p>
1643
- */
1644
- export interface InvalidRequestException extends __SmithyException, $MetadataBearer {
1645
- name: "InvalidRequestException";
1646
- $fault: "client";
1647
- message?: string;
1648
- }
1649
-
1650
- export namespace InvalidRequestException {
1651
- /**
1652
- * @internal
1653
- */
1654
- export const filterSensitiveLog = (obj: InvalidRequestException): any => ({
1655
- ...obj,
1656
- });
1657
- }
1658
-
1659
- /**
1660
- * <p>One or more fields in the certificate are invalid.</p>
1661
- */
1662
- export interface MalformedCertificateException extends __SmithyException, $MetadataBearer {
1663
- name: "MalformedCertificateException";
1664
- $fault: "client";
1665
- message?: string;
1666
- }
1667
-
1668
- export namespace MalformedCertificateException {
1669
- /**
1670
- * @internal
1671
- */
1672
- export const filterSensitiveLog = (obj: MalformedCertificateException): any => ({
1673
- ...obj,
1674
- });
1675
- }
1676
-
1677
- export enum PolicyQualifierId {
1678
- CPS = "CPS",
1679
- }
1680
-
1681
- /**
1682
- * <p>Defines a <code>PolicyInformation</code> qualifier. ACM Private CA supports the <a href="https://tools.ietf.org/html/rfc5280#section-4.2.1.4">certification practice
1683
- * statement (CPS) qualifier</a> defined in RFC 5280. </p>
1684
- */
1685
- export interface Qualifier {
1686
- /**
1687
- * <p>Contains a pointer to a certification practice statement (CPS) published by the
1688
- * CA.</p>
1689
- */
1690
- CpsUri: string | undefined;
1691
- }
1692
-
1693
- export namespace Qualifier {
1694
- /**
1695
- * @internal
1696
- */
1697
- export const filterSensitiveLog = (obj: Qualifier): any => ({
1698
- ...obj,
1699
- });
1700
- }
1701
-
1702
- /**
1703
- * <p>Modifies the <code>CertPolicyId</code> of a <code>PolicyInformation</code> object with
1704
- * a qualifier. ACM Private CA supports the certification practice statement (CPS) qualifier.</p>
1705
- */
1706
- export interface PolicyQualifierInfo {
1707
- /**
1708
- * <p>Identifies the qualifier modifying a <code>CertPolicyId</code>.</p>
1709
- */
1710
- PolicyQualifierId: PolicyQualifierId | string | undefined;
1711
-
1712
- /**
1713
- * <p>Defines the qualifier type. ACM Private CA supports the use of a URI for a CPS qualifier in
1714
- * this field.</p>
1715
- */
1716
- Qualifier: Qualifier | undefined;
1717
- }
1718
-
1719
- export namespace PolicyQualifierInfo {
1720
- /**
1721
- * @internal
1722
- */
1723
- export const filterSensitiveLog = (obj: PolicyQualifierInfo): any => ({
1724
- ...obj,
1725
- });
1726
- }
1727
-
1728
- /**
1729
- * <p>Defines the X.509 <code>CertificatePolicies</code> extension.</p>
1730
- */
1731
- export interface PolicyInformation {
1732
- /**
1733
- * <p>Specifies the object identifier (OID) of the certificate policy under which the
1734
- * certificate was issued. For more information, see NIST's definition of <a href="https://csrc.nist.gov/glossary/term/Object_Identifier">Object Identifier
1735
- * (OID)</a>.</p>
1736
- */
1737
- CertPolicyId: string | undefined;
1738
-
1739
- /**
1740
- * <p>Modifies the given <code>CertPolicyId</code> with a qualifier. ACM Private CA supports the
1741
- * certification practice statement (CPS) qualifier.</p>
1742
- */
1743
- PolicyQualifiers?: PolicyQualifierInfo[];
1744
- }
1745
-
1746
- export namespace PolicyInformation {
1747
- /**
1748
- * @internal
1749
- */
1750
- export const filterSensitiveLog = (obj: PolicyInformation): any => ({
1751
- ...obj,
1752
- });
1753
- }
1754
-
1755
- export enum ExtendedKeyUsageType {
1756
- CERTIFICATE_TRANSPARENCY = "CERTIFICATE_TRANSPARENCY",
1757
- CLIENT_AUTH = "CLIENT_AUTH",
1758
- CODE_SIGNING = "CODE_SIGNING",
1759
- DOCUMENT_SIGNING = "DOCUMENT_SIGNING",
1760
- EMAIL_PROTECTION = "EMAIL_PROTECTION",
1761
- OCSP_SIGNING = "OCSP_SIGNING",
1762
- SERVER_AUTH = "SERVER_AUTH",
1763
- SMART_CARD_LOGIN = "SMART_CARD_LOGIN",
1764
- TIME_STAMPING = "TIME_STAMPING",
1765
- }
1766
-
1767
- /**
1768
- * <p>Specifies additional purposes for which the certified public key may be used other
1769
- * than basic purposes indicated in the <code>KeyUsage</code> extension.</p>
1770
- */
1771
- export interface ExtendedKeyUsage {
1772
- /**
1773
- * <p>Specifies a standard <code>ExtendedKeyUsage</code> as defined as in <a href="https://tools.ietf.org/html/rfc5280#section-4.2.1.12">RFC 5280</a>.</p>
1774
- */
1775
- ExtendedKeyUsageType?: ExtendedKeyUsageType | string;
1776
-
1777
- /**
1778
- * <p>Specifies a custom <code>ExtendedKeyUsage</code> with an object identifier
1779
- * (OID).</p>
1780
- */
1781
- ExtendedKeyUsageObjectIdentifier?: string;
1782
- }
1783
-
1784
- export namespace ExtendedKeyUsage {
1785
- /**
1786
- * @internal
1787
- */
1788
- export const filterSensitiveLog = (obj: ExtendedKeyUsage): any => ({
1789
- ...obj,
1790
- });
1791
- }
1792
-
1793
- /**
1794
- * <p>Contains X.509 extension information for a certificate.</p>
1795
- */
1796
- export interface Extensions {
1797
- /**
1798
- * <p>Contains a sequence of one or more policy information terms, each of which consists of
1799
- * an object identifier (OID) and optional qualifiers. For more information, see NIST's
1800
- * definition of <a href="https://csrc.nist.gov/glossary/term/Object_Identifier">Object
1801
- * Identifier (OID)</a>.</p>
1802
- * <p>In an end-entity certificate, these terms indicate the policy under which the
1803
- * certificate was issued and the purposes for which it may be used. In a CA certificate,
1804
- * these terms limit the set of policies for certification paths that include this
1805
- * certificate.</p>
1806
- */
1807
- CertificatePolicies?: PolicyInformation[];
1808
-
1809
- /**
1810
- * <p>Specifies additional purposes for which the certified public key may be used other
1811
- * than basic purposes indicated in the <code>KeyUsage</code> extension.</p>
1812
- */
1813
- ExtendedKeyUsage?: ExtendedKeyUsage[];
1814
-
1815
- /**
1816
- * <p>Defines one or more purposes for which the key contained in the certificate can be
1817
- * used. Default value for each option is false.</p>
1818
- */
1819
- KeyUsage?: KeyUsage;
1820
-
1821
- /**
1822
- * <p>The subject alternative name extension allows identities to be bound to the subject of
1823
- * the certificate. These identities may be included in addition to or in place of the
1824
- * identity in the subject field of the certificate.</p>
1825
- */
1826
- SubjectAlternativeNames?: GeneralName[];
1827
- }
1828
-
1829
- export namespace Extensions {
1830
- /**
1831
- * @internal
1832
- */
1833
- export const filterSensitiveLog = (obj: Extensions): any => ({
1834
- ...obj,
1835
- });
1836
- }
1837
-
1838
- /**
1839
- * <p>Contains X.509 certificate information to be placed in an issued certificate. An
1840
- * <code>APIPassthrough</code> or <code>APICSRPassthrough</code> template variant must
1841
- * be selected, or else this parameter is ignored. </p>
1842
- * <p>If conflicting or duplicate certificate information is supplied from other sources,
1843
- * ACM Private CA applies <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/UsingTemplates.html#template-order-of-operations">order of
1844
- * operation rules</a> to determine what information is used.</p>
1845
- */
1846
- export interface ApiPassthrough {
1847
- /**
1848
- * <p>Specifies X.509 extension information for a certificate.</p>
1849
- */
1850
- Extensions?: Extensions;
1851
-
1852
- /**
1853
- * <p>Contains information about the certificate subject. The <code>Subject</code> field in
1854
- * the certificate identifies the entity that owns or controls the public key in the
1855
- * certificate. The entity can be a user, computer, device, or service. The <code>Subject
1856
- * </code>must contain an X.500 distinguished name (DN). A DN is a sequence of relative
1857
- * distinguished names (RDNs). The RDNs are separated by commas in the certificate.</p>
1858
- */
1859
- Subject?: ASN1Subject;
1860
- }
1861
-
1862
- export namespace ApiPassthrough {
1863
- /**
1864
- * @internal
1865
- */
1866
- export const filterSensitiveLog = (obj: ApiPassthrough): any => ({
1867
- ...obj,
1868
- });
1869
- }
1870
-
1871
- export enum ValidityPeriodType {
1872
- ABSOLUTE = "ABSOLUTE",
1873
- DAYS = "DAYS",
1874
- END_DATE = "END_DATE",
1875
- MONTHS = "MONTHS",
1876
- YEARS = "YEARS",
1877
- }
1878
-
1879
- /**
1880
- * <p>Validity specifies the period of time during which a certificate is valid. Validity
1881
- * can be expressed as an explicit date and time when the validity of a certificate starts
1882
- * or expires, or as a span of time after issuance, stated in days, months, or years. For
1883
- * more information, see <a href="https://tools.ietf.org/html/rfc5280#section-4.1.2.5">Validity</a> in RFC 5280.</p>
1884
- * <p>ACM Private CA API consumes the <code>Validity</code> data type differently in two distinct
1885
- * parameters of the <code>IssueCertificate</code> action. The required parameter
1886
- * <code>IssueCertificate</code>:<code>Validity</code> specifies the end of a
1887
- * certificate's validity period. The optional parameter
1888
- * <code>IssueCertificate</code>:<code>ValidityNotBefore</code> specifies a customized
1889
- * starting time for the validity period.</p>
1890
- */
1891
- export interface Validity {
1892
- /**
1893
- * <p>A long integer interpreted according to the value of <code>Type</code>, below.</p>
1894
- */
1895
- Value: number | undefined;
1896
-
1897
- /**
1898
- * <p>Determines how <i>ACM Private CA</i> interprets the <code>Value</code>
1899
- * parameter, an integer. Supported validity types include those listed below. Type
1900
- * definitions with values include a sample input value and the resulting output. </p>
1901
- * <p>
1902
- * <code>END_DATE</code>: The specific date and time when the certificate will expire,
1903
- * expressed using UTCTime (YYMMDDHHMMSS) or GeneralizedTime (YYYYMMDDHHMMSS) format. When
1904
- * UTCTime is used, if the year field (YY) is greater than or equal to 50, the year is
1905
- * interpreted as 19YY. If the year field is less than 50, the year is interpreted as
1906
- * 20YY.</p>
1907
- * <ul>
1908
- * <li>
1909
- * <p>Sample input value: 491231235959 (UTCTime format)</p>
1910
- * </li>
1911
- * <li>
1912
- * <p>Output expiration date/time: 12/31/2049 23:59:59</p>
1913
- * </li>
1914
- * </ul>
1915
- * <p>
1916
- * <code>ABSOLUTE</code>: The specific date and time when the validity of a certificate
1917
- * will start or expire, expressed in seconds since the Unix Epoch. </p>
1918
- * <ul>
1919
- * <li>
1920
- * <p>Sample input value: 2524608000</p>
1921
- * </li>
1922
- * <li>
1923
- * <p>Output expiration date/time: 01/01/2050 00:00:00</p>
1924
- * </li>
1925
- * </ul>
1926
- * <p>
1927
- * <code>DAYS</code>, <code>MONTHS</code>, <code>YEARS</code>: The relative time from the
1928
- * moment of issuance until the certificate will expire, expressed in days, months, or
1929
- * years. </p>
1930
- * <p>Example if <code>DAYS</code>, issued on 10/12/2020 at 12:34:54 UTC:</p>
1931
- * <ul>
1932
- * <li>
1933
- * <p>Sample input value: 90</p>
1934
- * </li>
1935
- * <li>
1936
- * <p>Output expiration date: 01/10/2020 12:34:54 UTC</p>
1937
- * </li>
1938
- * </ul>
1939
- * <p>The minimum validity duration for a certificate using relative time
1940
- * (<code>DAYS</code>) is one day. The minimum validity for a certificate using absolute
1941
- * time (<code>ABSOLUTE</code> or <code>END_DATE</code>) is one second.</p>
1942
- */
1943
- Type: ValidityPeriodType | string | undefined;
1944
- }
1945
-
1946
- export namespace Validity {
1947
- /**
1948
- * @internal
1949
- */
1950
- export const filterSensitiveLog = (obj: Validity): any => ({
1951
- ...obj,
1952
- });
1953
- }
1954
-
1955
- export interface IssueCertificateRequest {
1956
- /**
1957
- * <p>Specifies X.509 certificate information to be included in the issued certificate. An
1958
- * <code>APIPassthrough</code> or <code>APICSRPassthrough</code> template variant must
1959
- * be selected, or else this parameter is ignored. For more information about using these
1960
- * templates, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/UsingTemplates.html">Understanding Certificate Templates</a>.</p>
1961
- * <p>If conflicting or duplicate certificate information is supplied during certificate
1962
- * issuance, ACM Private CA applies <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/UsingTemplates.html#template-order-of-operations">order of
1963
- * operation rules</a> to determine what information is used.</p>
1964
- */
1965
- ApiPassthrough?: ApiPassthrough;
1966
-
1967
- /**
1968
- * <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>. This must be of the form:</p>
1969
- * <p>
1970
- * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
1971
- * </code>
1972
- * </p>
1973
- */
1974
- CertificateAuthorityArn: string | undefined;
1975
-
1976
- /**
1977
- * <p>The certificate signing request (CSR) for the certificate you want to issue. As an
1978
- * example, you can use the following OpenSSL command to create the CSR and a 2048 bit RSA
1979
- * private key. </p>
1980
- * <p>
1981
- * <code>openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem
1982
- * -out csr/test_cert_.csr</code>
1983
- * </p>
1984
- * <p>If you have a configuration file, you can then use the following OpenSSL command. The
1985
- * <code>usr_cert</code> block in the configuration file contains your X509 version 3
1986
- * extensions. </p>
1987
- * <p>
1988
- * <code>openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048
1989
- * -days -365 -keyout private/test_cert_priv_key.pem -out
1990
- * csr/test_cert_.csr</code>
1991
- * </p>
1992
- * <p>Note: A CSR must provide either a <i>subject name</i> or a
1993
- * <i>subject alternative name</i> or the request will be rejected.
1994
- * </p>
1995
- */
1996
- Csr: Uint8Array | undefined;
1997
-
1998
- /**
1999
- * <p>The name of the algorithm that will be used to sign the certificate to be issued. </p>
2000
- * <p>This parameter should not be confused with the <code>SigningAlgorithm</code> parameter
2001
- * used to sign a CSR in the <code>CreateCertificateAuthority</code> action.</p>
2002
- */
2003
- SigningAlgorithm: SigningAlgorithm | string | undefined;
2004
-
2005
- /**
2006
- * <p>Specifies a custom configuration template to use when issuing a certificate. If this
2007
- * parameter is not provided, ACM Private CA defaults to the <code>EndEntityCertificate/V1</code>
2008
- * template. For CA certificates, you should choose the shortest path length that meets
2009
- * your needs. The path length is indicated by the PathLen<i>N</i> portion of
2010
- * the ARN, where <i>N</i> is the <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaTerms.html#terms-cadepth">CA depth</a>.</p>
2011
- * <p>Note: The CA depth configured on a subordinate CA certificate must not exceed the
2012
- * limit set by its parents in the CA hierarchy.</p>
2013
- * <p>For a list of <code>TemplateArn</code> values supported by ACM Private CA, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/UsingTemplates.html">Understanding Certificate
2014
- * Templates</a>.</p>
2015
- */
2016
- TemplateArn?: string;
2017
-
2018
- /**
2019
- * <p>Information describing the end of the validity period of the certificate. This
2020
- * parameter sets the “Not After” date for the certificate.</p>
2021
- * <p>Certificate validity is the period of time during which a certificate is valid.
2022
- * Validity can be expressed as an explicit date and time when the certificate expires, or
2023
- * as a span of time after issuance, stated in days, months, or years. For more
2024
- * information, see <a href="https://tools.ietf.org/html/rfc5280#section-4.1.2.5">Validity</a> in RFC 5280. </p>
2025
- * <p>This value is unaffected when <code>ValidityNotBefore</code> is also specified. For
2026
- * example, if <code>Validity</code> is set to 20 days in the future, the certificate will
2027
- * expire 20 days from issuance time regardless of the <code>ValidityNotBefore</code>
2028
- * value.</p>
2029
- * <p>The end of the validity period configured on a certificate must not exceed the limit
2030
- * set on its parents in the CA hierarchy.</p>
2031
- */
2032
- Validity: Validity | undefined;
2033
-
2034
- /**
2035
- * <p>Information describing the start of the validity period of the certificate. This
2036
- * parameter sets the “Not Before" date for the certificate.</p>
2037
- * <p>By default, when issuing a certificate, ACM Private CA sets the "Not Before" date to the
2038
- * issuance time minus 60 minutes. This compensates for clock inconsistencies across
2039
- * computer systems. The <code>ValidityNotBefore</code> parameter can be used to customize
2040
- * the “Not Before” value. </p>
2041
- * <p>Unlike the <code>Validity</code> parameter, the <code>ValidityNotBefore</code>
2042
- * parameter is optional.</p>
2043
- * <p>The <code>ValidityNotBefore</code> value is expressed as an explicit date and time,
2044
- * using the <code>Validity</code> type value <code>ABSOLUTE</code>. For more information,
2045
- * see <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_Validity.html">Validity</a> in this API reference and <a href="https://tools.ietf.org/html/rfc5280#section-4.1.2.5">Validity</a> in RFC
2046
- * 5280.</p>
2047
- */
2048
- ValidityNotBefore?: Validity;
2049
-
2050
- /**
2051
- * <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
2052
- * call <b>IssueCertificate</b> multiple times with the same
2053
- * idempotency token within one minute, ACM Private CA recognizes that you are requesting only one
2054
- * certificate and will issue only one. If you change the idempotency token for each call,
2055
- * PCA recognizes that you are requesting multiple certificates.</p>
2056
- */
2057
- IdempotencyToken?: string;
2058
- }
2059
-
2060
- export namespace IssueCertificateRequest {
2061
- /**
2062
- * @internal
2063
- */
2064
- export const filterSensitiveLog = (obj: IssueCertificateRequest): any => ({
2065
- ...obj,
2066
- });
2067
- }
2068
-
2069
- export interface IssueCertificateResponse {
2070
- /**
2071
- * <p>The Amazon Resource Name (ARN) of the issued certificate and the certificate serial
2072
- * number. This is of the form:</p>
2073
- * <p>
2074
- * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>/certificate/<i>286535153982981100925020015808220737245</i>
2075
- * </code>
2076
- * </p>
2077
- */
2078
- CertificateArn?: string;
2079
- }
2080
-
2081
- export namespace IssueCertificateResponse {
2082
- /**
2083
- * @internal
2084
- */
2085
- export const filterSensitiveLog = (obj: IssueCertificateResponse): any => ({
2086
- ...obj,
2087
- });
2088
- }
2089
-
2090
- /**
2091
- * <p>The certificate signing request is invalid.</p>
2092
- */
2093
- export interface MalformedCSRException extends __SmithyException, $MetadataBearer {
2094
- name: "MalformedCSRException";
2095
- $fault: "client";
2096
- message?: string;
2097
- }
2098
-
2099
- export namespace MalformedCSRException {
2100
- /**
2101
- * @internal
2102
- */
2103
- export const filterSensitiveLog = (obj: MalformedCSRException): any => ({
2104
- ...obj,
2105
- });
2106
- }
2107
-
2108
- /**
2109
- * <p>The token specified in the <code>NextToken</code> argument is not valid. Use the token
2110
- * returned from your previous call to <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>.</p>
2111
- */
2112
- export interface InvalidNextTokenException extends __SmithyException, $MetadataBearer {
2113
- name: "InvalidNextTokenException";
2114
- $fault: "client";
2115
- message?: string;
2116
- }
2117
-
2118
- export namespace InvalidNextTokenException {
2119
- /**
2120
- * @internal
2121
- */
2122
- export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({
2123
- ...obj,
2124
- });
2125
- }
2126
-
2127
- export enum ResourceOwner {
2128
- OTHER_ACCOUNTS = "OTHER_ACCOUNTS",
2129
- SELF = "SELF",
2130
- }
2131
-
2132
- export interface ListCertificateAuthoritiesRequest {
2133
- /**
2134
- * <p>Use this parameter when paginating results in a subsequent request after you receive a
2135
- * response with truncated results. Set it to the value of the <code>NextToken</code>
2136
- * parameter from the response you just received.</p>
2137
- */
2138
- NextToken?: string;
2139
-
2140
- /**
2141
- * <p>Use this parameter when paginating results to specify the maximum number of items to
2142
- * return in the response on each page. If additional items exist beyond the number you
2143
- * specify, the <code>NextToken</code> element is sent in the response. Use this
2144
- * <code>NextToken</code> value in a subsequent request to retrieve additional
2145
- * items.</p>
2146
- */
2147
- MaxResults?: number;
2148
-
2149
- /**
2150
- * <p>Use this parameter to filter the returned set of certificate authorities based on
2151
- * their owner. The default is SELF.</p>
2152
- */
2153
- ResourceOwner?: ResourceOwner | string;
2154
- }
2155
-
2156
- export namespace ListCertificateAuthoritiesRequest {
2157
- /**
2158
- * @internal
2159
- */
2160
- export const filterSensitiveLog = (obj: ListCertificateAuthoritiesRequest): any => ({
2161
- ...obj,
2162
- });
2163
- }
2164
-
2165
- export interface ListCertificateAuthoritiesResponse {
2166
- /**
2167
- * <p>Summary information about each certificate authority you have created.</p>
2168
- */
2169
- CertificateAuthorities?: CertificateAuthority[];
2170
-
2171
- /**
2172
- * <p>When the list is truncated, this value is present and should be used for the
2173
- * <code>NextToken</code> parameter in a subsequent pagination request.</p>
2174
- */
2175
- NextToken?: string;
2176
- }
2177
-
2178
- export namespace ListCertificateAuthoritiesResponse {
2179
- /**
2180
- * @internal
2181
- */
2182
- export const filterSensitiveLog = (obj: ListCertificateAuthoritiesResponse): any => ({
2183
- ...obj,
2184
- });
2185
- }
2186
-
2187
- export interface ListPermissionsRequest {
2188
- /**
2189
- * <p>The Amazon Resource Number (ARN) of the private CA to inspect. You can find the ARN by
2190
- * calling the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action. This must be of the form:
2191
- * <code>arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012</code>
2192
- * You can get a private CA's ARN by running the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action.</p>
2193
- */
2194
- CertificateAuthorityArn: string | undefined;
2195
-
2196
- /**
2197
- * <p>When paginating results, use this parameter in a subsequent request after you receive
2198
- * a response with truncated results. Set it to the value of <b>NextToken</b> from the response you just received.</p>
2199
- */
2200
- NextToken?: string;
2201
-
2202
- /**
2203
- * <p>When paginating results, use this parameter to specify the maximum number of items to
2204
- * return in the response. If additional items exist beyond the number you specify, the
2205
- * <b>NextToken</b> element is sent in the response. Use this
2206
- * <b>NextToken</b> value in a subsequent request to retrieve
2207
- * additional items.</p>
2208
- */
2209
- MaxResults?: number;
2210
- }
2211
-
2212
- export namespace ListPermissionsRequest {
2213
- /**
2214
- * @internal
2215
- */
2216
- export const filterSensitiveLog = (obj: ListPermissionsRequest): any => ({
2217
- ...obj,
2218
- });
2219
- }
2220
-
2221
- /**
2222
- * <p>Permissions designate which private CA actions can be performed by an AWS service or
2223
- * entity. In order for ACM to automatically renew private certificates, you must give
2224
- * the ACM service principal all available permissions (<code>IssueCertificate</code>,
2225
- * <code>GetCertificate</code>, and <code>ListPermissions</code>). Permissions can be
2226
- * assigned with the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreatePermission.html">CreatePermission</a> action,
2227
- * removed with the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeletePermission.html">DeletePermission</a> action, and
2228
- * listed with the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListPermissions.html">ListPermissions</a> action.</p>
2229
- */
2230
- export interface Permission {
2231
- /**
2232
- * <p>The Amazon Resource Number (ARN) of the private CA from which the permission was
2233
- * issued.</p>
2234
- */
2235
- CertificateAuthorityArn?: string;
2236
-
2237
- /**
2238
- * <p>The time at which the permission was created.</p>
2239
- */
2240
- CreatedAt?: Date;
2241
-
2242
- /**
2243
- * <p>The AWS service or entity that holds the permission. At this time, the only valid
2244
- * principal is <code>acm.amazonaws.com</code>.</p>
2245
- */
2246
- Principal?: string;
2247
-
2248
- /**
2249
- * <p>The ID of the account that assigned the permission.</p>
2250
- */
2251
- SourceAccount?: string;
2252
-
2253
- /**
2254
- * <p>The private CA actions that can be performed by the designated AWS service.</p>
2255
- */
2256
- Actions?: (ActionType | string)[];
2257
-
2258
- /**
2259
- * <p>The name of the policy that is associated with the permission.</p>
2260
- */
2261
- Policy?: string;
2262
- }
2263
-
2264
- export namespace Permission {
2265
- /**
2266
- * @internal
2267
- */
2268
- export const filterSensitiveLog = (obj: Permission): any => ({
2269
- ...obj,
2270
- });
2271
- }
2272
-
2273
- export interface ListPermissionsResponse {
2274
- /**
2275
- * <p>Summary information about each permission assigned by the specified private CA,
2276
- * including the action enabled, the policy provided, and the time of creation.</p>
2277
- */
2278
- Permissions?: Permission[];
2279
-
2280
- /**
2281
- * <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.
2282
- * </p>
2283
- */
2284
- NextToken?: string;
2285
- }
2286
-
2287
- export namespace ListPermissionsResponse {
2288
- /**
2289
- * @internal
2290
- */
2291
- export const filterSensitiveLog = (obj: ListPermissionsResponse): any => ({
2292
- ...obj,
2293
- });
2294
- }
2295
-
2296
- export interface ListTagsRequest {
2297
- /**
2298
- * <p>The Amazon Resource Name (ARN) that was returned when you called the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action. This must be of the form: </p>
2299
- * <p>
2300
- * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
2301
- * </code>
2302
- * </p>
2303
- */
2304
- CertificateAuthorityArn: string | undefined;
2305
-
2306
- /**
2307
- * <p>Use this parameter when paginating results in a subsequent request after you receive a
2308
- * response with truncated results. Set it to the value of <b>NextToken</b> from the response you just received.</p>
2309
- */
2310
- NextToken?: string;
2311
-
2312
- /**
2313
- * <p>Use this parameter when paginating results to specify the maximum number of items to
2314
- * return in the response. If additional items exist beyond the number you specify, the
2315
- * <b>NextToken</b> element is sent in the response. Use this
2316
- * <b>NextToken</b> value in a subsequent request to retrieve
2317
- * additional items.</p>
2318
- */
2319
- MaxResults?: number;
2320
- }
2321
-
2322
- export namespace ListTagsRequest {
2323
- /**
2324
- * @internal
2325
- */
2326
- export const filterSensitiveLog = (obj: ListTagsRequest): any => ({
2327
- ...obj,
2328
- });
2329
- }
2330
-
2331
- export interface ListTagsResponse {
2332
- /**
2333
- * <p>The tags associated with your private CA.</p>
2334
- */
2335
- Tags?: Tag[];
2336
-
2337
- /**
2338
- * <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.
2339
- * </p>
2340
- */
2341
- NextToken?: string;
2342
- }
2343
-
2344
- export namespace ListTagsResponse {
2345
- /**
2346
- * @internal
2347
- */
2348
- export const filterSensitiveLog = (obj: ListTagsResponse): any => ({
2349
- ...obj,
2350
- });
2351
- }
2352
-
2353
- export interface PutPolicyRequest {
2354
- /**
2355
- * <p>The Amazon Resource Number (ARN) of the private CA to associate with the policy. The
2356
- * ARN of the CA can be found by calling the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action.</p>
2357
- * <p></p>
2358
- */
2359
- ResourceArn: string | undefined;
2360
-
2361
- /**
2362
- * <p>The path and file name of a JSON-formatted IAM policy to attach to the specified
2363
- * private CA resource. If this policy does not contain all required statements or if it
2364
- * includes any statement that is not allowed, the <code>PutPolicy</code> action returns an
2365
- * <code>InvalidPolicyException</code>. For information about IAM policy and
2366
- * statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview of JSON Policies</a>.</p>
2367
- */
2368
- Policy: string | undefined;
2369
- }
2370
-
2371
- export namespace PutPolicyRequest {
2372
- /**
2373
- * @internal
2374
- */
2375
- export const filterSensitiveLog = (obj: PutPolicyRequest): any => ({
2376
- ...obj,
2377
- });
2378
- }
2379
-
2380
- export interface RestoreCertificateAuthorityRequest {
2381
- /**
2382
- * <p>The Amazon Resource Name (ARN) that was returned when you called the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action. This must be of the form: </p>
2383
- * <p>
2384
- * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
2385
- * </code>
2386
- * </p>
2387
- */
2388
- CertificateAuthorityArn: string | undefined;
2389
- }
2390
-
2391
- export namespace RestoreCertificateAuthorityRequest {
2392
- /**
2393
- * @internal
2394
- */
2395
- export const filterSensitiveLog = (obj: RestoreCertificateAuthorityRequest): any => ({
2396
- ...obj,
2397
- });
2398
- }
2399
-
2400
- /**
2401
- * <p>Your request has already been completed.</p>
2402
- */
2403
- export interface RequestAlreadyProcessedException extends __SmithyException, $MetadataBearer {
2404
- name: "RequestAlreadyProcessedException";
2405
- $fault: "client";
2406
- message?: string;
2407
- }
2408
-
2409
- export namespace RequestAlreadyProcessedException {
2410
- /**
2411
- * @internal
2412
- */
2413
- export const filterSensitiveLog = (obj: RequestAlreadyProcessedException): any => ({
2414
- ...obj,
2415
- });
2416
- }
2417
-
2418
- export enum RevocationReason {
2419
- AFFILIATION_CHANGED = "AFFILIATION_CHANGED",
2420
- A_A_COMPROMISE = "A_A_COMPROMISE",
2421
- CERTIFICATE_AUTHORITY_COMPROMISE = "CERTIFICATE_AUTHORITY_COMPROMISE",
2422
- CESSATION_OF_OPERATION = "CESSATION_OF_OPERATION",
2423
- KEY_COMPROMISE = "KEY_COMPROMISE",
2424
- PRIVILEGE_WITHDRAWN = "PRIVILEGE_WITHDRAWN",
2425
- SUPERSEDED = "SUPERSEDED",
2426
- UNSPECIFIED = "UNSPECIFIED",
2427
- }
2428
-
2429
- export interface RevokeCertificateRequest {
2430
- /**
2431
- * <p>Amazon Resource Name (ARN) of the private CA that issued the certificate to be
2432
- * revoked. This must be of the form:</p>
2433
- * <p>
2434
- * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
2435
- * </code>
2436
- * </p>
2437
- */
2438
- CertificateAuthorityArn: string | undefined;
2439
-
2440
- /**
2441
- * <p>Serial number of the certificate to be revoked. This must be in hexadecimal format.
2442
- * You can retrieve the serial number by calling <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_GetCertificate.html">GetCertificate</a> with the Amazon
2443
- * Resource Name (ARN) of the certificate you want and the ARN of your private CA. The
2444
- * <b>GetCertificate</b> action retrieves the certificate in
2445
- * the PEM format. You can use the following OpenSSL command to list the certificate in
2446
- * text format and copy the hexadecimal serial number. </p>
2447
- * <p>
2448
- * <code>openssl x509 -in <i>file_path</i> -text -noout</code>
2449
- * </p>
2450
- * <p>You can also copy the serial number from the console or use the <a href="https://docs.aws.amazon.com/acm/latest/APIReference/API_DescribeCertificate.html">DescribeCertificate</a> action in the <i>AWS Certificate Manager API
2451
- * Reference</i>. </p>
2452
- */
2453
- CertificateSerial: string | undefined;
2454
-
2455
- /**
2456
- * <p>Specifies why you revoked the certificate.</p>
2457
- */
2458
- RevocationReason: RevocationReason | string | undefined;
2459
- }
2460
-
2461
- export namespace RevokeCertificateRequest {
2462
- /**
2463
- * @internal
2464
- */
2465
- export const filterSensitiveLog = (obj: RevokeCertificateRequest): any => ({
2466
- ...obj,
2467
- });
2468
- }
2469
-
2470
- export interface TagCertificateAuthorityRequest {
2471
- /**
2472
- * <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>. This must be of the form: </p>
2473
- * <p>
2474
- * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
2475
- * </code>
2476
- * </p>
2477
- */
2478
- CertificateAuthorityArn: string | undefined;
2479
-
2480
- /**
2481
- * <p>List of tags to be associated with the CA.</p>
2482
- */
2483
- Tags: Tag[] | undefined;
2484
- }
2485
-
2486
- export namespace TagCertificateAuthorityRequest {
2487
- /**
2488
- * @internal
2489
- */
2490
- export const filterSensitiveLog = (obj: TagCertificateAuthorityRequest): any => ({
2491
- ...obj,
2492
- });
2493
- }
2494
-
2495
- /**
2496
- * <p>You can associate up to 50 tags with a private CA. Exception information is contained
2497
- * in the exception message field.</p>
2498
- */
2499
- export interface TooManyTagsException extends __SmithyException, $MetadataBearer {
2500
- name: "TooManyTagsException";
2501
- $fault: "client";
2502
- message?: string;
2503
- }
2504
-
2505
- export namespace TooManyTagsException {
2506
- /**
2507
- * @internal
2508
- */
2509
- export const filterSensitiveLog = (obj: TooManyTagsException): any => ({
2510
- ...obj,
2511
- });
2512
- }
2513
-
2514
- export interface UntagCertificateAuthorityRequest {
2515
- /**
2516
- * <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>. This must be of the form: </p>
2517
- * <p>
2518
- * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
2519
- * </code>
2520
- * </p>
2521
- */
2522
- CertificateAuthorityArn: string | undefined;
2523
-
2524
- /**
2525
- * <p>List of tags to be removed from the CA.</p>
2526
- */
2527
- Tags: Tag[] | undefined;
2528
- }
2529
-
2530
- export namespace UntagCertificateAuthorityRequest {
2531
- /**
2532
- * @internal
2533
- */
2534
- export const filterSensitiveLog = (obj: UntagCertificateAuthorityRequest): any => ({
2535
- ...obj,
2536
- });
2537
- }
2538
-
2539
- export interface UpdateCertificateAuthorityRequest {
2540
- /**
2541
- * <p>Amazon Resource Name (ARN) of the private CA that issued the certificate to be
2542
- * revoked. This must be of the form:</p>
2543
- * <p>
2544
- * <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
2545
- * </code>
2546
- * </p>
2547
- */
2548
- CertificateAuthorityArn: string | undefined;
2549
-
2550
- /**
2551
- * <p>Contains information to enable Online Certificate Status Protocol (OCSP) support,
2552
- * to enable a certificate revocation list (CRL), to enable both, or to enable neither. If
2553
- * this parameter is not supplied, existing capibilites remain unchanged. For more
2554
- * information, see the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_OcspConfiguration.html">OcspConfiguration</a> and <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CrlConfiguration.html">CrlConfiguration</a> types.</p>
2555
- */
2556
- RevocationConfiguration?: RevocationConfiguration;
2557
-
2558
- /**
2559
- * <p>Status of your private CA.</p>
2560
- */
2561
- Status?: CertificateAuthorityStatus | string;
2562
- }
2563
-
2564
- export namespace UpdateCertificateAuthorityRequest {
2565
- /**
2566
- * @internal
2567
- */
2568
- export const filterSensitiveLog = (obj: UpdateCertificateAuthorityRequest): any => ({
2569
- ...obj,
2570
- });
2571
- }