CloudTrail / Client / create_event_data_store

create_event_data_store#

CloudTrail.Client.create_event_data_store(**kwargs)#

Creates a new event data store.

Request Syntax

response = 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'
        },
    ],
    KmsKeyId='string',
    StartIngestion=True|False,
    BillingMode='EXTENDABLE_RETENTION_PRICING'|'FIXED_RETENTION_PRICING'
)

Parameters:

Name (string) –
[REQUIRED]

The name of the event data store.
AdvancedEventSelectors (list) –
The advanced event selectors to use to select the events for the data store. You can configure up to five advanced event selectors for each event data store.

For more information about how to use advanced event selectors to log CloudTrail events, see Log events by using advanced event selectors in the CloudTrail User Guide.

For more information about how to use advanced event selectors to include Config configuration items in your event data store, see Create an event data store for Config configuration items in the CloudTrail User Guide.

For more information about how to use advanced event selectors to include non-Amazon Web Services events in your event data store, see Create an integration to log events from outside Amazon Web Services in the CloudTrail User Guide.
- (dict) –
  
  Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record ﬁelds. 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 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 a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for selecting events as filtering is not supported.
        
        For CloudTrail management events, supported fields include readOnly, eventCategory, and eventSource.
        
        For CloudTrail data events, supported fields include readOnly, eventCategory, eventName, resources.type, and resources.ARN.
        
        For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is eventCategory.
        
        readOnly - Optional. Can be set to Equals a value of true or false. If you do not add this field, CloudTrail logs both read and write events. A value of true logs only read events. A value of false logs only write events.
        
        eventSource - For filtering management events only. This can be set to NotEquals kms.amazonaws.com or NotEquals rdsdata.amazonaws.com.
        
        eventName - Can use any operator. You can use it to ﬁlter in or ﬁlter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock. You can have multiple values for this ﬁeld, separated by commas.
        
        eventCategory - This is required and must be set to Equals.
        
        For CloudTrail management events, the value must be Management.
        
        For CloudTrail data events, the value must be Data.
        
        The following are used only for event data stores:
        
        For CloudTrail Insights events, the value must be Insight.
        
        For Config configuration items, the value must be ConfigurationItem.
        
        For Audit Manager evidence, the value must be Evidence.
        
        For non-Amazon Web Services events, the value must be ActivityAuditLog.
        
        resources.type - This ﬁeld is required for CloudTrail data events. resources.type can only use the Equals operator, and the value can be one of the following:
        
        AWS::DynamoDB::Table
        
        AWS::Lambda::Function
        
        AWS::S3::Object
        
        AWS::B2BI::Transformer
        
        AWS::Bedrock::AgentAlias
        
        AWS::Bedrock::KnowledgeBase
        
        AWS::Cassandra::Table
        
        AWS::CloudFront::KeyValueStore
        
        AWS::CloudTrail::Channel
        
        AWS::CodeWhisperer::Customization
        
        AWS::CodeWhisperer::Profile
        
        AWS::Cognito::IdentityPool
        
        AWS::DynamoDB::Stream
        
        AWS::EC2::Snapshot
        
        AWS::EMRWAL::Workspace
        
        AWS::FinSpace::Environment
        
        AWS::Glue::Table
        
        AWS::GuardDuty::Detector
        
        AWS::IoTTwinMaker::Entity
        
        AWS::IoTTwinMaker::Workspace
        
        AWS::KendraRanking::ExecutionPlan
        
        AWS::KinesisVideo::Stream
        
        AWS::ManagedBlockchain::Network
        
        AWS::ManagedBlockchain::Node
        
        AWS::MedicalImaging::Datastore
        
        AWS::NeptuneGraph::Graph
        
        AWS::PCAConnectorAD::Connector
        
        AWS::QBusiness::Application
        
        AWS::QBusiness::DataSource
        
        AWS::QBusiness::Index
        
        AWS::QBusiness::WebExperience
        
        AWS::RDS::DBCluster
        
        AWS::SageMaker::Endpoint
        
        AWS::SageMaker::ExperimentTrialComponent
        
        AWS::SageMaker::FeatureGroup
        
        AWS::ServiceDiscovery::Namespace
        
        AWS::ServiceDiscovery::Service
        
        AWS::SCN::Instance
        
        AWS::SNS::PlatformEndpoint
        
        AWS::SNS::Topic
        
        AWS::SQS::Queue
        
        AWS::S3::AccessPoint
        
        AWS::S3ObjectLambda::AccessPoint
        
        AWS::S3Outposts::Object
        
        AWS::SSMMessages::ControlChannel
        
        AWS::ThinClient::Device
        
        AWS::ThinClient::Environment
        
        AWS::Timestream::Database
        
        AWS::Timestream::Table
        
        AWS::VerifiedPermissions::PolicyStore
        
        You can have only one resources.type ﬁeld 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 speciﬁed 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::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::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::B2BI::Transformer, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:b2bi:<region>:<account_ID>:transformer/<transformer_ID>
        
        When resources.type equals AWS::Bedrock::AgentAlias, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:bedrock:<region>:<account_ID>:agent-alias/<agent_ID>/<alias_ID>
        
        When resources.type equals AWS::Bedrock::KnowledgeBase, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:bedrock:<region>:<account_ID>:knowledge-base/<knowledge_base_ID>
        
        When resources.type equals AWS::Cassandra::Table, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:cassandra:<region>:<account_ID>:/keyspace/<keyspace_name>/table/<table_name>
        
        When resources.type equals AWS::CloudFront::KeyValueStore, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:cloudfront:<region>:<account_ID>:key-value-store/<KVS_name>
        
        When resources.type equals AWS::CloudTrail::Channel, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:cloudtrail:<region>:<account_ID>:channel/<channel_UUID>
        
        When resources.type equals AWS::CodeWhisperer::Customization, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:codewhisperer:<region>:<account_ID>:customization/<customization_ID>
        
        When resources.type equals AWS::CodeWhisperer::Profile, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:codewhisperer:<region>:<account_ID>:profile/<profile_ID>
        
        When resources.type equals AWS::Cognito::IdentityPool, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:cognito-identity:<region>:<account_ID>:identitypool/<identity_pool_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>
        
        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::EMRWAL::Workspace, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:emrwal:<region>:<account_ID>:workspace/<workspace_name>
        
        When resources.type equals AWS::FinSpace::Environment, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:finspace:<region>:<account_ID>:environment/<environment_ID>
        
        When resources.type equals AWS::Glue::Table, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
        
        When resources.type equals AWS::GuardDuty::Detector, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:guardduty:<region>:<account_ID>:detector/<detector_ID>
        
        When resources.type equals AWS::IoTTwinMaker::Entity, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:iottwinmaker:<region>:<account_ID>:workspace/<workspace_ID>/entity/<entity_ID>
        
        When resources.type equals AWS::IoTTwinMaker::Workspace, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:iottwinmaker:<region>:<account_ID>:workspace/<workspace_ID>
        
        When resources.type equals AWS::KendraRanking::ExecutionPlan, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:kendra-ranking:<region>:<account_ID>:rescore-execution-plan/<rescore_execution_plan_ID>
        
        When resources.type equals AWS::KinesisVideo::Stream, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:kinesisvideo:<region>:<account_ID>:stream/<stream_name>/<creation_time>
        
        When resources.type equals AWS::ManagedBlockchain::Network, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:managedblockchain:::networks/<network_name>
        
        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::MedicalImaging::Datastore, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:medical-imaging:<region>:<account_ID>:datastore/<data_store_ID>
        
        When resources.type equals AWS::NeptuneGraph::Graph, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:neptune-graph:<region>:<account_ID>:graph/<graph_ID>
        
        When resources.type equals AWS::PCAConnectorAD::Connector, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:pca-connector-ad:<region>:<account_ID>:connector/<connector_ID>
        
        When resources.type equals AWS::QBusiness::Application, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>
        
        When resources.type equals AWS::QBusiness::DataSource, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/index/<index_ID>/data-source/<datasource_ID>
        
        When resources.type equals AWS::QBusiness::Index, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/index/<index_ID>
        
        When resources.type equals AWS::QBusiness::WebExperience, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/web-experience/<web_experience_ID>
        
        When resources.type equals AWS::RDS::DBCluster, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:rds:<region>:<account_ID>:cluster/<cluster_name>
        
        When resources.type equals AWS::SageMaker::Endpoint, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:sagemaker:<region>:<account_ID>:endpoint/<endpoint_name>
        
        When resources.type equals AWS::SageMaker::ExperimentTrialComponent, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:sagemaker:<region>:<account_ID>:experiment-trial-component/<experiment_trial_component_name>
        
        When resources.type equals AWS::SageMaker::FeatureGroup, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:sagemaker:<region>:<account_ID>:feature-group/<feature_group_name>
        
        When resources.type equals AWS::SCN::Instance, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:scn:<region>:<account_ID>:instance/<instance_ID>
        
        When resources.type equals AWS::ServiceDiscovery::Namespace, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:servicediscovery:<region>:<account_ID>:namespace/<namespace_ID>
        
        When resources.type equals AWS::ServiceDiscovery::Service, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:servicediscovery:<region>:<account_ID>:service/<service_ID>
        
        When resources.type equals AWS::SNS::PlatformEndpoint, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:sns:<region>:<account_ID>:endpoint/<endpoint_type>/<endpoint_name>/<endpoint_ID>
        
        When resources.type equals AWS::SNS::Topic, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:sns:<region>:<account_ID>:<topic_name>
        
        When resources.type equals AWS::SQS::Queue, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:sqs:<region>:<account_ID>:<queue_name>
        
        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::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::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::SSMMessages::ControlChannel, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:ssmmessages:<region>:<account_ID>:control-channel/<channel_ID>
        
        When resources.type equals AWS::ThinClient::Device, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:thinclient:<region>:<account_ID>:device/<device_ID>
        
        When resources.type equals AWS::ThinClient::Environment, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:thinclient:<region>:<account_ID>:environment/<environment_ID>
        
        When resources.type equals AWS::Timestream::Database, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:timestream:<region>:<account_ID>:database/<database_name>
        
        When resources.type equals AWS::Timestream::Table, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:timestream:<region>:<account_ID>:database/<database_name>/table/<table_name>
        
        When resources.type equals AWS::VerifiedPermissions::PolicyStore, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:verifiedpermissions:<region>:<account_ID>:policy-store/<policy_store_UUID>
      - 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) – Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created.
OrganizationEnabled (boolean) – Specifies whether an event data store collects events logged for an organization in Organizations.
RetentionPeriod (integer) –
The retention period of the event data store, in days. If BillingMode is set to EXTENDABLE_RETENTION_PRICING, you can set a retention period of up to 3653 days, the equivalent of 10 years. If BillingMode is set to FIXED_RETENTION_PRICING, you can set a retention period of up to 2557 days, the equivalent of seven years.

CloudTrail Lake determines whether to retain an event by checking if the eventTime of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events when the eventTime is older than 90 days.

Note
If you plan to copy trail events to this event data store, we recommend that you consider both the age of the events that you want to copy as well as how long you want to keep the copied events in your event data store. For example, if you copy trail events that are 5 years old and specify a retention period of 7 years, the event data store will retain those events for two years.
TerminationProtectionEnabled (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.
TagsList (list) –
A list of tags.
- (dict) –
  
  A custom key-value pair associated with a resource such as a CloudTrail trail, event data store, or channel.
  - 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.
KmsKeyId (string) –
Specifies the KMS key ID to use to encrypt the events 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.

Warning
Disabling or deleting the KMS key, or removing CloudTrail permissions on the key, prevents CloudTrail from logging events to the event data store, and prevents users from querying the data in the event data store that was encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you disable or delete a KMS key that you are using with an event data store, delete or back up your event data store.

CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

Examples:
- alias/MyAliasName
- arn:aws:kms:us-east-2:123456789012:alias/MyAliasName
- arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
- 12345678-1234-1234-1234-123456789012
StartIngestion (boolean) – Specifies whether the event data store should start ingesting live events. The default is true.
BillingMode (string) –
The billing mode for the event data store determines the cost for ingesting events and the default and maximum retention period for the event data store.

The following are the possible values:
- EXTENDABLE_RETENTION_PRICING - This billing mode is generally recommended if you want a flexible retention period of up to 3653 days (about 10 years). The default retention period for this billing mode is 366 days.
- FIXED_RETENTION_PRICING - This billing mode is recommended if you expect to ingest more than 25 TB of event data per month and need a retention period of up to 2557 days (about 7 years). The default retention period for this billing mode is 2557 days.
The default value is EXTENDABLE_RETENTION_PRICING.

For more information about CloudTrail pricing, see CloudTrail Pricing and Managing CloudTrail Lake costs.

Return type:

dict

Returns:

Response Syntax

{
    'EventDataStoreArn': 'string',
    'Name': 'string',
    'Status': 'CREATED'|'ENABLED'|'PENDING_DELETION'|'STARTING_INGESTION'|'STOPPING_INGESTION'|'STOPPED_INGESTION',
    '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),
    'KmsKeyId': 'string',
    'BillingMode': 'EXTENDABLE_RETENTION_PRICING'|'FIXED_RETENTION_PRICING'
}

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 ﬁelds. 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 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 a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for selecting events as filtering is not supported.
        
        For CloudTrail management events, supported fields include readOnly, eventCategory, and eventSource.
        
        For CloudTrail data events, supported fields include readOnly, eventCategory, eventName, resources.type, and resources.ARN.
        
        For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is eventCategory.
        
        readOnly - Optional. Can be set to Equals a value of true or false. If you do not add this field, CloudTrail logs both read and write events. A value of true logs only read events. A value of false logs only write events.
        
        eventSource - For filtering management events only. This can be set to NotEquals kms.amazonaws.com or NotEquals rdsdata.amazonaws.com.
        
        eventName - Can use any operator. You can use it to ﬁlter in or ﬁlter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock. You can have multiple values for this ﬁeld, separated by commas.
        
        eventCategory - This is required and must be set to Equals.
        
        For CloudTrail management events, the value must be Management.
        
        For CloudTrail data events, the value must be Data.
        
        The following are used only for event data stores:
        
        For CloudTrail Insights events, the value must be Insight.
        
        For Config configuration items, the value must be ConfigurationItem.
        
        For Audit Manager evidence, the value must be Evidence.
        
        For non-Amazon Web Services events, the value must be ActivityAuditLog.
        
        resources.type - This ﬁeld is required for CloudTrail data events. resources.type can only use the Equals operator, and the value can be one of the following:
        
        AWS::DynamoDB::Table
        
        AWS::Lambda::Function
        
        AWS::S3::Object
        
        AWS::B2BI::Transformer
        
        AWS::Bedrock::AgentAlias
        
        AWS::Bedrock::KnowledgeBase
        
        AWS::Cassandra::Table
        
        AWS::CloudFront::KeyValueStore
        
        AWS::CloudTrail::Channel
        
        AWS::CodeWhisperer::Customization
        
        AWS::CodeWhisperer::Profile
        
        AWS::Cognito::IdentityPool
        
        AWS::DynamoDB::Stream
        
        AWS::EC2::Snapshot
        
        AWS::EMRWAL::Workspace
        
        AWS::FinSpace::Environment
        
        AWS::Glue::Table
        
        AWS::GuardDuty::Detector
        
        AWS::IoTTwinMaker::Entity
        
        AWS::IoTTwinMaker::Workspace
        
        AWS::KendraRanking::ExecutionPlan
        
        AWS::KinesisVideo::Stream
        
        AWS::ManagedBlockchain::Network
        
        AWS::ManagedBlockchain::Node
        
        AWS::MedicalImaging::Datastore
        
        AWS::NeptuneGraph::Graph
        
        AWS::PCAConnectorAD::Connector
        
        AWS::QBusiness::Application
        
        AWS::QBusiness::DataSource
        
        AWS::QBusiness::Index
        
        AWS::QBusiness::WebExperience
        
        AWS::RDS::DBCluster
        
        AWS::SageMaker::Endpoint
        
        AWS::SageMaker::ExperimentTrialComponent
        
        AWS::SageMaker::FeatureGroup
        
        AWS::ServiceDiscovery::Namespace
        
        AWS::ServiceDiscovery::Service
        
        AWS::SCN::Instance
        
        AWS::SNS::PlatformEndpoint
        
        AWS::SNS::Topic
        
        AWS::SQS::Queue
        
        AWS::S3::AccessPoint
        
        AWS::S3ObjectLambda::AccessPoint
        
        AWS::S3Outposts::Object
        
        AWS::SSMMessages::ControlChannel
        
        AWS::ThinClient::Device
        
        AWS::ThinClient::Environment
        
        AWS::Timestream::Database
        
        AWS::Timestream::Table
        
        AWS::VerifiedPermissions::PolicyStore
        
        You can have only one resources.type ﬁeld 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 speciﬁed 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::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::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::B2BI::Transformer, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:b2bi:<region>:<account_ID>:transformer/<transformer_ID>
        
        When resources.type equals AWS::Bedrock::AgentAlias, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:bedrock:<region>:<account_ID>:agent-alias/<agent_ID>/<alias_ID>
        
        When resources.type equals AWS::Bedrock::KnowledgeBase, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:bedrock:<region>:<account_ID>:knowledge-base/<knowledge_base_ID>
        
        When resources.type equals AWS::Cassandra::Table, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:cassandra:<region>:<account_ID>:/keyspace/<keyspace_name>/table/<table_name>
        
        When resources.type equals AWS::CloudFront::KeyValueStore, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:cloudfront:<region>:<account_ID>:key-value-store/<KVS_name>
        
        When resources.type equals AWS::CloudTrail::Channel, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:cloudtrail:<region>:<account_ID>:channel/<channel_UUID>
        
        When resources.type equals AWS::CodeWhisperer::Customization, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:codewhisperer:<region>:<account_ID>:customization/<customization_ID>
        
        When resources.type equals AWS::CodeWhisperer::Profile, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:codewhisperer:<region>:<account_ID>:profile/<profile_ID>
        
        When resources.type equals AWS::Cognito::IdentityPool, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:cognito-identity:<region>:<account_ID>:identitypool/<identity_pool_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>
        
        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::EMRWAL::Workspace, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:emrwal:<region>:<account_ID>:workspace/<workspace_name>
        
        When resources.type equals AWS::FinSpace::Environment, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:finspace:<region>:<account_ID>:environment/<environment_ID>
        
        When resources.type equals AWS::Glue::Table, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
        
        When resources.type equals AWS::GuardDuty::Detector, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:guardduty:<region>:<account_ID>:detector/<detector_ID>
        
        When resources.type equals AWS::IoTTwinMaker::Entity, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:iottwinmaker:<region>:<account_ID>:workspace/<workspace_ID>/entity/<entity_ID>
        
        When resources.type equals AWS::IoTTwinMaker::Workspace, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:iottwinmaker:<region>:<account_ID>:workspace/<workspace_ID>
        
        When resources.type equals AWS::KendraRanking::ExecutionPlan, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:kendra-ranking:<region>:<account_ID>:rescore-execution-plan/<rescore_execution_plan_ID>
        
        When resources.type equals AWS::KinesisVideo::Stream, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:kinesisvideo:<region>:<account_ID>:stream/<stream_name>/<creation_time>
        
        When resources.type equals AWS::ManagedBlockchain::Network, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:managedblockchain:::networks/<network_name>
        
        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::MedicalImaging::Datastore, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:medical-imaging:<region>:<account_ID>:datastore/<data_store_ID>
        
        When resources.type equals AWS::NeptuneGraph::Graph, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:neptune-graph:<region>:<account_ID>:graph/<graph_ID>
        
        When resources.type equals AWS::PCAConnectorAD::Connector, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:pca-connector-ad:<region>:<account_ID>:connector/<connector_ID>
        
        When resources.type equals AWS::QBusiness::Application, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>
        
        When resources.type equals AWS::QBusiness::DataSource, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/index/<index_ID>/data-source/<datasource_ID>
        
        When resources.type equals AWS::QBusiness::Index, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/index/<index_ID>
        
        When resources.type equals AWS::QBusiness::WebExperience, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/web-experience/<web_experience_ID>
        
        When resources.type equals AWS::RDS::DBCluster, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:rds:<region>:<account_ID>:cluster/<cluster_name>
        
        When resources.type equals AWS::SageMaker::Endpoint, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:sagemaker:<region>:<account_ID>:endpoint/<endpoint_name>
        
        When resources.type equals AWS::SageMaker::ExperimentTrialComponent, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:sagemaker:<region>:<account_ID>:experiment-trial-component/<experiment_trial_component_name>
        
        When resources.type equals AWS::SageMaker::FeatureGroup, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:sagemaker:<region>:<account_ID>:feature-group/<feature_group_name>
        
        When resources.type equals AWS::SCN::Instance, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:scn:<region>:<account_ID>:instance/<instance_ID>
        
        When resources.type equals AWS::ServiceDiscovery::Namespace, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:servicediscovery:<region>:<account_ID>:namespace/<namespace_ID>
        
        When resources.type equals AWS::ServiceDiscovery::Service, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:servicediscovery:<region>:<account_ID>:service/<service_ID>
        
        When resources.type equals AWS::SNS::PlatformEndpoint, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:sns:<region>:<account_ID>:endpoint/<endpoint_type>/<endpoint_name>/<endpoint_ID>
        
        When resources.type equals AWS::SNS::Topic, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:sns:<region>:<account_ID>:<topic_name>
        
        When resources.type equals AWS::SQS::Queue, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:sqs:<region>:<account_ID>:<queue_name>
        
        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::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::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::SSMMessages::ControlChannel, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:ssmmessages:<region>:<account_ID>:control-channel/<channel_ID>
        
        When resources.type equals AWS::ThinClient::Device, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:thinclient:<region>:<account_ID>:device/<device_ID>
        
        When resources.type equals AWS::ThinClient::Environment, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:thinclient:<region>:<account_ID>:environment/<environment_ID>
        
        When resources.type equals AWS::Timestream::Database, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:timestream:<region>:<account_ID>:database/<database_name>
        
        When resources.type equals AWS::Timestream::Table, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:timestream:<region>:<account_ID>:database/<database_name>/table/<table_name>
        
        When resources.type equals AWS::VerifiedPermissions::PolicyStore, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
        
        arn:<partition>:verifiedpermissions:<region>:<account_ID>:policy-store/<policy_store_UUID>
        
        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, event data store, or channel.
    - 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.
- KmsKeyId (string) –
  
  Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.
  
  arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
- BillingMode (string) –
  
  The billing mode for the event data store.

Exceptions

CloudTrail.Client.exceptions.EventDataStoreAlreadyExistsException
CloudTrail.Client.exceptions.EventDataStoreMaxLimitExceededException
CloudTrail.Client.exceptions.InvalidEventSelectorsException
CloudTrail.Client.exceptions.InvalidParameterException
CloudTrail.Client.exceptions.InvalidTagParameterException
CloudTrail.Client.exceptions.OperationNotPermittedException
CloudTrail.Client.exceptions.UnsupportedOperationException
CloudTrail.Client.exceptions.ConflictException
CloudTrail.Client.exceptions.InsufficientEncryptionPolicyException
CloudTrail.Client.exceptions.InvalidKmsKeyIdException
CloudTrail.Client.exceptions.KmsKeyNotFoundException
CloudTrail.Client.exceptions.KmsException
CloudTrail.Client.exceptions.CloudTrailAccessNotEnabledException
CloudTrail.Client.exceptions.InsufficientDependencyServiceAccessPermissionException
CloudTrail.Client.exceptions.NotOrganizationMasterAccountException
CloudTrail.Client.exceptions.OrganizationsNotInUseException
CloudTrail.Client.exceptions.OrganizationNotInAllFeaturesModeException
CloudTrail.Client.exceptions.NoManagementAccountSLRExistsException