2022/01/05 - AWS CloudTrail - 11 new api methods
Changes This release adds support for CloudTrail Lake, a new feature that lets you run SQL-based queries on events that you have aggregated into event data stores. New APIs have been added for creating and managing event data stores, and creating, running, and managing queries in CloudTrail Lake.
Restores a deleted event data store specified by EventDataStore , which accepts an event data store ARN. You can only restore a deleted event data store within the seven-day wait period after deletion. Restoring an event data store can take several minutes, depending on the size of the event data store.
See also: AWS API Documentation
Request Syntax
client.restore_event_data_store(
EventDataStore='string'
)
string
[REQUIRED]
The ARN (or the ID suffix of the ARN) of the event data store that you want to restore.
dict
Response Syntax
{
'EventDataStoreArn': 'string',
'Name': 'string',
'Status': 'CREATED'|'ENABLED'|'PENDING_DELETION',
'AdvancedEventSelectors': [
{
'Name': 'string',
'FieldSelectors': [
{
'Field': 'string',
'Equals': [
'string',
],
'StartsWith': [
'string',
],
'EndsWith': [
'string',
],
'NotEquals': [
'string',
],
'NotStartsWith': [
'string',
],
'NotEndsWith': [
'string',
]
},
]
},
],
'MultiRegionEnabled': True|False,
'OrganizationEnabled': True|False,
'RetentionPeriod': 123,
'TerminationProtectionEnabled': True|False,
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
EventDataStoreArn (string) --
The event data store ARN.
Name (string) --
The name of the event data store.
Status (string) --
The status of the event data store.
AdvancedEventSelectors (list) --
The advanced event selectors that were used to select events.
(dict) --
Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide .
readOnly
eventSource
eventName
eventCategory
resources.type
resources.ARN
You cannot apply both event selectors and advanced event selectors to a trail.
Name (string) --
An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".
FieldSelectors (list) --
Contains all selector statements in an advanced event selector.
(dict) --
A single selector statement in an advanced event selector.
Field (string) --
A field in an event record on which to filter events to be logged. Supported fields include readOnly , eventCategory , eventSource (for management events), eventName , resources.type , and resources.ARN .
**readOnly ** - Optional. Can be set to Equals a value of true or false . A value of false logs both read and write events.
**eventSource ** - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com .
**eventName ** - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock . You can have multiple values for this field, separated by commas.
**eventCategory ** - This is required. It must be set to Equals , and the value must be Management or Data .
**resources.type ** - This field is required. resources.type can only use the Equals operator, and the value can be one of the following:
AWS::S3::Object
AWS::Lambda::Function
AWS::DynamoDB::Table
AWS::S3Outposts::Object
AWS::ManagedBlockchain::Node
AWS::S3ObjectLambda::AccessPoint
AWS::EC2::Snapshot
AWS::S3::AccessPoint
AWS::DynamoDB::Stream
You can have only one resources.type field per selector. To log data events on more than one resource type, add another selector.
**resources.ARN ** - You can use any operator with resources.ARN , but if you use Equals or NotEquals , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. For example, if resources.type equals AWS::S3::Object , the ARN must be in one of the following formats. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value. The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
arn:<partition>:s3:::<bucket_name>/
arn:<partition>:s3:::<bucket_name>/<object_path>/
When resources.type equals AWS::S3::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the StartsWith or NotStartsWith operators.
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>
When resources.type equals AWS::Lambda::Function , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>
When resources.type equals AWS::DynamoDB::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>
When resources.type equals AWS::S3Outposts::Object , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>
When resources.type equals AWS::ManagedBlockchain::Node , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>
When resources.type equals AWS::S3ObjectLambda::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>
When resources.type equals AWS::EC2::Snapshot , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>
When resources.type equals AWS::DynamoDB::Stream , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>
Equals (list) --
An operator that includes events that match the exact value of the event record field specified as the value of Field . This is the only valid operator that you can use with the readOnly , eventCategory , and resources.type fields.
(string) --
StartsWith (list) --
An operator that includes events that match the first few characters of the event record field specified as the value of Field .
(string) --
EndsWith (list) --
An operator that includes events that match the last few characters of the event record field specified as the value of Field .
(string) --
NotEquals (list) --
An operator that excludes events that match the exact value of the event record field specified as the value of Field .
(string) --
NotStartsWith (list) --
An operator that excludes events that match the first few characters of the event record field specified as the value of Field .
(string) --
NotEndsWith (list) --
An operator that excludes events that match the last few characters of the event record field specified as the value of Field .
(string) --
MultiRegionEnabled (boolean) --
Indicates whether the event data store is collecting events from all regions, or only from the region in which the event data store was created.
OrganizationEnabled (boolean) --
Indicates whether an event data store is collecting logged events for an organization in Organizations.
RetentionPeriod (integer) --
The retention period, in days.
TerminationProtectionEnabled (boolean) --
Indicates that termination protection is enabled and the event data store cannot be automatically deleted.
CreatedTimestamp (datetime) --
The timestamp of an event data store's creation.
UpdatedTimestamp (datetime) --
The timestamp that shows when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp .
Gets event data results of a query. You must specify the QueryID value returned by the StartQuery operation, and an ARN for EventDataStore .
See also: AWS API Documentation
Request Syntax
client.get_query_results(
EventDataStore='string',
QueryId='string',
NextToken='string',
MaxQueryResults=123
)
string
[REQUIRED]
The ARN (or ID suffix of the ARN) of the event data store against which the query was run.
string
[REQUIRED]
The ID of the query for which you want to get results.
string
A token you can use to get the next page of query results.
integer
The maximum number of query results to display on a single page.
dict
Response Syntax
{
'QueryStatus': 'QUEUED'|'RUNNING'|'FINISHED'|'FAILED'|'CANCELLED',
'QueryStatistics': {
'ResultsCount': 123,
'TotalResultsCount': 123
},
'QueryResultRows': [
[
{
'string': 'string'
},
],
],
'NextToken': 'string',
'ErrorMessage': 'string'
}
Response Structure
(dict) --
QueryStatus (string) --
The status of the query. Values include QUEUED , RUNNING , FINISHED , FAILED , or CANCELLED .
QueryStatistics (dict) --
Shows the count of query results.
ResultsCount (integer) --
The number of results returned.
TotalResultsCount (integer) --
The total number of results returned by a query.
QueryResultRows (list) --
Contains the individual event results of the query.
(list) --
(dict) --
(string) --
(string) --
NextToken (string) --
A token you can use to get the next page of query results.
ErrorMessage (string) --
The error message returned if a query failed.
Creates a new event data store.
See also: AWS API Documentation
Request Syntax
client.create_event_data_store(
Name='string',
AdvancedEventSelectors=[
{
'Name': 'string',
'FieldSelectors': [
{
'Field': 'string',
'Equals': [
'string',
],
'StartsWith': [
'string',
],
'EndsWith': [
'string',
],
'NotEquals': [
'string',
],
'NotStartsWith': [
'string',
],
'NotEndsWith': [
'string',
]
},
]
},
],
MultiRegionEnabled=True|False,
OrganizationEnabled=True|False,
RetentionPeriod=123,
TerminationProtectionEnabled=True|False,
TagsList=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the event data store.
list
The advanced event selectors to use to select the events for the data store. For more information about how to use advanced event selectors, see Log events by using advanced event selectors in the CloudTrail User Guide.
(dict) --
Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide .
readOnly
eventSource
eventName
eventCategory
resources.type
resources.ARN
You cannot apply both event selectors and advanced event selectors to a trail.
Name (string) --
An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".
FieldSelectors (list) -- [REQUIRED]
Contains all selector statements in an advanced event selector.
(dict) --
A single selector statement in an advanced event selector.
Field (string) -- [REQUIRED]
A field in an event record on which to filter events to be logged. Supported fields include readOnly , eventCategory , eventSource (for management events), eventName , resources.type , and resources.ARN .
**readOnly ** - Optional. Can be set to Equals a value of true or false . A value of false logs both read and write events.
**eventSource ** - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com .
**eventName ** - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock . You can have multiple values for this field, separated by commas.
**eventCategory ** - This is required. It must be set to Equals , and the value must be Management or Data .
**resources.type ** - This field is required. resources.type can only use the Equals operator, and the value can be one of the following:
AWS::S3::Object
AWS::Lambda::Function
AWS::DynamoDB::Table
AWS::S3Outposts::Object
AWS::ManagedBlockchain::Node
AWS::S3ObjectLambda::AccessPoint
AWS::EC2::Snapshot
AWS::S3::AccessPoint
AWS::DynamoDB::Stream
You can have only one resources.type field per selector. To log data events on more than one resource type, add another selector.
**resources.ARN ** - You can use any operator with resources.ARN , but if you use Equals or NotEquals , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. For example, if resources.type equals AWS::S3::Object , the ARN must be in one of the following formats. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value. The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
arn:<partition>:s3:::<bucket_name>/
arn:<partition>:s3:::<bucket_name>/<object_path>/
When resources.type equals AWS::S3::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the StartsWith or NotStartsWith operators.
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>
When resources.type equals AWS::Lambda::Function , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>
When resources.type equals AWS::DynamoDB::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>
When resources.type equals AWS::S3Outposts::Object , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>
When resources.type equals AWS::ManagedBlockchain::Node , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>
When resources.type equals AWS::S3ObjectLambda::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>
When resources.type equals AWS::EC2::Snapshot , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>
When resources.type equals AWS::DynamoDB::Stream , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>
Equals (list) --
An operator that includes events that match the exact value of the event record field specified as the value of Field . This is the only valid operator that you can use with the readOnly , eventCategory , and resources.type fields.
(string) --
StartsWith (list) --
An operator that includes events that match the first few characters of the event record field specified as the value of Field .
(string) --
EndsWith (list) --
An operator that includes events that match the last few characters of the event record field specified as the value of Field .
(string) --
NotEquals (list) --
An operator that excludes events that match the exact value of the event record field specified as the value of Field .
(string) --
NotStartsWith (list) --
An operator that excludes events that match the first few characters of the event record field specified as the value of Field .
(string) --
NotEndsWith (list) --
An operator that excludes events that match the last few characters of the event record field specified as the value of Field .
(string) --
boolean
Specifies whether the event data store includes events from all regions, or only from the region in which the event data store is created.
boolean
Specifies whether an event data store collects events logged for an organization in Organizations.
integer
The retention period of the event data store, in days. You can set a retention period of up to 2555 days, the equivalent of seven years.
boolean
Specifies whether termination protection is enabled for the event data store. If termination protection is enabled, you cannot delete the event data store until termination protection is disabled.
list
A list of tags.
(dict) --
A custom key-value pair associated with a resource such as a CloudTrail trail.
Key (string) -- [REQUIRED]
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.
dict
Response Syntax
{
'EventDataStoreArn': 'string',
'Name': 'string',
'Status': 'CREATED'|'ENABLED'|'PENDING_DELETION',
'AdvancedEventSelectors': [
{
'Name': 'string',
'FieldSelectors': [
{
'Field': 'string',
'Equals': [
'string',
],
'StartsWith': [
'string',
],
'EndsWith': [
'string',
],
'NotEquals': [
'string',
],
'NotStartsWith': [
'string',
],
'NotEndsWith': [
'string',
]
},
]
},
],
'MultiRegionEnabled': True|False,
'OrganizationEnabled': True|False,
'RetentionPeriod': 123,
'TerminationProtectionEnabled': True|False,
'TagsList': [
{
'Key': 'string',
'Value': 'string'
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
EventDataStoreArn (string) --
The ARN of the event data store.
Name (string) --
The name of the event data store.
Status (string) --
The status of event data store creation.
AdvancedEventSelectors (list) --
The advanced event selectors that were used to select the events for the data store.
(dict) --
Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide .
readOnly
eventSource
eventName
eventCategory
resources.type
resources.ARN
You cannot apply both event selectors and advanced event selectors to a trail.
Name (string) --
An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".
FieldSelectors (list) --
Contains all selector statements in an advanced event selector.
(dict) --
A single selector statement in an advanced event selector.
Field (string) --
A field in an event record on which to filter events to be logged. Supported fields include readOnly , eventCategory , eventSource (for management events), eventName , resources.type , and resources.ARN .
**readOnly ** - Optional. Can be set to Equals a value of true or false . A value of false logs both read and write events.
**eventSource ** - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com .
**eventName ** - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock . You can have multiple values for this field, separated by commas.
**eventCategory ** - This is required. It must be set to Equals , and the value must be Management or Data .
**resources.type ** - This field is required. resources.type can only use the Equals operator, and the value can be one of the following:
AWS::S3::Object
AWS::Lambda::Function
AWS::DynamoDB::Table
AWS::S3Outposts::Object
AWS::ManagedBlockchain::Node
AWS::S3ObjectLambda::AccessPoint
AWS::EC2::Snapshot
AWS::S3::AccessPoint
AWS::DynamoDB::Stream
You can have only one resources.type field per selector. To log data events on more than one resource type, add another selector.
**resources.ARN ** - You can use any operator with resources.ARN , but if you use Equals or NotEquals , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. For example, if resources.type equals AWS::S3::Object , the ARN must be in one of the following formats. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value. The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
arn:<partition>:s3:::<bucket_name>/
arn:<partition>:s3:::<bucket_name>/<object_path>/
When resources.type equals AWS::S3::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the StartsWith or NotStartsWith operators.
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>
When resources.type equals AWS::Lambda::Function , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>
When resources.type equals AWS::DynamoDB::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>
When resources.type equals AWS::S3Outposts::Object , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>
When resources.type equals AWS::ManagedBlockchain::Node , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>
When resources.type equals AWS::S3ObjectLambda::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>
When resources.type equals AWS::EC2::Snapshot , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>
When resources.type equals AWS::DynamoDB::Stream , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>
Equals (list) --
An operator that includes events that match the exact value of the event record field specified as the value of Field . This is the only valid operator that you can use with the readOnly , eventCategory , and resources.type fields.
(string) --
StartsWith (list) --
An operator that includes events that match the first few characters of the event record field specified as the value of Field .
(string) --
EndsWith (list) --
An operator that includes events that match the last few characters of the event record field specified as the value of Field .
(string) --
NotEquals (list) --
An operator that excludes events that match the exact value of the event record field specified as the value of Field .
(string) --
NotStartsWith (list) --
An operator that excludes events that match the first few characters of the event record field specified as the value of Field .
(string) --
NotEndsWith (list) --
An operator that excludes events that match the last few characters of the event record field specified as the value of Field .
(string) --
MultiRegionEnabled (boolean) --
Indicates whether the event data store collects events from all regions, or only from the region in which it was created.
OrganizationEnabled (boolean) --
Indicates whether an event data store is collecting logged events for an organization in Organizations.
RetentionPeriod (integer) --
The retention period of an event data store, in days.
TerminationProtectionEnabled (boolean) --
Indicates whether termination protection is enabled for the event data store.
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.
CreatedTimestamp (datetime) --
The timestamp that shows when the event data store was created.
UpdatedTimestamp (datetime) --
The timestamp that shows when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp .
Updates an event data store. The required EventDataStore value is an ARN or the ID portion of the ARN. Other parameters are optional, but at least one optional parameter must be specified, or CloudTrail throws an error. RetentionPeriod is in days, and valid values are integers between 90 and 2555. By default, TerminationProtection is enabled. AdvancedEventSelectors includes or excludes management and data events in your event data store; for more information about AdvancedEventSelectors , see PutEventSelectorsRequest$AdvancedEventSelectors .
See also: AWS API Documentation
Request Syntax
client.update_event_data_store(
EventDataStore='string',
Name='string',
AdvancedEventSelectors=[
{
'Name': 'string',
'FieldSelectors': [
{
'Field': 'string',
'Equals': [
'string',
],
'StartsWith': [
'string',
],
'EndsWith': [
'string',
],
'NotEquals': [
'string',
],
'NotStartsWith': [
'string',
],
'NotEndsWith': [
'string',
]
},
]
},
],
MultiRegionEnabled=True|False,
OrganizationEnabled=True|False,
RetentionPeriod=123,
TerminationProtectionEnabled=True|False
)
string
[REQUIRED]
The ARN (or the ID suffix of the ARN) of the event data store that you want to update.
string
The event data store name.
list
The advanced event selectors used to select events for the event data store.
(dict) --
Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide .
readOnly
eventSource
eventName
eventCategory
resources.type
resources.ARN
You cannot apply both event selectors and advanced event selectors to a trail.
Name (string) --
An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".
FieldSelectors (list) -- [REQUIRED]
Contains all selector statements in an advanced event selector.
(dict) --
A single selector statement in an advanced event selector.
Field (string) -- [REQUIRED]
A field in an event record on which to filter events to be logged. Supported fields include readOnly , eventCategory , eventSource (for management events), eventName , resources.type , and resources.ARN .
**readOnly ** - Optional. Can be set to Equals a value of true or false . A value of false logs both read and write events.
**eventSource ** - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com .
**eventName ** - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock . You can have multiple values for this field, separated by commas.
**eventCategory ** - This is required. It must be set to Equals , and the value must be Management or Data .
**resources.type ** - This field is required. resources.type can only use the Equals operator, and the value can be one of the following:
AWS::S3::Object
AWS::Lambda::Function
AWS::DynamoDB::Table
AWS::S3Outposts::Object
AWS::ManagedBlockchain::Node
AWS::S3ObjectLambda::AccessPoint
AWS::EC2::Snapshot
AWS::S3::AccessPoint
AWS::DynamoDB::Stream
You can have only one resources.type field per selector. To log data events on more than one resource type, add another selector.
**resources.ARN ** - You can use any operator with resources.ARN , but if you use Equals or NotEquals , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. For example, if resources.type equals AWS::S3::Object , the ARN must be in one of the following formats. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value. The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
arn:<partition>:s3:::<bucket_name>/
arn:<partition>:s3:::<bucket_name>/<object_path>/
When resources.type equals AWS::S3::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the StartsWith or NotStartsWith operators.
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>
When resources.type equals AWS::Lambda::Function , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>
When resources.type equals AWS::DynamoDB::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>
When resources.type equals AWS::S3Outposts::Object , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>
When resources.type equals AWS::ManagedBlockchain::Node , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>
When resources.type equals AWS::S3ObjectLambda::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>
When resources.type equals AWS::EC2::Snapshot , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>
When resources.type equals AWS::DynamoDB::Stream , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>
Equals (list) --
An operator that includes events that match the exact value of the event record field specified as the value of Field . This is the only valid operator that you can use with the readOnly , eventCategory , and resources.type fields.
(string) --
StartsWith (list) --
An operator that includes events that match the first few characters of the event record field specified as the value of Field .
(string) --
EndsWith (list) --
An operator that includes events that match the last few characters of the event record field specified as the value of Field .
(string) --
NotEquals (list) --
An operator that excludes events that match the exact value of the event record field specified as the value of Field .
(string) --
NotStartsWith (list) --
An operator that excludes events that match the first few characters of the event record field specified as the value of Field .
(string) --
NotEndsWith (list) --
An operator that excludes events that match the last few characters of the event record field specified as the value of Field .
(string) --
boolean
Specifies whether an event data store collects events from all regions, or only from the region in which it was created.
boolean
Specifies whether an event data store collects events logged for an organization in Organizations.
integer
The retention period, in days.
boolean
Indicates that termination protection is enabled and the event data store cannot be automatically deleted.
dict
Response Syntax
{
'EventDataStoreArn': 'string',
'Name': 'string',
'Status': 'CREATED'|'ENABLED'|'PENDING_DELETION',
'AdvancedEventSelectors': [
{
'Name': 'string',
'FieldSelectors': [
{
'Field': 'string',
'Equals': [
'string',
],
'StartsWith': [
'string',
],
'EndsWith': [
'string',
],
'NotEquals': [
'string',
],
'NotStartsWith': [
'string',
],
'NotEndsWith': [
'string',
]
},
]
},
],
'MultiRegionEnabled': True|False,
'OrganizationEnabled': True|False,
'RetentionPeriod': 123,
'TerminationProtectionEnabled': True|False,
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
EventDataStoreArn (string) --
The ARN of the event data store.
Name (string) --
The name of the event data store.
Status (string) --
The status of an event data store. Values can be ENABLED and PENDING_DELETION .
AdvancedEventSelectors (list) --
The advanced event selectors that are applied to the event data store.
(dict) --
Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide .
readOnly
eventSource
eventName
eventCategory
resources.type
resources.ARN
You cannot apply both event selectors and advanced event selectors to a trail.
Name (string) --
An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".
FieldSelectors (list) --
Contains all selector statements in an advanced event selector.
(dict) --
A single selector statement in an advanced event selector.
Field (string) --
A field in an event record on which to filter events to be logged. Supported fields include readOnly , eventCategory , eventSource (for management events), eventName , resources.type , and resources.ARN .
**readOnly ** - Optional. Can be set to Equals a value of true or false . A value of false logs both read and write events.
**eventSource ** - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com .
**eventName ** - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock . You can have multiple values for this field, separated by commas.
**eventCategory ** - This is required. It must be set to Equals , and the value must be Management or Data .
**resources.type ** - This field is required. resources.type can only use the Equals operator, and the value can be one of the following:
AWS::S3::Object
AWS::Lambda::Function
AWS::DynamoDB::Table
AWS::S3Outposts::Object
AWS::ManagedBlockchain::Node
AWS::S3ObjectLambda::AccessPoint
AWS::EC2::Snapshot
AWS::S3::AccessPoint
AWS::DynamoDB::Stream
You can have only one resources.type field per selector. To log data events on more than one resource type, add another selector.
**resources.ARN ** - You can use any operator with resources.ARN , but if you use Equals or NotEquals , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. For example, if resources.type equals AWS::S3::Object , the ARN must be in one of the following formats. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value. The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
arn:<partition>:s3:::<bucket_name>/
arn:<partition>:s3:::<bucket_name>/<object_path>/
When resources.type equals AWS::S3::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the StartsWith or NotStartsWith operators.
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>
When resources.type equals AWS::Lambda::Function , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>
When resources.type equals AWS::DynamoDB::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>
When resources.type equals AWS::S3Outposts::Object , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>
When resources.type equals AWS::ManagedBlockchain::Node , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>
When resources.type equals AWS::S3ObjectLambda::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>
When resources.type equals AWS::EC2::Snapshot , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>
When resources.type equals AWS::DynamoDB::Stream , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>
Equals (list) --
An operator that includes events that match the exact value of the event record field specified as the value of Field . This is the only valid operator that you can use with the readOnly , eventCategory , and resources.type fields.
(string) --
StartsWith (list) --
An operator that includes events that match the first few characters of the event record field specified as the value of Field .
(string) --
EndsWith (list) --
An operator that includes events that match the last few characters of the event record field specified as the value of Field .
(string) --
NotEquals (list) --
An operator that excludes events that match the exact value of the event record field specified as the value of Field .
(string) --
NotStartsWith (list) --
An operator that excludes events that match the first few characters of the event record field specified as the value of Field .
(string) --
NotEndsWith (list) --
An operator that excludes events that match the last few characters of the event record field specified as the value of Field .
(string) --
MultiRegionEnabled (boolean) --
Indicates whether the event data store includes events from all regions, or only from the region in which it was created.
OrganizationEnabled (boolean) --
Indicates whether an event data store is collecting logged events for an organization in Organizations.
RetentionPeriod (integer) --
The retention period, in days.
TerminationProtectionEnabled (boolean) --
Indicates whether termination protection is enabled for the event data store.
CreatedTimestamp (datetime) --
The timestamp that shows when an event data store was first created.
UpdatedTimestamp (datetime) --
The timestamp that shows when the event data store was last updated. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp .
Cancels a query if the query is not in a terminated state, such as CANCELLED , FAILED or FINISHED . You must specify an ARN value for EventDataStore . The ID of the query that you want to cancel is also required. When you run CancelQuery , the query status might show as CANCELLED even if the operation is not yet finished.
See also: AWS API Documentation
Request Syntax
client.cancel_query(
EventDataStore='string',
QueryId='string'
)
string
[REQUIRED]
The ARN (or the ID suffix of the ARN) of an event data store on which the specified query is running.
string
[REQUIRED]
The ID of the query that you want to cancel. The QueryId comes from the response of a StartQuery operation.
dict
Response Syntax
{
'QueryId': 'string',
'QueryStatus': 'QUEUED'|'RUNNING'|'FINISHED'|'FAILED'|'CANCELLED'
}
Response Structure
(dict) --
QueryId (string) --
The ID of the canceled query.
QueryStatus (string) --
Shows the status of a query after a CancelQuery request. Typically, the values shown are either RUNNING or CANCELLED .
Disables the event data store specified by EventDataStore , which accepts an event data store ARN. After you run DeleteEventDataStore , the event data store is automatically deleted after a wait period of seven days. TerminationProtectionEnabled must be set to False on the event data store; this operation cannot work if TerminationProtectionEnabled is True .
After you run DeleteEventDataStore on an event data store, you cannot run ListQueries , DescribeQuery , or GetQueryResults on queries that are using an event data store in a PENDING_DELETION state.
See also: AWS API Documentation
Request Syntax
client.delete_event_data_store(
EventDataStore='string'
)
string
[REQUIRED]
The ARN (or the ID suffix of the ARN) of the event data store to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Returns information about an event data store specified as either an ARN or the ID portion of the ARN.
See also: AWS API Documentation
Request Syntax
client.get_event_data_store(
EventDataStore='string'
)
string
[REQUIRED]
The ARN (or ID suffix of the ARN) of the event data store about which you want information.
dict
Response Syntax
{
'EventDataStoreArn': 'string',
'Name': 'string',
'Status': 'CREATED'|'ENABLED'|'PENDING_DELETION',
'AdvancedEventSelectors': [
{
'Name': 'string',
'FieldSelectors': [
{
'Field': 'string',
'Equals': [
'string',
],
'StartsWith': [
'string',
],
'EndsWith': [
'string',
],
'NotEquals': [
'string',
],
'NotStartsWith': [
'string',
],
'NotEndsWith': [
'string',
]
},
]
},
],
'MultiRegionEnabled': True|False,
'OrganizationEnabled': True|False,
'RetentionPeriod': 123,
'TerminationProtectionEnabled': True|False,
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
EventDataStoreArn (string) --
The event data store Amazon Resource Number (ARN).
Name (string) --
The name of the event data store.
Status (string) --
The status of an event data store. Values can be ENABLED and PENDING_DELETION .
AdvancedEventSelectors (list) --
The advanced event selectors used to select events for the data store.
(dict) --
Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide .
readOnly
eventSource
eventName
eventCategory
resources.type
resources.ARN
You cannot apply both event selectors and advanced event selectors to a trail.
Name (string) --
An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".
FieldSelectors (list) --
Contains all selector statements in an advanced event selector.
(dict) --
A single selector statement in an advanced event selector.
Field (string) --
A field in an event record on which to filter events to be logged. Supported fields include readOnly , eventCategory , eventSource (for management events), eventName , resources.type , and resources.ARN .
**readOnly ** - Optional. Can be set to Equals a value of true or false . A value of false logs both read and write events.
**eventSource ** - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com .
**eventName ** - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock . You can have multiple values for this field, separated by commas.
**eventCategory ** - This is required. It must be set to Equals , and the value must be Management or Data .
**resources.type ** - This field is required. resources.type can only use the Equals operator, and the value can be one of the following:
AWS::S3::Object
AWS::Lambda::Function
AWS::DynamoDB::Table
AWS::S3Outposts::Object
AWS::ManagedBlockchain::Node
AWS::S3ObjectLambda::AccessPoint
AWS::EC2::Snapshot
AWS::S3::AccessPoint
AWS::DynamoDB::Stream
You can have only one resources.type field per selector. To log data events on more than one resource type, add another selector.
**resources.ARN ** - You can use any operator with resources.ARN , but if you use Equals or NotEquals , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. For example, if resources.type equals AWS::S3::Object , the ARN must be in one of the following formats. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value. The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
arn:<partition>:s3:::<bucket_name>/
arn:<partition>:s3:::<bucket_name>/<object_path>/
When resources.type equals AWS::S3::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the StartsWith or NotStartsWith operators.
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>
When resources.type equals AWS::Lambda::Function , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>
When resources.type equals AWS::DynamoDB::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>
When resources.type equals AWS::S3Outposts::Object , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>
When resources.type equals AWS::ManagedBlockchain::Node , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>
When resources.type equals AWS::S3ObjectLambda::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>
When resources.type equals AWS::EC2::Snapshot , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>
When resources.type equals AWS::DynamoDB::Stream , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>
Equals (list) --
An operator that includes events that match the exact value of the event record field specified as the value of Field . This is the only valid operator that you can use with the readOnly , eventCategory , and resources.type fields.
(string) --
StartsWith (list) --
An operator that includes events that match the first few characters of the event record field specified as the value of Field .
(string) --
EndsWith (list) --
An operator that includes events that match the last few characters of the event record field specified as the value of Field .
(string) --
NotEquals (list) --
An operator that excludes events that match the exact value of the event record field specified as the value of Field .
(string) --
NotStartsWith (list) --
An operator that excludes events that match the first few characters of the event record field specified as the value of Field .
(string) --
NotEndsWith (list) --
An operator that excludes events that match the last few characters of the event record field specified as the value of Field .
(string) --
MultiRegionEnabled (boolean) --
Indicates whether the event data store includes events from all regions, or only from the region in which it was created.
OrganizationEnabled (boolean) --
Indicates whether an event data store is collecting logged events for an organization in Organizations.
RetentionPeriod (integer) --
The retention period of the event data store, in days.
TerminationProtectionEnabled (boolean) --
Indicates that termination protection is enabled.
CreatedTimestamp (datetime) --
The timestamp of the event data store's creation.
UpdatedTimestamp (datetime) --
Shows the time that an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp .
Starts a CloudTrail Lake query. The required QueryStatement parameter provides your SQL query, enclosed in single quotation marks.
See also: AWS API Documentation
Request Syntax
client.start_query(
QueryStatement='string'
)
string
[REQUIRED]
The SQL code of your query.
dict
Response Syntax
{
'QueryId': 'string'
}
Response Structure
(dict) --
QueryId (string) --
The ID of the started query.
Returns information about all event data stores in the account, in the current region.
See also: AWS API Documentation
Request Syntax
client.list_event_data_stores(
NextToken='string',
MaxResults=123
)
string
A token you can use to get the next page of event data store results.
integer
The maximum number of event data stores to display on a single page.
dict
Response Syntax
{
'EventDataStores': [
{
'EventDataStoreArn': 'string',
'Name': 'string',
'TerminationProtectionEnabled': True|False,
'Status': 'CREATED'|'ENABLED'|'PENDING_DELETION',
'AdvancedEventSelectors': [
{
'Name': 'string',
'FieldSelectors': [
{
'Field': 'string',
'Equals': [
'string',
],
'StartsWith': [
'string',
],
'EndsWith': [
'string',
],
'NotEquals': [
'string',
],
'NotStartsWith': [
'string',
],
'NotEndsWith': [
'string',
]
},
]
},
],
'MultiRegionEnabled': True|False,
'OrganizationEnabled': True|False,
'RetentionPeriod': 123,
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EventDataStores (list) --
Contains information about event data stores in the account, in the current region.
(dict) --
A storage lake of event data against which you can run complex SQL-based queries. An event data store can include events that you have logged on your account from the last 90 to 2555 days (about three months to up to seven years). To select events for an event data store, use advanced event selectors .
EventDataStoreArn (string) --
The ARN of the event data store.
Name (string) --
The name of the event data store.
TerminationProtectionEnabled (boolean) --
Indicates whether the event data store is protected from termination.
Status (string) --
The status of an event data store. Values are ENABLED and PENDING_DELETION .
AdvancedEventSelectors (list) --
The advanced event selectors that were used to select events for the data store.
(dict) --
Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide .
readOnly
eventSource
eventName
eventCategory
resources.type
resources.ARN
You cannot apply both event selectors and advanced event selectors to a trail.
Name (string) --
An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".
FieldSelectors (list) --
Contains all selector statements in an advanced event selector.
(dict) --
A single selector statement in an advanced event selector.
Field (string) --
A field in an event record on which to filter events to be logged. Supported fields include readOnly , eventCategory , eventSource (for management events), eventName , resources.type , and resources.ARN .
**readOnly ** - Optional. Can be set to Equals a value of true or false . A value of false logs both read and write events.
**eventSource ** - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com .
**eventName ** - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock . You can have multiple values for this field, separated by commas.
**eventCategory ** - This is required. It must be set to Equals , and the value must be Management or Data .
**resources.type ** - This field is required. resources.type can only use the Equals operator, and the value can be one of the following:
AWS::S3::Object
AWS::Lambda::Function
AWS::DynamoDB::Table
AWS::S3Outposts::Object
AWS::ManagedBlockchain::Node
AWS::S3ObjectLambda::AccessPoint
AWS::EC2::Snapshot
AWS::S3::AccessPoint
AWS::DynamoDB::Stream
You can have only one resources.type field per selector. To log data events on more than one resource type, add another selector.
**resources.ARN ** - You can use any operator with resources.ARN , but if you use Equals or NotEquals , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. For example, if resources.type equals AWS::S3::Object , the ARN must be in one of the following formats. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value. The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
arn:<partition>:s3:::<bucket_name>/
arn:<partition>:s3:::<bucket_name>/<object_path>/
When resources.type equals AWS::S3::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the StartsWith or NotStartsWith operators.
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>
When resources.type equals AWS::Lambda::Function , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>
When resources.type equals AWS::DynamoDB::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>
When resources.type equals AWS::S3Outposts::Object , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>
When resources.type equals AWS::ManagedBlockchain::Node , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>
When resources.type equals AWS::S3ObjectLambda::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>
When resources.type equals AWS::EC2::Snapshot , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>
When resources.type equals AWS::DynamoDB::Stream , and the operator is set to Equals or NotEquals , the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>
Equals (list) --
An operator that includes events that match the exact value of the event record field specified as the value of Field . This is the only valid operator that you can use with the readOnly , eventCategory , and resources.type fields.
(string) --
StartsWith (list) --
An operator that includes events that match the first few characters of the event record field specified as the value of Field .
(string) --
EndsWith (list) --
An operator that includes events that match the last few characters of the event record field specified as the value of Field .
(string) --
NotEquals (list) --
An operator that excludes events that match the exact value of the event record field specified as the value of Field .
(string) --
NotStartsWith (list) --
An operator that excludes events that match the first few characters of the event record field specified as the value of Field .
(string) --
NotEndsWith (list) --
An operator that excludes events that match the last few characters of the event record field specified as the value of Field .
(string) --
MultiRegionEnabled (boolean) --
Indicates whether the event data store includes events from all regions, or only from the region in which it was created.
OrganizationEnabled (boolean) --
Indicates that an event data store is collecting logged events for an organization.
RetentionPeriod (integer) --
The retention period, in days.
CreatedTimestamp (datetime) --
The timestamp of the event data store's creation.
UpdatedTimestamp (datetime) --
The timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp .
NextToken (string) --
A token you can use to get the next page of results.
Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status. You must specify an ARN for EventDataStore , and a value for QueryID .
See also: AWS API Documentation
Request Syntax
client.describe_query(
EventDataStore='string',
QueryId='string'
)
string
[REQUIRED]
The ARN (or the ID suffix of the ARN) of an event data store on which the specified query was run.
string
[REQUIRED]
The query ID.
dict
Response Syntax
{
'QueryId': 'string',
'QueryString': 'string',
'QueryStatus': 'QUEUED'|'RUNNING'|'FINISHED'|'FAILED'|'CANCELLED',
'QueryStatistics': {
'EventsMatched': 123,
'EventsScanned': 123,
'ExecutionTimeInMillis': 123,
'CreationTime': datetime(2015, 1, 1)
},
'ErrorMessage': 'string'
}
Response Structure
(dict) --
QueryId (string) --
The ID of the query.
QueryString (string) --
The SQL code of a query.
QueryStatus (string) --
The status of a query. Values for QueryStatus include QUEUED , RUNNING , FINISHED , FAILED , or CANCELLED
QueryStatistics (dict) --
Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.
EventsMatched (integer) --
The number of events that matched a query.
EventsScanned (integer) --
The number of events that the query scanned in the event data store.
ExecutionTimeInMillis (integer) --
The query's run time, in milliseconds.
CreationTime (datetime) --
The creation time of the query.
ErrorMessage (string) --
The error message returned if a query failed.
Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for EventDataStore . Optionally, to shorten the list of results, you can specify a time range, formatted as timestamps, by adding StartTime and EndTime parameters, and a QueryStatus value. Valid values for QueryStatus include QUEUED , RUNNING , FINISHED , FAILED , or CANCELLED .
See also: AWS API Documentation
Request Syntax
client.list_queries(
EventDataStore='string',
NextToken='string',
MaxResults=123,
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
QueryStatus='QUEUED'|'RUNNING'|'FINISHED'|'FAILED'|'CANCELLED'
)
string
[REQUIRED]
The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.
string
A token you can use to get the next page of results.
integer
The maximum number of queries to show on a page.
datetime
Use with EndTime to bound a ListQueries request, and limit its results to only those queries run within a specified time period.
datetime
Use with StartTime to bound a ListQueries request, and limit its results to only those queries run within a specified time period.
string
The status of queries that you want to return in results. Valid values for QueryStatus include QUEUED , RUNNING , FINISHED , FAILED , or CANCELLED .
dict
Response Syntax
{
'Queries': [
{
'QueryId': 'string',
'QueryStatus': 'QUEUED'|'RUNNING'|'FINISHED'|'FAILED'|'CANCELLED',
'CreationTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Queries (list) --
Lists matching query results, and shows query ID, status, and creation time of each query.
(dict) --
A SQL string of criteria about events that you want to collect in an event data store.
QueryId (string) --
The ID of a query.
QueryStatus (string) --
The status of the query. This can be QUEUED , RUNNING , FINISHED , FAILED , or CANCELLED .
CreationTime (datetime) --
The creation time of a query.
NextToken (string) --
A token you can use to get the next page of results.