CloudTrail / Client / list_event_data_stores

list_event_data_stores#

CloudTrail.Client.list_event_data_stores(**kwargs)#

Returns information about all event data stores in the account, in the current Region.

Request Syntax

response = client.list_event_data_stores(
    NextToken='string',
    MaxResults=123
)

Parameters:

NextToken (string) – A token you can use to get the next page of event data store results.
MaxResults (integer) – The maximum number of event data stores to display on a single page.

Return type:

dict

Returns:

Response Syntax

{
    'EventDataStores': [
        {
            'EventDataStoreArn': 'string',
            'Name': 'string',
            'TerminationProtectionEnabled': True|False,
            '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,
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- EventDataStores (list) –
  
  Contains information about event data stores in the account, in the current Region.
  - (dict) –
    
    A storage lake of event data against which you can run complex SQL-based queries. An event data store can include events that you have logged on your account. To select events for an event data store, use advanced event selectors.
    - EventDataStoreArn (string) –
      
      The ARN of the event data store.
    - Name (string) –
      
      The name of the event data store.
    - TerminationProtectionEnabled (boolean) –
      
      Indicates whether the event data store is protected from termination.
    - Status (string) –
      
      The status of an event data store.
    - AdvancedEventSelectors (list) –
      
      The advanced event selectors that were used to select events for the data store.
      - (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 CloudTrail API Reference.
        
        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 CloudTrail API Reference.
        
        Note
        Selectors don’t support the use of wildcards like * . To match multiple values with a single condition, you may use StartsWith, EndsWith, NotStartsWith, or NotEndsWith to explicitly match the beginning or end of the event field.
        
        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 that an event data store is collecting logged events for an organization.
    - RetentionPeriod (integer) –
      
      The retention period, in days.
    - CreatedTimestamp (datetime) –
      
      The timestamp of the event data store’s creation.
    - UpdatedTimestamp (datetime) –
      
      The timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.
- NextToken (string) –
  
  A token you can use to get the next page of results.

Exceptions

CloudTrail.Client.exceptions.InvalidMaxResultsException
CloudTrail.Client.exceptions.InvalidNextTokenException
CloudTrail.Client.exceptions.OperationNotPermittedException
CloudTrail.Client.exceptions.UnsupportedOperationException
CloudTrail.Client.exceptions.NoManagementAccountSLRExistsException