:doc:`MemoryDB <../../memorydb>` / Client / describe_events

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



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

  

  Returns events related to clusters, security groups, and parameter groups. You can obtain events specific to a particular cluster, security group, or parameter group by providing the name as a parameter. By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

  

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


  **Request Syntax**
  ::

    response = client.describe_events(
        SourceName='string',
        SourceType='node'|'parameter-group'|'subnet-group'|'cluster'|'user'|'acl',
        StartTime=datetime(2015, 1, 1),
        EndTime=datetime(2015, 1, 1),
        Duration=123,
        MaxResults=123,
        NextToken='string'
    )
    
  :type SourceName: string
  :param SourceName: 

    The identifier of the event source for which events are returned. If not specified, all sources are included in the response.

    

  
  :type SourceType: string
  :param SourceType: 

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

    

  
  :type StartTime: datetime
  :param StartTime: 

    The beginning of the time interval to retrieve events for, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z

    

  
  :type EndTime: datetime
  :param EndTime: 

    The end of the time interval for which to retrieve events, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z

    

  
  :type Duration: integer
  :param Duration: 

    The number of minutes worth of events to retrieve.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    

  
  :type NextToken: string
  :param NextToken: 

    An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

    

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

    
    ::

      {
          'NextToken': 'string',
          'Events': [
              {
                  'SourceName': 'string',
                  'SourceType': 'node'|'parameter-group'|'subnet-group'|'cluster'|'user'|'acl',
                  'Message': 'string',
                  'Date': datetime(2015, 1, 1)
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **NextToken** *(string) --* 

        An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

        
      

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

        A list of events. Each element in the list contains detailed information about one event.

        
        

        - *(dict) --* 

          Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster or adding or removing a node.

          
          

          - **SourceName** *(string) --* 

            The name for the source of the event. For example, if the event occurred at the cluster level, the identifier would be the name of the cluster.

            
          

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

            Specifies the origin of this event - a cluster, a parameter group, a security group, etc.

            
          

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

            The text of the event.

            
          

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

            The date and time when the event occurred.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`MemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFault`

  
  *   :py:class:`MemoryDB.Client.exceptions.InvalidParameterValueException`

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

  