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