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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb

Overview

Note:

When making an API call, you may pass DescribeEventsRequest data as a 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",
}

Instance Attribute Summary collapse

Instance Attribute Details

#durationInteger

The number of minutes' worth of events to retrieve.

Returns:

  • (Integer)


650
651
652
653
654
655
656
657
658
659
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 650

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

#end_timeTime

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

Returns:

  • (Time)


650
651
652
653
654
655
656
657
658
659
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 650

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

#max_resultsInteger

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)


650
651
652
653
654
655
656
657
658
659
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 650

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

#next_tokenString

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)


650
651
652
653
654
655
656
657
658
659
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 650

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

#source_nameString

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)


650
651
652
653
654
655
656
657
658
659
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 650

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

#source_typeString

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

Returns:

  • (String)


650
651
652
653
654
655
656
657
658
659
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 650

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

#start_timeTime

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

Returns:

  • (Time)


650
651
652
653
654
655
656
657
658
659
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 650

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