:doc:`CloudTrail <../../cloudtrail>` / Client / get_insight_selectors

*********************
get_insight_selectors
*********************



.. py:method:: CloudTrail.Client.get_insight_selectors(**kwargs)

  

  Describes the settings for the Insights event selectors that you configured for your trail or event data store. ``GetInsightSelectors`` shows if CloudTrail Insights logging is enabled and which Insights types are configured with corresponding event categories. If you run ``GetInsightSelectors`` on a trail or event data store that does not have Insights events enabled, the operation throws the exception ``InsightNotEnabledException``

   

  Specify either the ``EventDataStore`` parameter to get Insights event selectors for an event data store, or the ``TrailName`` parameter to the get Insights event selectors for a trail. You cannot specify these parameters together.

   

  For more information, see `Working with CloudTrail Insights <https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-insights-events-with-cloudtrail.html>`__ in the *CloudTrail User Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetInsightSelectors>`_  


  **Request Syntax**
  ::

    response = client.get_insight_selectors(
        TrailName='string',
        EventDataStore='string'
    )
    
  :type TrailName: string
  :param TrailName: 

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

     

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

     

    You cannot use this parameter with the ``EventDataStore`` parameter.

    

  
  :type EventDataStore: string
  :param EventDataStore: 

    Specifies the ARN (or ID suffix of the ARN) of the event data store for which you want to get Insights selectors.

     

    You cannot use this parameter with the ``TrailName`` parameter.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'TrailARN': 'string',
          'InsightSelectors': [
              {
                  'InsightType': 'ApiCallRateInsight'|'ApiErrorRateInsight',
                  'EventCategories': [
                      'Management'|'Data',
                  ]
              },
          ],
          'EventDataStoreArn': 'string',
          'InsightsDestination': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **TrailARN** *(string) --* 

        The Amazon Resource Name (ARN) of a trail for which you want to get Insights selectors.

        
      

      - **InsightSelectors** *(list) --* 

        Contains the Insights types that are enabled on a trail or event data store. It also specifies the event categories on which a particular Insight type is enabled. ``ApiCallRateInsight`` and ``ApiErrorRateInsight`` are valid Insight types.The EventCategory field can specify ``Management`` or ``Data`` events or both. For event data store, you can log Insights for management events only.

        
        

        - *(dict) --* 

          A JSON string that contains a list of Insights types that are logged on a trail or event data store.

          
          

          - **InsightType** *(string) --* 

            The type of Insights events to log on a trail or event data store. ``ApiCallRateInsight`` and ``ApiErrorRateInsight`` are valid Insight types.

             

            The ``ApiCallRateInsight`` Insights type analyzes write-only management API calls or read and write data API calls that are aggregated per minute against a baseline API call volume.

             

            The ``ApiErrorRateInsight`` Insights type analyzes management and data API calls that result in error codes. The error is shown if the API call is unsuccessful.

            
          

          - **EventCategories** *(list) --* 

            Select the event category on which Insights should be enabled.

             

            
            * If EventCategories is not provided, the specified Insights types are enabled on management API calls by default.
             
            * If EventCategories is provided, the given event categories will overwrite the existing ones. For example, if a trail already has Insights enabled on management events, and then a PutInsightSelectors request is made with only data events specified in EventCategories, Insights on management events will be disabled.
            

            
            

            - *(string) --* 
        
      
    
      

      - **EventDataStoreArn** *(string) --* 

        The ARN of the source event data store that enabled Insights events.

        
      

      - **InsightsDestination** *(string) --* 

        The ARN of the destination event data store that logs Insights events.

        
  
  **Exceptions**
  
  *   :py:class:`CloudTrail.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`CloudTrail.Client.exceptions.InvalidParameterCombinationException`

  
  *   :py:class:`CloudTrail.Client.exceptions.TrailNotFoundException`

  
  *   :py:class:`CloudTrail.Client.exceptions.InvalidTrailNameException`

  
  *   :py:class:`CloudTrail.Client.exceptions.CloudTrailARNInvalidException`

  
  *   :py:class:`CloudTrail.Client.exceptions.UnsupportedOperationException`

  
  *   :py:class:`CloudTrail.Client.exceptions.OperationNotPermittedException`

  
  *   :py:class:`CloudTrail.Client.exceptions.InsightNotEnabledException`

  
  *   :py:class:`CloudTrail.Client.exceptions.NoManagementAccountSLRExistsException`

  
  *   :py:class:`CloudTrail.Client.exceptions.ThrottlingException`

  