AWS CloudTrail

Enables Lake query federation on the specified event data store. Federating an event data store lets you view the metadata associated with the event data store in the Glue Data Catalog and run SQL queries against your event data using Amazon Athena. The table metadata stored in the Glue Data Catalog lets the Athena query engine know how to find, read, and process the data that you want to query.

When you enable Lake query federation, CloudTrail creates a federated database named aws:cloudtrail (if the database doesn't already exist) and a federated table in the Glue Data Catalog. The event data store ID is used for the table name. CloudTrail registers the role ARN and event data store in Lake Formation, the service responsible for revoking or granting permissions to the federated resources in the Glue Data Catalog.

For more information about Lake query federation, see Federate an event data store.

See also: AWS API Documentation

Request Syntax

client.enable_federation(
    EventDataStore='string',
    FederationRoleArn='string'
)

type EventDataStore:

string

param EventDataStore:

[REQUIRED]

The ARN (or ID suffix of the ARN) of the event data store for which you want to enable Lake query federation.

type FederationRoleArn:

string

param FederationRoleArn:

[REQUIRED]

The ARN of the federation role to use for the event data store. Amazon Web Services services like Lake Formation use this federation role to access data for the federated event data store. The federation role must exist in your account and provide the required minimum permissions.

rtype:

dict

returns:

Response Syntax

{
    'EventDataStoreArn': 'string',
    'FederationStatus': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED',
    'FederationRoleArn': 'string'
}

Response Structure

• (dict) --

  • EventDataStoreArn (string) --

    The ARN of the event data store for which you enabled Lake query federation.

  • FederationStatus (string) --

    The federation status.

  • FederationRoleArn (string) --

    The ARN of the federation role.

Disables Lake query federation on the specified event data store. When you disable federation, CloudTrail removes the metadata associated with the federated event data store in the Glue Data Catalog and removes registration for the federation role ARN and event data store in Lake Formation. No CloudTrail Lake data is deleted when you disable federation.

See also: AWS API Documentation

Request Syntax

client.disable_federation(
    EventDataStore='string'
)

type EventDataStore:

string

param EventDataStore:

[REQUIRED]

The ARN (or ID suffix of the ARN) of the event data store for which you want to disable Lake query federation.

rtype:

dict

returns:

Response Syntax

{
    'EventDataStoreArn': 'string',
    'FederationStatus': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'
}

Response Structure

• (dict) --

  • EventDataStoreArn (string) --

    The ARN of the event data store for which you disabled Lake query federation.

  • FederationStatus (string) --

    The federation status.

{'FederationRoleArn': 'string',
 'FederationStatus': 'ENABLING | ENABLED | DISABLING | DISABLED'}

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'
)

type EventDataStore:

string

param EventDataStore:

[REQUIRED]

The ARN (or ID suffix of the ARN) of the event data store about which you want information.

rtype:

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,
    'CreatedTimestamp': datetime(2015, 1, 1),
    'UpdatedTimestamp': datetime(2015, 1, 1),
    'KmsKeyId': 'string',
    'BillingMode': 'EXTENDABLE_RETENTION_PRICING'|'FIXED_RETENTION_PRICING',
    'FederationStatus': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED',
    'FederationRoleArn': 'string'
}

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.

  • 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 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 Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the field is used only for selecting events as filtering is not supported.

            For CloudTrail event records, supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.

            For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, 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 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 and must be set to Equals.

              • For CloudTrail event records, the value must be Management or Data.

              • For CloudTrail Insights event records, 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 field 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::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::KendraRanking::ExecutionPlan

              • AWS::KinesisVideo::Stream

              • AWS::ManagedBlockchain::Network

              • AWS::ManagedBlockchain::Node

              • AWS::MedicalImaging::Datastore

              • AWS::PCAConnectorAD::Connector

              • AWS::SageMaker::Endpoint

              • AWS::SageMaker::ExperimentTrialComponent

              • AWS::SageMaker::FeatureGroup

              • AWS::SNS::PlatformEndpoint

              • AWS::SNS::Topic

              • AWS::S3::AccessPoint

              • AWS::S3ObjectLambda::AccessPoint

              • AWS::S3Outposts::Object

              • AWS::SSMMessages::ControlChannel

              • AWS::Timestream::Database

              • AWS::Timestream::Table

              • AWS::VerifiedPermissions::PolicyStore

            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::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::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>::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::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::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::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::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::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::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 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.

  • 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.

  • FederationStatus (string) --

    Indicates the Lake query federation status. The status is ENABLED if Lake query federation is enabled, or DISABLED if Lake query federation is disabled. You cannot delete an event data store if the FederationStatus is ENABLED.

  • FederationRoleArn (string) --

    If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.

{'FederationRoleArn': 'string',
 'FederationStatus': 'ENABLING | ENABLED | DISABLING | DISABLED'}

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 7 and 3653 if the BillingMode is set to EXTENDABLE_RETENTION_PRICING, or between 7 and 2557 if BillingMode is set to FIXED_RETENTION_PRICING. By default, TerminationProtection is enabled.

For event data stores for CloudTrail events, AdvancedEventSelectors includes or excludes management, data, or Insights events in your event data store. For more information about AdvancedEventSelectors, see AdvancedEventSelectors.

For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, AdvancedEventSelectors includes events of that type in your event data store.

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,
    KmsKeyId='string',
    BillingMode='EXTENDABLE_RETENTION_PRICING'|'FIXED_RETENTION_PRICING'
)

type EventDataStore:

string

param EventDataStore:

[REQUIRED]

The ARN (or the ID suffix of the ARN) of the event data store that you want to update.

type Name:

string

param Name:

The event data store name.

type AdvancedEventSelectors:

list

param AdvancedEventSelectors:

The advanced event selectors used to select events for the event data store. You can configure up to five advanced event selectors for each 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 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 Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the field is used only for selecting events as filtering is not supported.

        For CloudTrail event records, supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.

        For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, 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 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 and must be set to Equals.

          • For CloudTrail event records, the value must be Management or Data.

          • For CloudTrail Insights event records, 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 field 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::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::KendraRanking::ExecutionPlan

          • AWS::KinesisVideo::Stream

          • AWS::ManagedBlockchain::Network

          • AWS::ManagedBlockchain::Node

          • AWS::MedicalImaging::Datastore

          • AWS::PCAConnectorAD::Connector

          • AWS::SageMaker::Endpoint

          • AWS::SageMaker::ExperimentTrialComponent

          • AWS::SageMaker::FeatureGroup

          • AWS::SNS::PlatformEndpoint

          • AWS::SNS::Topic

          • AWS::S3::AccessPoint

          • AWS::S3ObjectLambda::AccessPoint

          • AWS::S3Outposts::Object

          • AWS::SSMMessages::ControlChannel

          • AWS::Timestream::Database

          • AWS::Timestream::Table

          • AWS::VerifiedPermissions::PolicyStore

        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::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::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>::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::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::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::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::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::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::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) --

type MultiRegionEnabled:

boolean

param MultiRegionEnabled:

Specifies whether an event data store collects events from all Regions, or only from the Region in which it was created.

type OrganizationEnabled:

boolean

param OrganizationEnabled:

Specifies whether an event data store collects events logged for an organization in Organizations.

type RetentionPeriod:

integer

param RetentionPeriod:

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.

type TerminationProtectionEnabled:

boolean

param TerminationProtectionEnabled:

Indicates that termination protection is enabled and the event data store cannot be automatically deleted.

type KmsKeyId:

string

param KmsKeyId:

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.

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

type BillingMode:

string

param BillingMode:

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.

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

rtype:

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,
    'CreatedTimestamp': datetime(2015, 1, 1),
    'UpdatedTimestamp': datetime(2015, 1, 1),
    'KmsKeyId': 'string',
    'BillingMode': 'EXTENDABLE_RETENTION_PRICING'|'FIXED_RETENTION_PRICING',
    'FederationStatus': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED',
    'FederationRoleArn': 'string'
}

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.

  • 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 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 Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the field is used only for selecting events as filtering is not supported.

            For CloudTrail event records, supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.

            For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, 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 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 and must be set to Equals.

              • For CloudTrail event records, the value must be Management or Data.

              • For CloudTrail Insights event records, 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 field 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::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::KendraRanking::ExecutionPlan

              • AWS::KinesisVideo::Stream

              • AWS::ManagedBlockchain::Network

              • AWS::ManagedBlockchain::Node

              • AWS::MedicalImaging::Datastore

              • AWS::PCAConnectorAD::Connector

              • AWS::SageMaker::Endpoint

              • AWS::SageMaker::ExperimentTrialComponent

              • AWS::SageMaker::FeatureGroup

              • AWS::SNS::PlatformEndpoint

              • AWS::SNS::Topic

              • AWS::S3::AccessPoint

              • AWS::S3ObjectLambda::AccessPoint

              • AWS::S3Outposts::Object

              • AWS::SSMMessages::ControlChannel

              • AWS::Timestream::Database

              • AWS::Timestream::Table

              • AWS::VerifiedPermissions::PolicyStore

            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::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::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>::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::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::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::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::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::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::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 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.

  • 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.

  • FederationStatus (string) --

    Indicates the Lake query federation status. The status is ENABLED if Lake query federation is enabled, or DISABLED if Lake query federation is disabled. You cannot delete an event data store if the FederationStatus is ENABLED.

  • FederationRoleArn (string) --

    If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.