class Aws::CloudWatch::Types::GetInsightRuleReportInput

@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",
    }

@!attribute [rw] rule_name

The name of the rule that you want to see data from.
@return [String]

@!attribute [rw] start_time

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`.
@return [Time]

@!attribute [rw] end_time

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`.
@return [Time]

@!attribute [rw] period

The period, in seconds, to use for the statistics in the
`InsightRuleMetricDatapoint` results.
@return [Integer]

@!attribute [rw] max_contributor_count

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.
@return [Integer]

@!attribute [rw] metrics

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.
@return [Array<String>]

@!attribute [rw] order_by

Determines what statistic to use to rank the contributors. Valid
values are SUM and MAXIMUM.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetInsightRuleReportInput AWS API Documentation

Constants

SENSITIVE