AWS SDK Version 3 for .NET
API Reference

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.

Container for the parameters to the GetInsightRuleReport operation. 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:

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CloudWatch.AmazonCloudWatchRequest
      Amazon.CloudWatch.Model.GetInsightRuleReportRequest

Namespace: Amazon.CloudWatch.Model
Assembly: AWSSDK.CloudWatch.dll
Version: 3.x.y.z

Syntax

C#
public class GetInsightRuleReportRequest : AmazonCloudWatchRequest
         IAmazonWebServiceRequest

The GetInsightRuleReportRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property EndTime System.DateTime

Gets and sets the property EndTime.

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.

Public Property MaxContributorCount System.Int32

Gets and sets the property MaxContributorCount.

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.

Public Property Metrics System.Collections.Generic.List<System.String>

Gets and sets the property 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.

Public Property OrderBy System.String

Gets and sets the property OrderBy.

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

Public Property Period System.Int32

Gets and sets the property Period.

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

Public Property RuleName System.String

Gets and sets the property RuleName.

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

Public Property StartTime System.DateTime

Gets and sets the property StartTime.

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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5