AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::CloudWatch::Types::GetInsightRuleReportInput

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

Overview

Note:

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

{
  rule_name: "InsightRuleName", # required
  start_time: Time.now, # required
  end_time: Time.now, # required
  period: 1, # required
  max_contributor_count: 1,
  metrics: ["InsightRuleMetricName"],
  order_by: "InsightRuleOrderBy",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#end_timeTime

The end time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

Returns:

  • (Time)


1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1232

class GetInsightRuleReportInput < Struct.new(
  :rule_name,
  :start_time,
  :end_time,
  :period,
  :max_contributor_count,
  :metrics,
  :order_by)
  SENSITIVE = []
  include Aws::Structure
end

#max_contributor_countInteger

The maximum number of contributors to include in the report. The range is 1 to 100. If you omit this, the default of 10 is used.

Returns:

  • (Integer)


1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1232

class GetInsightRuleReportInput < Struct.new(
  :rule_name,
  :start_time,
  :end_time,
  :period,
  :max_contributor_count,
  :metrics,
  :order_by)
  SENSITIVE = []
  include Aws::Structure
end

#metricsArray<String>

Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more of the following metrics:

  • UniqueContributors -- the number of unique contributors for each data point.

  • MaxContributorValue -- the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.

    If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value, during that period.

  • SampleCount -- the number of data points matched by the rule.

  • Sum -- the sum of the values from all contributors during the time period represented by that data point.

  • Minimum -- the minimum value from a single observation during the time period represented by that data point.

  • Maximum -- the maximum value from a single observation during the time period represented by that data point.

  • Average -- the average value from all contributors during the time period represented by that data point.

Returns:

  • (Array<String>)


1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1232

class GetInsightRuleReportInput < Struct.new(
  :rule_name,
  :start_time,
  :end_time,
  :period,
  :max_contributor_count,
  :metrics,
  :order_by)
  SENSITIVE = []
  include Aws::Structure
end

#order_byString

Determines what statistic to use to rank the contributors. Valid values are SUM and MAXIMUM.

Returns:

  • (String)


1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1232

class GetInsightRuleReportInput < Struct.new(
  :rule_name,
  :start_time,
  :end_time,
  :period,
  :max_contributor_count,
  :metrics,
  :order_by)
  SENSITIVE = []
  include Aws::Structure
end

#periodInteger

The period, in seconds, to use for the statistics in the InsightRuleMetricDatapoint results.

Returns:

  • (Integer)


1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1232

class GetInsightRuleReportInput < Struct.new(
  :rule_name,
  :start_time,
  :end_time,
  :period,
  :max_contributor_count,
  :metrics,
  :order_by)
  SENSITIVE = []
  include Aws::Structure
end

#rule_nameString

The name of the rule that you want to see data from.

Returns:

  • (String)


1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1232

class GetInsightRuleReportInput < Struct.new(
  :rule_name,
  :start_time,
  :end_time,
  :period,
  :max_contributor_count,
  :metrics,
  :order_by)
  SENSITIVE = []
  include Aws::Structure
end

#start_timeTime

The start time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

Returns:

  • (Time)


1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1232

class GetInsightRuleReportInput < Struct.new(
  :rule_name,
  :start_time,
  :end_time,
  :period,
  :max_contributor_count,
  :metrics,
  :order_by)
  SENSITIVE = []
  include Aws::Structure
end