You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DAX::Types::DescribeEventsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeEventsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  source_name: "String",
  source_type: "CLUSTER", # accepts CLUSTER, PARAMETER_GROUP, SUBNET_GROUP
  start_time: Time.now,
  end_time: Time.now,
  duration: 1,
  max_results: 1,
  next_token: "String",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#duration ⇒ Integer

The number of minutes\' worth of events to retrieve.

Returns:

  • (Integer) —

    The number of minutes\' worth of events to retrieve.

#end_time ⇒ Time

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Returns:

  • (Time) —

    The end of the time interval for which to retrieve events, specified in ISO 8601 format.

#max_results ⇒ 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.

Returns:

  • (Integer) —

    The maximum number of results to include in the response.

#next_token ⇒ 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.

Returns:

  • (String) —

    An optional token returned from a prior request.

#source_name ⇒ String

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

Returns:

  • (String) —

    The identifier of the event source for which events will be returned.

#source_type ⇒ String

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

Possible values:

  • CLUSTER
  • PARAMETER_GROUP
  • SUBNET_GROUP

Returns:

  • (String) —

    The event source to retrieve events for.

#start_time ⇒ Time

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Returns:

  • (Time) —

    The beginning of the time interval to retrieve events for, specified in ISO 8601 format.