@aws-sdk/client-cloudtrail 3.33.0 → 3.36.1

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 (275) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/{dist/cjs → dist-cjs}/CloudTrail.js +0 -19
  3. package/dist-cjs/CloudTrailClient.js +35 -0
  4. package/{dist/cjs → dist-cjs}/commands/AddTagsCommand.js +2 -30
  5. package/{dist/cjs → dist-cjs}/commands/CreateTrailCommand.js +2 -28
  6. package/{dist/cjs → dist-cjs}/commands/DeleteTrailCommand.js +2 -29
  7. package/{dist/cjs → dist-cjs}/commands/DescribeTrailsCommand.js +2 -27
  8. package/dist-cjs/commands/GetEventSelectorsCommand.js +36 -0
  9. package/dist-cjs/commands/GetInsightSelectorsCommand.js +36 -0
  10. package/{dist/cjs → dist-cjs}/commands/GetTrailCommand.js +2 -27
  11. package/{dist/cjs → dist-cjs}/commands/GetTrailStatusCommand.js +2 -27
  12. package/{dist/cjs → dist-cjs}/commands/ListPublicKeysCommand.js +2 -32
  13. package/{dist/cjs → dist-cjs}/commands/ListTagsCommand.js +2 -27
  14. package/{dist/cjs → dist-cjs}/commands/ListTrailsCommand.js +2 -27
  15. package/dist-cjs/commands/LookupEventsCommand.js +36 -0
  16. package/dist-cjs/commands/PutEventSelectorsCommand.js +36 -0
  17. package/{dist/cjs → dist-cjs}/commands/PutInsightSelectorsCommand.js +2 -30
  18. package/{dist/cjs → dist-cjs}/commands/RemoveTagsCommand.js +2 -27
  19. package/{dist/cjs → dist-cjs}/commands/StartLoggingCommand.js +2 -27
  20. package/{dist/cjs → dist-cjs}/commands/StopLoggingCommand.js +2 -33
  21. package/{dist/cjs → dist-cjs}/commands/UpdateTrailCommand.js +2 -32
  22. package/{dist/cjs → dist-cjs}/endpoints.js +0 -1
  23. package/{dist/cjs → dist-cjs}/index.js +0 -1
  24. package/{dist/cjs → dist-cjs}/models/index.js +0 -1
  25. package/{dist/cjs → dist-cjs}/models/models_0.js +0 -280
  26. package/{dist/cjs → dist-cjs}/pagination/Interfaces.js +0 -1
  27. package/{dist/cjs → dist-cjs}/pagination/ListPublicKeysPaginator.js +0 -11
  28. package/{dist/cjs → dist-cjs}/pagination/ListTagsPaginator.js +0 -11
  29. package/{dist/cjs → dist-cjs}/pagination/ListTrailsPaginator.js +0 -11
  30. package/{dist/cjs → dist-cjs}/pagination/LookupEventsPaginator.js +0 -11
  31. package/{dist/cjs → dist-cjs}/protocols/Aws_json1_1.js +0 -6
  32. package/{dist/cjs → dist-cjs}/runtimeConfig.browser.js +1 -5
  33. package/{dist/cjs → dist-cjs}/runtimeConfig.js +1 -5
  34. package/{dist/cjs → dist-cjs}/runtimeConfig.native.js +0 -4
  35. package/{dist/cjs → dist-cjs}/runtimeConfig.shared.js +1 -5
  36. package/{dist/es → dist-es}/CloudTrail.js +1 -20
  37. package/dist-es/CloudTrailClient.js +37 -0
  38. package/{dist/es → dist-es}/commands/AddTagsCommand.js +4 -33
  39. package/{dist/es → dist-es}/commands/CreateTrailCommand.js +4 -31
  40. package/{dist/es → dist-es}/commands/DeleteTrailCommand.js +4 -32
  41. package/{dist/es → dist-es}/commands/DescribeTrailsCommand.js +4 -30
  42. package/dist-es/commands/GetEventSelectorsCommand.js +39 -0
  43. package/{dist/es → dist-es}/commands/GetInsightSelectorsCommand.js +4 -36
  44. package/{dist/es → dist-es}/commands/GetTrailCommand.js +4 -30
  45. package/{dist/es → dist-es}/commands/GetTrailStatusCommand.js +4 -30
  46. package/{dist/es → dist-es}/commands/ListPublicKeysCommand.js +4 -35
  47. package/{dist/es → dist-es}/commands/ListTagsCommand.js +4 -30
  48. package/{dist/es → dist-es}/commands/ListTrailsCommand.js +4 -30
  49. package/dist-es/commands/LookupEventsCommand.js +39 -0
  50. package/dist-es/commands/PutEventSelectorsCommand.js +39 -0
  51. package/{dist/es → dist-es}/commands/PutInsightSelectorsCommand.js +4 -33
  52. package/{dist/es → dist-es}/commands/RemoveTagsCommand.js +4 -30
  53. package/{dist/es → dist-es}/commands/StartLoggingCommand.js +4 -30
  54. package/{dist/es → dist-es}/commands/StopLoggingCommand.js +4 -36
  55. package/{dist/es → dist-es}/commands/UpdateTrailCommand.js +4 -35
  56. package/{dist/es → dist-es}/endpoints.js +1 -2
  57. package/{dist/types/index.d.ts → dist-es/index.js} +0 -0
  58. package/{dist/types/models/index.d.ts → dist-es/models/index.js} +0 -0
  59. package/{dist/es → dist-es}/models/models_0.js +0 -280
  60. package/dist-es/pagination/Interfaces.js +1 -0
  61. package/{dist/es → dist-es}/pagination/ListPublicKeysPaginator.js +16 -29
  62. package/{dist/es → dist-es}/pagination/ListTagsPaginator.js +16 -29
  63. package/{dist/es → dist-es}/pagination/ListTrailsPaginator.js +16 -29
  64. package/{dist/es → dist-es}/pagination/LookupEventsPaginator.js +16 -29
  65. package/{dist/es → dist-es}/protocols/Aws_json1_1.js +788 -794
  66. package/{dist/es → dist-es}/runtimeConfig.browser.js +1 -5
  67. package/{dist/es → dist-es}/runtimeConfig.js +1 -5
  68. package/{dist/es → dist-es}/runtimeConfig.native.js +0 -4
  69. package/{dist/es → dist-es}/runtimeConfig.shared.js +1 -5
  70. package/{dist/types → dist-types}/CloudTrail.d.ts +1 -1
  71. package/{dist/types → dist-types}/CloudTrailClient.d.ts +8 -8
  72. package/{dist/types → dist-types}/commands/AddTagsCommand.d.ts +2 -2
  73. package/{dist/types → dist-types}/commands/CreateTrailCommand.d.ts +2 -2
  74. package/{dist/types → dist-types}/commands/DeleteTrailCommand.d.ts +2 -2
  75. package/{dist/types → dist-types}/commands/DescribeTrailsCommand.d.ts +2 -2
  76. package/{dist/types → dist-types}/commands/GetEventSelectorsCommand.d.ts +2 -2
  77. package/{dist/types → dist-types}/commands/GetInsightSelectorsCommand.d.ts +2 -2
  78. package/{dist/types → dist-types}/commands/GetTrailCommand.d.ts +2 -2
  79. package/{dist/types → dist-types}/commands/GetTrailStatusCommand.d.ts +2 -2
  80. package/{dist/types → dist-types}/commands/ListPublicKeysCommand.d.ts +2 -2
  81. package/{dist/types → dist-types}/commands/ListTagsCommand.d.ts +2 -2
  82. package/{dist/types → dist-types}/commands/ListTrailsCommand.d.ts +2 -2
  83. package/{dist/types → dist-types}/commands/LookupEventsCommand.d.ts +2 -2
  84. package/{dist/types → dist-types}/commands/PutEventSelectorsCommand.d.ts +2 -2
  85. package/{dist/types → dist-types}/commands/PutInsightSelectorsCommand.d.ts +2 -2
  86. package/{dist/types → dist-types}/commands/RemoveTagsCommand.d.ts +2 -2
  87. package/{dist/types → dist-types}/commands/StartLoggingCommand.d.ts +2 -2
  88. package/{dist/types → dist-types}/commands/StopLoggingCommand.d.ts +2 -2
  89. package/{dist/types → dist-types}/commands/UpdateTrailCommand.d.ts +2 -2
  90. package/{dist/types → dist-types}/endpoints.d.ts +0 -0
  91. package/{index.ts → dist-types/index.d.ts} +0 -0
  92. package/{models/index.ts → dist-types/models/index.d.ts} +0 -0
  93. package/{dist/types → dist-types}/models/models_0.d.ts +0 -0
  94. package/{dist/types → dist-types}/pagination/Interfaces.d.ts +1 -1
  95. package/{dist/types → dist-types}/pagination/ListPublicKeysPaginator.d.ts +1 -1
  96. package/{dist/types → dist-types}/pagination/ListTagsPaginator.d.ts +1 -1
  97. package/{dist/types → dist-types}/pagination/ListTrailsPaginator.d.ts +1 -1
  98. package/{dist/types → dist-types}/pagination/LookupEventsPaginator.d.ts +1 -1
  99. package/{dist/types → dist-types}/protocols/Aws_json1_1.d.ts +2 -2
  100. package/{dist/types → dist-types}/runtimeConfig.browser.d.ts +0 -0
  101. package/{dist/types → dist-types}/runtimeConfig.d.ts +1 -1
  102. package/{dist/types → dist-types}/runtimeConfig.native.d.ts +0 -0
  103. package/{dist/types → dist-types}/runtimeConfig.shared.d.ts +0 -0
  104. package/dist-types/ts3.4/CloudTrail.d.ts +95 -0
  105. package/{dist/types → dist-types}/ts3.4/CloudTrailClient.d.ts +32 -112
  106. package/dist-types/ts3.4/commands/AddTagsCommand.d.ts +17 -0
  107. package/dist-types/ts3.4/commands/CreateTrailCommand.d.ts +17 -0
  108. package/dist-types/ts3.4/commands/DeleteTrailCommand.d.ts +17 -0
  109. package/dist-types/ts3.4/commands/DescribeTrailsCommand.d.ts +17 -0
  110. package/dist-types/ts3.4/commands/GetEventSelectorsCommand.d.ts +17 -0
  111. package/dist-types/ts3.4/commands/GetInsightSelectorsCommand.d.ts +17 -0
  112. package/dist-types/ts3.4/commands/GetTrailCommand.d.ts +17 -0
  113. package/dist-types/ts3.4/commands/GetTrailStatusCommand.d.ts +17 -0
  114. package/dist-types/ts3.4/commands/ListPublicKeysCommand.d.ts +17 -0
  115. package/dist-types/ts3.4/commands/ListTagsCommand.d.ts +17 -0
  116. package/dist-types/ts3.4/commands/ListTrailsCommand.d.ts +17 -0
  117. package/dist-types/ts3.4/commands/LookupEventsCommand.d.ts +17 -0
  118. package/dist-types/ts3.4/commands/PutEventSelectorsCommand.d.ts +17 -0
  119. package/dist-types/ts3.4/commands/PutInsightSelectorsCommand.d.ts +17 -0
  120. package/dist-types/ts3.4/commands/RemoveTagsCommand.d.ts +17 -0
  121. package/dist-types/ts3.4/commands/StartLoggingCommand.d.ts +17 -0
  122. package/dist-types/ts3.4/commands/StopLoggingCommand.d.ts +17 -0
  123. package/dist-types/ts3.4/commands/UpdateTrailCommand.d.ts +17 -0
  124. package/{dist/types → dist-types}/ts3.4/endpoints.d.ts +0 -0
  125. package/{dist/types → dist-types}/ts3.4/index.d.ts +0 -0
  126. package/{dist/types → dist-types}/ts3.4/models/index.d.ts +0 -0
  127. package/dist-types/ts3.4/models/models_0.d.ts +1181 -0
  128. package/{dist/types → dist-types}/ts3.4/pagination/Interfaces.d.ts +1 -1
  129. package/{dist/types → dist-types}/ts3.4/pagination/ListPublicKeysPaginator.d.ts +1 -1
  130. package/{dist/types → dist-types}/ts3.4/pagination/ListTagsPaginator.d.ts +1 -1
  131. package/{dist/types → dist-types}/ts3.4/pagination/ListTrailsPaginator.d.ts +1 -1
  132. package/{dist/types → dist-types}/ts3.4/pagination/LookupEventsPaginator.d.ts +1 -1
  133. package/{dist/types → dist-types}/ts3.4/protocols/Aws_json1_1.d.ts +2 -2
  134. package/{dist/types → dist-types}/ts3.4/runtimeConfig.browser.d.ts +1 -3
  135. package/{dist/types → dist-types}/ts3.4/runtimeConfig.d.ts +2 -4
  136. package/{dist/types → dist-types}/ts3.4/runtimeConfig.native.d.ts +1 -3
  137. package/{dist/types → dist-types}/ts3.4/runtimeConfig.shared.d.ts +1 -3
  138. package/package.json +52 -49
  139. package/CloudTrail.ts +0 -730
  140. package/CloudTrailClient.ts +0 -310
  141. package/commands/AddTagsCommand.ts +0 -94
  142. package/commands/CreateTrailCommand.ts +0 -95
  143. package/commands/DeleteTrailCommand.ts +0 -96
  144. package/commands/DescribeTrailsCommand.ts +0 -94
  145. package/commands/GetEventSelectorsCommand.ts +0 -110
  146. package/commands/GetInsightSelectorsCommand.ts +0 -100
  147. package/commands/GetTrailCommand.ts +0 -91
  148. package/commands/GetTrailStatusCommand.ts +0 -94
  149. package/commands/ListPublicKeysCommand.ts +0 -99
  150. package/commands/ListTagsCommand.ts +0 -91
  151. package/commands/ListTrailsCommand.ts +0 -94
  152. package/commands/LookupEventsCommand.ts +0 -141
  153. package/commands/PutEventSelectorsCommand.ts +0 -138
  154. package/commands/PutInsightSelectorsCommand.ts +0 -97
  155. package/commands/RemoveTagsCommand.ts +0 -94
  156. package/commands/StartLoggingCommand.ts +0 -94
  157. package/commands/StopLoggingCommand.ts +0 -100
  158. package/commands/UpdateTrailCommand.ts +0 -99
  159. package/dist/cjs/CloudTrail.js.map +0 -1
  160. package/dist/cjs/CloudTrailClient.js +0 -59
  161. package/dist/cjs/CloudTrailClient.js.map +0 -1
  162. package/dist/cjs/commands/AddTagsCommand.js.map +0 -1
  163. package/dist/cjs/commands/CreateTrailCommand.js.map +0 -1
  164. package/dist/cjs/commands/DeleteTrailCommand.js.map +0 -1
  165. package/dist/cjs/commands/DescribeTrailsCommand.js.map +0 -1
  166. package/dist/cjs/commands/GetEventSelectorsCommand.js +0 -77
  167. package/dist/cjs/commands/GetEventSelectorsCommand.js.map +0 -1
  168. package/dist/cjs/commands/GetInsightSelectorsCommand.js +0 -67
  169. package/dist/cjs/commands/GetInsightSelectorsCommand.js.map +0 -1
  170. package/dist/cjs/commands/GetTrailCommand.js.map +0 -1
  171. package/dist/cjs/commands/GetTrailStatusCommand.js.map +0 -1
  172. package/dist/cjs/commands/ListPublicKeysCommand.js.map +0 -1
  173. package/dist/cjs/commands/ListTagsCommand.js.map +0 -1
  174. package/dist/cjs/commands/ListTrailsCommand.js.map +0 -1
  175. package/dist/cjs/commands/LookupEventsCommand.js +0 -108
  176. package/dist/cjs/commands/LookupEventsCommand.js.map +0 -1
  177. package/dist/cjs/commands/PutEventSelectorsCommand.js +0 -105
  178. package/dist/cjs/commands/PutEventSelectorsCommand.js.map +0 -1
  179. package/dist/cjs/commands/PutInsightSelectorsCommand.js.map +0 -1
  180. package/dist/cjs/commands/RemoveTagsCommand.js.map +0 -1
  181. package/dist/cjs/commands/StartLoggingCommand.js.map +0 -1
  182. package/dist/cjs/commands/StopLoggingCommand.js.map +0 -1
  183. package/dist/cjs/commands/UpdateTrailCommand.js.map +0 -1
  184. package/dist/cjs/endpoints.js.map +0 -1
  185. package/dist/cjs/index.js.map +0 -1
  186. package/dist/cjs/models/index.js.map +0 -1
  187. package/dist/cjs/models/models_0.js.map +0 -1
  188. package/dist/cjs/package.json +0 -91
  189. package/dist/cjs/pagination/Interfaces.js.map +0 -1
  190. package/dist/cjs/pagination/ListPublicKeysPaginator.js.map +0 -1
  191. package/dist/cjs/pagination/ListTagsPaginator.js.map +0 -1
  192. package/dist/cjs/pagination/ListTrailsPaginator.js.map +0 -1
  193. package/dist/cjs/pagination/LookupEventsPaginator.js.map +0 -1
  194. package/dist/cjs/protocols/Aws_json1_1.js.map +0 -1
  195. package/dist/cjs/runtimeConfig.browser.js.map +0 -1
  196. package/dist/cjs/runtimeConfig.js.map +0 -1
  197. package/dist/cjs/runtimeConfig.native.js.map +0 -1
  198. package/dist/cjs/runtimeConfig.shared.js.map +0 -1
  199. package/dist/es/CloudTrail.js.map +0 -1
  200. package/dist/es/CloudTrailClient.js +0 -61
  201. package/dist/es/CloudTrailClient.js.map +0 -1
  202. package/dist/es/commands/AddTagsCommand.js.map +0 -1
  203. package/dist/es/commands/CreateTrailCommand.js.map +0 -1
  204. package/dist/es/commands/DeleteTrailCommand.js.map +0 -1
  205. package/dist/es/commands/DescribeTrailsCommand.js.map +0 -1
  206. package/dist/es/commands/GetEventSelectorsCommand.js +0 -81
  207. package/dist/es/commands/GetEventSelectorsCommand.js.map +0 -1
  208. package/dist/es/commands/GetInsightSelectorsCommand.js.map +0 -1
  209. package/dist/es/commands/GetTrailCommand.js.map +0 -1
  210. package/dist/es/commands/GetTrailStatusCommand.js.map +0 -1
  211. package/dist/es/commands/ListPublicKeysCommand.js.map +0 -1
  212. package/dist/es/commands/ListTagsCommand.js.map +0 -1
  213. package/dist/es/commands/ListTrailsCommand.js.map +0 -1
  214. package/dist/es/commands/LookupEventsCommand.js +0 -112
  215. package/dist/es/commands/LookupEventsCommand.js.map +0 -1
  216. package/dist/es/commands/PutEventSelectorsCommand.js +0 -109
  217. package/dist/es/commands/PutEventSelectorsCommand.js.map +0 -1
  218. package/dist/es/commands/PutInsightSelectorsCommand.js.map +0 -1
  219. package/dist/es/commands/RemoveTagsCommand.js.map +0 -1
  220. package/dist/es/commands/StartLoggingCommand.js.map +0 -1
  221. package/dist/es/commands/StopLoggingCommand.js.map +0 -1
  222. package/dist/es/commands/UpdateTrailCommand.js.map +0 -1
  223. package/dist/es/endpoints.js.map +0 -1
  224. package/dist/es/index.js +0 -27
  225. package/dist/es/index.js.map +0 -1
  226. package/dist/es/models/index.js +0 -2
  227. package/dist/es/models/index.js.map +0 -1
  228. package/dist/es/models/models_0.js.map +0 -1
  229. package/dist/es/package.json +0 -91
  230. package/dist/es/pagination/Interfaces.js +0 -2
  231. package/dist/es/pagination/Interfaces.js.map +0 -1
  232. package/dist/es/pagination/ListPublicKeysPaginator.js.map +0 -1
  233. package/dist/es/pagination/ListTagsPaginator.js.map +0 -1
  234. package/dist/es/pagination/ListTrailsPaginator.js.map +0 -1
  235. package/dist/es/pagination/LookupEventsPaginator.js.map +0 -1
  236. package/dist/es/protocols/Aws_json1_1.js.map +0 -1
  237. package/dist/es/runtimeConfig.browser.js.map +0 -1
  238. package/dist/es/runtimeConfig.js.map +0 -1
  239. package/dist/es/runtimeConfig.native.js.map +0 -1
  240. package/dist/es/runtimeConfig.shared.js.map +0 -1
  241. package/dist/types/ts3.4/CloudTrail.d.ts +0 -286
  242. package/dist/types/ts3.4/commands/AddTagsCommand.d.ts +0 -38
  243. package/dist/types/ts3.4/commands/CreateTrailCommand.d.ts +0 -36
  244. package/dist/types/ts3.4/commands/DeleteTrailCommand.d.ts +0 -37
  245. package/dist/types/ts3.4/commands/DescribeTrailsCommand.d.ts +0 -35
  246. package/dist/types/ts3.4/commands/GetEventSelectorsCommand.d.ts +0 -51
  247. package/dist/types/ts3.4/commands/GetInsightSelectorsCommand.d.ts +0 -41
  248. package/dist/types/ts3.4/commands/GetTrailCommand.d.ts +0 -35
  249. package/dist/types/ts3.4/commands/GetTrailStatusCommand.d.ts +0 -35
  250. package/dist/types/ts3.4/commands/ListPublicKeysCommand.d.ts +0 -40
  251. package/dist/types/ts3.4/commands/ListTagsCommand.d.ts +0 -35
  252. package/dist/types/ts3.4/commands/ListTrailsCommand.d.ts +0 -35
  253. package/dist/types/ts3.4/commands/LookupEventsCommand.d.ts +0 -82
  254. package/dist/types/ts3.4/commands/PutEventSelectorsCommand.d.ts +0 -79
  255. package/dist/types/ts3.4/commands/PutInsightSelectorsCommand.d.ts +0 -38
  256. package/dist/types/ts3.4/commands/RemoveTagsCommand.d.ts +0 -35
  257. package/dist/types/ts3.4/commands/StartLoggingCommand.d.ts +0 -35
  258. package/dist/types/ts3.4/commands/StopLoggingCommand.d.ts +0 -41
  259. package/dist/types/ts3.4/commands/UpdateTrailCommand.d.ts +0 -40
  260. package/dist/types/ts3.4/models/models_0.d.ts +0 -2668
  261. package/endpoints.ts +0 -86
  262. package/jest.config.js +0 -4
  263. package/models/models_0.ts +0 -3167
  264. package/pagination/Interfaces.ts +0 -7
  265. package/pagination/ListPublicKeysPaginator.ts +0 -57
  266. package/pagination/ListTagsPaginator.ts +0 -53
  267. package/pagination/ListTrailsPaginator.ts +0 -53
  268. package/pagination/LookupEventsPaginator.ts +0 -58
  269. package/protocols/Aws_json1_1.ts +0 -4521
  270. package/runtimeConfig.browser.ts +0 -40
  271. package/runtimeConfig.native.ts +0 -16
  272. package/runtimeConfig.shared.ts +0 -16
  273. package/runtimeConfig.ts +0 -45
  274. package/tsconfig.es.json +0 -12
  275. package/tsconfig.json +0 -32
@@ -1,3167 +0,0 @@
1
- import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
-
3
- /**
4
- * <p>A custom key-value pair associated with a resource such as a CloudTrail trail.</p>
5
- */
6
- export interface Tag {
7
- /**
8
- * <p>The key in a key-value pair. The key must be must be no longer than 128 Unicode characters.
9
- * The key must be unique for the resource to which it applies.</p>
10
- */
11
- Key: string | undefined;
12
-
13
- /**
14
- * <p>The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.</p>
15
- */
16
- Value?: string;
17
- }
18
-
19
- export namespace Tag {
20
- /**
21
- * @internal
22
- */
23
- export const filterSensitiveLog = (obj: Tag): any => ({
24
- ...obj,
25
- });
26
- }
27
-
28
- /**
29
- * <p>Specifies the tags to add to a trail.</p>
30
- */
31
- export interface AddTagsRequest {
32
- /**
33
- * <p>Specifies the ARN of the trail to which one or more tags will be added. The format of a trail ARN is:</p>
34
- * <p>
35
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
36
- * </p>
37
- */
38
- ResourceId: string | undefined;
39
-
40
- /**
41
- * <p>Contains a list of tags, up to a limit of 50</p>
42
- */
43
- TagsList?: Tag[];
44
- }
45
-
46
- export namespace AddTagsRequest {
47
- /**
48
- * @internal
49
- */
50
- export const filterSensitiveLog = (obj: AddTagsRequest): any => ({
51
- ...obj,
52
- });
53
- }
54
-
55
- /**
56
- * <p>Returns the objects or data if successful. Otherwise, returns an error.</p>
57
- */
58
- export interface AddTagsResponse {}
59
-
60
- export namespace AddTagsResponse {
61
- /**
62
- * @internal
63
- */
64
- export const filterSensitiveLog = (obj: AddTagsResponse): any => ({
65
- ...obj,
66
- });
67
- }
68
-
69
- /**
70
- * <p>This exception is thrown when an operation is called with a trail ARN that is not valid. The following is the format of a trail ARN.</p>
71
- * <p>
72
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
73
- * </p>
74
- */
75
- export interface CloudTrailARNInvalidException extends __SmithyException, $MetadataBearer {
76
- name: "CloudTrailARNInvalidException";
77
- $fault: "client";
78
- /**
79
- * <p>Brief description of the exception returned by the request.</p>
80
- */
81
- Message?: string;
82
- }
83
-
84
- export namespace CloudTrailARNInvalidException {
85
- /**
86
- * @internal
87
- */
88
- export const filterSensitiveLog = (obj: CloudTrailARNInvalidException): any => ({
89
- ...obj,
90
- });
91
- }
92
-
93
- /**
94
- * <p>This exception is thrown when the specified tag key or values are not valid.
95
- * It can also occur if there are duplicate tags or too many tags on the resource.</p>
96
- */
97
- export interface InvalidTagParameterException extends __SmithyException, $MetadataBearer {
98
- name: "InvalidTagParameterException";
99
- $fault: "client";
100
- /**
101
- * <p>Brief description of the exception returned by the request.</p>
102
- */
103
- Message?: string;
104
- }
105
-
106
- export namespace InvalidTagParameterException {
107
- /**
108
- * @internal
109
- */
110
- export const filterSensitiveLog = (obj: InvalidTagParameterException): any => ({
111
- ...obj,
112
- });
113
- }
114
-
115
- /**
116
- * <p>This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements:</p>
117
- * <ul>
118
- * <li>
119
- * <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</p>
120
- * </li>
121
- * <li>
122
- * <p>Start with a letter or number, and end with a letter or number</p>
123
- * </li>
124
- * <li>
125
- * <p>Be between 3 and 128 characters</p>
126
- * </li>
127
- * <li>
128
- * <p>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code>
129
- * and <code>my--namespace</code> are not valid.</p>
130
- * </li>
131
- * <li>
132
- * <p>Not be in IP address format (for example, 192.168.5.4)</p>
133
- * </li>
134
- * </ul>
135
- */
136
- export interface InvalidTrailNameException extends __SmithyException, $MetadataBearer {
137
- name: "InvalidTrailNameException";
138
- $fault: "client";
139
- /**
140
- * <p>Brief description of the exception returned by the request.</p>
141
- */
142
- Message?: string;
143
- }
144
-
145
- export namespace InvalidTrailNameException {
146
- /**
147
- * @internal
148
- */
149
- export const filterSensitiveLog = (obj: InvalidTrailNameException): any => ({
150
- ...obj,
151
- });
152
- }
153
-
154
- /**
155
- * <p>This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail is not the management account for an
156
- * organization in Organizations. For more information, see
157
- * <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html">Prepare For Creating a Trail For Your Organization</a>.</p>
158
- */
159
- export interface NotOrganizationMasterAccountException extends __SmithyException, $MetadataBearer {
160
- name: "NotOrganizationMasterAccountException";
161
- $fault: "client";
162
- /**
163
- * <p>Brief description of the exception returned by the request.</p>
164
- */
165
- Message?: string;
166
- }
167
-
168
- export namespace NotOrganizationMasterAccountException {
169
- /**
170
- * @internal
171
- */
172
- export const filterSensitiveLog = (obj: NotOrganizationMasterAccountException): any => ({
173
- ...obj,
174
- });
175
- }
176
-
177
- /**
178
- * <p>This exception is thrown when the requested operation is not permitted.</p>
179
- */
180
- export interface OperationNotPermittedException extends __SmithyException, $MetadataBearer {
181
- name: "OperationNotPermittedException";
182
- $fault: "client";
183
- /**
184
- * <p>Brief description of the exception returned by the request.</p>
185
- */
186
- Message?: string;
187
- }
188
-
189
- export namespace OperationNotPermittedException {
190
- /**
191
- * @internal
192
- */
193
- export const filterSensitiveLog = (obj: OperationNotPermittedException): any => ({
194
- ...obj,
195
- });
196
- }
197
-
198
- /**
199
- * <p>This exception is thrown when the specified resource is not found.</p>
200
- */
201
- export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
202
- name: "ResourceNotFoundException";
203
- $fault: "client";
204
- /**
205
- * <p>Brief description of the exception returned by the request.</p>
206
- */
207
- Message?: string;
208
- }
209
-
210
- export namespace ResourceNotFoundException {
211
- /**
212
- * @internal
213
- */
214
- export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({
215
- ...obj,
216
- });
217
- }
218
-
219
- /**
220
- * <p>This exception is thrown when the specified resource type is not supported by CloudTrail.</p>
221
- */
222
- export interface ResourceTypeNotSupportedException extends __SmithyException, $MetadataBearer {
223
- name: "ResourceTypeNotSupportedException";
224
- $fault: "client";
225
- /**
226
- * <p>Brief description of the exception returned by the request.</p>
227
- */
228
- Message?: string;
229
- }
230
-
231
- export namespace ResourceTypeNotSupportedException {
232
- /**
233
- * @internal
234
- */
235
- export const filterSensitiveLog = (obj: ResourceTypeNotSupportedException): any => ({
236
- ...obj,
237
- });
238
- }
239
-
240
- /**
241
- * <p>The number of tags per trail has exceeded the permitted amount. Currently, the limit is 50.</p>
242
- */
243
- export interface TagsLimitExceededException extends __SmithyException, $MetadataBearer {
244
- name: "TagsLimitExceededException";
245
- $fault: "client";
246
- /**
247
- * <p>Brief description of the exception returned by the request.</p>
248
- */
249
- Message?: string;
250
- }
251
-
252
- export namespace TagsLimitExceededException {
253
- /**
254
- * @internal
255
- */
256
- export const filterSensitiveLog = (obj: TagsLimitExceededException): any => ({
257
- ...obj,
258
- });
259
- }
260
-
261
- /**
262
- * <p>This exception is thrown when the requested operation is not supported.</p>
263
- */
264
- export interface UnsupportedOperationException extends __SmithyException, $MetadataBearer {
265
- name: "UnsupportedOperationException";
266
- $fault: "client";
267
- /**
268
- * <p>Brief description of the exception returned by the request.</p>
269
- */
270
- Message?: string;
271
- }
272
-
273
- export namespace UnsupportedOperationException {
274
- /**
275
- * @internal
276
- */
277
- export const filterSensitiveLog = (obj: UnsupportedOperationException): any => ({
278
- ...obj,
279
- });
280
- }
281
-
282
- /**
283
- * <p>A single selector statement in an advanced event selector.</p>
284
- */
285
- export interface AdvancedFieldSelector {
286
- /**
287
- * <p>
288
- * A field in an event record on which to filter events to be logged. Supported fields include <code>readOnly</code>, <code>eventCategory</code>,
289
- * <code>eventSource</code> (for management events), <code>eventName</code>, <code>resources.type</code>, and <code>resources.ARN</code>.
290
- * </p>
291
- * <ul>
292
- * <li>
293
- * <p>
294
- * <b>
295
- * <code>readOnly</code>
296
- * </b> - Optional. Can be set to <code>Equals</code> a value of <code>true</code>
297
- * or <code>false</code>. A value of <code>false</code> logs both <code>read</code> and
298
- * <code>write</code> events.</p>
299
- * </li>
300
- * <li>
301
- * <p>
302
- * <b>
303
- * <code>eventSource</code>
304
- * </b> - For filtering management events only.
305
- * This can be set only to <code>NotEquals</code>
306
- * <code>kms.amazonaws.com</code>.</p>
307
- * </li>
308
- * <li>
309
- * <p>
310
- * <b>
311
- * <code>eventName</code>
312
- * </b> - Can use any operator. You can use it to filter in
313
- * or filter out any data event logged to CloudTrail, such as <code>PutBucket</code> or <code>GetSnapshotBlock</code>. You can have multiple values
314
- * for this field, separated by commas.</p>
315
- * </li>
316
- * <li>
317
- * <p>
318
- * <b>
319
- * <code>eventCategory</code>
320
- * </b> - This is required. It must be set to <code>Equals</code>, and
321
- * the value must be <code>Management</code> or <code>Data</code>.</p>
322
- * </li>
323
- * <li>
324
- * <p>
325
- * <b>
326
- * <code>resources.type</code>
327
- * </b> - This field is required.
328
- * <code>resources.type</code> can only use the <code>Equals</code> operator, and the
329
- * value can be one of the following: <code>AWS::S3::Object</code>,
330
- * <code>AWS::S3::AccessPoint</code>,
331
- * <code>AWS::Lambda::Function</code>, <code>AWS::DynamoDB::Table</code>,
332
- * <code>AWS::S3Outposts::Object</code>, <code>AWS::ManagedBlockchain::Node</code>,
333
- * <code>AWS::S3ObjectLambda::AccessPoint</code>, or <code>AWS::EC2::Snapshot</code>.
334
- * You can have only one <code>resources.type</code> field per selector. To log data
335
- * events on more than one resource type, add another selector.</p>
336
- * </li>
337
- * <li>
338
- * <p>
339
- * <b>
340
- * <code>resources.ARN</code>
341
- * </b> - You can use any operator with
342
- * resources.ARN, but if you use <code>Equals</code> or <code>NotEquals</code>, the
343
- * value must exactly match the ARN of a valid resource of the type you've specified in
344
- * the template as the value of resources.type. For example, if resources.type equals
345
- * <code>AWS::S3::Object</code>, the ARN must be in one of the following formats. To
346
- * log all data events for all objects in a specific S3 bucket, use the
347
- * <code>StartsWith</code> operator, and include only the bucket ARN as the matching value.</p>
348
- * <p>The trailing slash is intentional; do not exclude it. Replace the text between
349
- * less than and greater than symbols (<>) with resource-specific information. </p>
350
- * <ul>
351
- * <li>
352
- * <p>
353
- * <code>arn:<partition>:s3:::<bucket_name>/</code>
354
- * </p>
355
- * </li>
356
- * <li>
357
- * <p>
358
- * <code>arn:<partition>:s3:::<bucket_name>/<object_path>/</code>
359
- * </p>
360
- * </li>
361
- * </ul>
362
- * <p>When <code>resources.type</code> equals <code>AWS::S3::AccessPoint</code>, and the
363
- * operator is set to <code>Equals</code> or <code>NotEquals</code>, the ARN must be in
364
- * one of the following formats. To log events on all objects in an S3 access point, we
365
- * recommend that you use only the access point ARN, don’t include the object path, and
366
- * use the <code>StartsWith</code> or <code>NotStartsWith</code> operators.</p>
367
- * <ul>
368
- * <li>
369
- * <p>
370
- * <code>arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name></code>
371
- * </p>
372
- * </li>
373
- * <li>
374
- * <p>
375
- * <code>arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path></code>
376
- * </p>
377
- * </li>
378
- * </ul>
379
- * <p>When resources.type equals <code>AWS::Lambda::Function</code>, and the operator is set
380
- * to <code>Equals</code> or <code>NotEquals</code>, the ARN must be in the following format:</p>
381
- * <ul>
382
- * <li>
383
- * <p>
384
- * <code>arn:<partition>:lambda:<region>:<account_ID>:function:<function_name></code>
385
- * </p>
386
- * </li>
387
- * </ul>
388
- * <p>When resources.type equals <code>AWS::DynamoDB::Table</code>, and the operator is
389
- * set to <code>Equals</code> or <code>NotEquals</code>, the ARN must be in the
390
- * following format:</p>
391
- * <ul>
392
- * <li>
393
- * <p>
394
- * <code>arn:<partition>:dynamodb:<region>:<account_ID>:table:<table_name></code>
395
- * </p>
396
- * </li>
397
- * </ul>
398
- * <p>When <code>resources.type</code> equals <code>AWS::S3Outposts::Object</code>, and the operator
399
- * is set to <code>Equals</code> or <code>NotEquals</code>, the ARN must be in the following format:</p>
400
- * <ul>
401
- * <li>
402
- * <p>
403
- * <code>arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path></code>
404
- * </p>
405
- * </li>
406
- * </ul>
407
- * <p>When <code>resources.type</code> equals <code>AWS::ManagedBlockchain::Node</code>,
408
- * and the operator is set to <code>Equals</code> or <code>NotEquals</code>, the ARN
409
- * must be in the following format:</p>
410
- * <ul>
411
- * <li>
412
- * <p>
413
- * <code>arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID></code>
414
- * </p>
415
- * </li>
416
- * </ul>
417
- * <p>When <code>resources.type</code> equals
418
- * <code>AWS::S3ObjectLambda::AccessPoint</code>, and the operator is set to
419
- * <code>Equals</code> or <code>NotEquals</code>, the ARN must be in the following
420
- * format:</p>
421
- * <ul>
422
- * <li>
423
- * <p>
424
- * <code>arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name></code>
425
- * </p>
426
- * </li>
427
- * </ul>
428
- * <p>When <code>resources.type</code> equals <code>AWS::EC2::Snapshot</code>, and the
429
- * operator is set to <code>Equals</code> or <code>NotEquals</code>, the ARN must be in
430
- * the following format:</p>
431
- * <ul>
432
- * <li>
433
- * <p>
434
- * <code>arn:<partition>:ec2:<region>::snapshot/<snapshot_ID></code>
435
- * </p>
436
- * </li>
437
- * </ul>
438
- * </li>
439
- * </ul>
440
- */
441
- Field: string | undefined;
442
-
443
- /**
444
- * <p> An operator that includes events that match the exact value of the event record field
445
- * specified as the value of <code>Field</code>. This is the only valid operator that you can
446
- * use with the <code>readOnly</code>, <code>eventCategory</code>, and
447
- * <code>resources.type</code> fields.</p>
448
- */
449
- Equals?: string[];
450
-
451
- /**
452
- * <p>An operator that includes events that match the first few characters of the event record
453
- * field specified as the value of <code>Field</code>.</p>
454
- */
455
- StartsWith?: string[];
456
-
457
- /**
458
- * <p>An operator that includes events that match the last few characters of the event record
459
- * field specified as the value of <code>Field</code>.</p>
460
- */
461
- EndsWith?: string[];
462
-
463
- /**
464
- * <p>
465
- * An operator that excludes events that match the exact value of the event record field specified as the value of <code>Field</code>.
466
- * </p>
467
- */
468
- NotEquals?: string[];
469
-
470
- /**
471
- * <p>
472
- * An operator that excludes events that match the first few characters of the event record field specified as the value of <code>Field</code>.
473
- * </p>
474
- */
475
- NotStartsWith?: string[];
476
-
477
- /**
478
- * <p>
479
- * An operator that excludes events that match the last few characters of the event record field specified as the value of <code>Field</code>.
480
- * </p>
481
- */
482
- NotEndsWith?: string[];
483
- }
484
-
485
- export namespace AdvancedFieldSelector {
486
- /**
487
- * @internal
488
- */
489
- export const filterSensitiveLog = (obj: AdvancedFieldSelector): any => ({
490
- ...obj,
491
- });
492
- }
493
-
494
- /**
495
- * <p>Advanced event selectors let you create fine-grained selectors for the following CloudTrail
496
- * event record fields. They help you control costs by logging only those events
497
- * that are important to you. For more information about advanced event selectors, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html">Logging data events for trails</a> in the <i>CloudTrail User Guide</i>.</p>
498
- * <ul>
499
- * <li>
500
- * <p>
501
- * <code>readOnly</code>
502
- * </p>
503
- * </li>
504
- * <li>
505
- * <p>
506
- * <code>eventSource</code>
507
- * </p>
508
- * </li>
509
- * <li>
510
- * <p>
511
- * <code>eventName</code>
512
- * </p>
513
- * </li>
514
- * <li>
515
- * <p>
516
- * <code>eventCategory</code>
517
- * </p>
518
- * </li>
519
- * <li>
520
- * <p>
521
- * <code>resources.type</code>
522
- * </p>
523
- * </li>
524
- * <li>
525
- * <p>
526
- * <code>resources.ARN</code>
527
- * </p>
528
- * </li>
529
- * </ul>
530
- * <p>You cannot apply both event selectors and advanced event selectors to a trail.</p>
531
- */
532
- export interface AdvancedEventSelector {
533
- /**
534
- * <p>An optional, descriptive name for an advanced event selector, such as "Log data events
535
- * for only two S3 buckets".</p>
536
- */
537
- Name?: string;
538
-
539
- /**
540
- * <p>Contains all selector statements in an advanced event selector.</p>
541
- */
542
- FieldSelectors: AdvancedFieldSelector[] | undefined;
543
- }
544
-
545
- export namespace AdvancedEventSelector {
546
- /**
547
- * @internal
548
- */
549
- export const filterSensitiveLog = (obj: AdvancedEventSelector): any => ({
550
- ...obj,
551
- });
552
- }
553
-
554
- /**
555
- * <p>This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information,
556
- * see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html">Enabling Trusted Access with Other Amazon Web Services Services</a>
557
- * and <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html">Prepare For Creating a Trail For Your Organization</a>. </p>
558
- */
559
- export interface CloudTrailAccessNotEnabledException extends __SmithyException, $MetadataBearer {
560
- name: "CloudTrailAccessNotEnabledException";
561
- $fault: "client";
562
- /**
563
- * <p>Brief description of the exception returned by the request.</p>
564
- */
565
- Message?: string;
566
- }
567
-
568
- export namespace CloudTrailAccessNotEnabledException {
569
- /**
570
- * @internal
571
- */
572
- export const filterSensitiveLog = (obj: CloudTrailAccessNotEnabledException): any => ({
573
- ...obj,
574
- });
575
- }
576
-
577
- /**
578
- * <p>This exception is thrown when a call results in the <code>InvalidClientTokenId</code> error code.
579
- * This can occur when you are creating or updating a trail to send notifications to an Amazon SNS topic that
580
- * is in a suspended Amazon Web Services account.</p>
581
- */
582
- export interface CloudTrailInvalidClientTokenIdException extends __SmithyException, $MetadataBearer {
583
- name: "CloudTrailInvalidClientTokenIdException";
584
- $fault: "client";
585
- /**
586
- * <p>Brief description of the exception returned by the request.</p>
587
- */
588
- Message?: string;
589
- }
590
-
591
- export namespace CloudTrailInvalidClientTokenIdException {
592
- /**
593
- * @internal
594
- */
595
- export const filterSensitiveLog = (obj: CloudTrailInvalidClientTokenIdException): any => ({
596
- ...obj,
597
- });
598
- }
599
-
600
- /**
601
- * <p>Cannot set a CloudWatch Logs delivery for this region.</p>
602
- */
603
- export interface CloudWatchLogsDeliveryUnavailableException extends __SmithyException, $MetadataBearer {
604
- name: "CloudWatchLogsDeliveryUnavailableException";
605
- $fault: "client";
606
- /**
607
- * <p>Brief description of the exception returned by the request.</p>
608
- */
609
- Message?: string;
610
- }
611
-
612
- export namespace CloudWatchLogsDeliveryUnavailableException {
613
- /**
614
- * @internal
615
- */
616
- export const filterSensitiveLog = (obj: CloudWatchLogsDeliveryUnavailableException): any => ({
617
- ...obj,
618
- });
619
- }
620
-
621
- /**
622
- * <p>Specifies the settings for each trail.</p>
623
- */
624
- export interface CreateTrailRequest {
625
- /**
626
- * <p>Specifies the name of the trail. The name must meet the following requirements:</p>
627
- * <ul>
628
- * <li>
629
- * <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</p>
630
- * </li>
631
- * <li>
632
- * <p>Start with a letter or number, and end with a letter or number</p>
633
- * </li>
634
- * <li>
635
- * <p>Be between 3 and 128 characters</p>
636
- * </li>
637
- * <li>
638
- * <p>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code>
639
- * and <code>my--namespace</code> are not valid.</p>
640
- * </li>
641
- * <li>
642
- * <p>Not be in IP address format (for example, 192.168.5.4)</p>
643
- * </li>
644
- * </ul>
645
- */
646
- Name: string | undefined;
647
-
648
- /**
649
- * <p>Specifies the name of the Amazon S3 bucket designated for publishing log files. See <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html">Amazon S3 Bucket Naming Requirements</a>.</p>
650
- */
651
- S3BucketName: string | undefined;
652
-
653
- /**
654
- * <p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated
655
- * for log file delivery. For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html">Finding Your CloudTrail Log Files</a>. The maximum length is 200 characters.</p>
656
- */
657
- S3KeyPrefix?: string;
658
-
659
- /**
660
- * <p>Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.</p>
661
- */
662
- SnsTopicName?: string;
663
-
664
- /**
665
- * <p>Specifies whether the trail is publishing events from global services such as IAM to the log files.</p>
666
- */
667
- IncludeGlobalServiceEvents?: boolean;
668
-
669
- /**
670
- * <p>Specifies whether the trail is created in the current region or in all regions. The default is false, which creates a trail only in the region where you are signed in. As a best practice, consider
671
- * creating trails that log events in all regions.</p>
672
- */
673
- IsMultiRegionTrail?: boolean;
674
-
675
- /**
676
- * <p>Specifies whether log file integrity validation is enabled. The default is false.</p>
677
- * <note>
678
- * <p>When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail does
679
- * not create digest files for log files that were delivered during a period in which log file integrity validation was disabled.
680
- * For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable
681
- * it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on
682
- * January 10. The same applies whenever you stop CloudTrail logging or delete a trail.</p>
683
- * </note>
684
- */
685
- EnableLogFileValidation?: boolean;
686
-
687
- /**
688
- * <p>Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group
689
- * to which CloudTrail logs will be delivered. Not required unless you specify <code>CloudWatchLogsRoleArn</code>.</p>
690
- */
691
- CloudWatchLogsLogGroupArn?: string;
692
-
693
- /**
694
- * <p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.</p>
695
- */
696
- CloudWatchLogsRoleArn?: string;
697
-
698
- /**
699
- * <p>Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The
700
- * value can be an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully
701
- * specified ARN to a key, or a globally unique identifier.</p>
702
- * <p>CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys,
703
- * see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
704
- * <p>Examples:</p>
705
- * <ul>
706
- * <li>
707
- * <p>alias/MyAliasName</p>
708
- * </li>
709
- * <li>
710
- * <p>arn:aws:kms:us-east-2:123456789012:alias/MyAliasName</p>
711
- * </li>
712
- * <li>
713
- * <p>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</p>
714
- * </li>
715
- * <li>
716
- * <p>12345678-1234-1234-1234-123456789012</p>
717
- * </li>
718
- * </ul>
719
- */
720
- KmsKeyId?: string;
721
-
722
- /**
723
- * <p>Specifies whether the trail is created for all accounts in an organization in Organizations, or only for the current Amazon Web Services account.
724
- * The default is false, and cannot be true unless the call is made on behalf of an Amazon Web Services account that is the management account for an organization in
725
- * Organizations.</p>
726
- */
727
- IsOrganizationTrail?: boolean;
728
-
729
- /**
730
- * <p>A list of tags.</p>
731
- */
732
- TagsList?: Tag[];
733
- }
734
-
735
- export namespace CreateTrailRequest {
736
- /**
737
- * @internal
738
- */
739
- export const filterSensitiveLog = (obj: CreateTrailRequest): any => ({
740
- ...obj,
741
- });
742
- }
743
-
744
- /**
745
- * <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>
746
- */
747
- export interface CreateTrailResponse {
748
- /**
749
- * <p>Specifies the name of the trail.</p>
750
- */
751
- Name?: string;
752
-
753
- /**
754
- * <p>Specifies the name of the Amazon S3 bucket designated for publishing log files.</p>
755
- */
756
- S3BucketName?: string;
757
-
758
- /**
759
- * <p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated
760
- * for log file delivery. For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html">Finding Your CloudTrail Log Files</a>.</p>
761
- */
762
- S3KeyPrefix?: string;
763
-
764
- /**
765
- * @deprecated
766
- *
767
- * <p>This field is no longer in use. Use SnsTopicARN.</p>
768
- */
769
- SnsTopicName?: string;
770
-
771
- /**
772
- * <p>Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:</p>
773
- * <p>
774
- * <code>arn:aws:sns:us-east-2:123456789012:MyTopic</code>
775
- * </p>
776
- */
777
- SnsTopicARN?: string;
778
-
779
- /**
780
- * <p>Specifies whether the trail is publishing events from global services such as IAM to the log files.</p>
781
- */
782
- IncludeGlobalServiceEvents?: boolean;
783
-
784
- /**
785
- * <p>Specifies whether the trail exists in one region or in all regions.</p>
786
- */
787
- IsMultiRegionTrail?: boolean;
788
-
789
- /**
790
- * <p>Specifies the ARN of the trail that was created. The format of a trail ARN
791
- * is:</p>
792
- * <p>
793
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
794
- * </p>
795
- */
796
- TrailARN?: string;
797
-
798
- /**
799
- * <p>Specifies whether log file integrity validation is enabled.</p>
800
- */
801
- LogFileValidationEnabled?: boolean;
802
-
803
- /**
804
- * <p>Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.</p>
805
- */
806
- CloudWatchLogsLogGroupArn?: string;
807
-
808
- /**
809
- * <p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.</p>
810
- */
811
- CloudWatchLogsRoleArn?: string;
812
-
813
- /**
814
- * <p>Specifies the KMS key ID that encrypts the logs delivered by CloudTrail.
815
- * The value is a fully specified ARN to a KMS key in the following format.</p>
816
- * <p>
817
- * <code>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</code>
818
- * </p>
819
- */
820
- KmsKeyId?: string;
821
-
822
- /**
823
- * <p>Specifies whether the trail is an organization trail.</p>
824
- */
825
- IsOrganizationTrail?: boolean;
826
- }
827
-
828
- export namespace CreateTrailResponse {
829
- /**
830
- * @internal
831
- */
832
- export const filterSensitiveLog = (obj: CreateTrailResponse): any => ({
833
- ...obj,
834
- });
835
- }
836
-
837
- /**
838
- * <p>This exception is thrown when the IAM user or role that is used to create the organization trail is lacking one or more required permissions for
839
- * creating an organization trail in a required service. For more information, see
840
- * <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html">Prepare For Creating a Trail For Your Organization</a>.</p>
841
- */
842
- export interface InsufficientDependencyServiceAccessPermissionException extends __SmithyException, $MetadataBearer {
843
- name: "InsufficientDependencyServiceAccessPermissionException";
844
- $fault: "client";
845
- /**
846
- * <p>Brief description of the exception returned by the request.</p>
847
- */
848
- Message?: string;
849
- }
850
-
851
- export namespace InsufficientDependencyServiceAccessPermissionException {
852
- /**
853
- * @internal
854
- */
855
- export const filterSensitiveLog = (obj: InsufficientDependencyServiceAccessPermissionException): any => ({
856
- ...obj,
857
- });
858
- }
859
-
860
- /**
861
- * <p>This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient.</p>
862
- */
863
- export interface InsufficientEncryptionPolicyException extends __SmithyException, $MetadataBearer {
864
- name: "InsufficientEncryptionPolicyException";
865
- $fault: "client";
866
- /**
867
- * <p>Brief description of the exception returned by the request.</p>
868
- */
869
- Message?: string;
870
- }
871
-
872
- export namespace InsufficientEncryptionPolicyException {
873
- /**
874
- * @internal
875
- */
876
- export const filterSensitiveLog = (obj: InsufficientEncryptionPolicyException): any => ({
877
- ...obj,
878
- });
879
- }
880
-
881
- /**
882
- * <p>This exception is thrown when the policy on the S3 bucket is not sufficient.</p>
883
- */
884
- export interface InsufficientS3BucketPolicyException extends __SmithyException, $MetadataBearer {
885
- name: "InsufficientS3BucketPolicyException";
886
- $fault: "client";
887
- /**
888
- * <p>Brief description of the exception returned by the request.</p>
889
- */
890
- Message?: string;
891
- }
892
-
893
- export namespace InsufficientS3BucketPolicyException {
894
- /**
895
- * @internal
896
- */
897
- export const filterSensitiveLog = (obj: InsufficientS3BucketPolicyException): any => ({
898
- ...obj,
899
- });
900
- }
901
-
902
- /**
903
- * <p>This exception is thrown when the policy on the Amazon SNS topic is not sufficient.</p>
904
- */
905
- export interface InsufficientSnsTopicPolicyException extends __SmithyException, $MetadataBearer {
906
- name: "InsufficientSnsTopicPolicyException";
907
- $fault: "client";
908
- /**
909
- * <p>Brief description of the exception returned by the request.</p>
910
- */
911
- Message?: string;
912
- }
913
-
914
- export namespace InsufficientSnsTopicPolicyException {
915
- /**
916
- * @internal
917
- */
918
- export const filterSensitiveLog = (obj: InsufficientSnsTopicPolicyException): any => ({
919
- ...obj,
920
- });
921
- }
922
-
923
- /**
924
- * <p>This exception is thrown when the provided CloudWatch Logs log group is not valid.</p>
925
- */
926
- export interface InvalidCloudWatchLogsLogGroupArnException extends __SmithyException, $MetadataBearer {
927
- name: "InvalidCloudWatchLogsLogGroupArnException";
928
- $fault: "client";
929
- /**
930
- * <p>Brief description of the exception returned by the request.</p>
931
- */
932
- Message?: string;
933
- }
934
-
935
- export namespace InvalidCloudWatchLogsLogGroupArnException {
936
- /**
937
- * @internal
938
- */
939
- export const filterSensitiveLog = (obj: InvalidCloudWatchLogsLogGroupArnException): any => ({
940
- ...obj,
941
- });
942
- }
943
-
944
- /**
945
- * <p>This exception is thrown when the provided role is not valid.</p>
946
- */
947
- export interface InvalidCloudWatchLogsRoleArnException extends __SmithyException, $MetadataBearer {
948
- name: "InvalidCloudWatchLogsRoleArnException";
949
- $fault: "client";
950
- /**
951
- * <p>Brief description of the exception returned by the request.</p>
952
- */
953
- Message?: string;
954
- }
955
-
956
- export namespace InvalidCloudWatchLogsRoleArnException {
957
- /**
958
- * @internal
959
- */
960
- export const filterSensitiveLog = (obj: InvalidCloudWatchLogsRoleArnException): any => ({
961
- ...obj,
962
- });
963
- }
964
-
965
- /**
966
- * <p>This exception is thrown when the KMS key ARN is not valid.</p>
967
- */
968
- export interface InvalidKmsKeyIdException extends __SmithyException, $MetadataBearer {
969
- name: "InvalidKmsKeyIdException";
970
- $fault: "client";
971
- /**
972
- * <p>Brief description of the exception returned by the request.</p>
973
- */
974
- Message?: string;
975
- }
976
-
977
- export namespace InvalidKmsKeyIdException {
978
- /**
979
- * @internal
980
- */
981
- export const filterSensitiveLog = (obj: InvalidKmsKeyIdException): any => ({
982
- ...obj,
983
- });
984
- }
985
-
986
- /**
987
- * <p>This exception is thrown when the combination of parameters provided is not valid.</p>
988
- */
989
- export interface InvalidParameterCombinationException extends __SmithyException, $MetadataBearer {
990
- name: "InvalidParameterCombinationException";
991
- $fault: "client";
992
- /**
993
- * <p>Brief description of the exception returned by the request.</p>
994
- */
995
- Message?: string;
996
- }
997
-
998
- export namespace InvalidParameterCombinationException {
999
- /**
1000
- * @internal
1001
- */
1002
- export const filterSensitiveLog = (obj: InvalidParameterCombinationException): any => ({
1003
- ...obj,
1004
- });
1005
- }
1006
-
1007
- /**
1008
- * <p>This exception is thrown when the provided S3 bucket name is not valid.</p>
1009
- */
1010
- export interface InvalidS3BucketNameException extends __SmithyException, $MetadataBearer {
1011
- name: "InvalidS3BucketNameException";
1012
- $fault: "client";
1013
- /**
1014
- * <p>Brief description of the exception returned by the request.</p>
1015
- */
1016
- Message?: string;
1017
- }
1018
-
1019
- export namespace InvalidS3BucketNameException {
1020
- /**
1021
- * @internal
1022
- */
1023
- export const filterSensitiveLog = (obj: InvalidS3BucketNameException): any => ({
1024
- ...obj,
1025
- });
1026
- }
1027
-
1028
- /**
1029
- * <p>This exception is thrown when the provided S3 prefix is not valid.</p>
1030
- */
1031
- export interface InvalidS3PrefixException extends __SmithyException, $MetadataBearer {
1032
- name: "InvalidS3PrefixException";
1033
- $fault: "client";
1034
- /**
1035
- * <p>Brief description of the exception returned by the request.</p>
1036
- */
1037
- Message?: string;
1038
- }
1039
-
1040
- export namespace InvalidS3PrefixException {
1041
- /**
1042
- * @internal
1043
- */
1044
- export const filterSensitiveLog = (obj: InvalidS3PrefixException): any => ({
1045
- ...obj,
1046
- });
1047
- }
1048
-
1049
- /**
1050
- * <p>This exception is thrown when the provided SNS topic name is not valid.</p>
1051
- */
1052
- export interface InvalidSnsTopicNameException extends __SmithyException, $MetadataBearer {
1053
- name: "InvalidSnsTopicNameException";
1054
- $fault: "client";
1055
- /**
1056
- * <p>Brief description of the exception returned by the request.</p>
1057
- */
1058
- Message?: string;
1059
- }
1060
-
1061
- export namespace InvalidSnsTopicNameException {
1062
- /**
1063
- * @internal
1064
- */
1065
- export const filterSensitiveLog = (obj: InvalidSnsTopicNameException): any => ({
1066
- ...obj,
1067
- });
1068
- }
1069
-
1070
- /**
1071
- * <p>This exception is thrown when there is an issue with the specified KMS key and the trail can’t be updated.</p>
1072
- */
1073
- export interface KmsException extends __SmithyException, $MetadataBearer {
1074
- name: "KmsException";
1075
- $fault: "client";
1076
- /**
1077
- * <p>Brief description of the exception returned by the request.</p>
1078
- */
1079
- Message?: string;
1080
- }
1081
-
1082
- export namespace KmsException {
1083
- /**
1084
- * @internal
1085
- */
1086
- export const filterSensitiveLog = (obj: KmsException): any => ({
1087
- ...obj,
1088
- });
1089
- }
1090
-
1091
- /**
1092
- * @deprecated
1093
- *
1094
- * <p>This exception is no longer in use.</p>
1095
- */
1096
- export interface KmsKeyDisabledException extends __SmithyException, $MetadataBearer {
1097
- name: "KmsKeyDisabledException";
1098
- $fault: "client";
1099
- /**
1100
- * <p>Brief description of the exception returned by the request.</p>
1101
- */
1102
- Message?: string;
1103
- }
1104
-
1105
- export namespace KmsKeyDisabledException {
1106
- /**
1107
- * @internal
1108
- */
1109
- export const filterSensitiveLog = (obj: KmsKeyDisabledException): any => ({
1110
- ...obj,
1111
- });
1112
- }
1113
-
1114
- /**
1115
- * <p>This exception is thrown when the KMS key does not exist, when the S3 bucket and the
1116
- * KMS key are not in the same region, or when the KMS key associated with the Amazon SNS
1117
- * topic either does not exist or is not in the same region.</p>
1118
- */
1119
- export interface KmsKeyNotFoundException extends __SmithyException, $MetadataBearer {
1120
- name: "KmsKeyNotFoundException";
1121
- $fault: "client";
1122
- /**
1123
- * <p>Brief description of the exception returned by the request.</p>
1124
- */
1125
- Message?: string;
1126
- }
1127
-
1128
- export namespace KmsKeyNotFoundException {
1129
- /**
1130
- * @internal
1131
- */
1132
- export const filterSensitiveLog = (obj: KmsKeyNotFoundException): any => ({
1133
- ...obj,
1134
- });
1135
- }
1136
-
1137
- /**
1138
- * <p>This exception is thrown when the maximum number of trails is reached.</p>
1139
- */
1140
- export interface MaximumNumberOfTrailsExceededException extends __SmithyException, $MetadataBearer {
1141
- name: "MaximumNumberOfTrailsExceededException";
1142
- $fault: "client";
1143
- /**
1144
- * <p>Brief description of the exception returned by the request.</p>
1145
- */
1146
- Message?: string;
1147
- }
1148
-
1149
- export namespace MaximumNumberOfTrailsExceededException {
1150
- /**
1151
- * @internal
1152
- */
1153
- export const filterSensitiveLog = (obj: MaximumNumberOfTrailsExceededException): any => ({
1154
- ...obj,
1155
- });
1156
- }
1157
-
1158
- /**
1159
- * <p>This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support
1160
- * creating an organization trail. For more information, see
1161
- * <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html">Prepare For Creating a Trail For Your Organization</a>.</p>
1162
- */
1163
- export interface OrganizationNotInAllFeaturesModeException extends __SmithyException, $MetadataBearer {
1164
- name: "OrganizationNotInAllFeaturesModeException";
1165
- $fault: "client";
1166
- /**
1167
- * <p>Brief description of the exception returned by the request.</p>
1168
- */
1169
- Message?: string;
1170
- }
1171
-
1172
- export namespace OrganizationNotInAllFeaturesModeException {
1173
- /**
1174
- * @internal
1175
- */
1176
- export const filterSensitiveLog = (obj: OrganizationNotInAllFeaturesModeException): any => ({
1177
- ...obj,
1178
- });
1179
- }
1180
-
1181
- /**
1182
- * <p>This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization.
1183
- * To make this request, sign in using the credentials of an account that belongs to an organization.</p>
1184
- */
1185
- export interface OrganizationsNotInUseException extends __SmithyException, $MetadataBearer {
1186
- name: "OrganizationsNotInUseException";
1187
- $fault: "client";
1188
- /**
1189
- * <p>Brief description of the exception returned by the request.</p>
1190
- */
1191
- Message?: string;
1192
- }
1193
-
1194
- export namespace OrganizationsNotInUseException {
1195
- /**
1196
- * @internal
1197
- */
1198
- export const filterSensitiveLog = (obj: OrganizationsNotInUseException): any => ({
1199
- ...obj,
1200
- });
1201
- }
1202
-
1203
- /**
1204
- * <p>This exception is thrown when the specified S3 bucket does not exist.</p>
1205
- */
1206
- export interface S3BucketDoesNotExistException extends __SmithyException, $MetadataBearer {
1207
- name: "S3BucketDoesNotExistException";
1208
- $fault: "client";
1209
- /**
1210
- * <p>Brief description of the exception returned by the request.</p>
1211
- */
1212
- Message?: string;
1213
- }
1214
-
1215
- export namespace S3BucketDoesNotExistException {
1216
- /**
1217
- * @internal
1218
- */
1219
- export const filterSensitiveLog = (obj: S3BucketDoesNotExistException): any => ({
1220
- ...obj,
1221
- });
1222
- }
1223
-
1224
- /**
1225
- * <p>This exception is thrown when the specified trail already exists.</p>
1226
- */
1227
- export interface TrailAlreadyExistsException extends __SmithyException, $MetadataBearer {
1228
- name: "TrailAlreadyExistsException";
1229
- $fault: "client";
1230
- /**
1231
- * <p>Brief description of the exception returned by the request.</p>
1232
- */
1233
- Message?: string;
1234
- }
1235
-
1236
- export namespace TrailAlreadyExistsException {
1237
- /**
1238
- * @internal
1239
- */
1240
- export const filterSensitiveLog = (obj: TrailAlreadyExistsException): any => ({
1241
- ...obj,
1242
- });
1243
- }
1244
-
1245
- /**
1246
- * <p>This exception is no longer in use.</p>
1247
- */
1248
- export interface TrailNotProvidedException extends __SmithyException, $MetadataBearer {
1249
- name: "TrailNotProvidedException";
1250
- $fault: "client";
1251
- /**
1252
- * <p>Brief description of the exception returned by the request.</p>
1253
- */
1254
- Message?: string;
1255
- }
1256
-
1257
- export namespace TrailNotProvidedException {
1258
- /**
1259
- * @internal
1260
- */
1261
- export const filterSensitiveLog = (obj: TrailNotProvidedException): any => ({
1262
- ...obj,
1263
- });
1264
- }
1265
-
1266
- /**
1267
- * <p>This exception is thrown when the specified resource is not ready for an operation.
1268
- * This can occur when you try to run an operation on a trail before CloudTrail has time to fully load the trail.
1269
- * If this exception occurs, wait a few minutes, and then try the operation again.</p>
1270
- */
1271
- export interface ConflictException extends __SmithyException, $MetadataBearer {
1272
- name: "ConflictException";
1273
- $fault: "client";
1274
- /**
1275
- * <p>Brief description of the exception returned by the request.</p>
1276
- */
1277
- Message?: string;
1278
- }
1279
-
1280
- export namespace ConflictException {
1281
- /**
1282
- * @internal
1283
- */
1284
- export const filterSensitiveLog = (obj: ConflictException): any => ({
1285
- ...obj,
1286
- });
1287
- }
1288
-
1289
- /**
1290
- * <p>The request that specifies the name of a trail to delete.</p>
1291
- */
1292
- export interface DeleteTrailRequest {
1293
- /**
1294
- * <p>Specifies the name or the CloudTrail ARN of the trail to be deleted. The following is the format of a
1295
- * trail ARN.
1296
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
1297
- * </p>
1298
- */
1299
- Name: string | undefined;
1300
- }
1301
-
1302
- export namespace DeleteTrailRequest {
1303
- /**
1304
- * @internal
1305
- */
1306
- export const filterSensitiveLog = (obj: DeleteTrailRequest): any => ({
1307
- ...obj,
1308
- });
1309
- }
1310
-
1311
- /**
1312
- * <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>
1313
- */
1314
- export interface DeleteTrailResponse {}
1315
-
1316
- export namespace DeleteTrailResponse {
1317
- /**
1318
- * @internal
1319
- */
1320
- export const filterSensitiveLog = (obj: DeleteTrailResponse): any => ({
1321
- ...obj,
1322
- });
1323
- }
1324
-
1325
- /**
1326
- * <p>This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created.</p>
1327
- */
1328
- export interface InvalidHomeRegionException extends __SmithyException, $MetadataBearer {
1329
- name: "InvalidHomeRegionException";
1330
- $fault: "client";
1331
- /**
1332
- * <p>Brief description of the exception returned by the request.</p>
1333
- */
1334
- Message?: string;
1335
- }
1336
-
1337
- export namespace InvalidHomeRegionException {
1338
- /**
1339
- * @internal
1340
- */
1341
- export const filterSensitiveLog = (obj: InvalidHomeRegionException): any => ({
1342
- ...obj,
1343
- });
1344
- }
1345
-
1346
- /**
1347
- * <p>This exception is thrown when the trail with the given name is not found.</p>
1348
- */
1349
- export interface TrailNotFoundException extends __SmithyException, $MetadataBearer {
1350
- name: "TrailNotFoundException";
1351
- $fault: "client";
1352
- /**
1353
- * <p>Brief description of the exception returned by the request.</p>
1354
- */
1355
- Message?: string;
1356
- }
1357
-
1358
- export namespace TrailNotFoundException {
1359
- /**
1360
- * @internal
1361
- */
1362
- export const filterSensitiveLog = (obj: TrailNotFoundException): any => ({
1363
- ...obj,
1364
- });
1365
- }
1366
-
1367
- /**
1368
- * <p>Returns information about the trail.</p>
1369
- */
1370
- export interface DescribeTrailsRequest {
1371
- /**
1372
- * <p>Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is:</p>
1373
- * <p>
1374
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
1375
- * </p>
1376
- *
1377
- * <p>If an empty list is specified, information for the trail in the current region is returned.</p>
1378
- * <ul>
1379
- * <li>
1380
- * <p>If an empty list is specified and <code>IncludeShadowTrails</code> is false, then
1381
- * information for all trails in the current region is returned.</p>
1382
- * </li>
1383
- * <li>
1384
- * <p>If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current region and any associated shadow trails in other regions is returned.</p>
1385
- * </li>
1386
- * </ul>
1387
- * <note>
1388
- * <p>If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current region. To return information about a trail in another region, you must specify its trail ARN.</p>
1389
- * </note>
1390
- */
1391
- trailNameList?: string[];
1392
-
1393
- /**
1394
- * <p>Specifies whether to include shadow trails in the response. A shadow trail is the replication in a region of a trail that was created in a different region,
1395
- * or in the case of an organization trail, the replication of an organization trail in member accounts. If you do not include shadow trails, organization trails in a member account
1396
- * and region replication trails will not be returned. The default is true.</p>
1397
- */
1398
- includeShadowTrails?: boolean;
1399
- }
1400
-
1401
- export namespace DescribeTrailsRequest {
1402
- /**
1403
- * @internal
1404
- */
1405
- export const filterSensitiveLog = (obj: DescribeTrailsRequest): any => ({
1406
- ...obj,
1407
- });
1408
- }
1409
-
1410
- /**
1411
- * <p>The settings for a trail.</p>
1412
- */
1413
- export interface Trail {
1414
- /**
1415
- * <p>Name of the trail set by calling <a>CreateTrail</a>. The maximum length is 128
1416
- * characters.</p>
1417
- */
1418
- Name?: string;
1419
-
1420
- /**
1421
- * <p>Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html">Amazon S3 Bucket Naming Requirements</a>.</p>
1422
- */
1423
- S3BucketName?: string;
1424
-
1425
- /**
1426
- * <p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated
1427
- * for log file delivery. For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html">Finding Your CloudTrail Log Files</a>.
1428
- * The maximum length is 200 characters.</p>
1429
- */
1430
- S3KeyPrefix?: string;
1431
-
1432
- /**
1433
- * @deprecated
1434
- *
1435
- * <p>This field is no longer in use. Use SnsTopicARN.</p>
1436
- */
1437
- SnsTopicName?: string;
1438
-
1439
- /**
1440
- * <p>Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications
1441
- * when log files are delivered. The following is the format of a topic ARN.</p>
1442
- * <p>
1443
- * <code>arn:aws:sns:us-east-2:123456789012:MyTopic</code>
1444
- * </p>
1445
- */
1446
- SnsTopicARN?: string;
1447
-
1448
- /**
1449
- * <p>Set to <b>True</b> to include Amazon Web Services API calls from Amazon Web Services global services such as IAM.
1450
- * Otherwise, <b>False</b>.</p>
1451
- */
1452
- IncludeGlobalServiceEvents?: boolean;
1453
-
1454
- /**
1455
- * <p>Specifies whether the trail exists only in one region or exists in all regions.</p>
1456
- */
1457
- IsMultiRegionTrail?: boolean;
1458
-
1459
- /**
1460
- * <p>The region in which the trail was created.</p>
1461
- */
1462
- HomeRegion?: string;
1463
-
1464
- /**
1465
- * <p>Specifies the ARN of the trail. The following is the format of a trail ARN.</p>
1466
- * <p>
1467
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
1468
- * </p>
1469
- */
1470
- TrailARN?: string;
1471
-
1472
- /**
1473
- * <p>Specifies whether log file validation is enabled.</p>
1474
- */
1475
- LogFileValidationEnabled?: boolean;
1476
-
1477
- /**
1478
- * <p>Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.</p>
1479
- */
1480
- CloudWatchLogsLogGroupArn?: string;
1481
-
1482
- /**
1483
- * <p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.</p>
1484
- */
1485
- CloudWatchLogsRoleArn?: string;
1486
-
1487
- /**
1488
- * <p>Specifies the KMS key ID that encrypts the logs delivered by CloudTrail.
1489
- * The value is a fully specified ARN to a KMS key in the following format.</p>
1490
- * <p>
1491
- * <code>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</code>
1492
- * </p>
1493
- */
1494
- KmsKeyId?: string;
1495
-
1496
- /**
1497
- * <p>Specifies if the trail has custom event selectors.</p>
1498
- */
1499
- HasCustomEventSelectors?: boolean;
1500
-
1501
- /**
1502
- * <p>Specifies whether a trail has insight types specified in an <code>InsightSelector</code> list.</p>
1503
- */
1504
- HasInsightSelectors?: boolean;
1505
-
1506
- /**
1507
- * <p>Specifies whether the trail is an organization trail.</p>
1508
- */
1509
- IsOrganizationTrail?: boolean;
1510
- }
1511
-
1512
- export namespace Trail {
1513
- /**
1514
- * @internal
1515
- */
1516
- export const filterSensitiveLog = (obj: Trail): any => ({
1517
- ...obj,
1518
- });
1519
- }
1520
-
1521
- /**
1522
- * <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>
1523
- */
1524
- export interface DescribeTrailsResponse {
1525
- /**
1526
- * <p>The list of trail objects. Trail objects with string values are only returned if values for the objects exist in a trail's configuration.
1527
- * For example, <code>SNSTopicName</code> and <code>SNSTopicARN</code> are only returned in results if a trail is configured to send SNS notifications. Similarly,
1528
- * <code>KMSKeyId</code> only appears in results if a trail's log files are encrypted with KMS customer managed keys.</p>
1529
- */
1530
- trailList?: Trail[];
1531
- }
1532
-
1533
- export namespace DescribeTrailsResponse {
1534
- /**
1535
- * @internal
1536
- */
1537
- export const filterSensitiveLog = (obj: DescribeTrailsResponse): any => ({
1538
- ...obj,
1539
- });
1540
- }
1541
-
1542
- export interface GetEventSelectorsRequest {
1543
- /**
1544
- * <p>Specifies the name of the trail or trail ARN. If you specify a trail name, the
1545
- * string must meet the following requirements:</p>
1546
- * <ul>
1547
- * <li>
1548
- * <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</p>
1549
- * </li>
1550
- * <li>
1551
- * <p>Start with a letter or number, and end with a letter or number</p>
1552
- * </li>
1553
- * <li>
1554
- * <p>Be between 3 and 128 characters</p>
1555
- * </li>
1556
- * <li>
1557
- * <p>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code>
1558
- * and <code>my--namespace</code> are not valid.</p>
1559
- * </li>
1560
- * <li>
1561
- * <p>Not be in IP address format (for example, 192.168.5.4)</p>
1562
- * </li>
1563
- * </ul>
1564
- * <p>If you specify a trail ARN, it must be in the format:</p>
1565
- * <p>
1566
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
1567
- * </p>
1568
- */
1569
- TrailName: string | undefined;
1570
- }
1571
-
1572
- export namespace GetEventSelectorsRequest {
1573
- /**
1574
- * @internal
1575
- */
1576
- export const filterSensitiveLog = (obj: GetEventSelectorsRequest): any => ({
1577
- ...obj,
1578
- });
1579
- }
1580
-
1581
- /**
1582
- * <p>The Amazon S3 buckets, Lambda functions, or Amazon DynamoDB tables that you specify
1583
- * in your event selectors for your trail to log data events. Data events provide information
1584
- * about the resource operations performed on or within a resource itself. These are also
1585
- * known as data plane operations. You can specify up to 250 data resources for a
1586
- * trail.</p>
1587
- * <note>
1588
- * <p>The total number of allowed data resources is 250. This number can be distributed between 1 and 5 event selectors,
1589
- * but the total cannot exceed 250 across all selectors.</p>
1590
- * <p>If you are using advanced event selectors, the maximum total number of values for
1591
- * all conditions, across all advanced event selectors for the trail, is 500.</p>
1592
- * </note>
1593
- * <p>The following example demonstrates how logging works when you configure logging of all data events
1594
- * for an S3 bucket named <code>bucket-1</code>. In this example, the CloudTrail user specified an empty prefix,
1595
- * and the option to log both <code>Read</code> and <code>Write</code> data events.</p>
1596
- * <ol>
1597
- * <li>
1598
- * <p>A user uploads an image file to <code>bucket-1</code>.</p>
1599
- * </li>
1600
- * <li>
1601
- * <p>The <code>PutObject</code> API operation is an Amazon S3 object-level API.
1602
- * It is recorded as a data event in CloudTrail. Because the CloudTrail user specified an S3 bucket
1603
- * with an empty prefix, events that occur on any object in that bucket are logged. The trail processes and logs the
1604
- * event.</p>
1605
- * </li>
1606
- * <li>
1607
- * <p>A user uploads an object to an Amazon S3 bucket named
1608
- * <code>arn:aws:s3:::bucket-2</code>.</p>
1609
- * </li>
1610
- * <li>
1611
- * <p>The <code>PutObject</code> API operation occurred for an object in an S3 bucket that the CloudTrail
1612
- * user didn't specify for the trail. The trail doesn’t log the event.</p>
1613
- * </li>
1614
- * </ol>
1615
- * <p>The following example demonstrates how logging works when you configure logging of Lambda data events for a
1616
- * Lambda function named <i>MyLambdaFunction</i>, but not for all Lambda functions.</p>
1617
- * <ol>
1618
- * <li>
1619
- * <p>A user runs a script that includes a call to the <i>MyLambdaFunction</i> function and the
1620
- * <i>MyOtherLambdaFunction</i> function.</p>
1621
- * </li>
1622
- * <li>
1623
- * <p>The <code>Invoke</code> API operation on <i>MyLambdaFunction</i> is an Lambda API.
1624
- * It is recorded as a data event in CloudTrail. Because the CloudTrail user specified logging data events for
1625
- * <i>MyLambdaFunction</i>, any invocations of that function are logged. The trail processes and logs the event.</p>
1626
- * </li>
1627
- * <li>
1628
- * <p>The <code>Invoke</code> API operation on <i>MyOtherLambdaFunction</i> is an Lambda API.
1629
- * Because the CloudTrail user did not specify logging data events for all Lambda functions,
1630
- * the <code>Invoke</code> operation for <i>MyOtherLambdaFunction</i> does not match the function specified for the trail.
1631
- * The trail doesn’t log the event. </p>
1632
- * </li>
1633
- * </ol>
1634
- */
1635
- export interface DataResource {
1636
- /**
1637
- * <p>The resource type in which you want to log data events. You can specify
1638
- * <code>AWS::S3::Object</code>, <code>AWS::Lambda::Function</code>, or
1639
- * <code>AWS::DynamoDB::Table</code> resources.</p>
1640
- * <p>The <code>AWS::S3Outposts::Object</code>, <code>AWS::ManagedBlockchain::Node</code>,
1641
- * <code>AWS::S3ObjectLambda::AccessPoint</code>, and <code>AWS::EC2::Snapshot</code> resource types are not valid in basic
1642
- * event selectors. To log data events on these resource types, use advanced event
1643
- * selectors.</p>
1644
- */
1645
- Type?: string;
1646
-
1647
- /**
1648
- * <p>An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.</p>
1649
- * <ul>
1650
- * <li>
1651
- * <p>To log data events for all objects in all S3 buckets in your Amazon Web Services account, specify the
1652
- * prefix as <code>arn:aws:s3:::</code>.</p>
1653
- * <note>
1654
- * <p>This also enables logging of data event activity performed by any user or role in your Amazon Web Services account,
1655
- * even if that activity is performed on a bucket that belongs to another Amazon Web Services account.</p>
1656
- * </note>
1657
- * </li>
1658
- * <li>
1659
- * <p>To log data events for all objects in an S3 bucket, specify the bucket and an empty
1660
- * object prefix such as <code>arn:aws:s3:::bucket-1/</code>. The trail logs data events for
1661
- * all objects in this S3 bucket.</p>
1662
- * </li>
1663
- * <li>
1664
- * <p>To log data events for specific objects, specify the S3 bucket and object prefix such
1665
- * as <code>arn:aws:s3:::bucket-1/example-images</code>. The trail logs data events for
1666
- * objects in this S3 bucket that match the prefix.</p>
1667
- * </li>
1668
- * <li>
1669
- * <p>To log data events for all Lambda functions in your Amazon Web Services account, specify the prefix as
1670
- * <code>arn:aws:lambda</code>.</p>
1671
- * <note>
1672
- * <p>This also enables logging of <code>Invoke</code> activity performed by any user or role in your Amazon Web Services account,
1673
- * even if that activity is performed on a function that belongs to another Amazon Web Services account. </p>
1674
- * </note>
1675
- * </li>
1676
- * <li>
1677
- * <p>To log data events for a specific Lambda function, specify the function ARN.</p>
1678
- * <note>
1679
- * <p>Lambda function ARNs are exact. For example, if you specify a
1680
- * function ARN <i>arn:aws:lambda:us-west-2:111111111111:function:helloworld</i>, data events will
1681
- * only be logged for <i>arn:aws:lambda:us-west-2:111111111111:function:helloworld</i>. They will
1682
- * not be logged for <i>arn:aws:lambda:us-west-2:111111111111:function:helloworld2</i>.</p>
1683
- * </note>
1684
- * </li>
1685
- * <li>
1686
- * <p>To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix
1687
- * as <code>arn:aws:dynamodb</code>.</p>
1688
- * </li>
1689
- * </ul>
1690
- */
1691
- Values?: string[];
1692
- }
1693
-
1694
- export namespace DataResource {
1695
- /**
1696
- * @internal
1697
- */
1698
- export const filterSensitiveLog = (obj: DataResource): any => ({
1699
- ...obj,
1700
- });
1701
- }
1702
-
1703
- export enum ReadWriteType {
1704
- All = "All",
1705
- ReadOnly = "ReadOnly",
1706
- WriteOnly = "WriteOnly",
1707
- }
1708
-
1709
- /**
1710
- * <p>Use event selectors to further specify the management and data event settings for your trail. By
1711
- * default, trails created without specific event selectors will be configured to log all read and
1712
- * write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector
1713
- * for all trails. For each trail, if the event matches any event selector, the trail
1714
- * processes and logs the event. If the event doesn't match any event selector, the trail
1715
- * doesn't log the event.</p>
1716
- * <p>You can configure up to five event selectors for a trail.</p>
1717
- * <p>You cannot apply both event selectors and advanced event selectors to a trail.</p>
1718
- */
1719
- export interface EventSelector {
1720
- /**
1721
- * <p>Specify if you want your trail to log read-only events, write-only events, or all. For example,
1722
- * the EC2 <code>GetConsoleOutput</code> is a read-only API operation and
1723
- * <code>RunInstances</code> is a write-only API operation.</p>
1724
- * <p> By default, the value is <code>All</code>.</p>
1725
- */
1726
- ReadWriteType?: ReadWriteType | string;
1727
-
1728
- /**
1729
- * <p>Specify if you want your event selector to include management events for your trail.</p>
1730
- * <p>
1731
- * For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html#logging-management-events">Management Events</a> in the <i>CloudTrail User Guide</i>.</p>
1732
- *
1733
- * <p>By default, the value is <code>true</code>.</p>
1734
- * <p>The first copy of management events is free. You are charged for additional copies of management
1735
- * events that you are logging on any subsequent trail in the same region. For more information about
1736
- * CloudTrail pricing, see <a href="http://aws.amazon.com/cloudtrail/pricing/">CloudTrail Pricing</a>.</p>
1737
- */
1738
- IncludeManagementEvents?: boolean;
1739
-
1740
- /**
1741
- * <p>CloudTrail supports data event logging for Amazon S3 objects, Lambda functions,
1742
- * and Amazon DynamoDB tables
1743
- * with basic event selectors. You can specify up to 250 resources for an individual event
1744
- * selector, but the total number of data resources cannot exceed 250 across all event
1745
- * selectors in a trail. This limit does not apply if you configure resource logging for all
1746
- * data events.</p>
1747
- * <p>For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html#logging-data-events">Data Events</a> and <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html">Limits in CloudTrail</a>
1748
- * in the <i>CloudTrail User Guide</i>.</p>
1749
- */
1750
- DataResources?: DataResource[];
1751
-
1752
- /**
1753
- * <p>An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter),
1754
- * or it can filter out Key Management Service or Amazon RDS Data API events by
1755
- * containing <code>kms.amazonaws.com</code> or <code>rdsdata.amazonaws.com</code>. By default, <code>ExcludeManagementEventSources</code> is empty, and KMS and
1756
- * Amazon RDS Data API events are logged to your trail.</p>
1757
- */
1758
- ExcludeManagementEventSources?: string[];
1759
- }
1760
-
1761
- export namespace EventSelector {
1762
- /**
1763
- * @internal
1764
- */
1765
- export const filterSensitiveLog = (obj: EventSelector): any => ({
1766
- ...obj,
1767
- });
1768
- }
1769
-
1770
- export interface GetEventSelectorsResponse {
1771
- /**
1772
- * <p>The specified trail ARN that has the event selectors.</p>
1773
- */
1774
- TrailARN?: string;
1775
-
1776
- /**
1777
- * <p>The event selectors that are configured for the trail.</p>
1778
- */
1779
- EventSelectors?: EventSelector[];
1780
-
1781
- /**
1782
- * <p>
1783
- * The advanced event selectors that are configured for the trail.
1784
- * </p>
1785
- */
1786
- AdvancedEventSelectors?: AdvancedEventSelector[];
1787
- }
1788
-
1789
- export namespace GetEventSelectorsResponse {
1790
- /**
1791
- * @internal
1792
- */
1793
- export const filterSensitiveLog = (obj: GetEventSelectorsResponse): any => ({
1794
- ...obj,
1795
- });
1796
- }
1797
-
1798
- export interface GetInsightSelectorsRequest {
1799
- /**
1800
- * <p>Specifies the name of the trail or trail ARN. If you specify a trail name, the
1801
- * string must meet the following requirements:</p>
1802
- * <ul>
1803
- * <li>
1804
- * <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</p>
1805
- * </li>
1806
- * <li>
1807
- * <p>Start with a letter or number, and end with a letter or number</p>
1808
- * </li>
1809
- * <li>
1810
- * <p>Be between 3 and 128 characters</p>
1811
- * </li>
1812
- * <li>
1813
- * <p>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code>
1814
- * and <code>my--namespace</code> are not valid.</p>
1815
- * </li>
1816
- * <li>
1817
- * <p>Not be in IP address format (for example, 192.168.5.4)</p>
1818
- * </li>
1819
- * </ul>
1820
- * <p>If you specify a trail ARN, it must be in the format:</p>
1821
- * <p>
1822
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
1823
- * </p>
1824
- */
1825
- TrailName: string | undefined;
1826
- }
1827
-
1828
- export namespace GetInsightSelectorsRequest {
1829
- /**
1830
- * @internal
1831
- */
1832
- export const filterSensitiveLog = (obj: GetInsightSelectorsRequest): any => ({
1833
- ...obj,
1834
- });
1835
- }
1836
-
1837
- export enum InsightType {
1838
- ApiCallRateInsight = "ApiCallRateInsight",
1839
- }
1840
-
1841
- /**
1842
- * <p>A JSON string that contains a list of insight types that are logged on a trail.</p>
1843
- */
1844
- export interface InsightSelector {
1845
- /**
1846
- * <p>The type of Insights events to log on a trail. The valid Insights type in this release is <code>ApiCallRateInsight</code>.</p>
1847
- */
1848
- InsightType?: InsightType | string;
1849
- }
1850
-
1851
- export namespace InsightSelector {
1852
- /**
1853
- * @internal
1854
- */
1855
- export const filterSensitiveLog = (obj: InsightSelector): any => ({
1856
- ...obj,
1857
- });
1858
- }
1859
-
1860
- export interface GetInsightSelectorsResponse {
1861
- /**
1862
- * <p>The Amazon Resource Name (ARN) of a trail for which you want to get Insights selectors.</p>
1863
- */
1864
- TrailARN?: string;
1865
-
1866
- /**
1867
- * <p>A JSON string that contains the insight types you want to log on a trail. In this release, only <code>ApiCallRateInsight</code> is supported as an insight type.</p>
1868
- */
1869
- InsightSelectors?: InsightSelector[];
1870
- }
1871
-
1872
- export namespace GetInsightSelectorsResponse {
1873
- /**
1874
- * @internal
1875
- */
1876
- export const filterSensitiveLog = (obj: GetInsightSelectorsResponse): any => ({
1877
- ...obj,
1878
- });
1879
- }
1880
-
1881
- /**
1882
- * <p>If you run <code>GetInsightSelectors</code> on a trail that does not have Insights events enabled, the operation throws the exception <code>InsightNotEnabledException</code>.</p>
1883
- */
1884
- export interface InsightNotEnabledException extends __SmithyException, $MetadataBearer {
1885
- name: "InsightNotEnabledException";
1886
- $fault: "client";
1887
- /**
1888
- * <p>Brief description of the exception returned by the request.</p>
1889
- */
1890
- Message?: string;
1891
- }
1892
-
1893
- export namespace InsightNotEnabledException {
1894
- /**
1895
- * @internal
1896
- */
1897
- export const filterSensitiveLog = (obj: InsightNotEnabledException): any => ({
1898
- ...obj,
1899
- });
1900
- }
1901
-
1902
- export interface GetTrailRequest {
1903
- /**
1904
- * <p>The name or the Amazon Resource Name (ARN) of the trail for which you want to retrieve settings information.</p>
1905
- */
1906
- Name: string | undefined;
1907
- }
1908
-
1909
- export namespace GetTrailRequest {
1910
- /**
1911
- * @internal
1912
- */
1913
- export const filterSensitiveLog = (obj: GetTrailRequest): any => ({
1914
- ...obj,
1915
- });
1916
- }
1917
-
1918
- export interface GetTrailResponse {
1919
- /**
1920
- * <p>The settings for a trail.</p>
1921
- */
1922
- Trail?: Trail;
1923
- }
1924
-
1925
- export namespace GetTrailResponse {
1926
- /**
1927
- * @internal
1928
- */
1929
- export const filterSensitiveLog = (obj: GetTrailResponse): any => ({
1930
- ...obj,
1931
- });
1932
- }
1933
-
1934
- /**
1935
- * <p>The name of a trail about which you want the current status.</p>
1936
- */
1937
- export interface GetTrailStatusRequest {
1938
- /**
1939
- * <p>Specifies the name or the CloudTrail ARN of the trail for which you are requesting status. To get the status of a
1940
- * shadow trail (a replication of the trail in another region), you must specify its ARN. The following is the format of a trail ARN.</p>
1941
- * <p>
1942
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
1943
- * </p>
1944
- */
1945
- Name: string | undefined;
1946
- }
1947
-
1948
- export namespace GetTrailStatusRequest {
1949
- /**
1950
- * @internal
1951
- */
1952
- export const filterSensitiveLog = (obj: GetTrailStatusRequest): any => ({
1953
- ...obj,
1954
- });
1955
- }
1956
-
1957
- /**
1958
- * <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>
1959
- */
1960
- export interface GetTrailStatusResponse {
1961
- /**
1962
- * <p>Whether the CloudTrail trail is currently logging Amazon Web Services API calls.</p>
1963
- */
1964
- IsLogging?: boolean;
1965
-
1966
- /**
1967
- * <p>Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver log files
1968
- * to the designated bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html">Error
1969
- * Responses</a> in the Amazon S3 API Reference. </p>
1970
- * <note>
1971
- * <p>This error occurs only when there is a problem with the destination S3 bucket, and does
1972
- * not occur for requests that time out. To resolve the issue, create a new bucket, and then call
1973
- * <code>UpdateTrail</code> to specify the new bucket; or fix the existing objects so that
1974
- * CloudTrail can again write to the bucket.</p>
1975
- * </note>
1976
- */
1977
- LatestDeliveryError?: string;
1978
-
1979
- /**
1980
- * <p>Displays any Amazon SNS error that CloudTrail encountered when attempting to send a
1981
- * notification. For more information about Amazon SNS errors, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/welcome.html">Amazon SNS Developer Guide</a>.
1982
- * </p>
1983
- */
1984
- LatestNotificationError?: string;
1985
-
1986
- /**
1987
- * <p>Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.</p>
1988
- */
1989
- LatestDeliveryTime?: Date;
1990
-
1991
- /**
1992
- * <p>Specifies the date and time of the most recent Amazon SNS notification that CloudTrail has written a new log file to an account's Amazon S3 bucket.</p>
1993
- */
1994
- LatestNotificationTime?: Date;
1995
-
1996
- /**
1997
- * <p>Specifies the most recent date and time when CloudTrail started recording API calls for an Amazon Web Services account.</p>
1998
- */
1999
- StartLoggingTime?: Date;
2000
-
2001
- /**
2002
- * <p>Specifies the most recent date and time when CloudTrail stopped recording API calls for an Amazon Web Services account.</p>
2003
- */
2004
- StopLoggingTime?: Date;
2005
-
2006
- /**
2007
- * <p>Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs.</p>
2008
- */
2009
- LatestCloudWatchLogsDeliveryError?: string;
2010
-
2011
- /**
2012
- * <p>Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.</p>
2013
- */
2014
- LatestCloudWatchLogsDeliveryTime?: Date;
2015
-
2016
- /**
2017
- * <p>Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket.</p>
2018
- */
2019
- LatestDigestDeliveryTime?: Date;
2020
-
2021
- /**
2022
- * <p>Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver a digest
2023
- * file to the designated bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html">Error
2024
- * Responses</a> in the Amazon S3 API Reference. </p>
2025
- * <note>
2026
- * <p>This error occurs only when there is a problem with the destination S3 bucket, and does
2027
- * not occur for requests that time out. To resolve the issue, create a new bucket, and then call
2028
- * <code>UpdateTrail</code> to specify the new bucket; or fix the existing objects so that
2029
- * CloudTrail can again write to the bucket.</p>
2030
- * </note>
2031
- */
2032
- LatestDigestDeliveryError?: string;
2033
-
2034
- /**
2035
- * <p>This field is no longer in use.</p>
2036
- */
2037
- LatestDeliveryAttemptTime?: string;
2038
-
2039
- /**
2040
- * <p>This field is no longer in use.</p>
2041
- */
2042
- LatestNotificationAttemptTime?: string;
2043
-
2044
- /**
2045
- * <p>This field is no longer in use.</p>
2046
- */
2047
- LatestNotificationAttemptSucceeded?: string;
2048
-
2049
- /**
2050
- * <p>This field is no longer in use.</p>
2051
- */
2052
- LatestDeliveryAttemptSucceeded?: string;
2053
-
2054
- /**
2055
- * <p>This field is no longer in use.</p>
2056
- */
2057
- TimeLoggingStarted?: string;
2058
-
2059
- /**
2060
- * <p>This field is no longer in use.</p>
2061
- */
2062
- TimeLoggingStopped?: string;
2063
- }
2064
-
2065
- export namespace GetTrailStatusResponse {
2066
- /**
2067
- * @internal
2068
- */
2069
- export const filterSensitiveLog = (obj: GetTrailStatusResponse): any => ({
2070
- ...obj,
2071
- });
2072
- }
2073
-
2074
- /**
2075
- * <p>Occurs if the timestamp values are not valid. Either the start time occurs after the end time, or the time range is outside the range of possible values.</p>
2076
- */
2077
- export interface InvalidTimeRangeException extends __SmithyException, $MetadataBearer {
2078
- name: "InvalidTimeRangeException";
2079
- $fault: "client";
2080
- /**
2081
- * <p>Brief description of the exception returned by the request.</p>
2082
- */
2083
- Message?: string;
2084
- }
2085
-
2086
- export namespace InvalidTimeRangeException {
2087
- /**
2088
- * @internal
2089
- */
2090
- export const filterSensitiveLog = (obj: InvalidTimeRangeException): any => ({
2091
- ...obj,
2092
- });
2093
- }
2094
-
2095
- /**
2096
- * <p>Reserved for future use.</p>
2097
- */
2098
- export interface InvalidTokenException extends __SmithyException, $MetadataBearer {
2099
- name: "InvalidTokenException";
2100
- $fault: "client";
2101
- /**
2102
- * <p>Brief description of the exception returned by the request.</p>
2103
- */
2104
- Message?: string;
2105
- }
2106
-
2107
- export namespace InvalidTokenException {
2108
- /**
2109
- * @internal
2110
- */
2111
- export const filterSensitiveLog = (obj: InvalidTokenException): any => ({
2112
- ...obj,
2113
- });
2114
- }
2115
-
2116
- /**
2117
- * <p>Requests the public keys for a specified time range.</p>
2118
- */
2119
- export interface ListPublicKeysRequest {
2120
- /**
2121
- * <p>Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files.
2122
- * If not specified, the current time is used, and the current public key is returned.</p>
2123
- */
2124
- StartTime?: Date;
2125
-
2126
- /**
2127
- * <p>Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If not
2128
- * specified, the current time is used.</p>
2129
- */
2130
- EndTime?: Date;
2131
-
2132
- /**
2133
- * <p>Reserved for future use.</p>
2134
- */
2135
- NextToken?: string;
2136
- }
2137
-
2138
- export namespace ListPublicKeysRequest {
2139
- /**
2140
- * @internal
2141
- */
2142
- export const filterSensitiveLog = (obj: ListPublicKeysRequest): any => ({
2143
- ...obj,
2144
- });
2145
- }
2146
-
2147
- /**
2148
- * <p>Contains information about a returned public key.</p>
2149
- */
2150
- export interface PublicKey {
2151
- /**
2152
- * <p>The DER encoded public key value in PKCS#1 format.</p>
2153
- */
2154
- Value?: Uint8Array;
2155
-
2156
- /**
2157
- * <p>The starting time of validity of the public key.</p>
2158
- */
2159
- ValidityStartTime?: Date;
2160
-
2161
- /**
2162
- * <p>The ending time of validity of the public key.</p>
2163
- */
2164
- ValidityEndTime?: Date;
2165
-
2166
- /**
2167
- * <p>The fingerprint of the public key.</p>
2168
- */
2169
- Fingerprint?: string;
2170
- }
2171
-
2172
- export namespace PublicKey {
2173
- /**
2174
- * @internal
2175
- */
2176
- export const filterSensitiveLog = (obj: PublicKey): any => ({
2177
- ...obj,
2178
- });
2179
- }
2180
-
2181
- /**
2182
- * <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>
2183
- */
2184
- export interface ListPublicKeysResponse {
2185
- /**
2186
- * <p>Contains an array of PublicKey objects.</p>
2187
- * <note>
2188
- * <p>The returned public keys may have validity time ranges that overlap.</p>
2189
- * </note>
2190
- */
2191
- PublicKeyList?: PublicKey[];
2192
-
2193
- /**
2194
- * <p>Reserved for future use.</p>
2195
- */
2196
- NextToken?: string;
2197
- }
2198
-
2199
- export namespace ListPublicKeysResponse {
2200
- /**
2201
- * @internal
2202
- */
2203
- export const filterSensitiveLog = (obj: ListPublicKeysResponse): any => ({
2204
- ...obj,
2205
- });
2206
- }
2207
-
2208
- /**
2209
- * <p>Specifies a list of trail tags to return.</p>
2210
- */
2211
- export interface ListTagsRequest {
2212
- /**
2213
- * <p>Specifies a list of trail ARNs whose tags will be listed. The list has a limit of 20 ARNs. The following is the format of
2214
- * a trail ARN.</p>
2215
- * <p>
2216
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
2217
- * </p>
2218
- */
2219
- ResourceIdList: string[] | undefined;
2220
-
2221
- /**
2222
- * <p>Reserved for future use.</p>
2223
- */
2224
- NextToken?: string;
2225
- }
2226
-
2227
- export namespace ListTagsRequest {
2228
- /**
2229
- * @internal
2230
- */
2231
- export const filterSensitiveLog = (obj: ListTagsRequest): any => ({
2232
- ...obj,
2233
- });
2234
- }
2235
-
2236
- /**
2237
- * <p>A resource tag.</p>
2238
- */
2239
- export interface ResourceTag {
2240
- /**
2241
- * <p>Specifies the ARN of the resource.</p>
2242
- */
2243
- ResourceId?: string;
2244
-
2245
- /**
2246
- * <p>A list of tags.</p>
2247
- */
2248
- TagsList?: Tag[];
2249
- }
2250
-
2251
- export namespace ResourceTag {
2252
- /**
2253
- * @internal
2254
- */
2255
- export const filterSensitiveLog = (obj: ResourceTag): any => ({
2256
- ...obj,
2257
- });
2258
- }
2259
-
2260
- /**
2261
- * <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>
2262
- */
2263
- export interface ListTagsResponse {
2264
- /**
2265
- * <p>A list of resource tags.</p>
2266
- */
2267
- ResourceTagList?: ResourceTag[];
2268
-
2269
- /**
2270
- * <p>Reserved for future use.</p>
2271
- */
2272
- NextToken?: string;
2273
- }
2274
-
2275
- export namespace ListTagsResponse {
2276
- /**
2277
- * @internal
2278
- */
2279
- export const filterSensitiveLog = (obj: ListTagsResponse): any => ({
2280
- ...obj,
2281
- });
2282
- }
2283
-
2284
- export interface ListTrailsRequest {
2285
- /**
2286
- * <p>The token to use to get the next page of results after a previous API call. This token must be passed
2287
- * in with the same parameters that were specified in the the original call. For example, if the original
2288
- * call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should
2289
- * include those same parameters.</p>
2290
- */
2291
- NextToken?: string;
2292
- }
2293
-
2294
- export namespace ListTrailsRequest {
2295
- /**
2296
- * @internal
2297
- */
2298
- export const filterSensitiveLog = (obj: ListTrailsRequest): any => ({
2299
- ...obj,
2300
- });
2301
- }
2302
-
2303
- /**
2304
- * <p>Information about a CloudTrail trail, including the trail's name, home region, and Amazon Resource Name (ARN).</p>
2305
- */
2306
- export interface TrailInfo {
2307
- /**
2308
- * <p>The ARN of a trail.</p>
2309
- */
2310
- TrailARN?: string;
2311
-
2312
- /**
2313
- * <p>The name of a trail.</p>
2314
- */
2315
- Name?: string;
2316
-
2317
- /**
2318
- * <p>The Amazon Web Services Region in which a trail was created.</p>
2319
- */
2320
- HomeRegion?: string;
2321
- }
2322
-
2323
- export namespace TrailInfo {
2324
- /**
2325
- * @internal
2326
- */
2327
- export const filterSensitiveLog = (obj: TrailInfo): any => ({
2328
- ...obj,
2329
- });
2330
- }
2331
-
2332
- export interface ListTrailsResponse {
2333
- /**
2334
- * <p>Returns the name, ARN, and home region of trails in the current account.</p>
2335
- */
2336
- Trails?: TrailInfo[];
2337
-
2338
- /**
2339
- * <p>The token to use to get the next page of results after a previous API call. If the token does not appear,
2340
- * there are no more results to return. The token must be passed in with the same parameters as the previous call.
2341
- * For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with
2342
- * NextToken should include those same parameters.</p>
2343
- */
2344
- NextToken?: string;
2345
- }
2346
-
2347
- export namespace ListTrailsResponse {
2348
- /**
2349
- * @internal
2350
- */
2351
- export const filterSensitiveLog = (obj: ListTrailsResponse): any => ({
2352
- ...obj,
2353
- });
2354
- }
2355
-
2356
- /**
2357
- * <p>Occurs if an event category that is not valid is specified as a value of <code>EventCategory</code>.</p>
2358
- */
2359
- export interface InvalidEventCategoryException extends __SmithyException, $MetadataBearer {
2360
- name: "InvalidEventCategoryException";
2361
- $fault: "client";
2362
- /**
2363
- * <p>Brief description of the exception returned by the request.</p>
2364
- */
2365
- Message?: string;
2366
- }
2367
-
2368
- export namespace InvalidEventCategoryException {
2369
- /**
2370
- * @internal
2371
- */
2372
- export const filterSensitiveLog = (obj: InvalidEventCategoryException): any => ({
2373
- ...obj,
2374
- });
2375
- }
2376
-
2377
- /**
2378
- * <p>Occurs when a lookup attribute is specified that is not valid.</p>
2379
- */
2380
- export interface InvalidLookupAttributesException extends __SmithyException, $MetadataBearer {
2381
- name: "InvalidLookupAttributesException";
2382
- $fault: "client";
2383
- /**
2384
- * <p>Brief description of the exception returned by the request.</p>
2385
- */
2386
- Message?: string;
2387
- }
2388
-
2389
- export namespace InvalidLookupAttributesException {
2390
- /**
2391
- * @internal
2392
- */
2393
- export const filterSensitiveLog = (obj: InvalidLookupAttributesException): any => ({
2394
- ...obj,
2395
- });
2396
- }
2397
-
2398
- /**
2399
- * <p>This exception is thrown if the limit specified is not valid.</p>
2400
- */
2401
- export interface InvalidMaxResultsException extends __SmithyException, $MetadataBearer {
2402
- name: "InvalidMaxResultsException";
2403
- $fault: "client";
2404
- /**
2405
- * <p>Brief description of the exception returned by the request.</p>
2406
- */
2407
- Message?: string;
2408
- }
2409
-
2410
- export namespace InvalidMaxResultsException {
2411
- /**
2412
- * @internal
2413
- */
2414
- export const filterSensitiveLog = (obj: InvalidMaxResultsException): any => ({
2415
- ...obj,
2416
- });
2417
- }
2418
-
2419
- /**
2420
- * <p>A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.</p>
2421
- */
2422
- export interface InvalidNextTokenException extends __SmithyException, $MetadataBearer {
2423
- name: "InvalidNextTokenException";
2424
- $fault: "client";
2425
- /**
2426
- * <p>Brief description of the exception returned by the request.</p>
2427
- */
2428
- Message?: string;
2429
- }
2430
-
2431
- export namespace InvalidNextTokenException {
2432
- /**
2433
- * @internal
2434
- */
2435
- export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({
2436
- ...obj,
2437
- });
2438
- }
2439
-
2440
- export enum EventCategory {
2441
- Insight = "insight",
2442
- }
2443
-
2444
- export enum LookupAttributeKey {
2445
- ACCESS_KEY_ID = "AccessKeyId",
2446
- EVENT_ID = "EventId",
2447
- EVENT_NAME = "EventName",
2448
- EVENT_SOURCE = "EventSource",
2449
- READ_ONLY = "ReadOnly",
2450
- RESOURCE_NAME = "ResourceName",
2451
- RESOURCE_TYPE = "ResourceType",
2452
- USERNAME = "Username",
2453
- }
2454
-
2455
- /**
2456
- * <p>Specifies an attribute and value that filter the events returned.</p>
2457
- */
2458
- export interface LookupAttribute {
2459
- /**
2460
- * <p>Specifies an attribute on which to filter the events returned.</p>
2461
- */
2462
- AttributeKey: LookupAttributeKey | string | undefined;
2463
-
2464
- /**
2465
- * <p>Specifies a value for the specified AttributeKey.</p>
2466
- */
2467
- AttributeValue: string | undefined;
2468
- }
2469
-
2470
- export namespace LookupAttribute {
2471
- /**
2472
- * @internal
2473
- */
2474
- export const filterSensitiveLog = (obj: LookupAttribute): any => ({
2475
- ...obj,
2476
- });
2477
- }
2478
-
2479
- /**
2480
- * <p>Contains a request for LookupEvents.</p>
2481
- */
2482
- export interface LookupEventsRequest {
2483
- /**
2484
- * <p>Contains a list of lookup attributes. Currently the list can contain only one item.</p>
2485
- */
2486
- LookupAttributes?: LookupAttribute[];
2487
-
2488
- /**
2489
- * <p>Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.</p>
2490
- */
2491
- StartTime?: Date;
2492
-
2493
- /**
2494
- * <p>Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.</p>
2495
- */
2496
- EndTime?: Date;
2497
-
2498
- /**
2499
- * <p>Specifies the event category. If you do not specify an event category, events of the category are not returned in the response. For example,
2500
- * if you do not specify <code>insight</code> as the value of <code>EventCategory</code>, no Insights events are returned.</p>
2501
- */
2502
- EventCategory?: EventCategory | string;
2503
-
2504
- /**
2505
- * <p>The number of events to return. Possible values are 1 through 50. The default is 50.</p>
2506
- */
2507
- MaxResults?: number;
2508
-
2509
- /**
2510
- * <p>The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call.
2511
- * For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.</p>
2512
- */
2513
- NextToken?: string;
2514
- }
2515
-
2516
- export namespace LookupEventsRequest {
2517
- /**
2518
- * @internal
2519
- */
2520
- export const filterSensitiveLog = (obj: LookupEventsRequest): any => ({
2521
- ...obj,
2522
- });
2523
- }
2524
-
2525
- /**
2526
- * <p>Specifies the type and name of a resource referenced by an event.</p>
2527
- */
2528
- export interface Resource {
2529
- /**
2530
- * <p>The type of a resource referenced by the event returned. When the resource type cannot be
2531
- * determined, null is returned. Some examples of resource types are: <b>Instance</b> for EC2,
2532
- * <b>Trail</b> for CloudTrail, <b>DBInstance</b> for Amazon RDS, and <b>AccessKey</b> for IAM.
2533
- * To learn more about how to look up and filter events by the resource types supported for a service, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events-console.html#filtering-cloudtrail-events">Filtering CloudTrail Events</a>.</p>
2534
- */
2535
- ResourceType?: string;
2536
-
2537
- /**
2538
- * <p>The name of the resource referenced by the event returned. These are user-created names whose values will depend on the environment. For example, the resource name might be "auto-scaling-test-group" for an Auto Scaling Group or "i-1234567" for an EC2 Instance.</p>
2539
- */
2540
- ResourceName?: string;
2541
- }
2542
-
2543
- export namespace Resource {
2544
- /**
2545
- * @internal
2546
- */
2547
- export const filterSensitiveLog = (obj: Resource): any => ({
2548
- ...obj,
2549
- });
2550
- }
2551
-
2552
- /**
2553
- * <p>Contains information about an event that was returned by a lookup request. The result includes a representation of a CloudTrail event.</p>
2554
- */
2555
- export interface Event {
2556
- /**
2557
- * <p>The CloudTrail ID of the event returned.</p>
2558
- */
2559
- EventId?: string;
2560
-
2561
- /**
2562
- * <p>The name of the event returned.</p>
2563
- */
2564
- EventName?: string;
2565
-
2566
- /**
2567
- * <p>Information about whether the event is a write event or a read event. </p>
2568
- */
2569
- ReadOnly?: string;
2570
-
2571
- /**
2572
- * <p>The Amazon Web Services access key ID that was used to sign the request. If the request was made
2573
- * with temporary security credentials, this is the access key ID of the temporary credentials.</p>
2574
- */
2575
- AccessKeyId?: string;
2576
-
2577
- /**
2578
- * <p>The date and time of the event returned.</p>
2579
- */
2580
- EventTime?: Date;
2581
-
2582
- /**
2583
- * <p>The Amazon Web Services service to which the request was made.</p>
2584
- */
2585
- EventSource?: string;
2586
-
2587
- /**
2588
- * <p>A user name or role name of the requester that called the API in the event returned.</p>
2589
- */
2590
- Username?: string;
2591
-
2592
- /**
2593
- * <p>A list of resources referenced by the event returned.</p>
2594
- */
2595
- Resources?: Resource[];
2596
-
2597
- /**
2598
- * <p>A JSON string that contains a representation of the event returned.</p>
2599
- */
2600
- CloudTrailEvent?: string;
2601
- }
2602
-
2603
- export namespace Event {
2604
- /**
2605
- * @internal
2606
- */
2607
- export const filterSensitiveLog = (obj: Event): any => ({
2608
- ...obj,
2609
- });
2610
- }
2611
-
2612
- /**
2613
- * <p>Contains a response to a LookupEvents action.</p>
2614
- */
2615
- export interface LookupEventsResponse {
2616
- /**
2617
- * <p>A list of events returned based on the lookup attributes specified and the CloudTrail event. The events list is sorted by time. The most recent event is listed first.</p>
2618
- */
2619
- Events?: Event[];
2620
-
2621
- /**
2622
- * <p>The token to use to get the next page of results after a previous API call. If the token does not appear,
2623
- * there are no more results to return. The token must be passed in with the same parameters as the previous call.
2624
- * For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with
2625
- * NextToken should include those same parameters.</p>
2626
- */
2627
- NextToken?: string;
2628
- }
2629
-
2630
- export namespace LookupEventsResponse {
2631
- /**
2632
- * @internal
2633
- */
2634
- export const filterSensitiveLog = (obj: LookupEventsResponse): any => ({
2635
- ...obj,
2636
- });
2637
- }
2638
-
2639
- /**
2640
- * <p>This exception is thrown when the <code>PutEventSelectors</code> operation is called with a number of event
2641
- * selectors, advanced event selectors, or data resources that is not valid. The combination of event selectors or advanced event selectors and
2642
- * data resources is not valid. A trail can have up to 5 event selectors. If a trail uses advanced event selectors, a maximum
2643
- * of 500 total values for all conditions in all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources can be distributed across event selectors, but the overall total cannot exceed 250.</p>
2644
- * <p>You can:</p>
2645
- * <ul>
2646
- * <li>
2647
- * <p>Specify a valid number of event selectors (1 to 5) for a trail.</p>
2648
- * </li>
2649
- * <li>
2650
- * <p>Specify a valid number of data resources (1 to 250) for an event selector.
2651
- * The limit of number of resources on an individual event selector is configurable up to 250.
2652
- * However, this upper limit is allowed only if the total number of data resources does not
2653
- * exceed 250 across all event selectors for a trail.</p>
2654
- * </li>
2655
- * <li>
2656
- * <p>Specify up to 500 values for all conditions in all advanced event selectors for a trail.</p>
2657
- * </li>
2658
- * <li>
2659
- * <p>Specify a valid value for a parameter. For example, specifying the <code>ReadWriteType</code>
2660
- * parameter with a value of <code>read-only</code> is not valid.</p>
2661
- * </li>
2662
- * </ul>
2663
- */
2664
- export interface InvalidEventSelectorsException extends __SmithyException, $MetadataBearer {
2665
- name: "InvalidEventSelectorsException";
2666
- $fault: "client";
2667
- /**
2668
- * <p>Brief description of the exception returned by the request.</p>
2669
- */
2670
- Message?: string;
2671
- }
2672
-
2673
- export namespace InvalidEventSelectorsException {
2674
- /**
2675
- * @internal
2676
- */
2677
- export const filterSensitiveLog = (obj: InvalidEventSelectorsException): any => ({
2678
- ...obj,
2679
- });
2680
- }
2681
-
2682
- export interface PutEventSelectorsRequest {
2683
- /**
2684
- * <p>Specifies the name of the trail or trail ARN. If you specify a trail name, the
2685
- * string must meet the following requirements:</p>
2686
- * <ul>
2687
- * <li>
2688
- * <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</p>
2689
- * </li>
2690
- * <li>
2691
- * <p>Start with a letter or number, and end with a letter or number</p>
2692
- * </li>
2693
- * <li>
2694
- * <p>Be between 3 and 128 characters</p>
2695
- * </li>
2696
- * <li>
2697
- * <p>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code>
2698
- * and <code>my--namespace</code> are not valid.</p>
2699
- * </li>
2700
- * <li>
2701
- * <p>Not be in IP address format (for example, 192.168.5.4)</p>
2702
- * </li>
2703
- * </ul>
2704
- * <p>If you specify a trail ARN, it must be in the following format.</p>
2705
- * <p>
2706
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
2707
- * </p>
2708
- */
2709
- TrailName: string | undefined;
2710
-
2711
- /**
2712
- * <p>Specifies the settings for your event selectors. You can configure up to five event selectors for a trail.
2713
- * You can use either <code>EventSelectors</code> or <code>AdvancedEventSelectors</code> in a <code>PutEventSelectors</code> request, but not both.
2714
- * If you apply <code>EventSelectors</code> to a trail, any existing <code>AdvancedEventSelectors</code> are overwritten.</p>
2715
- */
2716
- EventSelectors?: EventSelector[];
2717
-
2718
- /**
2719
- * <p>
2720
- * Specifies the settings for advanced event selectors. You can add advanced event selectors, and conditions for your advanced
2721
- * event selectors, up to a maximum of 500 values for all conditions and selectors on a trail.
2722
- * You can use either <code>AdvancedEventSelectors</code> or <code>EventSelectors</code>, but not both. If you apply <code>AdvancedEventSelectors</code>
2723
- * to a trail, any existing <code>EventSelectors</code> are overwritten. For more information about
2724
- * advanced event selectors, see
2725
- * <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html">Logging
2726
- * data events for trails</a> in the <i>CloudTrail User Guide</i>.
2727
- * </p>
2728
- */
2729
- AdvancedEventSelectors?: AdvancedEventSelector[];
2730
- }
2731
-
2732
- export namespace PutEventSelectorsRequest {
2733
- /**
2734
- * @internal
2735
- */
2736
- export const filterSensitiveLog = (obj: PutEventSelectorsRequest): any => ({
2737
- ...obj,
2738
- });
2739
- }
2740
-
2741
- export interface PutEventSelectorsResponse {
2742
- /**
2743
- * <p>Specifies the ARN of the trail that was updated with event selectors. The following is the format of a trail ARN.</p>
2744
- * <p>
2745
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
2746
- * </p>
2747
- */
2748
- TrailARN?: string;
2749
-
2750
- /**
2751
- * <p>Specifies the event selectors configured for your trail.</p>
2752
- */
2753
- EventSelectors?: EventSelector[];
2754
-
2755
- /**
2756
- * <p>Specifies the advanced event selectors configured for your trail.</p>
2757
- */
2758
- AdvancedEventSelectors?: AdvancedEventSelector[];
2759
- }
2760
-
2761
- export namespace PutEventSelectorsResponse {
2762
- /**
2763
- * @internal
2764
- */
2765
- export const filterSensitiveLog = (obj: PutEventSelectorsResponse): any => ({
2766
- ...obj,
2767
- });
2768
- }
2769
-
2770
- /**
2771
- * <p>The formatting or syntax of the <code>InsightSelectors</code> JSON statement in your <code>PutInsightSelectors</code> or <code>GetInsightSelectors</code> request
2772
- * is not valid, or the specified insight type in the <code>InsightSelectors</code> statement is not a valid insight type.</p>
2773
- */
2774
- export interface InvalidInsightSelectorsException extends __SmithyException, $MetadataBearer {
2775
- name: "InvalidInsightSelectorsException";
2776
- $fault: "client";
2777
- /**
2778
- * <p>Brief description of the exception returned by the request.</p>
2779
- */
2780
- Message?: string;
2781
- }
2782
-
2783
- export namespace InvalidInsightSelectorsException {
2784
- /**
2785
- * @internal
2786
- */
2787
- export const filterSensitiveLog = (obj: InvalidInsightSelectorsException): any => ({
2788
- ...obj,
2789
- });
2790
- }
2791
-
2792
- export interface PutInsightSelectorsRequest {
2793
- /**
2794
- * <p>The name of the CloudTrail trail for which you want to change or add Insights selectors.</p>
2795
- */
2796
- TrailName: string | undefined;
2797
-
2798
- /**
2799
- * <p>A JSON string that contains the Insights types that you want to log on a trail. The valid Insights type in this release is <code>ApiCallRateInsight</code>.</p>
2800
- */
2801
- InsightSelectors: InsightSelector[] | undefined;
2802
- }
2803
-
2804
- export namespace PutInsightSelectorsRequest {
2805
- /**
2806
- * @internal
2807
- */
2808
- export const filterSensitiveLog = (obj: PutInsightSelectorsRequest): any => ({
2809
- ...obj,
2810
- });
2811
- }
2812
-
2813
- export interface PutInsightSelectorsResponse {
2814
- /**
2815
- * <p>The Amazon Resource Name (ARN) of a trail for which you want to change or add Insights selectors.</p>
2816
- */
2817
- TrailARN?: string;
2818
-
2819
- /**
2820
- * <p>A JSON string that contains the Insights event types that you want to log on a trail. The valid Insights type in this release is <code>ApiCallRateInsight</code>.</p>
2821
- */
2822
- InsightSelectors?: InsightSelector[];
2823
- }
2824
-
2825
- export namespace PutInsightSelectorsResponse {
2826
- /**
2827
- * @internal
2828
- */
2829
- export const filterSensitiveLog = (obj: PutInsightSelectorsResponse): any => ({
2830
- ...obj,
2831
- });
2832
- }
2833
-
2834
- /**
2835
- * <p>Specifies the tags to remove from a trail.</p>
2836
- */
2837
- export interface RemoveTagsRequest {
2838
- /**
2839
- * <p>Specifies the ARN of the trail from which tags should be removed. The format of a trail ARN is:</p>
2840
- * <p>
2841
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
2842
- * </p>
2843
- */
2844
- ResourceId: string | undefined;
2845
-
2846
- /**
2847
- * <p>Specifies a list of tags to be removed.</p>
2848
- */
2849
- TagsList?: Tag[];
2850
- }
2851
-
2852
- export namespace RemoveTagsRequest {
2853
- /**
2854
- * @internal
2855
- */
2856
- export const filterSensitiveLog = (obj: RemoveTagsRequest): any => ({
2857
- ...obj,
2858
- });
2859
- }
2860
-
2861
- /**
2862
- * <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>
2863
- */
2864
- export interface RemoveTagsResponse {}
2865
-
2866
- export namespace RemoveTagsResponse {
2867
- /**
2868
- * @internal
2869
- */
2870
- export const filterSensitiveLog = (obj: RemoveTagsResponse): any => ({
2871
- ...obj,
2872
- });
2873
- }
2874
-
2875
- /**
2876
- * <p>The request to CloudTrail to start logging Amazon Web Services API calls for an account.</p>
2877
- */
2878
- export interface StartLoggingRequest {
2879
- /**
2880
- * <p>Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs Amazon Web Services API calls.
2881
- * The following is the format of a trail ARN.</p>
2882
- * <p>
2883
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
2884
- * </p>
2885
- */
2886
- Name: string | undefined;
2887
- }
2888
-
2889
- export namespace StartLoggingRequest {
2890
- /**
2891
- * @internal
2892
- */
2893
- export const filterSensitiveLog = (obj: StartLoggingRequest): any => ({
2894
- ...obj,
2895
- });
2896
- }
2897
-
2898
- /**
2899
- * <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>
2900
- */
2901
- export interface StartLoggingResponse {}
2902
-
2903
- export namespace StartLoggingResponse {
2904
- /**
2905
- * @internal
2906
- */
2907
- export const filterSensitiveLog = (obj: StartLoggingResponse): any => ({
2908
- ...obj,
2909
- });
2910
- }
2911
-
2912
- /**
2913
- * <p>Passes the request to CloudTrail to stop logging Amazon Web Services API calls for the specified account.</p>
2914
- */
2915
- export interface StopLoggingRequest {
2916
- /**
2917
- * <p>Specifies the name or the CloudTrail ARN of the trail for which CloudTrail will stop logging Amazon Web Services
2918
- * API calls. The following is the format of a trail ARN.</p>
2919
- * <p>
2920
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
2921
- * </p>
2922
- */
2923
- Name: string | undefined;
2924
- }
2925
-
2926
- export namespace StopLoggingRequest {
2927
- /**
2928
- * @internal
2929
- */
2930
- export const filterSensitiveLog = (obj: StopLoggingRequest): any => ({
2931
- ...obj,
2932
- });
2933
- }
2934
-
2935
- /**
2936
- * <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>
2937
- */
2938
- export interface StopLoggingResponse {}
2939
-
2940
- export namespace StopLoggingResponse {
2941
- /**
2942
- * @internal
2943
- */
2944
- export const filterSensitiveLog = (obj: StopLoggingResponse): any => ({
2945
- ...obj,
2946
- });
2947
- }
2948
-
2949
- /**
2950
- * <p>Specifies settings to update for the trail.</p>
2951
- */
2952
- export interface UpdateTrailRequest {
2953
- /**
2954
- * <p>Specifies the name of the trail or trail ARN. If <code>Name</code> is a trail name, the
2955
- * string must meet the following requirements:</p>
2956
- * <ul>
2957
- * <li>
2958
- * <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</p>
2959
- * </li>
2960
- * <li>
2961
- * <p>Start with a letter or number, and end with a letter or number</p>
2962
- * </li>
2963
- * <li>
2964
- * <p>Be between 3 and 128 characters</p>
2965
- * </li>
2966
- * <li>
2967
- * <p>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code>
2968
- * and <code>my--namespace</code> are not valid.</p>
2969
- * </li>
2970
- * <li>
2971
- * <p>Not be in IP address format (for example, 192.168.5.4)</p>
2972
- * </li>
2973
- * </ul>
2974
- * <p>If <code>Name</code> is a trail ARN, it must be in the following format.</p>
2975
- * <p>
2976
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
2977
- * </p>
2978
- */
2979
- Name: string | undefined;
2980
-
2981
- /**
2982
- * <p>Specifies the name of the Amazon S3 bucket designated for publishing log files. See <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html">Amazon S3 Bucket Naming Requirements</a>.</p>
2983
- */
2984
- S3BucketName?: string;
2985
-
2986
- /**
2987
- * <p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated
2988
- * for log file delivery. For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html">Finding Your CloudTrail Log Files</a>. The maximum length is 200 characters.</p>
2989
- */
2990
- S3KeyPrefix?: string;
2991
-
2992
- /**
2993
- * <p>Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.</p>
2994
- */
2995
- SnsTopicName?: string;
2996
-
2997
- /**
2998
- * <p>Specifies whether the trail is publishing events from global services such as IAM to the log files.</p>
2999
- */
3000
- IncludeGlobalServiceEvents?: boolean;
3001
-
3002
- /**
3003
- * <p>Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true,
3004
- * shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region
3005
- * where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider
3006
- * using trails that log events in all regions.</p>
3007
- */
3008
- IsMultiRegionTrail?: boolean;
3009
-
3010
- /**
3011
- * <p>Specifies whether log file validation is enabled. The default is false.</p>
3012
- * <note>
3013
- * <p>When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail
3014
- * does not create digest files for log files that were delivered during a period in which log file integrity validation
3015
- * was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on
3016
- * January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon
3017
- * on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.</p>
3018
- * </note>
3019
- */
3020
- EnableLogFileValidation?: boolean;
3021
-
3022
- /**
3023
- * <p>Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs are delivered. Not required unless you specify <code>CloudWatchLogsRoleArn</code>.</p>
3024
- */
3025
- CloudWatchLogsLogGroupArn?: string;
3026
-
3027
- /**
3028
- * <p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.</p>
3029
- */
3030
- CloudWatchLogsRoleArn?: string;
3031
-
3032
- /**
3033
- * <p>Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The
3034
- * value can be an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully
3035
- * specified ARN to a key, or a globally unique identifier.</p>
3036
- * <p>CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys,
3037
- * see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
3038
- * <p>Examples:</p>
3039
- * <ul>
3040
- * <li>
3041
- * <p>alias/MyAliasName</p>
3042
- * </li>
3043
- * <li>
3044
- * <p>arn:aws:kms:us-east-2:123456789012:alias/MyAliasName</p>
3045
- * </li>
3046
- * <li>
3047
- * <p>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</p>
3048
- * </li>
3049
- * <li>
3050
- * <p>12345678-1234-1234-1234-123456789012</p>
3051
- * </li>
3052
- * </ul>
3053
- */
3054
- KmsKeyId?: string;
3055
-
3056
- /**
3057
- * <p>Specifies whether the trail is applied to all accounts in an organization in Organizations, or only for the current Amazon Web Services account.
3058
- * The default is false, and cannot be true unless the call is made on behalf of an Amazon Web Services account that is the management account for an organization in
3059
- * Organizations. If the trail is not an organization trail and this is set to <code>true</code>, the trail will be created in all Amazon Web Services accounts that belong
3060
- * to the organization. If the trail is an organization trail and this is set to <code>false</code>, the trail will remain in the current Amazon Web Services account but be
3061
- * deleted from all member accounts in the organization.</p>
3062
- */
3063
- IsOrganizationTrail?: boolean;
3064
- }
3065
-
3066
- export namespace UpdateTrailRequest {
3067
- /**
3068
- * @internal
3069
- */
3070
- export const filterSensitiveLog = (obj: UpdateTrailRequest): any => ({
3071
- ...obj,
3072
- });
3073
- }
3074
-
3075
- /**
3076
- * <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>
3077
- */
3078
- export interface UpdateTrailResponse {
3079
- /**
3080
- * <p>Specifies the name of the trail.</p>
3081
- */
3082
- Name?: string;
3083
-
3084
- /**
3085
- * <p>Specifies the name of the Amazon S3 bucket designated for publishing log files.</p>
3086
- */
3087
- S3BucketName?: string;
3088
-
3089
- /**
3090
- * <p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated
3091
- * for log file delivery.
3092
- * For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html">Finding Your IAM Log Files</a>.</p>
3093
- */
3094
- S3KeyPrefix?: string;
3095
-
3096
- /**
3097
- * @deprecated
3098
- *
3099
- * <p>This field is no longer in use. Use <a>UpdateTrailResponse$SnsTopicARN</a>.</p>
3100
- */
3101
- SnsTopicName?: string;
3102
-
3103
- /**
3104
- * <p>Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications
3105
- * when log files are delivered. The following is the format of a topic ARN.</p>
3106
- * <p>
3107
- * <code>arn:aws:sns:us-east-2:123456789012:MyTopic</code>
3108
- * </p>
3109
- */
3110
- SnsTopicARN?: string;
3111
-
3112
- /**
3113
- * <p>Specifies whether the trail is publishing events from global services such as IAM to the log files.</p>
3114
- */
3115
- IncludeGlobalServiceEvents?: boolean;
3116
-
3117
- /**
3118
- * <p>Specifies whether the trail exists in one region or in all regions.</p>
3119
- */
3120
- IsMultiRegionTrail?: boolean;
3121
-
3122
- /**
3123
- * <p>Specifies the ARN of the trail that was updated. The following is the format of a trail ARN.</p>
3124
- * <p>
3125
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
3126
- * </p>
3127
- */
3128
- TrailARN?: string;
3129
-
3130
- /**
3131
- * <p>Specifies whether log file integrity validation is enabled.</p>
3132
- */
3133
- LogFileValidationEnabled?: boolean;
3134
-
3135
- /**
3136
- * <p>Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs are delivered.</p>
3137
- */
3138
- CloudWatchLogsLogGroupArn?: string;
3139
-
3140
- /**
3141
- * <p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.</p>
3142
- */
3143
- CloudWatchLogsRoleArn?: string;
3144
-
3145
- /**
3146
- * <p>Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.</p>
3147
- *
3148
- * <p>
3149
- * <code>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</code>
3150
- * </p>
3151
- */
3152
- KmsKeyId?: string;
3153
-
3154
- /**
3155
- * <p>Specifies whether the trail is an organization trail.</p>
3156
- */
3157
- IsOrganizationTrail?: boolean;
3158
- }
3159
-
3160
- export namespace UpdateTrailResponse {
3161
- /**
3162
- * @internal
3163
- */
3164
- export const filterSensitiveLog = (obj: UpdateTrailResponse): any => ({
3165
- ...obj,
3166
- });
3167
- }