describe_events

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

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'
)

Parameters

• SourceName (string) -- The identifier of the event source for which events are returned. If not specified, all sources are included in the response.
• SourceType (string) -- The event source to retrieve events for. If no value is specified, all events are returned.
• StartTime (datetime) -- The beginning of the time interval to retrieve events for, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z
• EndTime (datetime) -- The end of the time interval for which to retrieve events, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z
• Duration (integer) -- The number of minutes worth of events to retrieve.
• MaxResults (integer) -- 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.
• 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.

Return type

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

• MemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFault
• MemoryDB.Client.exceptions.InvalidParameterValueException
• MemoryDB.Client.exceptions.InvalidParameterCombinationException