class Amazonite::CloudWatch::GetInsightRuleReportInput

Amazonite::CloudWatch::GetInsightRuleReportInput
Reference
Object

Included Modules

JSON::Serializable

Defined in:

cloudwatch/get_insight_rule_report_input.cr

Constructors

.new(rule_name : String, start_time : Time, end_time : Time, period : Int32, max_contributor_count : Int32 | Nil = nil, metrics : Array(String) | Nil = nil, order_by : String | Nil = nil)
.new(pull : JSON::PullParser)
.new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance Method Summary

#==(other : self)
Returns true if this reference is the same as other.
#end_time : Time
The end time of the data to use in the report.
#end_time=(end_time : Time)
The end time of the data to use in the report.
#hash(hasher)
See Object#hash(hasher)
#max_contributor_count : Int32 | Nil
The maximum number of contributors to include in the report.
#max_contributor_count=(max_contributor_count : Int32 | Nil)
The maximum number of contributors to include in the report.
#metrics : Array(String) | Nil
Specifies which metrics to use for aggregation of contributor values for the report.
#metrics=(metrics : Array(String) | Nil)
Specifies which metrics to use for aggregation of contributor values for the report.
#order_by : String | Nil
Determines what statistic to use to rank the contributors.
#order_by=(order_by : String | Nil)
Determines what statistic to use to rank the contributors.
#period : Int32
The period, in seconds, to use for the statistics in the InsightRuleMetricDatapoint results.
#period=(period : Int32)
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.
#rule_name=(rule_name : 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.
#start_time=(start_time : Time)
The start time of the data to use in the report.
#validate! : Nil

Constructor Detail

def self.new(rule_name : String, start_time : Time, end_time : Time, period : Int32, max_contributor_count : Int32 | Nil = nil, metrics : Array(String) | Nil = nil, order_by : String | Nil = nil) #

[View source]

def self.new(pull : JSON::PullParser) #

[View source]

def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #

Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.

def 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.

[View source]

def end_time=(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.

[View source]

def hash(hasher) #

Description copied from class Reference

See Object#hash(hasher)

def max_contributor_count : Int32 | Nil #

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.

[View source]

def max_contributor_count=(max_contributor_count : Int32 | Nil) #

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.

[View source]

def metrics : Array(String) | Nil #

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.

[View source]

def metrics=(metrics : Array(String) | Nil) #

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.

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.

[View source]

def order_by : String | Nil #

Determines what statistic to use to rank the contributors. Valid values are Sum and Maximum.

[View source]

def order_by=(order_by : String | Nil) #

Determines what statistic to use to rank the contributors. Valid values are Sum and Maximum.

[View source]

def period : Int32 #

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

[View source]

def period=(period : Int32) #

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

[View source]

def rule_name : String #

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

[View source]

def rule_name=(rule_name : String) #

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

[View source]

def 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.

[View source]

def start_time=(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.

[View source]

def validate! : Nil #

[View source]