CloudTrail / Client / put_event_selectors

put_event_selectors

CloudTrail.Client.put_event_selectors(**kwargs)

Configures event selectors (also referred to as basic event selectors) or advanced event selectors for your trail. You can use either AdvancedEventSelectors or EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten.

You can use AdvancedEventSelectors to log management events, data events for all resource types, and network activity events.

You can use EventSelectors to log management events and data events for the following resource types:

• AWS::DynamoDB::Table

• AWS::Lambda::Function

• AWS::S3::Object

You can’t use EventSelectors to log network activity events.

If you want your trail to log Insights events, be sure the event selector or advanced event selector enables logging of the Insights event types you want configured for your trail. For more information about logging Insights events, see Logging Insights events in the CloudTrail User Guide. By default, trails created without specific event selectors are configured to log all read and write management events, and no data events or network activity events.

When an event occurs in your account, CloudTrail evaluates the event selectors or advanced event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn’t match any event selector, the trail doesn’t log the event.

Example

• You create an event selector for a trail and specify that you want to log write-only events.

• The EC2 GetConsoleOutput and RunInstances API operations occur in your account.

• CloudTrail evaluates whether the events match your event selectors.

• The RunInstances is a write-only event and it matches your event selector. The trail logs the event.

• The GetConsoleOutput is a read-only event that doesn’t match your event selector. The trail doesn’t log the event.

The PutEventSelectors operation must be called from the Region in which the trail was created; otherwise, an InvalidHomeRegionException exception is thrown.

You can configure up to five event selectors for each trail.

You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. For more information, see Logging management events, Logging data events, Logging network activity events, and Quotas in CloudTrail in the CloudTrail User Guide.

See also: AWS API Documentation

Request Syntax

response = client.put_event_selectors(
    TrailName='string',
    EventSelectors=[
        {
            'ReadWriteType': 'ReadOnly'|'WriteOnly'|'All',
            'IncludeManagementEvents': True|False,
            'DataResources': [
                {
                    'Type': 'string',
                    'Values': [
                        'string',
                    ]
                },
            ],
            'ExcludeManagementEventSources': [
                'string',
            ]
        },
    ],
    AdvancedEventSelectors=[
        {
            'Name': 'string',
            'FieldSelectors': [
                {
                    'Field': 'string',
                    'Equals': [
                        'string',
                    ],
                    'StartsWith': [
                        'string',
                    ],
                    'EndsWith': [
                        'string',
                    ],
                    'NotEquals': [
                        'string',
                    ],
                    'NotStartsWith': [
                        'string',
                    ],
                    'NotEndsWith': [
                        'string',
                    ]
                },
            ]
        },
    ]
)

Parameters:

• TrailName (string) –

  [REQUIRED]

  Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)

  • Start with a letter or number, and end with a letter or number

  • Be between 3 and 128 characters

  • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are not valid.

  • Not be in IP address format (for example, 192.168.5.4)

  If you specify a trail ARN, it must be in the following format.

  arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

• EventSelectors (list) –

  Specifies the settings for your event selectors. You can use event selectors to log management events and data events for the following resource types:

  • AWS::DynamoDB::Table

  • AWS::Lambda::Function

  • AWS::S3::Object

  You can’t use event selectors to log network activity events.

  You can configure up to five event selectors for a trail. You can use either EventSelectors or AdvancedEventSelectors in a PutEventSelectors request, but not both. If you apply EventSelectors to a trail, any existing AdvancedEventSelectors are overwritten.

  • (dict) –

    Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn’t match any event selector, the trail doesn’t log the event.

    You can configure up to five event selectors for a trail.

    You cannot apply both event selectors and advanced event selectors to a trail.

    • ReadWriteType (string) –

      Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation.

      By default, the value is All.

    • IncludeManagementEvents (boolean) –

      Specify if you want your event selector to include management events for your trail.

      For more information, see Management Events in the CloudTrail User Guide.

      By default, the value is true.

      The first copy of management events is free. You are charged for additional copies of management events that you are logging on any subsequent trail in the same Region. For more information about CloudTrail pricing, see CloudTrail Pricing.

    • DataResources (list) –

      CloudTrail supports data event logging for Amazon S3 objects in standard S3 buckets, Lambda functions, and Amazon DynamoDB tables with basic event selectors. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events.

      For more information, see Data Events and Limits in CloudTrail in the CloudTrail User Guide.

      Note

      To log data events for all other resource types including objects stored in directory buckets, you must use AdvancedEventSelectors. You must also use AdvancedEventSelectors if you want to filter on the eventName field.

      • (dict) –

        You can configure the DataResource in an EventSelector to log data events for the following three resource types:

        • AWS::DynamoDB::Table

        • AWS::Lambda::Function

        • AWS::S3::Object

        To log data events for all other resource types including objects stored in directory buckets, you must use AdvancedEventSelectors. You must also use AdvancedEventSelectors if you want to filter on the eventName field.

        Configure the DataResource to specify the resource type and resource ARNs for which you want to log data events.

        Note

        The total number of allowed data resources is 250. This number can be distributed between 1 and 5 event selectors, but the total cannot exceed 250 across all selectors for the trail.

        The following example demonstrates how logging works when you configure logging of all data events for a general purpose bucket named amzn-s3-demo-bucket1. In this example, the CloudTrail user specified an empty prefix, and the option to log both Read and Write data events.

        • A user uploads an image file to amzn-s3-demo-bucket1.

        • The PutObject API operation is an Amazon S3 object-level API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified an S3 bucket with an empty prefix, events that occur on any object in that bucket are logged. The trail processes and logs the event.

        • A user uploads an object to an Amazon S3 bucket named arn:aws:s3:::amzn-s3-demo-bucket1.

        • The PutObject API operation occurred for an object in an S3 bucket that the CloudTrail user didn’t specify for the trail. The trail doesn’t log the event.

        The following example demonstrates how logging works when you configure logging of Lambda data events for a Lambda function named MyLambdaFunction, but not for all Lambda functions.

        • A user runs a script that includes a call to the MyLambdaFunction function and the MyOtherLambdaFunction function.

        • The Invoke API operation on MyLambdaFunction is an Lambda API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified logging data events for MyLambdaFunction, any invocations of that function are logged. The trail processes and logs the event.

        • The Invoke API operation on MyOtherLambdaFunction is an Lambda API. Because the CloudTrail user did not specify logging data events for all Lambda functions, the Invoke operation for MyOtherLambdaFunction does not match the function specified for the trail. The trail doesn’t log the event.

        • Type (string) –

          The resource type in which you want to log data events. You can specify the following basic event selector resource types:

          • AWS::DynamoDB::Table

          • AWS::Lambda::Function

          • AWS::S3::Object

          Additional resource types are available through advanced event selectors. For more information, see AdvancedEventSelector.

        • Values (list) –

          An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified resource type.

          • To log data events for all objects in all S3 buckets in your Amazon Web Services account, specify the prefix as arn:aws:s3.

          Note

          This also enables logging of data event activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a bucket that belongs to another Amazon Web Services account.

          • To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as arn:aws:s3:::amzn-s3-demo-bucket1/. The trail logs data events for all objects in this S3 bucket.

          • To log data events for specific objects, specify the S3 bucket and object prefix such as arn:aws:s3:::amzn-s3-demo-bucket1/example-images. The trail logs data events for objects in this S3 bucket that match the prefix.

          • To log data events for all Lambda functions in your Amazon Web Services account, specify the prefix as arn:aws:lambda.

          Note

          This also enables logging of Invoke activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a function that belongs to another Amazon Web Services account.

          • To log data events for a specific Lambda function, specify the function ARN.

          Note

          Lambda function ARNs are exact. For example, if you specify a function ARN arn:aws:lambda:us-west-2:111111111111:function:helloworld, data events will only be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld. They will not be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld2.

          • To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix as arn:aws:dynamodb.

          • (string) –

    • ExcludeManagementEventSources (list) –

      An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out Key Management Service or Amazon RDS Data API events by containing kms.amazonaws.com or rdsdata.amazonaws.com. By default, ExcludeManagementEventSources is empty, and KMS and Amazon RDS Data API events are logged to your trail. You can exclude management event sources only in Regions that support the event source.

      • (string) –

• AdvancedEventSelectors (list) –

  Specifies the settings for advanced event selectors. You can use advanced event selectors to log management events, data events for all resource types, and network activity events.

  You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging data events and Logging network activity events in the CloudTrail User Guide.

  • (dict) –

    Advanced event selectors let you create fine-grained selectors for CloudTrail management, data, and network activity events. They help you control costs by logging only those events that are important to you. For more information about configuring advanced event selectors, see the Logging data events, Logging network activity events, and Logging management events topics in the CloudTrail User Guide.

    You cannot apply both event selectors and advanced event selectors to a trail.

    For information about configurable advanced event selector fields, see AdvancedEventSelector in the CloudTrailUser Guide.

    • 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 more information, see AdvancedFieldSelector in the CloudTrailUser Guide.

        • 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) –

Return type:

dict

Returns:

Response Syntax

{
    'TrailARN': 'string',
    'EventSelectors': [
        {
            'ReadWriteType': 'ReadOnly'|'WriteOnly'|'All',
            'IncludeManagementEvents': True|False,
            'DataResources': [
                {
                    'Type': 'string',
                    'Values': [
                        'string',
                    ]
                },
            ],
            'ExcludeManagementEventSources': [
                'string',
            ]
        },
    ],
    'AdvancedEventSelectors': [
        {
            'Name': 'string',
            'FieldSelectors': [
                {
                    'Field': 'string',
                    'Equals': [
                        'string',
                    ],
                    'StartsWith': [
                        'string',
                    ],
                    'EndsWith': [
                        'string',
                    ],
                    'NotEquals': [
                        'string',
                    ],
                    'NotStartsWith': [
                        'string',
                    ],
                    'NotEndsWith': [
                        'string',
                    ]
                },
            ]
        },
    ]
}

Response Structure

• (dict) –

  • TrailARN (string) –

    Specifies the ARN of the trail that was updated with event selectors. The following is the format of a trail ARN.

    arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

  • EventSelectors (list) –

    Specifies the event selectors configured for your trail.

    • (dict) –

      Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn’t match any event selector, the trail doesn’t log the event.

      You can configure up to five event selectors for a trail.

      You cannot apply both event selectors and advanced event selectors to a trail.

      • ReadWriteType (string) –

        Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation.

        By default, the value is All.

      • IncludeManagementEvents (boolean) –

        Specify if you want your event selector to include management events for your trail.

        For more information, see Management Events in the CloudTrail User Guide.

        By default, the value is true.

        The first copy of management events is free. You are charged for additional copies of management events that you are logging on any subsequent trail in the same Region. For more information about CloudTrail pricing, see CloudTrail Pricing.

      • DataResources (list) –

        CloudTrail supports data event logging for Amazon S3 objects in standard S3 buckets, Lambda functions, and Amazon DynamoDB tables with basic event selectors. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events.

        For more information, see Data Events and Limits in CloudTrail in the CloudTrail User Guide.

        Note

        To log data events for all other resource types including objects stored in directory buckets, you must use AdvancedEventSelectors. You must also use AdvancedEventSelectors if you want to filter on the eventName field.

        • (dict) –

          You can configure the DataResource in an EventSelector to log data events for the following three resource types:

          • AWS::DynamoDB::Table

          • AWS::Lambda::Function

          • AWS::S3::Object

          To log data events for all other resource types including objects stored in directory buckets, you must use AdvancedEventSelectors. You must also use AdvancedEventSelectors if you want to filter on the eventName field.

          Configure the DataResource to specify the resource type and resource ARNs for which you want to log data events.

          Note

          The total number of allowed data resources is 250. This number can be distributed between 1 and 5 event selectors, but the total cannot exceed 250 across all selectors for the trail.

          The following example demonstrates how logging works when you configure logging of all data events for a general purpose bucket named amzn-s3-demo-bucket1. In this example, the CloudTrail user specified an empty prefix, and the option to log both Read and Write data events.

          • A user uploads an image file to amzn-s3-demo-bucket1.

          • The PutObject API operation is an Amazon S3 object-level API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified an S3 bucket with an empty prefix, events that occur on any object in that bucket are logged. The trail processes and logs the event.

          • A user uploads an object to an Amazon S3 bucket named arn:aws:s3:::amzn-s3-demo-bucket1.

          • The PutObject API operation occurred for an object in an S3 bucket that the CloudTrail user didn’t specify for the trail. The trail doesn’t log the event.

          The following example demonstrates how logging works when you configure logging of Lambda data events for a Lambda function named MyLambdaFunction, but not for all Lambda functions.

          • A user runs a script that includes a call to the MyLambdaFunction function and the MyOtherLambdaFunction function.

          • The Invoke API operation on MyLambdaFunction is an Lambda API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified logging data events for MyLambdaFunction, any invocations of that function are logged. The trail processes and logs the event.

          • The Invoke API operation on MyOtherLambdaFunction is an Lambda API. Because the CloudTrail user did not specify logging data events for all Lambda functions, the Invoke operation for MyOtherLambdaFunction does not match the function specified for the trail. The trail doesn’t log the event.

          • Type (string) –

            The resource type in which you want to log data events. You can specify the following basic event selector resource types:

            • AWS::DynamoDB::Table

            • AWS::Lambda::Function

            • AWS::S3::Object

            Additional resource types are available through advanced event selectors. For more information, see AdvancedEventSelector.

          • Values (list) –

            An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified resource type.

            • To log data events for all objects in all S3 buckets in your Amazon Web Services account, specify the prefix as arn:aws:s3.

            Note

            This also enables logging of data event activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a bucket that belongs to another Amazon Web Services account.

            • To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as arn:aws:s3:::amzn-s3-demo-bucket1/. The trail logs data events for all objects in this S3 bucket.

            • To log data events for specific objects, specify the S3 bucket and object prefix such as arn:aws:s3:::amzn-s3-demo-bucket1/example-images. The trail logs data events for objects in this S3 bucket that match the prefix.

            • To log data events for all Lambda functions in your Amazon Web Services account, specify the prefix as arn:aws:lambda.

            Note

            This also enables logging of Invoke activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a function that belongs to another Amazon Web Services account.

            • To log data events for a specific Lambda function, specify the function ARN.

            Note

            Lambda function ARNs are exact. For example, if you specify a function ARN arn:aws:lambda:us-west-2:111111111111:function:helloworld, data events will only be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld. They will not be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld2.

            • To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix as arn:aws:dynamodb.

            • (string) –

      • ExcludeManagementEventSources (list) –

        An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out Key Management Service or Amazon RDS Data API events by containing kms.amazonaws.com or rdsdata.amazonaws.com. By default, ExcludeManagementEventSources is empty, and KMS and Amazon RDS Data API events are logged to your trail. You can exclude management event sources only in Regions that support the event source.

        • (string) –

  • AdvancedEventSelectors (list) –

    Specifies the advanced event selectors configured for your trail.

    • (dict) –

      Advanced event selectors let you create fine-grained selectors for CloudTrail management, data, and network activity events. They help you control costs by logging only those events that are important to you. For more information about configuring advanced event selectors, see the Logging data events, Logging network activity events, and Logging management events topics in the CloudTrail User Guide.

      You cannot apply both event selectors and advanced event selectors to a trail.

      For information about configurable advanced event selector fields, see AdvancedEventSelector in the CloudTrailUser Guide.

      • 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 more information, see AdvancedFieldSelector in the CloudTrailUser Guide.

          • 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) –

Exceptions

• CloudTrail.Client.exceptions.TrailNotFoundException

• CloudTrail.Client.exceptions.InvalidTrailNameException

• CloudTrail.Client.exceptions.CloudTrailARNInvalidException

• CloudTrail.Client.exceptions.InvalidHomeRegionException

• CloudTrail.Client.exceptions.InvalidEventSelectorsException

• CloudTrail.Client.exceptions.ConflictException

• CloudTrail.Client.exceptions.ThrottlingException

• CloudTrail.Client.exceptions.UnsupportedOperationException

• CloudTrail.Client.exceptions.OperationNotPermittedException

• CloudTrail.Client.exceptions.NotOrganizationMasterAccountException

• CloudTrail.Client.exceptions.NoManagementAccountSLRExistsException

• CloudTrail.Client.exceptions.InsufficientDependencyServiceAccessPermissionException