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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-redshift/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#durationInteger

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)


4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
# File 'lib/aws-sdk-redshift/types.rb', line 4930

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

#end_timeTime

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)


4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
# File 'lib/aws-sdk-redshift/types.rb', line 4930

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

#markerString

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`, Amazon Web Services 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)


4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
# File 'lib/aws-sdk-redshift/types.rb', line 4930

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

#max_recordsInteger

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)


4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
# File 'lib/aws-sdk-redshift/types.rb', line 4930

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

#source_identifierString

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)


4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
# File 'lib/aws-sdk-redshift/types.rb', line 4930

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

#source_typeString

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)


4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
# File 'lib/aws-sdk-redshift/types.rb', line 4930

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

#start_timeTime

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)


4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
# File 'lib/aws-sdk-redshift/types.rb', line 4930

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