@aws-sdk/client-cloudtrail 3.312.0 → 3.316.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -44,568 +44,290 @@ import { StopLoggingCommandInput, StopLoggingCommandOutput } from "./commands/St
44
44
  import { UpdateChannelCommandInput, UpdateChannelCommandOutput } from "./commands/UpdateChannelCommand";
45
45
  import { UpdateEventDataStoreCommandInput, UpdateEventDataStoreCommandOutput } from "./commands/UpdateEventDataStoreCommand";
46
46
  import { UpdateTrailCommandInput, UpdateTrailCommandOutput } from "./commands/UpdateTrailCommand";
47
- /**
48
- * @public
49
- * <fullname>CloudTrail</fullname>
50
- * <p>This is the CloudTrail API Reference. It provides descriptions of actions, data
51
- * types, common parameters, and common errors for CloudTrail.</p>
52
- * <p>CloudTrail is a web service that records Amazon Web Services API calls for your
53
- * Amazon Web Services account and delivers log files to an Amazon S3 bucket. The
54
- * recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response
55
- * elements returned by the service.</p>
56
- * <note>
57
- * <p>As an alternative to the API, you can use one of the Amazon Web Services SDKs, which
58
- * consist of libraries and sample code for various programming languages and platforms
59
- * (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide programmatic access to CloudTrail. For example, the SDKs handle cryptographically signing requests,
60
- * managing errors, and retrying requests automatically. For more information about the
61
- * Amazon Web Services SDKs, including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools to Build on Amazon Web Services</a>.</p>
62
- * </note>
63
- * <p>See the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-user-guide.html">CloudTrail
64
- * User Guide</a> for information about the data that is included with each Amazon Web Services API call listed in the log files.</p>
65
- */
66
- export declare class CloudTrail extends CloudTrailClient {
47
+ export interface CloudTrail {
67
48
  /**
68
- * @public
69
- * <p>Adds one or more tags to a trail, event data store, or channel, up to a limit of 50. Overwrites an
70
- * existing tag's value when a new value is specified for an existing tag key. Tag key names
71
- * must be unique; you cannot have two keys with the same name but different
72
- * values. If you specify a key without a value, the tag will be created with the specified
73
- * key and a value of null. You can tag a trail or event data store that applies to all
74
- * Amazon Web Services Regions only from the Region in which the trail or event data store
75
- * was created (also known as its home region).</p>
49
+ * @see {@link AddTagsCommand}
76
50
  */
77
51
  addTags(args: AddTagsCommandInput, options?: __HttpHandlerOptions): Promise<AddTagsCommandOutput>;
78
52
  addTags(args: AddTagsCommandInput, cb: (err: any, data?: AddTagsCommandOutput) => void): void;
79
53
  addTags(args: AddTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsCommandOutput) => void): void;
80
54
  /**
81
- * @public
82
- * <p>Cancels a query if the query is not in a terminated state, such as
83
- * <code>CANCELLED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or
84
- * <code>FINISHED</code>. You must specify an ARN value for <code>EventDataStore</code>.
85
- * The ID of the query that you want to cancel is also required. When you run
86
- * <code>CancelQuery</code>, the query status might show as <code>CANCELLED</code> even if
87
- * the operation is not yet finished.</p>
55
+ * @see {@link CancelQueryCommand}
88
56
  */
89
57
  cancelQuery(args: CancelQueryCommandInput, options?: __HttpHandlerOptions): Promise<CancelQueryCommandOutput>;
90
58
  cancelQuery(args: CancelQueryCommandInput, cb: (err: any, data?: CancelQueryCommandOutput) => void): void;
91
59
  cancelQuery(args: CancelQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelQueryCommandOutput) => void): void;
92
60
  /**
93
- * @public
94
- * <p>Creates a channel for CloudTrail to ingest events from a partner or external source.
95
- * After you create a channel, a CloudTrail Lake event data store can log events
96
- * from the partner or source that you specify.</p>
61
+ * @see {@link CreateChannelCommand}
97
62
  */
98
63
  createChannel(args: CreateChannelCommandInput, options?: __HttpHandlerOptions): Promise<CreateChannelCommandOutput>;
99
64
  createChannel(args: CreateChannelCommandInput, cb: (err: any, data?: CreateChannelCommandOutput) => void): void;
100
65
  createChannel(args: CreateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelCommandOutput) => void): void;
101
66
  /**
102
- * @public
103
- * <p>Creates a new event data store.</p>
67
+ * @see {@link CreateEventDataStoreCommand}
104
68
  */
105
69
  createEventDataStore(args: CreateEventDataStoreCommandInput, options?: __HttpHandlerOptions): Promise<CreateEventDataStoreCommandOutput>;
106
70
  createEventDataStore(args: CreateEventDataStoreCommandInput, cb: (err: any, data?: CreateEventDataStoreCommandOutput) => void): void;
107
71
  createEventDataStore(args: CreateEventDataStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEventDataStoreCommandOutput) => void): void;
108
72
  /**
109
- * @public
110
- * <p>Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
111
- * </p>
73
+ * @see {@link CreateTrailCommand}
112
74
  */
113
75
  createTrail(args: CreateTrailCommandInput, options?: __HttpHandlerOptions): Promise<CreateTrailCommandOutput>;
114
76
  createTrail(args: CreateTrailCommandInput, cb: (err: any, data?: CreateTrailCommandOutput) => void): void;
115
77
  createTrail(args: CreateTrailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTrailCommandOutput) => void): void;
116
78
  /**
117
- * @public
118
- * <p>Deletes a channel.</p>
79
+ * @see {@link DeleteChannelCommand}
119
80
  */
120
81
  deleteChannel(args: DeleteChannelCommandInput, options?: __HttpHandlerOptions): Promise<DeleteChannelCommandOutput>;
121
82
  deleteChannel(args: DeleteChannelCommandInput, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void;
122
83
  deleteChannel(args: DeleteChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void;
123
84
  /**
124
- * @public
125
- * <p>Disables the event data store specified by <code>EventDataStore</code>, which accepts an
126
- * event data store ARN. After you run <code>DeleteEventDataStore</code>, the event data store
127
- * enters a <code>PENDING_DELETION</code> state, and is automatically deleted after a wait
128
- * period of seven days. <code>TerminationProtectionEnabled</code> must be set to
129
- * <code>False</code> on the event data store; this operation cannot work if
130
- * <code>TerminationProtectionEnabled</code> is <code>True</code>.</p>
131
- * <p>After you run <code>DeleteEventDataStore</code> on an event data store, you cannot run
132
- * <code>ListQueries</code>, <code>DescribeQuery</code>, or <code>GetQueryResults</code> on
133
- * queries that are using an event data store in a <code>PENDING_DELETION</code> state. An
134
- * event data store in the <code>PENDING_DELETION</code> state does not incur costs.</p>
85
+ * @see {@link DeleteEventDataStoreCommand}
135
86
  */
136
87
  deleteEventDataStore(args: DeleteEventDataStoreCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEventDataStoreCommandOutput>;
137
88
  deleteEventDataStore(args: DeleteEventDataStoreCommandInput, cb: (err: any, data?: DeleteEventDataStoreCommandOutput) => void): void;
138
89
  deleteEventDataStore(args: DeleteEventDataStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventDataStoreCommandOutput) => void): void;
139
90
  /**
140
- * @public
141
- * <p>
142
- * Deletes the resource-based policy attached to the CloudTrail channel.
143
- * </p>
91
+ * @see {@link DeleteResourcePolicyCommand}
144
92
  */
145
93
  deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteResourcePolicyCommandOutput>;
146
94
  deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void): void;
147
95
  deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void): void;
148
96
  /**
149
- * @public
150
- * <p>Deletes a trail. This operation must be called from the region in which the trail was
151
- * created. <code>DeleteTrail</code> cannot be called on the shadow trails (replicated trails
152
- * in other regions) of a trail that is enabled in all regions.</p>
97
+ * @see {@link DeleteTrailCommand}
153
98
  */
154
99
  deleteTrail(args: DeleteTrailCommandInput, options?: __HttpHandlerOptions): Promise<DeleteTrailCommandOutput>;
155
100
  deleteTrail(args: DeleteTrailCommandInput, cb: (err: any, data?: DeleteTrailCommandOutput) => void): void;
156
101
  deleteTrail(args: DeleteTrailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTrailCommandOutput) => void): void;
157
102
  /**
158
- * @public
159
- * <p>Removes CloudTrail delegated administrator permissions from a member account in
160
- * an organization.</p>
103
+ * @see {@link DeregisterOrganizationDelegatedAdminCommand}
161
104
  */
162
105
  deregisterOrganizationDelegatedAdmin(args: DeregisterOrganizationDelegatedAdminCommandInput, options?: __HttpHandlerOptions): Promise<DeregisterOrganizationDelegatedAdminCommandOutput>;
163
106
  deregisterOrganizationDelegatedAdmin(args: DeregisterOrganizationDelegatedAdminCommandInput, cb: (err: any, data?: DeregisterOrganizationDelegatedAdminCommandOutput) => void): void;
164
107
  deregisterOrganizationDelegatedAdmin(args: DeregisterOrganizationDelegatedAdminCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterOrganizationDelegatedAdminCommandOutput) => void): void;
165
108
  /**
166
- * @public
167
- * <p>Returns metadata about a query, including query run time in milliseconds, number of
168
- * events scanned and matched, and query status. You must specify an ARN for
169
- * <code>EventDataStore</code>, and a value for <code>QueryID</code>.</p>
109
+ * @see {@link DescribeQueryCommand}
170
110
  */
171
111
  describeQuery(args: DescribeQueryCommandInput, options?: __HttpHandlerOptions): Promise<DescribeQueryCommandOutput>;
172
112
  describeQuery(args: DescribeQueryCommandInput, cb: (err: any, data?: DescribeQueryCommandOutput) => void): void;
173
113
  describeQuery(args: DescribeQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeQueryCommandOutput) => void): void;
174
114
  /**
175
- * @public
176
- * <p>Retrieves settings for one or more trails associated with the current region for your
177
- * account.</p>
115
+ * @see {@link DescribeTrailsCommand}
178
116
  */
179
117
  describeTrails(args: DescribeTrailsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTrailsCommandOutput>;
180
118
  describeTrails(args: DescribeTrailsCommandInput, cb: (err: any, data?: DescribeTrailsCommandOutput) => void): void;
181
119
  describeTrails(args: DescribeTrailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTrailsCommandOutput) => void): void;
182
120
  /**
183
- * @public
184
- * <p> Returns information about a specific channel.
185
- * </p>
121
+ * @see {@link GetChannelCommand}
186
122
  */
187
123
  getChannel(args: GetChannelCommandInput, options?: __HttpHandlerOptions): Promise<GetChannelCommandOutput>;
188
124
  getChannel(args: GetChannelCommandInput, cb: (err: any, data?: GetChannelCommandOutput) => void): void;
189
125
  getChannel(args: GetChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelCommandOutput) => void): void;
190
126
  /**
191
- * @public
192
- * <p>Returns information about an event data store specified as either an ARN or the ID
193
- * portion of the ARN.</p>
127
+ * @see {@link GetEventDataStoreCommand}
194
128
  */
195
129
  getEventDataStore(args: GetEventDataStoreCommandInput, options?: __HttpHandlerOptions): Promise<GetEventDataStoreCommandOutput>;
196
130
  getEventDataStore(args: GetEventDataStoreCommandInput, cb: (err: any, data?: GetEventDataStoreCommandOutput) => void): void;
197
131
  getEventDataStore(args: GetEventDataStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEventDataStoreCommandOutput) => void): void;
198
132
  /**
199
- * @public
200
- * <p>Describes the settings for the event selectors that you configured for your trail. The
201
- * information returned for your event selectors includes the following:</p>
202
- * <ul>
203
- * <li>
204
- * <p>If your event selector includes read-only events, write-only events, or all
205
- * events. This applies to both management events and data events.</p>
206
- * </li>
207
- * <li>
208
- * <p>If your event selector includes management events.</p>
209
- * </li>
210
- * <li>
211
- * <p>If your event selector includes data events, the resources on which you are
212
- * logging data events.</p>
213
- * </li>
214
- * </ul>
215
- * <p>For more information about logging management and data events, see the following topics
216
- * in the <i>CloudTrail User Guide</i>:</p>
217
- * <ul>
218
- * <li>
219
- * <p>
220
- * <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html">Logging management events for trails </a>
221
- * </p>
222
- * </li>
223
- * <li>
224
- * <p>
225
- * <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html">Logging data events for trails </a>
226
- * </p>
227
- * </li>
228
- * </ul>
133
+ * @see {@link GetEventSelectorsCommand}
229
134
  */
230
135
  getEventSelectors(args: GetEventSelectorsCommandInput, options?: __HttpHandlerOptions): Promise<GetEventSelectorsCommandOutput>;
231
136
  getEventSelectors(args: GetEventSelectorsCommandInput, cb: (err: any, data?: GetEventSelectorsCommandOutput) => void): void;
232
137
  getEventSelectors(args: GetEventSelectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEventSelectorsCommandOutput) => void): void;
233
138
  /**
234
- * @public
235
- * <p> Returns information about a specific import. </p>
139
+ * @see {@link GetImportCommand}
236
140
  */
237
141
  getImport(args: GetImportCommandInput, options?: __HttpHandlerOptions): Promise<GetImportCommandOutput>;
238
142
  getImport(args: GetImportCommandInput, cb: (err: any, data?: GetImportCommandOutput) => void): void;
239
143
  getImport(args: GetImportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetImportCommandOutput) => void): void;
240
144
  /**
241
- * @public
242
- * <p>Describes the settings for the Insights event selectors that you configured for your
243
- * trail. <code>GetInsightSelectors</code> shows if CloudTrail Insights event logging
244
- * is enabled on the trail, and if it is, which insight types are enabled. If you run
245
- * <code>GetInsightSelectors</code> on a trail that does not have Insights events enabled,
246
- * the operation throws the exception <code>InsightNotEnabledException</code>
247
- * </p>
248
- * <p>For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-insights-events-with-cloudtrail.html">Logging CloudTrail Insights Events for Trails </a> in the <i>CloudTrail User Guide</i>.</p>
145
+ * @see {@link GetInsightSelectorsCommand}
249
146
  */
250
147
  getInsightSelectors(args: GetInsightSelectorsCommandInput, options?: __HttpHandlerOptions): Promise<GetInsightSelectorsCommandOutput>;
251
148
  getInsightSelectors(args: GetInsightSelectorsCommandInput, cb: (err: any, data?: GetInsightSelectorsCommandOutput) => void): void;
252
149
  getInsightSelectors(args: GetInsightSelectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInsightSelectorsCommandOutput) => void): void;
253
150
  /**
254
- * @public
255
- * <p>Gets event data results of a query. You must specify the <code>QueryID</code> value
256
- * returned by the <code>StartQuery</code> operation, and an ARN for
257
- * <code>EventDataStore</code>.</p>
151
+ * @see {@link GetQueryResultsCommand}
258
152
  */
259
153
  getQueryResults(args: GetQueryResultsCommandInput, options?: __HttpHandlerOptions): Promise<GetQueryResultsCommandOutput>;
260
154
  getQueryResults(args: GetQueryResultsCommandInput, cb: (err: any, data?: GetQueryResultsCommandOutput) => void): void;
261
155
  getQueryResults(args: GetQueryResultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueryResultsCommandOutput) => void): void;
262
156
  /**
263
- * @public
264
- * <p>
265
- * Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.
266
- * </p>
157
+ * @see {@link GetResourcePolicyCommand}
267
158
  */
268
159
  getResourcePolicy(args: GetResourcePolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetResourcePolicyCommandOutput>;
269
160
  getResourcePolicy(args: GetResourcePolicyCommandInput, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void): void;
270
161
  getResourcePolicy(args: GetResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void): void;
271
162
  /**
272
- * @public
273
- * <p>Returns settings information for a specified trail.</p>
163
+ * @see {@link GetTrailCommand}
274
164
  */
275
165
  getTrail(args: GetTrailCommandInput, options?: __HttpHandlerOptions): Promise<GetTrailCommandOutput>;
276
166
  getTrail(args: GetTrailCommandInput, cb: (err: any, data?: GetTrailCommandOutput) => void): void;
277
167
  getTrail(args: GetTrailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTrailCommandOutput) => void): void;
278
168
  /**
279
- * @public
280
- * <p>Returns a JSON-formatted list of information about the specified trail. Fields include
281
- * information on delivery errors, Amazon SNS and Amazon S3 errors, and start
282
- * and stop logging times for each trail. This operation returns trail status from a single
283
- * region. To return trail status from all regions, you must call the operation on each
284
- * region.</p>
169
+ * @see {@link GetTrailStatusCommand}
285
170
  */
286
171
  getTrailStatus(args: GetTrailStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetTrailStatusCommandOutput>;
287
172
  getTrailStatus(args: GetTrailStatusCommandInput, cb: (err: any, data?: GetTrailStatusCommandOutput) => void): void;
288
173
  getTrailStatus(args: GetTrailStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTrailStatusCommandOutput) => void): void;
289
174
  /**
290
- * @public
291
- * <p> Lists the channels in the current account, and their source names.
292
- * </p>
175
+ * @see {@link ListChannelsCommand}
293
176
  */
294
177
  listChannels(args: ListChannelsCommandInput, options?: __HttpHandlerOptions): Promise<ListChannelsCommandOutput>;
295
178
  listChannels(args: ListChannelsCommandInput, cb: (err: any, data?: ListChannelsCommandOutput) => void): void;
296
179
  listChannels(args: ListChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsCommandOutput) => void): void;
297
180
  /**
298
- * @public
299
- * <p>Returns information about all event data stores in the account, in the current
300
- * region.</p>
181
+ * @see {@link ListEventDataStoresCommand}
301
182
  */
302
183
  listEventDataStores(args: ListEventDataStoresCommandInput, options?: __HttpHandlerOptions): Promise<ListEventDataStoresCommandOutput>;
303
184
  listEventDataStores(args: ListEventDataStoresCommandInput, cb: (err: any, data?: ListEventDataStoresCommandOutput) => void): void;
304
185
  listEventDataStores(args: ListEventDataStoresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventDataStoresCommandOutput) => void): void;
305
186
  /**
306
- * @public
307
- * <p> Returns a list of failures for the specified import. </p>
187
+ * @see {@link ListImportFailuresCommand}
308
188
  */
309
189
  listImportFailures(args: ListImportFailuresCommandInput, options?: __HttpHandlerOptions): Promise<ListImportFailuresCommandOutput>;
310
190
  listImportFailures(args: ListImportFailuresCommandInput, cb: (err: any, data?: ListImportFailuresCommandOutput) => void): void;
311
191
  listImportFailures(args: ListImportFailuresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImportFailuresCommandOutput) => void): void;
312
192
  /**
313
- * @public
314
- * <p> Returns information on all imports, or a select set of imports by
315
- * <code>ImportStatus</code> or <code>Destination</code>. </p>
193
+ * @see {@link ListImportsCommand}
316
194
  */
317
195
  listImports(args: ListImportsCommandInput, options?: __HttpHandlerOptions): Promise<ListImportsCommandOutput>;
318
196
  listImports(args: ListImportsCommandInput, cb: (err: any, data?: ListImportsCommandOutput) => void): void;
319
197
  listImports(args: ListImportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImportsCommandOutput) => void): void;
320
198
  /**
321
- * @public
322
- * <p>Returns all public keys whose private keys were used to sign the digest files within the
323
- * specified time range. The public key is needed to validate digest files that were signed
324
- * with its corresponding private key.</p>
325
- * <note>
326
- * <p>CloudTrail uses different private and public key pairs per region. Each digest
327
- * file is signed with a private key unique to its region. When you validate a digest file
328
- * from a specific region, you must look in the same region for its corresponding public
329
- * key.</p>
330
- * </note>
199
+ * @see {@link ListPublicKeysCommand}
331
200
  */
332
201
  listPublicKeys(args: ListPublicKeysCommandInput, options?: __HttpHandlerOptions): Promise<ListPublicKeysCommandOutput>;
333
202
  listPublicKeys(args: ListPublicKeysCommandInput, cb: (err: any, data?: ListPublicKeysCommandOutput) => void): void;
334
203
  listPublicKeys(args: ListPublicKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPublicKeysCommandOutput) => void): void;
335
204
  /**
336
- * @public
337
- * <p>Returns a list of queries and query statuses for the past seven days. You must specify
338
- * an ARN value for <code>EventDataStore</code>. Optionally, to shorten the list of results,
339
- * you can specify a time range, formatted as timestamps, by adding <code>StartTime</code> and
340
- * <code>EndTime</code> parameters, and a <code>QueryStatus</code> value. Valid values for
341
- * <code>QueryStatus</code> include <code>QUEUED</code>, <code>RUNNING</code>,
342
- * <code>FINISHED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or
343
- * <code>CANCELLED</code>.</p>
205
+ * @see {@link ListQueriesCommand}
344
206
  */
345
207
  listQueries(args: ListQueriesCommandInput, options?: __HttpHandlerOptions): Promise<ListQueriesCommandOutput>;
346
208
  listQueries(args: ListQueriesCommandInput, cb: (err: any, data?: ListQueriesCommandOutput) => void): void;
347
209
  listQueries(args: ListQueriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListQueriesCommandOutput) => void): void;
348
210
  /**
349
- * @public
350
- * <p>Lists the tags for the trail, event data store, or channel in the current region.</p>
211
+ * @see {@link ListTagsCommand}
351
212
  */
352
213
  listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsCommandOutput>;
353
214
  listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void;
354
215
  listTags(args: ListTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsCommandOutput) => void): void;
355
216
  /**
356
- * @public
357
- * <p>Lists trails that are in the current account.</p>
217
+ * @see {@link ListTrailsCommand}
358
218
  */
359
219
  listTrails(args: ListTrailsCommandInput, options?: __HttpHandlerOptions): Promise<ListTrailsCommandOutput>;
360
220
  listTrails(args: ListTrailsCommandInput, cb: (err: any, data?: ListTrailsCommandOutput) => void): void;
361
221
  listTrails(args: ListTrailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTrailsCommandOutput) => void): void;
362
222
  /**
363
- * @public
364
- * <p>Looks up <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html#cloudtrail-concepts-management-events">management events</a> or <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html#cloudtrail-concepts-insights-events">CloudTrail Insights events</a> that are captured by CloudTrail.
365
- * You can look up events that occurred in a region within the last 90 days. Lookup supports
366
- * the following attributes for management events:</p>
367
- * <ul>
368
- * <li>
369
- * <p>Amazon Web Services access key</p>
370
- * </li>
371
- * <li>
372
- * <p>Event ID</p>
373
- * </li>
374
- * <li>
375
- * <p>Event name</p>
376
- * </li>
377
- * <li>
378
- * <p>Event source</p>
379
- * </li>
380
- * <li>
381
- * <p>Read only</p>
382
- * </li>
383
- * <li>
384
- * <p>Resource name</p>
385
- * </li>
386
- * <li>
387
- * <p>Resource type</p>
388
- * </li>
389
- * <li>
390
- * <p>User name</p>
391
- * </li>
392
- * </ul>
393
- * <p>Lookup supports the following attributes for Insights events:</p>
394
- * <ul>
395
- * <li>
396
- * <p>Event ID</p>
397
- * </li>
398
- * <li>
399
- * <p>Event name</p>
400
- * </li>
401
- * <li>
402
- * <p>Event source</p>
403
- * </li>
404
- * </ul>
405
- * <p>All attributes are optional. The default number of results returned is 50, with a
406
- * maximum of 50 possible. The response includes a token that you can use to get the next page
407
- * of results.</p>
408
- * <important>
409
- * <p>The rate of lookup requests is limited to two per second, per account, per region. If
410
- * this limit is exceeded, a throttling error occurs.</p>
411
- * </important>
223
+ * @see {@link LookupEventsCommand}
412
224
  */
413
225
  lookupEvents(args: LookupEventsCommandInput, options?: __HttpHandlerOptions): Promise<LookupEventsCommandOutput>;
414
226
  lookupEvents(args: LookupEventsCommandInput, cb: (err: any, data?: LookupEventsCommandOutput) => void): void;
415
227
  lookupEvents(args: LookupEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: LookupEventsCommandOutput) => void): void;
416
228
  /**
417
- * @public
418
- * <p>Configures an event selector or advanced event selectors for your trail. Use event
419
- * selectors or advanced event selectors to specify management and data event settings for
420
- * your trail. By default, trails created without specific event selectors are configured to
421
- * log all read and write management events, and no data events.</p>
422
- * <p>When an event occurs in your account, CloudTrail evaluates the event selectors or
423
- * advanced event selectors in all trails. For each trail, if the event matches any event
424
- * selector, the trail processes and logs the event. If the event doesn't match any event
425
- * selector, the trail doesn't log the event.</p>
426
- * <p>Example</p>
427
- * <ol>
428
- * <li>
429
- * <p>You create an event selector for a trail and specify that you want write-only
430
- * events.</p>
431
- * </li>
432
- * <li>
433
- * <p>The EC2 <code>GetConsoleOutput</code> and <code>RunInstances</code> API operations
434
- * occur in your account.</p>
435
- * </li>
436
- * <li>
437
- * <p>CloudTrail evaluates whether the events match your event selectors.</p>
438
- * </li>
439
- * <li>
440
- * <p>The <code>RunInstances</code> is a write-only event and it matches your event
441
- * selector. The trail logs the event.</p>
442
- * </li>
443
- * <li>
444
- * <p>The <code>GetConsoleOutput</code> is a read-only event that doesn't match your
445
- * event selector. The trail doesn't log the event. </p>
446
- * </li>
447
- * </ol>
448
- * <p>The <code>PutEventSelectors</code> operation must be called from the region in which the
449
- * trail was created; otherwise, an <code>InvalidHomeRegionException</code> exception is
450
- * thrown.</p>
451
- * <p>You can configure up to five event selectors for each trail. For more information, see
452
- * <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html">Logging management events for trails </a>, <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html">Logging
453
- * data events for trails </a>, and <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html">Quotas in CloudTrail</a> in the <i>CloudTrail User
454
- * Guide</i>.</p>
455
- * <p>You can add advanced event selectors, and conditions for your advanced event selectors,
456
- * up to a maximum of 500 values for all conditions and selectors on a trail. You can use
457
- * either <code>AdvancedEventSelectors</code> or <code>EventSelectors</code>, but not both. If
458
- * you apply <code>AdvancedEventSelectors</code> to a trail, any existing
459
- * <code>EventSelectors</code> are overwritten. For more information about advanced event
460
- * 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>
229
+ * @see {@link PutEventSelectorsCommand}
461
230
  */
462
231
  putEventSelectors(args: PutEventSelectorsCommandInput, options?: __HttpHandlerOptions): Promise<PutEventSelectorsCommandOutput>;
463
232
  putEventSelectors(args: PutEventSelectorsCommandInput, cb: (err: any, data?: PutEventSelectorsCommandOutput) => void): void;
464
233
  putEventSelectors(args: PutEventSelectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEventSelectorsCommandOutput) => void): void;
465
234
  /**
466
- * @public
467
- * <p>Lets you enable Insights event logging by specifying the Insights selectors that you
468
- * want to enable on an existing trail. You also use <code>PutInsightSelectors</code> to turn
469
- * off Insights event logging, by passing an empty list of insight types. The valid Insights
470
- * event types in this release are <code>ApiErrorRateInsight</code> and
471
- * <code>ApiCallRateInsight</code>.</p>
235
+ * @see {@link PutInsightSelectorsCommand}
472
236
  */
473
237
  putInsightSelectors(args: PutInsightSelectorsCommandInput, options?: __HttpHandlerOptions): Promise<PutInsightSelectorsCommandOutput>;
474
238
  putInsightSelectors(args: PutInsightSelectorsCommandInput, cb: (err: any, data?: PutInsightSelectorsCommandOutput) => void): void;
475
239
  putInsightSelectors(args: PutInsightSelectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutInsightSelectorsCommandOutput) => void): void;
476
240
  /**
477
- * @public
478
- * <p>
479
- * Attaches a resource-based permission policy to a CloudTrail channel that is used for an integration with an event source outside of Amazon Web Services. For more information about resource-based policies, see
480
- * <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html">CloudTrail resource-based policy examples</a>
481
- * in the <i>CloudTrail User Guide</i>.
482
- * </p>
241
+ * @see {@link PutResourcePolicyCommand}
483
242
  */
484
243
  putResourcePolicy(args: PutResourcePolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutResourcePolicyCommandOutput>;
485
244
  putResourcePolicy(args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void): void;
486
245
  putResourcePolicy(args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void): void;
487
246
  /**
488
- * @public
489
- * <p>Registers an organization’s member account as the CloudTrail delegated
490
- * administrator.</p>
247
+ * @see {@link RegisterOrganizationDelegatedAdminCommand}
491
248
  */
492
249
  registerOrganizationDelegatedAdmin(args: RegisterOrganizationDelegatedAdminCommandInput, options?: __HttpHandlerOptions): Promise<RegisterOrganizationDelegatedAdminCommandOutput>;
493
250
  registerOrganizationDelegatedAdmin(args: RegisterOrganizationDelegatedAdminCommandInput, cb: (err: any, data?: RegisterOrganizationDelegatedAdminCommandOutput) => void): void;
494
251
  registerOrganizationDelegatedAdmin(args: RegisterOrganizationDelegatedAdminCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterOrganizationDelegatedAdminCommandOutput) => void): void;
495
252
  /**
496
- * @public
497
- * <p>Removes the specified tags from a trail, event data store, or channel.</p>
253
+ * @see {@link RemoveTagsCommand}
498
254
  */
499
255
  removeTags(args: RemoveTagsCommandInput, options?: __HttpHandlerOptions): Promise<RemoveTagsCommandOutput>;
500
256
  removeTags(args: RemoveTagsCommandInput, cb: (err: any, data?: RemoveTagsCommandOutput) => void): void;
501
257
  removeTags(args: RemoveTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsCommandOutput) => void): void;
502
258
  /**
503
- * @public
504
- * <p>Restores a deleted event data store specified by <code>EventDataStore</code>, which
505
- * accepts an event data store ARN. You can only restore a deleted event data store within the
506
- * seven-day wait period after deletion. Restoring an event data store can take several
507
- * minutes, depending on the size of the event data store.</p>
259
+ * @see {@link RestoreEventDataStoreCommand}
508
260
  */
509
261
  restoreEventDataStore(args: RestoreEventDataStoreCommandInput, options?: __HttpHandlerOptions): Promise<RestoreEventDataStoreCommandOutput>;
510
262
  restoreEventDataStore(args: RestoreEventDataStoreCommandInput, cb: (err: any, data?: RestoreEventDataStoreCommandOutput) => void): void;
511
263
  restoreEventDataStore(args: RestoreEventDataStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreEventDataStoreCommandOutput) => void): void;
512
264
  /**
513
- * @public
514
- * <p> Starts an import of logged trail events from a source S3 bucket to a destination event
515
- * data store. By default, CloudTrail only imports events contained in the S3 bucket's
516
- * <code>CloudTrail</code> prefix and the prefixes inside the <code>CloudTrail</code> prefix, and does not check prefixes for other Amazon Web Services
517
- * services. If you want to import CloudTrail events contained in another prefix, you
518
- * must include the prefix in the <code>S3LocationUri</code>. For more considerations about
519
- * importing trail events, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-copy-trail-to-lake.html#cloudtrail-trail-copy-considerations">Considerations</a>. </p>
520
- * <p> When you start a new import, the <code>Destinations</code> and
521
- * <code>ImportSource</code> parameters are required. Before starting a new import, disable
522
- * any access control lists (ACLs) attached to the source S3 bucket. For more information
523
- * about disabling ACLs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling ownership of
524
- * objects and disabling ACLs for your bucket</a>. </p>
525
- * <p> When you retry an import, the <code>ImportID</code> parameter is required. </p>
526
- * <note>
527
- * <p> If the destination event data store is for an organization, you must use the
528
- * management account to import trail events. You cannot use the delegated administrator
529
- * account for the organization. </p>
530
- * </note>
265
+ * @see {@link StartImportCommand}
531
266
  */
532
267
  startImport(args: StartImportCommandInput, options?: __HttpHandlerOptions): Promise<StartImportCommandOutput>;
533
268
  startImport(args: StartImportCommandInput, cb: (err: any, data?: StartImportCommandOutput) => void): void;
534
269
  startImport(args: StartImportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartImportCommandOutput) => void): void;
535
270
  /**
536
- * @public
537
- * <p>Starts the recording of Amazon Web Services API calls and log file delivery for a trail.
538
- * For a trail that is enabled in all regions, this operation must be called from the region
539
- * in which the trail was created. This operation cannot be called on the shadow trails
540
- * (replicated trails in other regions) of a trail that is enabled in all regions.</p>
271
+ * @see {@link StartLoggingCommand}
541
272
  */
542
273
  startLogging(args: StartLoggingCommandInput, options?: __HttpHandlerOptions): Promise<StartLoggingCommandOutput>;
543
274
  startLogging(args: StartLoggingCommandInput, cb: (err: any, data?: StartLoggingCommandOutput) => void): void;
544
275
  startLogging(args: StartLoggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartLoggingCommandOutput) => void): void;
545
276
  /**
546
- * @public
547
- * <p>Starts a CloudTrail Lake query. The required <code>QueryStatement</code>
548
- * parameter provides your SQL query, enclosed in single quotation marks. Use the optional
549
- * <code>DeliveryS3Uri</code> parameter to deliver the query results to an S3
550
- * bucket.</p>
277
+ * @see {@link StartQueryCommand}
551
278
  */
552
279
  startQuery(args: StartQueryCommandInput, options?: __HttpHandlerOptions): Promise<StartQueryCommandOutput>;
553
280
  startQuery(args: StartQueryCommandInput, cb: (err: any, data?: StartQueryCommandOutput) => void): void;
554
281
  startQuery(args: StartQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartQueryCommandOutput) => void): void;
555
282
  /**
556
- * @public
557
- * <p> Stops a specified import. </p>
283
+ * @see {@link StopImportCommand}
558
284
  */
559
285
  stopImport(args: StopImportCommandInput, options?: __HttpHandlerOptions): Promise<StopImportCommandOutput>;
560
286
  stopImport(args: StopImportCommandInput, cb: (err: any, data?: StopImportCommandOutput) => void): void;
561
287
  stopImport(args: StopImportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopImportCommandOutput) => void): void;
562
288
  /**
563
- * @public
564
- * <p>Suspends the recording of Amazon Web Services API calls and log file delivery for the
565
- * specified trail. Under most circumstances, there is no need to use this action. You can
566
- * update a trail without stopping it first. This action is the only way to stop recording.
567
- * For a trail enabled in all regions, this operation must be called from the region in which
568
- * the trail was created, or an <code>InvalidHomeRegionException</code> will occur. This
569
- * operation cannot be called on the shadow trails (replicated trails in other regions) of a
570
- * trail enabled in all regions.</p>
289
+ * @see {@link StopLoggingCommand}
571
290
  */
572
291
  stopLogging(args: StopLoggingCommandInput, options?: __HttpHandlerOptions): Promise<StopLoggingCommandOutput>;
573
292
  stopLogging(args: StopLoggingCommandInput, cb: (err: any, data?: StopLoggingCommandOutput) => void): void;
574
293
  stopLogging(args: StopLoggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopLoggingCommandOutput) => void): void;
575
294
  /**
576
- * @public
577
- * <p>Updates a channel specified by a required channel ARN or UUID.</p>
295
+ * @see {@link UpdateChannelCommand}
578
296
  */
579
297
  updateChannel(args: UpdateChannelCommandInput, options?: __HttpHandlerOptions): Promise<UpdateChannelCommandOutput>;
580
298
  updateChannel(args: UpdateChannelCommandInput, cb: (err: any, data?: UpdateChannelCommandOutput) => void): void;
581
299
  updateChannel(args: UpdateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelCommandOutput) => void): void;
582
300
  /**
583
- * @public
584
- * <p>Updates an event data store. The required <code>EventDataStore</code> value is an ARN or
585
- * the ID portion of the ARN. Other parameters are optional, but at least one optional
586
- * parameter must be specified, or CloudTrail throws an error.
587
- * <code>RetentionPeriod</code> is in days, and valid values are integers between 90 and
588
- * 2557. By default, <code>TerminationProtection</code> is enabled.</p>
589
- * <p>For event data stores for CloudTrail events, <code>AdvancedEventSelectors</code>
590
- * includes or excludes management and data events in your event data store. For more
591
- * information about <code>AdvancedEventSelectors</code>, see <a>PutEventSelectorsRequest$AdvancedEventSelectors</a>. </p>
592
- * <p> For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events,
593
- * <code>AdvancedEventSelectors</code> includes events of that type in your event data
594
- * store.</p>
301
+ * @see {@link UpdateEventDataStoreCommand}
595
302
  */
596
303
  updateEventDataStore(args: UpdateEventDataStoreCommandInput, options?: __HttpHandlerOptions): Promise<UpdateEventDataStoreCommandOutput>;
597
304
  updateEventDataStore(args: UpdateEventDataStoreCommandInput, cb: (err: any, data?: UpdateEventDataStoreCommandOutput) => void): void;
598
305
  updateEventDataStore(args: UpdateEventDataStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEventDataStoreCommandOutput) => void): void;
599
306
  /**
600
- * @public
601
- * <p>Updates trail settings that control what events you are logging, and how to handle log
602
- * files. Changes to a trail do not require stopping the CloudTrail service. Use this
603
- * action to designate an existing bucket for log delivery. If the existing bucket has
604
- * previously been a target for CloudTrail log files, an IAM policy
605
- * exists for the bucket. <code>UpdateTrail</code> must be called from the region in which the
606
- * trail was created; otherwise, an <code>InvalidHomeRegionException</code> is thrown.</p>
307
+ * @see {@link UpdateTrailCommand}
607
308
  */
608
309
  updateTrail(args: UpdateTrailCommandInput, options?: __HttpHandlerOptions): Promise<UpdateTrailCommandOutput>;
609
310
  updateTrail(args: UpdateTrailCommandInput, cb: (err: any, data?: UpdateTrailCommandOutput) => void): void;
610
311
  updateTrail(args: UpdateTrailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTrailCommandOutput) => void): void;
611
312
  }
313
+ /**
314
+ * @public
315
+ * <fullname>CloudTrail</fullname>
316
+ * <p>This is the CloudTrail API Reference. It provides descriptions of actions, data
317
+ * types, common parameters, and common errors for CloudTrail.</p>
318
+ * <p>CloudTrail is a web service that records Amazon Web Services API calls for your
319
+ * Amazon Web Services account and delivers log files to an Amazon S3 bucket. The
320
+ * recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response
321
+ * elements returned by the service.</p>
322
+ * <note>
323
+ * <p>As an alternative to the API, you can use one of the Amazon Web Services SDKs, which
324
+ * consist of libraries and sample code for various programming languages and platforms
325
+ * (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide programmatic access to CloudTrail. For example, the SDKs handle cryptographically signing requests,
326
+ * managing errors, and retrying requests automatically. For more information about the
327
+ * Amazon Web Services SDKs, including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools to Build on Amazon Web Services</a>.</p>
328
+ * </note>
329
+ * <p>See the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-user-guide.html">CloudTrail
330
+ * User Guide</a> for information about the data that is included with each Amazon Web Services API call listed in the log files.</p>
331
+ */
332
+ export declare class CloudTrail extends CloudTrailClient implements CloudTrail {
333
+ }