DescribeEvents - Amazon MemoryDB
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

DescribeEvents

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.

Request Syntax

{ "Duration": number, "EndTime": number, "MaxResults": number, "NextToken": "string", "SourceName": "string", "SourceType": "string", "StartTime": number }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Duration

The number of minutes worth of events to retrieve.

Type: Integer

Required: No

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

Required: No

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

Required: No

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.

Type: String

Required: No

SourceName

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

Type: String

Required: No

SourceType

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

Type: String

Valid Values: node | parameter-group | subnet-group | cluster | user | acl

Required: No

StartTime

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

Type: Timestamp

Required: No

Response Syntax

{ "Events": [ { "Date": number, "Message": "string", "SourceName": "string", "SourceType": "string" } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Events

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

Type: Array of Event objects

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.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterCombinationException

HTTP Status Code: 400

InvalidParameterValueException

HTTP Status Code: 400

ServiceLinkedRoleNotFoundFault

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: