:doc:`Redshift <../../redshift>` / Client / describe_events

***************
describe_events
***************



.. py:method:: Redshift.Client.describe_events(**kwargs)

  

  Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeEvents>`_  


  **Request Syntax**
  ::

    response = client.describe_events(
        SourceIdentifier='string',
        SourceType='cluster'|'cluster-parameter-group'|'cluster-security-group'|'cluster-snapshot'|'scheduled-action',
        StartTime=datetime(2015, 1, 1),
        EndTime=datetime(2015, 1, 1),
        Duration=123,
        MaxRecords=123,
        Marker='string'
    )
    
  :type SourceIdentifier: string
  :param SourceIdentifier: 

    The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.

     

    Constraints:

     

    If *SourceIdentifier* is supplied, *SourceType* must also be provided.

     

    
    * Specify a cluster identifier when *SourceType* is ``cluster``.
     
    * Specify a cluster security group name when *SourceType* is ``cluster-security-group``.
     
    * Specify a cluster parameter group name when *SourceType* is ``cluster-parameter-group``.
     
    * Specify a cluster snapshot identifier when *SourceType* is ``cluster-snapshot``.
    

    

  
  :type SourceType: string
  :param SourceType: 

    The event source to retrieve events for. If no value is specified, all events are returned.

     

    Constraints:

     

    If *SourceType* is supplied, *SourceIdentifier* must also be provided.

     

    
    * Specify ``cluster`` when *SourceIdentifier* is a cluster identifier.
     
    * Specify ``cluster-security-group`` when *SourceIdentifier* is a cluster security group name.
     
    * Specify ``cluster-parameter-group`` when *SourceIdentifier* is a cluster parameter group name.
     
    * Specify ``cluster-snapshot`` when *SourceIdentifier* is a cluster snapshot identifier.
    

    

  
  :type StartTime: datetime
  :param StartTime: 

    The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the `ISO8601 Wikipedia page. <http://en.wikipedia.org/wiki/ISO_8601>`__

     

    Example: ``2009-07-08T18:00Z``

    

  
  :type EndTime: datetime
  :param EndTime: 

    The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the `ISO8601 Wikipedia page. <http://en.wikipedia.org/wiki/ISO_8601>`__

     

    Example: ``2009-07-08T18:00Z``

    

  
  :type Duration: integer
  :param Duration: 

    The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.

     

    Default: ``60``

    

  
  :type MaxRecords: integer
  :param MaxRecords: 

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified ``MaxRecords`` value, a value is returned in a ``marker`` field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

     

    Default: ``100``

     

    Constraints: minimum 20, maximum 100.

    

  
  :type Marker: string
  :param Marker: 

    An optional parameter that specifies the starting point to return a set of response records. When the results of a  DescribeEvents request exceed the value specified in ``MaxRecords``, Amazon Web Services returns a value in the ``Marker`` field of the response. You can retrieve the next set of response records by providing the returned marker value in the ``Marker`` parameter and retrying the request.

    

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

    
    ::

      {
          'Marker': 'string',
          'Events': [
              {
                  'SourceIdentifier': 'string',
                  'SourceType': 'cluster'|'cluster-parameter-group'|'cluster-security-group'|'cluster-snapshot'|'scheduled-action',
                  'Message': 'string',
                  'EventCategories': [
                      'string',
                  ],
                  'Severity': 'string',
                  'Date': datetime(2015, 1, 1),
                  'EventId': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Marker** *(string) --* 

        A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the ``Marker`` parameter and retrying the command. If the ``Marker`` field is empty, all response records have been retrieved for the request.

        
      

      - **Events** *(list) --* 

        A list of ``Event`` instances.

        
        

        - *(dict) --* 

          Describes an event.

          
          

          - **SourceIdentifier** *(string) --* 

            The identifier for the source of the event.

            
          

          - **SourceType** *(string) --* 

            The source type for this event.

            
          

          - **Message** *(string) --* 

            The text of this event.

            
          

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

            A list of the event categories.

             

            Values: Configuration, Management, Monitoring, Security, Pending

            
            

            - *(string) --* 
        
          

          - **Severity** *(string) --* 

            The severity of the event.

             

            Values: ERROR, INFO

            
          

          - **Date** *(datetime) --* 

            The date and time of the event.

            
          

          - **EventId** *(string) --* 

            The identifier of the event.

            
      
    
  