CloudTrail / Client / put_event_configuration

put_event_configuration

CloudTrail.Client.put_event_configuration(**kwargs)

Updates the event configuration settings for the specified event data store or trail. This operation supports updating the maximum event size, adding or modifying context key selectors for event data store, and configuring aggregation settings for the trail.

See also: AWS API Documentation

Request Syntax

response = client.put_event_configuration(
    TrailName='string',
    EventDataStore='string',
    MaxEventSize='Standard'|'Large',
    ContextKeySelectors=[
        {
            'Type': 'TagContext'|'RequestContext',
            'Equals': [
                'string',
            ]
        },
    ],
    AggregationConfigurations=[
        {
            'Templates': [
                'API_ACTIVITY'|'RESOURCE_ACCESS'|'USER_ACTIONS',
            ],
            'EventCategory': 'Data'
        },
    ]
)
Parameters:

  • TrailName (string) – The name of the trail for which you want to update event configuration settings.

  • EventDataStore (string) – The Amazon Resource Name (ARN) or ID suffix of the ARN of the event data store for which event configuration settings are updated.

  • MaxEventSize (string) – The maximum allowed size for events to be stored in the specified event data store. If you are using context key selectors, MaxEventSize must be set to Large.

  • ContextKeySelectors (list) –

    A list of context key selectors that will be included to provide enriched event data.

    • (dict) –

      An object that contains information types to be included in CloudTrail enriched events.

      • Type (string) – [REQUIRED]

        Specifies the type of the event record field in ContextKeySelector. Valid values include RequestContext, TagContext.

      • Equals (list) – [REQUIRED]

        A list of keys defined by Type to be included in CloudTrail enriched events.

        • (string) –

  • AggregationConfigurations (list) –

    The list of aggregation configurations that you want to configure for the trail.

    • (dict) –

      An object that contains configuration settings for aggregating events.

      • Templates (list) – [REQUIRED]

        A list of aggregation templates that can be used to configure event aggregation.

        • (string) –

          Specifies the type of the aggregation templates in the aggregation configuration. Valid values include API_ACTIVITY, RESOURCE_ACCESS and USER_ACTIONS.

      • EventCategory (string) – [REQUIRED]

        Specifies the event category for which aggregation should be performed.

Return type:

dict

Returns:

Response Syntax

{
    'TrailARN': 'string',
    'EventDataStoreArn': 'string',
    'MaxEventSize': 'Standard'|'Large',
    'ContextKeySelectors': [
        {
            'Type': 'TagContext'|'RequestContext',
            'Equals': [
                'string',
            ]
        },
    ],
    'AggregationConfigurations': [
        {
            'Templates': [
                'API_ACTIVITY'|'RESOURCE_ACCESS'|'USER_ACTIONS',
            ],
            'EventCategory': 'Data'
        },
    ]
}

Response Structure

  • (dict) –

    • TrailARN (string) –

      The Amazon Resource Name (ARN) of the trail that has aggregation enabled.

    • EventDataStoreArn (string) –

      The Amazon Resource Name (ARN) or ID suffix of the ARN of the event data store for which the event configuration settings were updated.

    • MaxEventSize (string) –

      The maximum allowed size for events stored in the specified event data store.

    • ContextKeySelectors (list) –

      The list of context key selectors that are configured for the event data store.

      • (dict) –

        An object that contains information types to be included in CloudTrail enriched events.

        • Type (string) –

          Specifies the type of the event record field in ContextKeySelector. Valid values include RequestContext, TagContext.

        • Equals (list) –

          A list of keys defined by Type to be included in CloudTrail enriched events.

          • (string) –

    • AggregationConfigurations (list) –

      A list of aggregation configurations that are configured for the trail.

      • (dict) –

        An object that contains configuration settings for aggregating events.

        • Templates (list) –

          A list of aggregation templates that can be used to configure event aggregation.

          • (string) –

            Specifies the type of the aggregation templates in the aggregation configuration. Valid values include API_ACTIVITY, RESOURCE_ACCESS and USER_ACTIONS.

        • EventCategory (string) –

          Specifies the event category for which aggregation should be performed.

Exceptions