Class: Aws::Redshift::Types::DescribeEventsMessage

Inherits:

Struct

• Object
• Struct
• Aws::Redshift::Types::DescribeEventsMessage

Includes:

Structure

Defined in:

lib/aws-sdk-redshift/types.rb

Overview

Note:

When making an API call, you may pass DescribeEventsMessage data as a hash:

{
  source_identifier: "String",
  source_type: "cluster", # accepts cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot
  start_time: Time.now,
  end_time: Time.now,
  duration: 1,
  max_records: 1,
  marker: "String",
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #duration ⇒ Integer

  The number of minutes prior to the time of the request for which to retrieve events.

• #end_time ⇒ Time

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

• #marker ⇒ String

  An optional parameter that specifies the starting point to return a set of response records.

• #max_records ⇒ Integer

  The maximum number of response records to return in each call.

• #source_identifier ⇒ 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 prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.

Default: ‘60`

Returns:

• (Integer)

# File 'lib/aws-sdk-redshift/types.rb', line 3740

class DescribeEventsMessage < Struct.new(
  :source_identifier,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :max_records,
  :marker)
  include Aws::Structure
end

#end_time ⇒ Time

The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the

ISO8601 Wikipedia page.][1

Example: ‘2009-07-08T18:00Z`

[1]: en.wikipedia.org/wiki/ISO_8601

Returns:

• (Time)

# File 'lib/aws-sdk-redshift/types.rb', line 3740

class DescribeEventsMessage < Struct.new(
  :source_identifier,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :max_records,
  :marker)
  include Aws::Structure
end

#marker ⇒ String

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in ‘MaxRecords`, AWS returns a value in the `Marker` field of the response. You can retrieve the next set of response records by providing the returned marker value in the `Marker` parameter and retrying the request.

Returns:

• (String)

# File 'lib/aws-sdk-redshift/types.rb', line 3740

class DescribeEventsMessage < Struct.new(
  :source_identifier,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :max_records,
  :marker)
  include Aws::Structure
end

#max_records ⇒ Integer

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified ‘MaxRecords` value, a value is returned in a `marker` field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: ‘100`

Constraints: minimum 20, maximum 100.

Returns:

• (Integer)

# File 'lib/aws-sdk-redshift/types.rb', line 3740

class DescribeEventsMessage < Struct.new(
  :source_identifier,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :max_records,
  :marker)
  include Aws::Structure
end

#source_identifier ⇒ String

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

Constraints:

If SourceIdentifier is supplied, SourceType must also be provided.

• Specify a cluster identifier when SourceType is ‘cluster`.

• Specify a cluster security group name when SourceType is ‘cluster-security-group`.

• Specify a cluster parameter group name when SourceType is ‘cluster-parameter-group`.

• Specify a cluster snapshot identifier when SourceType is ‘cluster-snapshot`.

Returns:

• (String)

# File 'lib/aws-sdk-redshift/types.rb', line 3740

class DescribeEventsMessage < Struct.new(
  :source_identifier,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :max_records,
  :marker)
  include Aws::Structure
end

#source_type ⇒ String

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

Constraints:

If SourceType is supplied, SourceIdentifier must also be provided.

• Specify ‘cluster` when SourceIdentifier is a cluster identifier.

• Specify ‘cluster-security-group` when SourceIdentifier is a cluster security group name.

• Specify ‘cluster-parameter-group` when SourceIdentifier is a cluster parameter group name.

• Specify ‘cluster-snapshot` when SourceIdentifier is a cluster snapshot identifier.

Returns:

• (String)

# File 'lib/aws-sdk-redshift/types.rb', line 3740

class DescribeEventsMessage < Struct.new(
  :source_identifier,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :max_records,
  :marker)
  include Aws::Structure
end

#start_time ⇒ Time

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the

ISO8601 Wikipedia page.][1

Example: ‘2009-07-08T18:00Z`

[1]: en.wikipedia.org/wiki/ISO_8601

Returns:

• (Time)

# File 'lib/aws-sdk-redshift/types.rb', line 3740

class DescribeEventsMessage < Struct.new(
  :source_identifier,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :max_records,
  :marker)
  include Aws::Structure
end