DAX / Client / describe_events

describe_events#

DAX.Client.describe_events(**kwargs)#

Returns events related to DAX clusters and parameter groups. You can obtain events specific to a particular DAX cluster or parameter group by providing the name as a parameter.

By default, only the events occurring within the last 24 hours 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='CLUSTER'|'PARAMETER_GROUP'|'SUBNET_GROUP',
    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 will be returned. If not specified, then 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.

  • EndTime (datetime) – The end of the time interval for which to retrieve events, specified in ISO 8601 format.

  • Duration (integer) – The number of minutes’ worth of events to retrieve.

  • MaxResults (integer) –

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

    The value for MaxResults must be between 20 and 100.

  • NextToken (string) – An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Events': [
        {
            'SourceName': 'string',
            'SourceType': 'CLUSTER'|'PARAMETER_GROUP'|'SUBNET_GROUP',
            'Message': 'string',
            'Date': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      Provides an identifier to allow retrieval of paginated results.

    • Events (list) –

      An array of events. Each element in the array represents one event.

      • (dict) –

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

        • SourceName (string) –

          The source of the event. For example, if the event occurred at the node level, the source would be the node ID.

        • SourceType (string) –

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

        • Message (string) –

          A user-defined message associated with the event.

        • Date (datetime) –

          The date and time when the event occurred.

Exceptions

  • DAX.Client.exceptions.ServiceLinkedRoleNotFoundFault

  • DAX.Client.exceptions.InvalidParameterValueException

  • DAX.Client.exceptions.InvalidParameterCombinationException