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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetInsightRuleReportInput as input to an Aws::Client method, you can use a vanilla 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",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#end_time ⇒ 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.

Returns:

  • (Time) —

    The end time of the data to use in the report.

#max_contributor_count ⇒ Integer

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) —

    The maximum number of contributors to include in the report.

#metrics ⇒ Array<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>) —

    Specifies which metrics to use for aggregation of contributor values for the report.

#order_by ⇒ String

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

Returns:

  • (String) —

    Determines what statistic to use to rank the contributors.

#period ⇒ Integer

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

Returns:

  • (Integer) —

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

#rule_name ⇒ String

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

Returns:

  • (String) —

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

#start_time ⇒ 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.

Returns:

  • (Time) —

    The start time of the data to use in the report.