Struct aws_sdk_cloudwatch::client::fluent_builders::GetInsightRuleReport

pub struct GetInsightRuleReport<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to GetInsightRuleReport.

This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log group.

You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:

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

Implementations

impl<C, M, R> GetInsightRuleReport<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<GetInsightRuleReportOutput, SdkError<GetInsightRuleReportError>> where
    R::Policy: SmithyRetryPolicy<GetInsightRuleReportInputOperationOutputAlias, GetInsightRuleReportOutput, GetInsightRuleReportError, GetInsightRuleReportInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn rule_name(self, inp: impl Into<String>) -> Self

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

pub fn set_rule_name(self, input: Option<String>) -> Self

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

pub fn start_time(self, inp: Instant) -> Self

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.

pub fn set_start_time(self, input: Option<Instant>) -> Self

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.

pub fn end_time(self, inp: Instant) -> Self

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.

pub fn set_end_time(self, input: Option<Instant>) -> Self

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.

pub fn period(self, inp: i32) -> Self

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

pub fn set_period(self, input: Option<i32>) -> Self

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

pub fn max_contributor_count(self, inp: i32) -> Self

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.

pub fn set_max_contributor_count(self, input: Option<i32>) -> Self

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.

pub fn metrics(self, inp: impl Into<String>) -> Self

Appends an item to Metrics.

To override the contents of this collection use set_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.

pub fn set_metrics(self, input: Option<Vec<String>>) -> Self

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.

pub fn order_by(self, inp: impl Into<String>) -> Self

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

pub fn set_order_by(self, input: Option<String>) -> Self

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

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for GetInsightRuleReport<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.