CloudTrail / Client / get_event_configuration

get_event_configuration¶

CloudTrail.Client.get_event_configuration(**kwargs)¶

Retrieves the current event configuration settings for the specified event data store or trail. The response includes maximum event size configuration, the context key selectors configured for the event data store, and any aggregation settings configured for the trail.

Request Syntax

response = client.get_event_configuration(
    TrailName='string',
    EventDataStore='string'
)

Parameters:

TrailName (string) – The name of the trail for which you want to retrieve event configuration settings.
EventDataStore (string) – The Amazon Resource Name (ARN) or ID suffix of the ARN of the event data store for which you want to retrieve event configuration settings.

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 for which the event configuration settings are returned.
- EventDataStoreArn (string) –
  
  The Amazon Resource Name (ARN) or ID suffix of the ARN of the event data store for which the event configuration settings are returned.
- 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) –
  
  The 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

CloudTrail.Client.exceptions.TrailNotFoundException
CloudTrail.Client.exceptions.InvalidTrailNameException
CloudTrail.Client.exceptions.CloudTrailARNInvalidException
CloudTrail.Client.exceptions.UnsupportedOperationException
CloudTrail.Client.exceptions.OperationNotPermittedException
CloudTrail.Client.exceptions.EventDataStoreARNInvalidException
CloudTrail.Client.exceptions.EventDataStoreNotFoundException
CloudTrail.Client.exceptions.InvalidEventDataStoreStatusException
CloudTrail.Client.exceptions.InvalidParameterException
CloudTrail.Client.exceptions.InvalidEventDataStoreCategoryException
CloudTrail.Client.exceptions.NoManagementAccountSLRExistsException
CloudTrail.Client.exceptions.InvalidParameterCombinationException