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

Inherits:

Struct

• Object
• Struct
• Aws::DAX::Types::DescribeEventsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-dax/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #duration ⇒ 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.

• #max_results ⇒ Integer

  The maximum number of results to include in the response.

• #next_token ⇒ String

  An optional token returned from a prior request.

• #source_name ⇒ String

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

• #source_type ⇒ 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.

Instance Attribute Details

#duration ⇒ Integer

The number of minutes’ worth of events to retrieve.

Returns:

• (Integer)

# File 'lib/aws-sdk-dax/types.rb', line 623

class DescribeEventsRequest < Struct.new(
  :source_name,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-dax/types.rb', line 623

class DescribeEventsRequest < Struct.new(
  :source_name,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'lib/aws-sdk-dax/types.rb', line 623

class DescribeEventsRequest < Struct.new(
  :source_name,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'lib/aws-sdk-dax/types.rb', line 623

class DescribeEventsRequest < Struct.new(
  :source_name,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'lib/aws-sdk-dax/types.rb', line 623

class DescribeEventsRequest < Struct.new(
  :source_name,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#source_type ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-dax/types.rb', line 623

class DescribeEventsRequest < Struct.new(
  :source_name,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-dax/types.rb', line 623

class DescribeEventsRequest < Struct.new(
  :source_name,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end