Table of Contents
A low-level client representing AWS CloudTrail:
import boto3
client = boto3.client('cloudtrail')
These are the available methods:
Adds one or more tags to a trail, up to a limit of 50. Tags must be unique per trail. Overwrites an existing tag's value when a new value is specified for an existing tag key. 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 regions only from the region in which the trail was created (that is, from its home region).
See also: AWS API Documentation
Request Syntax
response = client.add_tags(
ResourceId='string',
TagsList=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
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
Contains a list of CloudTrail tags, up to a limit of 50
A custom key-value pair associated with a resource such as a CloudTrail trail.
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.
The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.
dict
Response Syntax
{}
Response Structure
(dict) --
Returns the objects or data listed below if successful. Otherwise, returns an error.
Check if an operation can be paginated.
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created.
See also: AWS API Documentation
Request Syntax
response = client.create_trail(
Name='string',
S3BucketName='string',
S3KeyPrefix='string',
SnsTopicName='string',
IncludeGlobalServiceEvents=True|False,
IsMultiRegionTrail=True|False,
EnableLogFileValidation=True|False,
CloudWatchLogsLogGroupArn='string',
CloudWatchLogsRoleArn='string',
KmsKeyId='string'
)
[REQUIRED]
Specifies the name of the trail. The name must meet the following requirements:
[REQUIRED]
Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements .
Specifies whether log file integrity validation is enabled. The default is false.
Note
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.
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:
dict
Response Syntax
{
'Name': 'string',
'S3BucketName': 'string',
'S3KeyPrefix': 'string',
'SnsTopicName': 'string',
'SnsTopicARN': 'string',
'IncludeGlobalServiceEvents': True|False,
'IsMultiRegionTrail': True|False,
'TrailARN': 'string',
'LogFileValidationEnabled': True|False,
'CloudWatchLogsLogGroupArn': 'string',
'CloudWatchLogsRoleArn': 'string',
'KmsKeyId': 'string'
}
Response Structure
(dict) --
Returns the objects or data listed below if successful. Otherwise, returns an error.
Name (string) --
Specifies the name of the trail.
S3BucketName (string) --
Specifies the name of the Amazon S3 bucket designated for publishing log files.
S3KeyPrefix (string) --
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 .
SnsTopicName (string) --
This field is deprecated. Use SnsTopicARN.
SnsTopicARN (string) --
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
IncludeGlobalServiceEvents (boolean) --
Specifies whether the trail is publishing events from global services such as IAM to the log files.
IsMultiRegionTrail (boolean) --
Specifies whether the trail exists in one region or in all regions.
TrailARN (string) --
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
LogFileValidationEnabled (boolean) --
Specifies whether log file integrity validation is enabled.
CloudWatchLogsLogGroupArn (string) --
Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.
CloudWatchLogsRoleArn (string) --
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
KmsKeyId (string) --
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
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.
See also: AWS API Documentation
Request Syntax
response = client.delete_trail(
Name='string'
)
[REQUIRED]
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
{}
Response Structure
Returns the objects or data listed below if successful. Otherwise, returns an error.
Retrieves settings for the trail associated with the current region for your account.
See also: AWS API Documentation
Request Syntax
response = client.describe_trails(
trailNameList=[
'string',
],
includeShadowTrails=True|False
)
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.
Note
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.
dict
Response Syntax
{
'trailList': [
{
'Name': 'string',
'S3BucketName': 'string',
'S3KeyPrefix': 'string',
'SnsTopicName': 'string',
'SnsTopicARN': 'string',
'IncludeGlobalServiceEvents': True|False,
'IsMultiRegionTrail': True|False,
'HomeRegion': 'string',
'TrailARN': 'string',
'LogFileValidationEnabled': True|False,
'CloudWatchLogsLogGroupArn': 'string',
'CloudWatchLogsRoleArn': 'string',
'KmsKeyId': 'string',
'HasCustomEventSelectors': True|False
},
]
}
Response Structure
(dict) --
Returns the objects or data listed below if successful. Otherwise, returns an error.
trailList (list) --
The list of trail objects.
(dict) --
The settings for a trail.
Name (string) --
Name of the trail set by calling CreateTrail . The maximum length is 128 characters.
S3BucketName (string) --
Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements .
S3KeyPrefix (string) --
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.
SnsTopicName (string) --
This field is deprecated. Use SnsTopicARN.
SnsTopicARN (string) --
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
IncludeGlobalServiceEvents (boolean) --
Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False .
IsMultiRegionTrail (boolean) --
Specifies whether the trail belongs only to one region or exists in all regions.
HomeRegion (string) --
The region in which the trail was created.
TrailARN (string) --
Specifies the ARN of the trail. The format of a trail ARN is:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
LogFileValidationEnabled (boolean) --
Specifies whether log file validation is enabled.
CloudWatchLogsLogGroupArn (string) --
Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
CloudWatchLogsRoleArn (string) --
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
KmsKeyId (string) --
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
HasCustomEventSelectors (boolean) --
Specifies if the trail has custom event selectors.
Generate a presigned url given a client, its method, and arguments
The presigned url
Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:
For more information, see Logging Data and Management Events for Trails in the AWS CloudTrail User Guide .
See also: AWS API Documentation
Request Syntax
response = client.get_event_selectors(
TrailName='string'
)
[REQUIRED]
Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements:
If you specify a trail ARN, it must be in the format:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
{
'TrailARN': 'string',
'EventSelectors': [
{
'ReadWriteType': 'ReadOnly'|'WriteOnly'|'All',
'IncludeManagementEvents': True|False,
'DataResources': [
{
'Type': 'string',
'Values': [
'string',
]
},
]
},
]
}
Response Structure
The specified trail ARN that has the event selectors.
The event selectors that are configured for the 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 selector for 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.
You can configure up to five event selectors for a trail.
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 .
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 .
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 .
The Amazon S3 buckets or AWS Lambda functions that you specify in your event selectors for your trail to log data events. Data events provide insight into the resource operations performed on or within a resource itself. These are also known as data plane operations. You can specify up to 250 data resources for a trail.
Note
The total number of allowed data resources is 250. This number can be distributed between 1 and 5 event selectors, but the total cannot exceed 250 across all selectors.
The following example demonstrates how logging works when you configure logging of all data events for an S3 bucket named bucket-1 . In this example, the CloudTrail user spcified an empty prefix, and the option to log both Read and Write data events.
The following example demonstrates how logging works when you configure logging of AWS Lambda data events for a Lambda function named MyLambdaFunction , but not for all AWS Lambda functions.
The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources.
An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.
Note
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.
Note
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.
Note
Lambda function ARNs are exact. Unlike S3, you cannot use matching. 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 .
Create a paginator for an operation.
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.
See also: AWS API Documentation
Request Syntax
response = client.get_trail_status(
Name='string'
)
[REQUIRED]
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
{
'IsLogging': True|False,
'LatestDeliveryError': 'string',
'LatestNotificationError': 'string',
'LatestDeliveryTime': datetime(2015, 1, 1),
'LatestNotificationTime': datetime(2015, 1, 1),
'StartLoggingTime': datetime(2015, 1, 1),
'StopLoggingTime': datetime(2015, 1, 1),
'LatestCloudWatchLogsDeliveryError': 'string',
'LatestCloudWatchLogsDeliveryTime': datetime(2015, 1, 1),
'LatestDigestDeliveryTime': datetime(2015, 1, 1),
'LatestDigestDeliveryError': 'string',
'LatestDeliveryAttemptTime': 'string',
'LatestNotificationAttemptTime': 'string',
'LatestNotificationAttemptSucceeded': 'string',
'LatestDeliveryAttemptSucceeded': 'string',
'TimeLoggingStarted': 'string',
'TimeLoggingStopped': 'string'
}
Response Structure
Returns the objects or data listed below if successful. Otherwise, returns an error.
Whether the CloudTrail is currently logging AWS API calls.
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.
Note
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.
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 .
Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.
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.
Specifies the most recent date and time when CloudTrail started recording API calls for an AWS account.
Specifies the most recent date and time when CloudTrail stopped recording API calls for an AWS account.
Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs.
Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.
Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket.
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.
Note
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.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
This field is deprecated.
Returns an object that can wait for some condition.
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.
Note
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.
See also: AWS API Documentation
Request Syntax
response = client.list_public_keys(
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
NextToken='string'
)
dict
Response Syntax
{
'PublicKeyList': [
{
'Value': b'bytes',
'ValidityStartTime': datetime(2015, 1, 1),
'ValidityEndTime': datetime(2015, 1, 1),
'Fingerprint': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Returns the objects or data listed below if successful. Otherwise, returns an error.
PublicKeyList (list) --
Contains an array of PublicKey objects.
Note
The returned public keys may have validity time ranges that overlap.
(dict) --
Contains information about a returned public key.
Value (bytes) --
The DER encoded public key value in PKCS#1 format.
ValidityStartTime (datetime) --
The starting time of validity of the public key.
ValidityEndTime (datetime) --
The ending time of validity of the public key.
Fingerprint (string) --
The fingerprint of the public key.
NextToken (string) --
Reserved for future use.
Lists the tags for the trail in the current region.
See also: AWS API Documentation
Request Syntax
response = client.list_tags(
ResourceIdList=[
'string',
],
NextToken='string'
)
[REQUIRED]
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
dict
Response Syntax
{
'ResourceTagList': [
{
'ResourceId': 'string',
'TagsList': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Returns the objects or data listed below if successful. Otherwise, returns an error.
ResourceTagList (list) --
A list of resource tags.
(dict) --
A resource tag.
ResourceId (string) --
Specifies the ARN of the resource.
TagsList (list) --
A list of tags.
(dict) --
A custom key-value pair associated with a resource such as a CloudTrail trail.
Key (string) --
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.
Value (string) --
The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.
NextToken (string) --
Reserved for future use.
Looks up management events captured by CloudTrail. Events for a region can be looked up in that region during the last 90 days. Lookup supports the following attributes:
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.
Warning
The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs.
Warning
Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.
See also: AWS API Documentation
Request Syntax
response = client.lookup_events(
LookupAttributes=[
{
'AttributeKey': 'EventId'|'EventName'|'ReadOnly'|'Username'|'ResourceType'|'ResourceName'|'EventSource'|'AccessKeyId',
'AttributeValue': 'string'
},
],
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
MaxResults=123,
NextToken='string'
)
Contains a list of lookup attributes. Currently the list can contain only one item.
Specifies an attribute and value that filter the events returned.
Specifies an attribute on which to filter the events returned.
Specifies a value for the specified AttributeKey.
dict
Response Syntax
{
'Events': [
{
'EventId': 'string',
'EventName': 'string',
'ReadOnly': 'string',
'AccessKeyId': 'string',
'EventTime': datetime(2015, 1, 1),
'EventSource': 'string',
'Username': 'string',
'Resources': [
{
'ResourceType': 'string',
'ResourceName': 'string'
},
],
'CloudTrailEvent': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains a response to a LookupEvents action.
Events (list) --
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.
(dict) --
Contains information about an event that was returned by a lookup request. The result includes a representation of a CloudTrail event.
EventId (string) --
The CloudTrail ID of the event returned.
EventName (string) --
The name of the event returned.
ReadOnly (string) --
Information about whether the event is a write event or a read event.
AccessKeyId (string) --
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.
EventTime (datetime) --
The date and time of the event returned.
EventSource (string) --
The AWS service that the request was made to.
Username (string) --
A user name or role name of the requester that called the API in the event returned.
Resources (list) --
A list of resources referenced by the event returned.
(dict) --
Specifies the type and name of a resource referenced by an event.
ResourceType (string) --
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. For a list of resource types supported for event lookup, see Resource Types Supported for Event Lookup .
ResourceName (string) --
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.
CloudTrailEvent (string) --
A JSON string that contains a representation of the event returned.
NextToken (string) --
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.
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
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 .
See also: AWS API Documentation
Request Syntax
response = client.put_event_selectors(
TrailName='string',
EventSelectors=[
{
'ReadWriteType': 'ReadOnly'|'WriteOnly'|'All',
'IncludeManagementEvents': True|False,
'DataResources': [
{
'Type': 'string',
'Values': [
'string',
]
},
]
},
]
)
[REQUIRED]
Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements:
If you specify a trail ARN, it must be in the format:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
[REQUIRED]
Specifies the settings for your event selectors. You can configure up to five event selectors for a 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 selector for 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.
You can configure up to five event selectors for a trail.
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 .
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 .
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 .
The Amazon S3 buckets or AWS Lambda functions that you specify in your event selectors for your trail to log data events. Data events provide insight into the resource operations performed on or within a resource itself. These are also known as data plane operations. You can specify up to 250 data resources for a trail.
Note
The total number of allowed data resources is 250. This number can be distributed between 1 and 5 event selectors, but the total cannot exceed 250 across all selectors.
The following example demonstrates how logging works when you configure logging of all data events for an S3 bucket named bucket-1 . In this example, the CloudTrail user spcified an empty prefix, and the option to log both Read and Write data events.
The following example demonstrates how logging works when you configure logging of AWS Lambda data events for a Lambda function named MyLambdaFunction , but not for all AWS Lambda functions.
The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources.
An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.
Note
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.
Note
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.
Note
Lambda function ARNs are exact. Unlike S3, you cannot use matching. 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 .
dict
Response Syntax
{
'TrailARN': 'string',
'EventSelectors': [
{
'ReadWriteType': 'ReadOnly'|'WriteOnly'|'All',
'IncludeManagementEvents': True|False,
'DataResources': [
{
'Type': 'string',
'Values': [
'string',
]
},
]
},
]
}
Response Structure
(dict) --
TrailARN (string) --
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
EventSelectors (list) --
Specifies the event selectors configured for your trail.
(dict) --
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 selector for 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.
You can configure up to five event selectors for a trail.
ReadWriteType (string) --
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 .
IncludeManagementEvents (boolean) --
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 .
DataResources (list) --
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 .
(dict) --
The Amazon S3 buckets or AWS Lambda functions that you specify in your event selectors for your trail to log data events. Data events provide insight into the resource operations performed on or within a resource itself. These are also known as data plane operations. You can specify up to 250 data resources for a trail.
Note
The total number of allowed data resources is 250. This number can be distributed between 1 and 5 event selectors, but the total cannot exceed 250 across all selectors.
The following example demonstrates how logging works when you configure logging of all data events for an S3 bucket named bucket-1 . In this example, the CloudTrail user spcified an empty prefix, and the option to log both Read and Write data events.
The following example demonstrates how logging works when you configure logging of AWS Lambda data events for a Lambda function named MyLambdaFunction , but not for all AWS Lambda functions.
Type (string) --
The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources.
Values (list) --
An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.
Note
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.
Note
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.
Note
Lambda function ARNs are exact. Unlike S3, you cannot use matching. 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 .
Removes the specified tags from a trail.
See also: AWS API Documentation
Request Syntax
response = client.remove_tags(
ResourceId='string',
TagsList=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
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
Specifies a list of tags to be removed.
A custom key-value pair associated with a resource such as a CloudTrail trail.
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.
The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.
dict
Response Syntax
{}
Response Structure
(dict) --
Returns the objects or data listed below if successful. Otherwise, returns an error.
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.
See also: AWS API Documentation
Request Syntax
response = client.start_logging(
Name='string'
)
[REQUIRED]
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
{}
Response Structure
Returns the objects or data listed below if successful. Otherwise, returns an error.
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.
See also: AWS API Documentation
Request Syntax
response = client.stop_logging(
Name='string'
)
[REQUIRED]
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
{}
Response Structure
Returns the objects or data listed below if successful. Otherwise, returns an error.
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.
See also: AWS API Documentation
Request Syntax
response = client.update_trail(
Name='string',
S3BucketName='string',
S3KeyPrefix='string',
SnsTopicName='string',
IncludeGlobalServiceEvents=True|False,
IsMultiRegionTrail=True|False,
EnableLogFileValidation=True|False,
CloudWatchLogsLogGroupArn='string',
CloudWatchLogsRoleArn='string',
KmsKeyId='string'
)
[REQUIRED]
Specifies the name of the trail or trail ARN. If Name is a trail name, the string must meet the following requirements:
If Name is a trail ARN, it must be in the format:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
Specifies whether log file validation is enabled. The default is false.
Note
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.
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:
dict
Response Syntax
{
'Name': 'string',
'S3BucketName': 'string',
'S3KeyPrefix': 'string',
'SnsTopicName': 'string',
'SnsTopicARN': 'string',
'IncludeGlobalServiceEvents': True|False,
'IsMultiRegionTrail': True|False,
'TrailARN': 'string',
'LogFileValidationEnabled': True|False,
'CloudWatchLogsLogGroupArn': 'string',
'CloudWatchLogsRoleArn': 'string',
'KmsKeyId': 'string'
}
Response Structure
(dict) --
Returns the objects or data listed below if successful. Otherwise, returns an error.
Name (string) --
Specifies the name of the trail.
S3BucketName (string) --
Specifies the name of the Amazon S3 bucket designated for publishing log files.
S3KeyPrefix (string) --
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 .
SnsTopicName (string) --
This field is deprecated. Use SnsTopicARN.
SnsTopicARN (string) --
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
IncludeGlobalServiceEvents (boolean) --
Specifies whether the trail is publishing events from global services such as IAM to the log files.
IsMultiRegionTrail (boolean) --
Specifies whether the trail exists in one region or in all regions.
TrailARN (string) --
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
LogFileValidationEnabled (boolean) --
Specifies whether log file integrity validation is enabled.
CloudWatchLogsLogGroupArn (string) --
Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.
CloudWatchLogsRoleArn (string) --
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
KmsKeyId (string) --
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
The available paginators are:
paginator = client.get_paginator('lookup_events')
Creates an iterator that will paginate through responses from CloudTrail.Client.lookup_events().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
LookupAttributes=[
{
'AttributeKey': 'EventId'|'EventName'|'ReadOnly'|'Username'|'ResourceType'|'ResourceName'|'EventSource'|'AccessKeyId',
'AttributeValue': 'string'
},
],
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Contains a list of lookup attributes. Currently the list can contain only one item.
Specifies an attribute and value that filter the events returned.
Specifies an attribute on which to filter the events returned.
Specifies a value for the specified AttributeKey.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Events': [
{
'EventId': 'string',
'EventName': 'string',
'ReadOnly': 'string',
'AccessKeyId': 'string',
'EventTime': datetime(2015, 1, 1),
'EventSource': 'string',
'Username': 'string',
'Resources': [
{
'ResourceType': 'string',
'ResourceName': 'string'
},
],
'CloudTrailEvent': 'string'
},
],
}
Response Structure
(dict) --
Contains a response to a LookupEvents action.
Events (list) --
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.
(dict) --
Contains information about an event that was returned by a lookup request. The result includes a representation of a CloudTrail event.
EventId (string) --
The CloudTrail ID of the event returned.
EventName (string) --
The name of the event returned.
ReadOnly (string) --
Information about whether the event is a write event or a read event.
AccessKeyId (string) --
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.
EventTime (datetime) --
The date and time of the event returned.
EventSource (string) --
The AWS service that the request was made to.
Username (string) --
A user name or role name of the requester that called the API in the event returned.
Resources (list) --
A list of resources referenced by the event returned.
(dict) --
Specifies the type and name of a resource referenced by an event.
ResourceType (string) --
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. For a list of resource types supported for event lookup, see Resource Types Supported for Event Lookup .
ResourceName (string) --
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.
CloudTrailEvent (string) --
A JSON string that contains a representation of the event returned.