UNPKG

60.7 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class CloudTrail extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: CloudTrail.Types.ClientConfiguration)
13 config: Config & CloudTrail.Types.ClientConfiguration;
14 /**
15 * Adds one or more tags to a trail, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique for a trail; you cannot have two keys with the same name but different values. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all AWS Regions only from the Region in which the trail was created (also known as its home region).
16 */
17 addTags(params: CloudTrail.Types.AddTagsRequest, callback?: (err: AWSError, data: CloudTrail.Types.AddTagsResponse) => void): Request<CloudTrail.Types.AddTagsResponse, AWSError>;
18 /**
19 * Adds one or more tags to a trail, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique for a trail; you cannot have two keys with the same name but different values. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all AWS Regions only from the Region in which the trail was created (also known as its home region).
20 */
21 addTags(callback?: (err: AWSError, data: CloudTrail.Types.AddTagsResponse) => void): Request<CloudTrail.Types.AddTagsResponse, AWSError>;
22 /**
23 * Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
24 */
25 createTrail(params: CloudTrail.Types.CreateTrailRequest, callback?: (err: AWSError, data: CloudTrail.Types.CreateTrailResponse) => void): Request<CloudTrail.Types.CreateTrailResponse, AWSError>;
26 /**
27 * Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
28 */
29 createTrail(callback?: (err: AWSError, data: CloudTrail.Types.CreateTrailResponse) => void): Request<CloudTrail.Types.CreateTrailResponse, AWSError>;
30 /**
31 * Deletes a trail. This operation must be called from the region in which the trail was created. DeleteTrail cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.
32 */
33 deleteTrail(params: CloudTrail.Types.DeleteTrailRequest, callback?: (err: AWSError, data: CloudTrail.Types.DeleteTrailResponse) => void): Request<CloudTrail.Types.DeleteTrailResponse, AWSError>;
34 /**
35 * Deletes a trail. This operation must be called from the region in which the trail was created. DeleteTrail cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.
36 */
37 deleteTrail(callback?: (err: AWSError, data: CloudTrail.Types.DeleteTrailResponse) => void): Request<CloudTrail.Types.DeleteTrailResponse, AWSError>;
38 /**
39 * Retrieves settings for one or more trails associated with the current region for your account.
40 */
41 describeTrails(params: CloudTrail.Types.DescribeTrailsRequest, callback?: (err: AWSError, data: CloudTrail.Types.DescribeTrailsResponse) => void): Request<CloudTrail.Types.DescribeTrailsResponse, AWSError>;
42 /**
43 * Retrieves settings for one or more trails associated with the current region for your account.
44 */
45 describeTrails(callback?: (err: AWSError, data: CloudTrail.Types.DescribeTrailsResponse) => void): Request<CloudTrail.Types.DescribeTrailsResponse, AWSError>;
46 /**
47 * Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following: If your event selector includes read-only events, write-only events, or all events. This applies to both management events and data events. If your event selector includes management events. If your event selector includes data events, the Amazon S3 objects or AWS Lambda functions that you are logging for data events. For more information, see Logging Data and Management Events for Trails in the AWS CloudTrail User Guide.
48 */
49 getEventSelectors(params: CloudTrail.Types.GetEventSelectorsRequest, callback?: (err: AWSError, data: CloudTrail.Types.GetEventSelectorsResponse) => void): Request<CloudTrail.Types.GetEventSelectorsResponse, AWSError>;
50 /**
51 * Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following: If your event selector includes read-only events, write-only events, or all events. This applies to both management events and data events. If your event selector includes management events. If your event selector includes data events, the Amazon S3 objects or AWS Lambda functions that you are logging for data events. For more information, see Logging Data and Management Events for Trails in the AWS CloudTrail User Guide.
52 */
53 getEventSelectors(callback?: (err: AWSError, data: CloudTrail.Types.GetEventSelectorsResponse) => void): Request<CloudTrail.Types.GetEventSelectorsResponse, AWSError>;
54 /**
55 * Describes the settings for the Insights event selectors that you configured for your trail. GetInsightSelectors shows if CloudTrail Insights event logging is enabled on the trail, and if it is, which insight types are enabled. If you run GetInsightSelectors on a trail that does not have Insights events enabled, the operation throws the exception InsightNotEnabledException For more information, see Logging CloudTrail Insights Events for Trails in the AWS CloudTrail User Guide.
56 */
57 getInsightSelectors(params: CloudTrail.Types.GetInsightSelectorsRequest, callback?: (err: AWSError, data: CloudTrail.Types.GetInsightSelectorsResponse) => void): Request<CloudTrail.Types.GetInsightSelectorsResponse, AWSError>;
58 /**
59 * Describes the settings for the Insights event selectors that you configured for your trail. GetInsightSelectors shows if CloudTrail Insights event logging is enabled on the trail, and if it is, which insight types are enabled. If you run GetInsightSelectors on a trail that does not have Insights events enabled, the operation throws the exception InsightNotEnabledException For more information, see Logging CloudTrail Insights Events for Trails in the AWS CloudTrail User Guide.
60 */
61 getInsightSelectors(callback?: (err: AWSError, data: CloudTrail.Types.GetInsightSelectorsResponse) => void): Request<CloudTrail.Types.GetInsightSelectorsResponse, AWSError>;
62 /**
63 * Returns settings information for a specified trail.
64 */
65 getTrail(params: CloudTrail.Types.GetTrailRequest, callback?: (err: AWSError, data: CloudTrail.Types.GetTrailResponse) => void): Request<CloudTrail.Types.GetTrailResponse, AWSError>;
66 /**
67 * Returns settings information for a specified trail.
68 */
69 getTrail(callback?: (err: AWSError, data: CloudTrail.Types.GetTrailResponse) => void): Request<CloudTrail.Types.GetTrailResponse, AWSError>;
70 /**
71 * Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region.
72 */
73 getTrailStatus(params: CloudTrail.Types.GetTrailStatusRequest, callback?: (err: AWSError, data: CloudTrail.Types.GetTrailStatusResponse) => void): Request<CloudTrail.Types.GetTrailStatusResponse, AWSError>;
74 /**
75 * Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region.
76 */
77 getTrailStatus(callback?: (err: AWSError, data: CloudTrail.Types.GetTrailStatusResponse) => void): Request<CloudTrail.Types.GetTrailStatusResponse, AWSError>;
78 /**
79 * Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key. CloudTrail uses different private/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular region, you must look in the same region for its corresponding public key.
80 */
81 listPublicKeys(params: CloudTrail.Types.ListPublicKeysRequest, callback?: (err: AWSError, data: CloudTrail.Types.ListPublicKeysResponse) => void): Request<CloudTrail.Types.ListPublicKeysResponse, AWSError>;
82 /**
83 * Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key. CloudTrail uses different private/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular region, you must look in the same region for its corresponding public key.
84 */
85 listPublicKeys(callback?: (err: AWSError, data: CloudTrail.Types.ListPublicKeysResponse) => void): Request<CloudTrail.Types.ListPublicKeysResponse, AWSError>;
86 /**
87 * Lists the tags for the trail in the current region.
88 */
89 listTags(params: CloudTrail.Types.ListTagsRequest, callback?: (err: AWSError, data: CloudTrail.Types.ListTagsResponse) => void): Request<CloudTrail.Types.ListTagsResponse, AWSError>;
90 /**
91 * Lists the tags for the trail in the current region.
92 */
93 listTags(callback?: (err: AWSError, data: CloudTrail.Types.ListTagsResponse) => void): Request<CloudTrail.Types.ListTagsResponse, AWSError>;
94 /**
95 * Lists trails that are in the current account.
96 */
97 listTrails(params: CloudTrail.Types.ListTrailsRequest, callback?: (err: AWSError, data: CloudTrail.Types.ListTrailsResponse) => void): Request<CloudTrail.Types.ListTrailsResponse, AWSError>;
98 /**
99 * Lists trails that are in the current account.
100 */
101 listTrails(callback?: (err: AWSError, data: CloudTrail.Types.ListTrailsResponse) => void): Request<CloudTrail.Types.ListTrailsResponse, AWSError>;
102 /**
103 * Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a region within the last 90 days. Lookup supports the following attributes for management events: AWS access key Event ID Event name Event source Read only Resource name Resource type User name Lookup supports the following attributes for Insights events: Event ID Event name Event source All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results. The rate of lookup requests is limited to two per second per account. If this limit is exceeded, a throttling error occurs.
104 */
105 lookupEvents(params: CloudTrail.Types.LookupEventsRequest, callback?: (err: AWSError, data: CloudTrail.Types.LookupEventsResponse) => void): Request<CloudTrail.Types.LookupEventsResponse, AWSError>;
106 /**
107 * Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a region within the last 90 days. Lookup supports the following attributes for management events: AWS access key Event ID Event name Event source Read only Resource name Resource type User name Lookup supports the following attributes for Insights events: Event ID Event name Event source All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results. The rate of lookup requests is limited to two per second per account. If this limit is exceeded, a throttling error occurs.
108 */
109 lookupEvents(callback?: (err: AWSError, data: CloudTrail.Types.LookupEventsResponse) => void): Request<CloudTrail.Types.LookupEventsResponse, AWSError>;
110 /**
111 * Configures an event selector for your trail. Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. Example You create an event selector for a trail and specify that you want write-only events. The EC2 GetConsoleOutput and RunInstances API operations occur in your account. CloudTrail evaluates whether the events match your event selectors. The RunInstances is a write-only event and it matches your event selector. The trail logs the event. The GetConsoleOutput is a read-only event but it doesn't match your event selector. The trail doesn't log the event. The PutEventSelectors operation must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown. You can configure up to five event selectors for each trail. For more information, see Logging Data and Management Events for Trails and Limits in AWS CloudTrail in the AWS CloudTrail User Guide.
112 */
113 putEventSelectors(params: CloudTrail.Types.PutEventSelectorsRequest, callback?: (err: AWSError, data: CloudTrail.Types.PutEventSelectorsResponse) => void): Request<CloudTrail.Types.PutEventSelectorsResponse, AWSError>;
114 /**
115 * Configures an event selector for your trail. Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. Example You create an event selector for a trail and specify that you want write-only events. The EC2 GetConsoleOutput and RunInstances API operations occur in your account. CloudTrail evaluates whether the events match your event selectors. The RunInstances is a write-only event and it matches your event selector. The trail logs the event. The GetConsoleOutput is a read-only event but it doesn't match your event selector. The trail doesn't log the event. The PutEventSelectors operation must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown. You can configure up to five event selectors for each trail. For more information, see Logging Data and Management Events for Trails and Limits in AWS CloudTrail in the AWS CloudTrail User Guide.
116 */
117 putEventSelectors(callback?: (err: AWSError, data: CloudTrail.Types.PutEventSelectorsResponse) => void): Request<CloudTrail.Types.PutEventSelectorsResponse, AWSError>;
118 /**
119 * Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail. You also use PutInsightSelectors to turn off Insights event logging, by passing an empty list of insight types. In this release, only ApiCallRateInsight is supported as an Insights selector.
120 */
121 putInsightSelectors(params: CloudTrail.Types.PutInsightSelectorsRequest, callback?: (err: AWSError, data: CloudTrail.Types.PutInsightSelectorsResponse) => void): Request<CloudTrail.Types.PutInsightSelectorsResponse, AWSError>;
122 /**
123 * Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail. You also use PutInsightSelectors to turn off Insights event logging, by passing an empty list of insight types. In this release, only ApiCallRateInsight is supported as an Insights selector.
124 */
125 putInsightSelectors(callback?: (err: AWSError, data: CloudTrail.Types.PutInsightSelectorsResponse) => void): Request<CloudTrail.Types.PutInsightSelectorsResponse, AWSError>;
126 /**
127 * Removes the specified tags from a trail.
128 */
129 removeTags(params: CloudTrail.Types.RemoveTagsRequest, callback?: (err: AWSError, data: CloudTrail.Types.RemoveTagsResponse) => void): Request<CloudTrail.Types.RemoveTagsResponse, AWSError>;
130 /**
131 * Removes the specified tags from a trail.
132 */
133 removeTags(callback?: (err: AWSError, data: CloudTrail.Types.RemoveTagsResponse) => void): Request<CloudTrail.Types.RemoveTagsResponse, AWSError>;
134 /**
135 * Starts the recording of AWS API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.
136 */
137 startLogging(params: CloudTrail.Types.StartLoggingRequest, callback?: (err: AWSError, data: CloudTrail.Types.StartLoggingResponse) => void): Request<CloudTrail.Types.StartLoggingResponse, AWSError>;
138 /**
139 * Starts the recording of AWS API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.
140 */
141 startLogging(callback?: (err: AWSError, data: CloudTrail.Types.StartLoggingResponse) => void): Request<CloudTrail.Types.StartLoggingResponse, AWSError>;
142 /**
143 * Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an InvalidHomeRegionException will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all regions.
144 */
145 stopLogging(params: CloudTrail.Types.StopLoggingRequest, callback?: (err: AWSError, data: CloudTrail.Types.StopLoggingResponse) => void): Request<CloudTrail.Types.StopLoggingResponse, AWSError>;
146 /**
147 * Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an InvalidHomeRegionException will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all regions.
148 */
149 stopLogging(callback?: (err: AWSError, data: CloudTrail.Types.StopLoggingResponse) => void): Request<CloudTrail.Types.StopLoggingResponse, AWSError>;
150 /**
151 * Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. UpdateTrail must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown.
152 */
153 updateTrail(params: CloudTrail.Types.UpdateTrailRequest, callback?: (err: AWSError, data: CloudTrail.Types.UpdateTrailResponse) => void): Request<CloudTrail.Types.UpdateTrailResponse, AWSError>;
154 /**
155 * Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. UpdateTrail must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown.
156 */
157 updateTrail(callback?: (err: AWSError, data: CloudTrail.Types.UpdateTrailResponse) => void): Request<CloudTrail.Types.UpdateTrailResponse, AWSError>;
158}
159declare namespace CloudTrail {
160 export interface AddTagsRequest {
161 /**
162 * Specifies the ARN of the trail to which one or more tags will be added. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
163 */
164 ResourceId: String;
165 /**
166 * Contains a list of CloudTrail tags, up to a limit of 50
167 */
168 TagsList?: TagsList;
169 }
170 export interface AddTagsResponse {
171 }
172 export type Boolean = boolean;
173 export type ByteBuffer = Buffer|Uint8Array|Blob|string;
174 export interface CreateTrailRequest {
175 /**
176 * Specifies the name of the trail. The name must meet the following requirements: Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) Start with a letter or number, and end with a letter or number Be between 3 and 128 characters Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid. Not be in IP address format (for example, 192.168.5.4)
177 */
178 Name: String;
179 /**
180 * Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
181 */
182 S3BucketName: String;
183 /**
184 * Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.
185 */
186 S3KeyPrefix?: String;
187 /**
188 * Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
189 */
190 SnsTopicName?: String;
191 /**
192 * Specifies whether the trail is publishing events from global services such as IAM to the log files.
193 */
194 IncludeGlobalServiceEvents?: Boolean;
195 /**
196 * 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 creating trails that log events in all regions.
197 */
198 IsMultiRegionTrail?: Boolean;
199 /**
200 * Specifies whether log file integrity validation is enabled. The default is false. When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable 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 January 10. The same applies whenever you stop CloudTrail logging or delete a trail.
201 */
202 EnableLogFileValidation?: Boolean;
203 /**
204 * Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.
205 */
206 CloudWatchLogsLogGroupArn?: String;
207 /**
208 * Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
209 */
210 CloudWatchLogsRoleArn?: String;
211 /**
212 * Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier. Examples: alias/MyAliasName arn:aws:kms:us-east-2:123456789012:alias/MyAliasName arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 12345678-1234-1234-1234-123456789012
213 */
214 KmsKeyId?: String;
215 /**
216 * Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations.
217 */
218 IsOrganizationTrail?: Boolean;
219 TagsList?: TagsList;
220 }
221 export interface CreateTrailResponse {
222 /**
223 * Specifies the name of the trail.
224 */
225 Name?: String;
226 /**
227 * Specifies the name of the Amazon S3 bucket designated for publishing log files.
228 */
229 S3BucketName?: String;
230 /**
231 * Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.
232 */
233 S3KeyPrefix?: String;
234 /**
235 * This field is no longer in use. Use SnsTopicARN.
236 */
237 SnsTopicName?: String;
238 /**
239 * 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: arn:aws:sns:us-east-2:123456789012:MyTopic
240 */
241 SnsTopicARN?: String;
242 /**
243 * Specifies whether the trail is publishing events from global services such as IAM to the log files.
244 */
245 IncludeGlobalServiceEvents?: Boolean;
246 /**
247 * Specifies whether the trail exists in one region or in all regions.
248 */
249 IsMultiRegionTrail?: Boolean;
250 /**
251 * Specifies the ARN of the trail that was created. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
252 */
253 TrailARN?: String;
254 /**
255 * Specifies whether log file integrity validation is enabled.
256 */
257 LogFileValidationEnabled?: Boolean;
258 /**
259 * Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.
260 */
261 CloudWatchLogsLogGroupArn?: String;
262 /**
263 * Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
264 */
265 CloudWatchLogsRoleArn?: String;
266 /**
267 * 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 format: arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
268 */
269 KmsKeyId?: String;
270 /**
271 * Specifies whether the trail is an organization trail.
272 */
273 IsOrganizationTrail?: Boolean;
274 }
275 export interface DataResource {
276 /**
277 * The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources.
278 */
279 Type?: String;
280 /**
281 * An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects. To log data events for all objects in all S3 buckets in your AWS account, specify the prefix as arn:aws:s3:::. This will also enable logging of data event activity performed by any user or role in your AWS account, even if that activity is performed on a bucket that belongs to another AWS account. To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as arn:aws:s3:::bucket-1/. The trail logs data events for all objects in this S3 bucket. To log data events for specific objects, specify the S3 bucket and object prefix such as arn:aws:s3:::bucket-1/example-images. The trail logs data events for objects in this S3 bucket that match the prefix. To log data events for all functions in your AWS account, specify the prefix as arn:aws:lambda. This will also enable logging of Invoke activity performed by any user or role in your AWS account, even if that activity is performed on a function that belongs to another AWS account. To log data events for a specific Lambda function, specify the function ARN. Lambda function ARNs are exact. For example, if you specify a function ARN arn:aws:lambda:us-west-2:111111111111:function:helloworld, data events will only be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld. They will not be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld2.
282 */
283 Values?: DataResourceValues;
284 }
285 export type DataResourceValues = String[];
286 export type DataResources = DataResource[];
287 export type _Date = Date;
288 export interface DeleteTrailRequest {
289 /**
290 * Specifies the name or the CloudTrail ARN of the trail to be deleted. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
291 */
292 Name: String;
293 }
294 export interface DeleteTrailResponse {
295 }
296 export interface DescribeTrailsRequest {
297 /**
298 * Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail If an empty list is specified, information for the trail in the current region is returned. If an empty list is specified and IncludeShadowTrails is false, then information for all trails in the current region is returned. 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. 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.
299 */
300 trailNameList?: TrailNameList;
301 /**
302 * 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, 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 and region replication trails will not be returned. The default is true.
303 */
304 includeShadowTrails?: Boolean;
305 }
306 export interface DescribeTrailsResponse {
307 /**
308 * The list of trail objects. Trail objects with string values are only returned if values for the objects exist in a trail's configuration. For example, SNSTopicName and SNSTopicARN are only returned in results if a trail is configured to send SNS notifications. Similarly, KMSKeyId only appears in results if a trail's log files are encrypted with AWS KMS-managed keys.
309 */
310 trailList?: TrailList;
311 }
312 export interface Event {
313 /**
314 * The CloudTrail ID of the event returned.
315 */
316 EventId?: String;
317 /**
318 * The name of the event returned.
319 */
320 EventName?: String;
321 /**
322 * Information about whether the event is a write event or a read event.
323 */
324 ReadOnly?: String;
325 /**
326 * The AWS access key ID that was used to sign the request. If the request was made with temporary security credentials, this is the access key ID of the temporary credentials.
327 */
328 AccessKeyId?: String;
329 /**
330 * The date and time of the event returned.
331 */
332 EventTime?: _Date;
333 /**
334 * The AWS service that the request was made to.
335 */
336 EventSource?: String;
337 /**
338 * A user name or role name of the requester that called the API in the event returned.
339 */
340 Username?: String;
341 /**
342 * A list of resources referenced by the event returned.
343 */
344 Resources?: ResourceList;
345 /**
346 * A JSON string that contains a representation of the event returned.
347 */
348 CloudTrailEvent?: String;
349 }
350 export type EventCategory = "insight"|string;
351 export interface EventSelector {
352 /**
353 * Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation. By default, the value is All.
354 */
355 ReadWriteType?: ReadWriteType;
356 /**
357 * Specify if you want your event selector to include management events for your trail. For more information, see Management Events in the AWS CloudTrail User Guide. By default, the value is true.
358 */
359 IncludeManagementEvents?: Boolean;
360 /**
361 * CloudTrail supports data event logging for Amazon S3 objects and AWS Lambda functions. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events. For more information, see Data Events and Limits in AWS CloudTrail in the AWS CloudTrail User Guide.
362 */
363 DataResources?: DataResources;
364 /**
365 * 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), or it can filter out AWS Key Management Service events by containing "kms.amazonaws.com". By default, ExcludeManagementEventSources is empty, and AWS KMS events are included in events that are logged to your trail.
366 */
367 ExcludeManagementEventSources?: ExcludeManagementEventSources;
368 }
369 export type EventSelectors = EventSelector[];
370 export type EventsList = Event[];
371 export type ExcludeManagementEventSources = String[];
372 export interface GetEventSelectorsRequest {
373 /**
374 * Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements: Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) Start with a letter or number, and end with a letter or number Be between 3 and 128 characters Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are not valid. Not be in IP address format (for example, 192.168.5.4) If you specify a trail ARN, it must be in the format: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
375 */
376 TrailName: String;
377 }
378 export interface GetEventSelectorsResponse {
379 /**
380 * The specified trail ARN that has the event selectors.
381 */
382 TrailARN?: String;
383 /**
384 * The event selectors that are configured for the trail.
385 */
386 EventSelectors?: EventSelectors;
387 }
388 export interface GetInsightSelectorsRequest {
389 /**
390 * Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements: Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) Start with a letter or number, and end with a letter or number Be between 3 and 128 characters Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are not valid. Not be in IP address format (for example, 192.168.5.4) If you specify a trail ARN, it must be in the format: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
391 */
392 TrailName: String;
393 }
394 export interface GetInsightSelectorsResponse {
395 /**
396 * The Amazon Resource Name (ARN) of a trail for which you want to get Insights selectors.
397 */
398 TrailARN?: String;
399 /**
400 * A JSON string that contains the insight types you want to log on a trail. In this release, only ApiCallRateInsight is supported as an insight type.
401 */
402 InsightSelectors?: InsightSelectors;
403 }
404 export interface GetTrailRequest {
405 /**
406 * The name or the Amazon Resource Name (ARN) of the trail for which you want to retrieve settings information.
407 */
408 Name: String;
409 }
410 export interface GetTrailResponse {
411 Trail?: Trail;
412 }
413 export interface GetTrailStatusRequest {
414 /**
415 * Specifies the name or the CloudTrail ARN of the trail for which you are requesting status. To get the status of a shadow trail (a replication of the trail in another region), you must specify its ARN. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
416 */
417 Name: String;
418 }
419 export interface GetTrailStatusResponse {
420 /**
421 * Whether the CloudTrail is currently logging AWS API calls.
422 */
423 IsLogging?: Boolean;
424 /**
425 * Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver log files to the designated bucket. For more information see the topic Error Responses in the Amazon S3 API Reference. This error occurs only when there is a problem with the destination S3 bucket and will not occur for timeouts. To resolve the issue, create a new bucket and call UpdateTrail to specify the new bucket, or fix the existing objects so that CloudTrail can again write to the bucket.
426 */
427 LatestDeliveryError?: String;
428 /**
429 * Displays any Amazon SNS error that CloudTrail encountered when attempting to send a notification. For more information about Amazon SNS errors, see the Amazon SNS Developer Guide.
430 */
431 LatestNotificationError?: String;
432 /**
433 * Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.
434 */
435 LatestDeliveryTime?: _Date;
436 /**
437 * 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.
438 */
439 LatestNotificationTime?: _Date;
440 /**
441 * Specifies the most recent date and time when CloudTrail started recording API calls for an AWS account.
442 */
443 StartLoggingTime?: _Date;
444 /**
445 * Specifies the most recent date and time when CloudTrail stopped recording API calls for an AWS account.
446 */
447 StopLoggingTime?: _Date;
448 /**
449 * Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs.
450 */
451 LatestCloudWatchLogsDeliveryError?: String;
452 /**
453 * Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.
454 */
455 LatestCloudWatchLogsDeliveryTime?: _Date;
456 /**
457 * Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket.
458 */
459 LatestDigestDeliveryTime?: _Date;
460 /**
461 * Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver a digest file to the designated bucket. For more information see the topic Error Responses in the Amazon S3 API Reference. This error occurs only when there is a problem with the destination S3 bucket and will not occur for timeouts. To resolve the issue, create a new bucket and call UpdateTrail to specify the new bucket, or fix the existing objects so that CloudTrail can again write to the bucket.
462 */
463 LatestDigestDeliveryError?: String;
464 /**
465 * This field is no longer in use.
466 */
467 LatestDeliveryAttemptTime?: String;
468 /**
469 * This field is no longer in use.
470 */
471 LatestNotificationAttemptTime?: String;
472 /**
473 * This field is no longer in use.
474 */
475 LatestNotificationAttemptSucceeded?: String;
476 /**
477 * This field is no longer in use.
478 */
479 LatestDeliveryAttemptSucceeded?: String;
480 /**
481 * This field is no longer in use.
482 */
483 TimeLoggingStarted?: String;
484 /**
485 * This field is no longer in use.
486 */
487 TimeLoggingStopped?: String;
488 }
489 export interface InsightSelector {
490 /**
491 * The type of insights to log on a trail. In this release, only ApiCallRateInsight is supported as an insight type.
492 */
493 InsightType?: InsightType;
494 }
495 export type InsightSelectors = InsightSelector[];
496 export type InsightType = "ApiCallRateInsight"|string;
497 export interface ListPublicKeysRequest {
498 /**
499 * Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used, and the current public key is returned.
500 */
501 StartTime?: _Date;
502 /**
503 * Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used.
504 */
505 EndTime?: _Date;
506 /**
507 * Reserved for future use.
508 */
509 NextToken?: String;
510 }
511 export interface ListPublicKeysResponse {
512 /**
513 * Contains an array of PublicKey objects. The returned public keys may have validity time ranges that overlap.
514 */
515 PublicKeyList?: PublicKeyList;
516 /**
517 * Reserved for future use.
518 */
519 NextToken?: String;
520 }
521 export interface ListTagsRequest {
522 /**
523 * Specifies a list of trail ARNs whose tags will be listed. The list has a limit of 20 ARNs. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
524 */
525 ResourceIdList: ResourceIdList;
526 /**
527 * Reserved for future use.
528 */
529 NextToken?: String;
530 }
531 export interface ListTagsResponse {
532 /**
533 * A list of resource tags.
534 */
535 ResourceTagList?: ResourceTagList;
536 /**
537 * Reserved for future use.
538 */
539 NextToken?: String;
540 }
541 export interface ListTrailsRequest {
542 /**
543 * 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. 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.
544 */
545 NextToken?: String;
546 }
547 export interface ListTrailsResponse {
548 /**
549 * Returns the name, ARN, and home region of trails in the current account.
550 */
551 Trails?: Trails;
552 /**
553 * The token to use to get the next page of results after a previous API call. If the token does not appear, there are no more results to return. The token must be passed in with the same parameters as the previous call. 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.
554 */
555 NextToken?: String;
556 }
557 export interface LookupAttribute {
558 /**
559 * Specifies an attribute on which to filter the events returned.
560 */
561 AttributeKey: LookupAttributeKey;
562 /**
563 * Specifies a value for the specified AttributeKey.
564 */
565 AttributeValue: String;
566 }
567 export type LookupAttributeKey = "EventId"|"EventName"|"ReadOnly"|"Username"|"ResourceType"|"ResourceName"|"EventSource"|"AccessKeyId"|string;
568 export type LookupAttributesList = LookupAttribute[];
569 export interface LookupEventsRequest {
570 /**
571 * Contains a list of lookup attributes. Currently the list can contain only one item.
572 */
573 LookupAttributes?: LookupAttributesList;
574 /**
575 * 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.
576 */
577 StartTime?: _Date;
578 /**
579 * 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.
580 */
581 EndTime?: _Date;
582 /**
583 * Specifies the event category. If you do not specify an event category, events of the category are not returned in the response. For example, if you do not specify insight as the value of EventCategory, no Insights events are returned.
584 */
585 EventCategory?: EventCategory;
586 /**
587 * The number of events to return. Possible values are 1 through 50. The default is 50.
588 */
589 MaxResults?: MaxResults;
590 /**
591 * 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. 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.
592 */
593 NextToken?: NextToken;
594 }
595 export interface LookupEventsResponse {
596 /**
597 * 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.
598 */
599 Events?: EventsList;
600 /**
601 * The token to use to get the next page of results after a previous API call. If the token does not appear, there are no more results to return. The token must be passed in with the same parameters as the previous call. 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.
602 */
603 NextToken?: NextToken;
604 }
605 export type MaxResults = number;
606 export type NextToken = string;
607 export interface PublicKey {
608 /**
609 * The DER encoded public key value in PKCS#1 format.
610 */
611 Value?: ByteBuffer;
612 /**
613 * The starting time of validity of the public key.
614 */
615 ValidityStartTime?: _Date;
616 /**
617 * The ending time of validity of the public key.
618 */
619 ValidityEndTime?: _Date;
620 /**
621 * The fingerprint of the public key.
622 */
623 Fingerprint?: String;
624 }
625 export type PublicKeyList = PublicKey[];
626 export interface PutEventSelectorsRequest {
627 /**
628 * Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements: Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) Start with a letter or number, and end with a letter or number Be between 3 and 128 characters Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid. Not be in IP address format (for example, 192.168.5.4) If you specify a trail ARN, it must be in the format: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
629 */
630 TrailName: String;
631 /**
632 * Specifies the settings for your event selectors. You can configure up to five event selectors for a trail.
633 */
634 EventSelectors: EventSelectors;
635 }
636 export interface PutEventSelectorsResponse {
637 /**
638 * Specifies the ARN of the trail that was updated with event selectors. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
639 */
640 TrailARN?: String;
641 /**
642 * Specifies the event selectors configured for your trail.
643 */
644 EventSelectors?: EventSelectors;
645 }
646 export interface PutInsightSelectorsRequest {
647 /**
648 * The name of the CloudTrail trail for which you want to change or add Insights selectors.
649 */
650 TrailName: String;
651 /**
652 * A JSON string that contains the insight types you want to log on a trail. In this release, only ApiCallRateInsight is supported as an insight type.
653 */
654 InsightSelectors: InsightSelectors;
655 }
656 export interface PutInsightSelectorsResponse {
657 /**
658 * The Amazon Resource Name (ARN) of a trail for which you want to change or add Insights selectors.
659 */
660 TrailARN?: String;
661 /**
662 * A JSON string that contains the insight types you want to log on a trail. In this release, only ApiCallRateInsight is supported as an insight type.
663 */
664 InsightSelectors?: InsightSelectors;
665 }
666 export type ReadWriteType = "ReadOnly"|"WriteOnly"|"All"|string;
667 export interface RemoveTagsRequest {
668 /**
669 * Specifies the ARN of the trail from which tags should be removed. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
670 */
671 ResourceId: String;
672 /**
673 * Specifies a list of tags to be removed.
674 */
675 TagsList?: TagsList;
676 }
677 export interface RemoveTagsResponse {
678 }
679 export interface Resource {
680 /**
681 * The type of a resource referenced by the event returned. When the resource type cannot be determined, null is returned. Some examples of resource types are: Instance for EC2, Trail for CloudTrail, DBInstance for RDS, and AccessKey for IAM. To learn more about how to look up and filter events by the resource types supported for a service, see Filtering CloudTrail Events.
682 */
683 ResourceType?: String;
684 /**
685 * 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.
686 */
687 ResourceName?: String;
688 }
689 export type ResourceIdList = String[];
690 export type ResourceList = Resource[];
691 export interface ResourceTag {
692 /**
693 * Specifies the ARN of the resource.
694 */
695 ResourceId?: String;
696 /**
697 * A list of tags.
698 */
699 TagsList?: TagsList;
700 }
701 export type ResourceTagList = ResourceTag[];
702 export interface StartLoggingRequest {
703 /**
704 * Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs AWS API calls. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
705 */
706 Name: String;
707 }
708 export interface StartLoggingResponse {
709 }
710 export interface StopLoggingRequest {
711 /**
712 * Specifies the name or the CloudTrail ARN of the trail for which CloudTrail will stop logging AWS API calls. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
713 */
714 Name: String;
715 }
716 export interface StopLoggingResponse {
717 }
718 export type String = string;
719 export interface Tag {
720 /**
721 * The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be unique for the resource to which it applies.
722 */
723 Key: String;
724 /**
725 * The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.
726 */
727 Value?: String;
728 }
729 export type TagsList = Tag[];
730 export interface Trail {
731 /**
732 * Name of the trail set by calling CreateTrail. The maximum length is 128 characters.
733 */
734 Name?: String;
735 /**
736 * Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements.
737 */
738 S3BucketName?: String;
739 /**
740 * Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.The maximum length is 200 characters.
741 */
742 S3KeyPrefix?: String;
743 /**
744 * This field is no longer in use. Use SnsTopicARN.
745 */
746 SnsTopicName?: String;
747 /**
748 * 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: arn:aws:sns:us-east-2:123456789012:MyTopic
749 */
750 SnsTopicARN?: String;
751 /**
752 * Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
753 */
754 IncludeGlobalServiceEvents?: Boolean;
755 /**
756 * Specifies whether the trail exists only in one region or exists in all regions.
757 */
758 IsMultiRegionTrail?: Boolean;
759 /**
760 * The region in which the trail was created.
761 */
762 HomeRegion?: String;
763 /**
764 * Specifies the ARN of the trail. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
765 */
766 TrailARN?: String;
767 /**
768 * Specifies whether log file validation is enabled.
769 */
770 LogFileValidationEnabled?: Boolean;
771 /**
772 * Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
773 */
774 CloudWatchLogsLogGroupArn?: String;
775 /**
776 * Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
777 */
778 CloudWatchLogsRoleArn?: String;
779 /**
780 * 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 format: arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
781 */
782 KmsKeyId?: String;
783 /**
784 * Specifies if the trail has custom event selectors.
785 */
786 HasCustomEventSelectors?: Boolean;
787 /**
788 * Specifies whether a trail has insight types specified in an InsightSelector list.
789 */
790 HasInsightSelectors?: Boolean;
791 /**
792 * Specifies whether the trail is an organization trail.
793 */
794 IsOrganizationTrail?: Boolean;
795 }
796 export interface TrailInfo {
797 /**
798 * The ARN of a trail.
799 */
800 TrailARN?: String;
801 /**
802 * The name of a trail.
803 */
804 Name?: String;
805 /**
806 * The AWS region in which a trail was created.
807 */
808 HomeRegion?: String;
809 }
810 export type TrailList = Trail[];
811 export type TrailNameList = String[];
812 export type Trails = TrailInfo[];
813 export interface UpdateTrailRequest {
814 /**
815 * Specifies the name of the trail or trail ARN. If Name is a trail name, the string must meet the following requirements: Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) Start with a letter or number, and end with a letter or number Be between 3 and 128 characters Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid. Not be in IP address format (for example, 192.168.5.4) If Name is a trail ARN, it must be in the format: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
816 */
817 Name: String;
818 /**
819 * Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
820 */
821 S3BucketName?: String;
822 /**
823 * Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.
824 */
825 S3KeyPrefix?: String;
826 /**
827 * Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
828 */
829 SnsTopicName?: String;
830 /**
831 * Specifies whether the trail is publishing events from global services such as IAM to the log files.
832 */
833 IncludeGlobalServiceEvents?: Boolean;
834 /**
835 * 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, 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 where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions.
836 */
837 IsMultiRegionTrail?: Boolean;
838 /**
839 * Specifies whether log file validation is enabled. The default is false. When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable 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 January 10. The same applies whenever you stop CloudTrail logging or delete a trail.
840 */
841 EnableLogFileValidation?: Boolean;
842 /**
843 * Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.
844 */
845 CloudWatchLogsLogGroupArn?: String;
846 /**
847 * Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
848 */
849 CloudWatchLogsRoleArn?: String;
850 /**
851 * Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier. Examples: alias/MyAliasName arn:aws:kms:us-east-2:123456789012:alias/MyAliasName arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 12345678-1234-1234-1234-123456789012
852 */
853 KmsKeyId?: String;
854 /**
855 * Specifies whether the trail is applied to all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations. If the trail is not an organization trail and this is set to true, the trail will be created in all AWS accounts that belong to the organization. If the trail is an organization trail and this is set to false, the trail will remain in the current AWS account but be deleted from all member accounts in the organization.
856 */
857 IsOrganizationTrail?: Boolean;
858 }
859 export interface UpdateTrailResponse {
860 /**
861 * Specifies the name of the trail.
862 */
863 Name?: String;
864 /**
865 * Specifies the name of the Amazon S3 bucket designated for publishing log files.
866 */
867 S3BucketName?: String;
868 /**
869 * Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.
870 */
871 S3KeyPrefix?: String;
872 /**
873 * This field is no longer in use. Use SnsTopicARN.
874 */
875 SnsTopicName?: String;
876 /**
877 * 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: arn:aws:sns:us-east-2:123456789012:MyTopic
878 */
879 SnsTopicARN?: String;
880 /**
881 * Specifies whether the trail is publishing events from global services such as IAM to the log files.
882 */
883 IncludeGlobalServiceEvents?: Boolean;
884 /**
885 * Specifies whether the trail exists in one region or in all regions.
886 */
887 IsMultiRegionTrail?: Boolean;
888 /**
889 * Specifies the ARN of the trail that was updated. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
890 */
891 TrailARN?: String;
892 /**
893 * Specifies whether log file integrity validation is enabled.
894 */
895 LogFileValidationEnabled?: Boolean;
896 /**
897 * Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.
898 */
899 CloudWatchLogsLogGroupArn?: String;
900 /**
901 * Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
902 */
903 CloudWatchLogsRoleArn?: String;
904 /**
905 * 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 format: arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
906 */
907 KmsKeyId?: String;
908 /**
909 * Specifies whether the trail is an organization trail.
910 */
911 IsOrganizationTrail?: Boolean;
912 }
913 /**
914 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
915 */
916 export type apiVersion = "2013-11-01"|"latest"|string;
917 export interface ClientApiVersions {
918 /**
919 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
920 */
921 apiVersion?: apiVersion;
922 }
923 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
924 /**
925 * Contains interfaces for use with the CloudTrail client.
926 */
927 export import Types = CloudTrail;
928}
929export = CloudTrail;