Class DescribeEventsCommandProtected

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.

Example

Use a bare-bones client and the command you need to make an API call.

import { DAXClient, DescribeEventsCommand } from "@aws-sdk/client-dax"; // ES Modules import
// const { DAXClient, DescribeEventsCommand } = require("@aws-sdk/client-dax"); // CommonJS import
const client = new DAXClient(config);
const input = { // DescribeEventsRequest
  SourceName: "STRING_VALUE",
  SourceType: "CLUSTER" || "PARAMETER_GROUP" || "SUBNET_GROUP",
  StartTime: new Date("TIMESTAMP"),
  EndTime: new Date("TIMESTAMP"),
  Duration: Number("int"),
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new DescribeEventsCommand(input);
const response = await client.send(command);
// { // DescribeEventsResponse
//   NextToken: "STRING_VALUE",
//   Events: [ // EventList
//     { // Event
//       SourceName: "STRING_VALUE",
//       SourceType: "CLUSTER" || "PARAMETER_GROUP" || "SUBNET_GROUP",
//       Message: "STRING_VALUE",
//       Date: new Date("TIMESTAMP"),
//     },
//   ],
// };

Param

DescribeEventsCommandInput

Returns

DescribeEventsCommandOutput

See

• DescribeEventsCommandInput for command's input shape.
• DescribeEventsCommandOutput for command's response shape.
• config for DAXClient's config shape.

Throws

InvalidParameterCombinationException (client fault)

Two or more incompatible parameters were specified.

Throws

InvalidParameterValueException (client fault)

The value for a parameter is invalid.

Throws

ServiceLinkedRoleNotFoundFault (client fault)

The specified service linked role (SLR) was not found.

Throws

DAXServiceException

Base exception class for all service exceptions from DAX service.