Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudWatch.GetInsightRuleReport

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

Creating a Request

data GetInsightRuleReport Source #

See: newGetInsightRuleReport smart constructor.

Constructors

GetInsightRuleReport'

Fields

maxContributorCount :: Maybe Int
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.
metrics :: Maybe [Text]
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.
orderBy :: Maybe Text
Determines what statistic to use to rank the contributors. Valid values are SUM and MAXIMUM.
ruleName :: Text
The name of the rule that you want to see data from.
startTime :: ISO8601
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.
endTime :: ISO8601
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.
period :: Natural
The period, in seconds, to use for the statistics in the InsightRuleMetricDatapoint results.

Instances

Instances details

ToHeaders GetInsightRuleReport Source #
Instance details Defined in Amazonka.CloudWatch.GetInsightRuleReport Methods toHeaders :: GetInsightRuleReport -> [Header] #
ToPath GetInsightRuleReport Source #
Instance details Defined in Amazonka.CloudWatch.GetInsightRuleReport Methods toPath :: GetInsightRuleReport -> ByteString #
ToQuery GetInsightRuleReport Source #
Instance details Defined in Amazonka.CloudWatch.GetInsightRuleReport Methods toQuery :: GetInsightRuleReport -> QueryString #
AWSRequest GetInsightRuleReport Source #
Instance details Defined in Amazonka.CloudWatch.GetInsightRuleReport Associated Types type AWSResponse GetInsightRuleReport # Methods request :: (Service -> Service) -> GetInsightRuleReport -> Request GetInsightRuleReport # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetInsightRuleReport -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetInsightRuleReport))) #
Generic GetInsightRuleReport Source #
Instance details Defined in Amazonka.CloudWatch.GetInsightRuleReport Associated Types type Rep GetInsightRuleReport :: Type -> Type # Methods from :: GetInsightRuleReport -> Rep GetInsightRuleReport x # to :: Rep GetInsightRuleReport x -> GetInsightRuleReport #
Read GetInsightRuleReport Source #
Instance details Defined in Amazonka.CloudWatch.GetInsightRuleReport Methods readsPrec :: Int -> ReadS GetInsightRuleReport # readList :: ReadS [GetInsightRuleReport] # readPrec :: ReadPrec GetInsightRuleReport # readListPrec :: ReadPrec [GetInsightRuleReport] #
Show GetInsightRuleReport Source #
Instance details Defined in Amazonka.CloudWatch.GetInsightRuleReport Methods showsPrec :: Int -> GetInsightRuleReport -> ShowS # show :: GetInsightRuleReport -> String # showList :: [GetInsightRuleReport] -> ShowS #
NFData GetInsightRuleReport Source #
Instance details Defined in Amazonka.CloudWatch.GetInsightRuleReport Methods rnf :: GetInsightRuleReport -> () #
Eq GetInsightRuleReport Source #
Instance details Defined in Amazonka.CloudWatch.GetInsightRuleReport Methods (==) :: GetInsightRuleReport -> GetInsightRuleReport -> Bool # (/=) :: GetInsightRuleReport -> GetInsightRuleReport -> Bool #
Hashable GetInsightRuleReport Source #
Instance details Defined in Amazonka.CloudWatch.GetInsightRuleReport Methods hashWithSalt :: Int -> GetInsightRuleReport -> Int # hash :: GetInsightRuleReport -> Int #
type AWSResponse GetInsightRuleReport Source #
Instance details Defined in Amazonka.CloudWatch.GetInsightRuleReport type AWSResponse GetInsightRuleReport = GetInsightRuleReportResponse
type Rep GetInsightRuleReport Source #
Instance details Defined in Amazonka.CloudWatch.GetInsightRuleReport type Rep GetInsightRuleReport = D1 ('MetaData "GetInsightRuleReport" "Amazonka.CloudWatch.GetInsightRuleReport" "amazonka-cloudwatch-2.0-9xq2AWTkbYo3pEtgQNn4jD" 'False) (C1 ('MetaCons "GetInsightRuleReport'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxContributorCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "metrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "orderBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "ruleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601)) :: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601) :: S1 ('MetaSel ('Just "period") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))))

newGetInsightRuleReport Source #

Arguments

:: Text	`GetInsightRuleReport`
-> UTCTime	`GetInsightRuleReport`
-> UTCTime	`GetInsightRuleReport`
-> Natural	`GetInsightRuleReport`
-> GetInsightRuleReport

Create a value of GetInsightRuleReport with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:maxContributorCount:GetInsightRuleReport', getInsightRuleReport_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.

GetInsightRuleReport, getInsightRuleReport_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.

$sel:orderBy:GetInsightRuleReport', getInsightRuleReport_orderBy - Determines what statistic to use to rank the contributors. Valid values are SUM and MAXIMUM.

GetInsightRuleReport, getInsightRuleReport_ruleName - The name of the rule that you want to see data from.

GetInsightRuleReport, getInsightRuleReport_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.

GetInsightRuleReport, getInsightRuleReport_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.

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

Request Lenses

getInsightRuleReport_maxContributorCount :: Lens' GetInsightRuleReport (Maybe Int) Source #

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.

getInsightRuleReport_metrics :: Lens' GetInsightRuleReport (Maybe [Text]) Source #

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.

getInsightRuleReport_orderBy :: Lens' GetInsightRuleReport (Maybe Text) Source #

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

getInsightRuleReport_ruleName :: Lens' GetInsightRuleReport Text Source #

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

getInsightRuleReport_startTime :: Lens' GetInsightRuleReport UTCTime Source #

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.

getInsightRuleReport_endTime :: Lens' GetInsightRuleReport UTCTime Source #

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.

getInsightRuleReport_period :: Lens' GetInsightRuleReport Natural Source #

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

Destructuring the Response

data GetInsightRuleReportResponse Source #

See: newGetInsightRuleReportResponse smart constructor.

Constructors

GetInsightRuleReportResponse'

Fields

aggregateValue :: Maybe Double
The sum of the values from all individual contributors that match the rule.
aggregationStatistic :: Maybe Text
Specifies whether this rule aggregates contributor data by COUNT or SUM.
approximateUniqueCount :: Maybe Integer
An approximate count of the unique contributors found by this rule in this time period.
contributors :: Maybe [InsightRuleContributor]
An array of the unique contributors found by this rule in this time period. If the rule contains multiple keys, each combination of values for the keys counts as a unique contributor.
keyLabels :: Maybe [Text]
An array of the strings used as the keys for this rule. The keys are the dimensions used to classify contributors. If the rule contains more than one key, then each unique combination of values for the keys is counted as a unique contributor.
metricDatapoints :: Maybe [InsightRuleMetricDatapoint]
A time series of metric data points that matches the time period in the rule request.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetInsightRuleReportResponse Source #
Instance details Defined in Amazonka.CloudWatch.GetInsightRuleReport Associated Types type Rep GetInsightRuleReportResponse :: Type -> Type # Methods from :: GetInsightRuleReportResponse -> Rep GetInsightRuleReportResponse x # to :: Rep GetInsightRuleReportResponse x -> GetInsightRuleReportResponse #
Read GetInsightRuleReportResponse Source #
Instance details Defined in Amazonka.CloudWatch.GetInsightRuleReport Methods readsPrec :: Int -> ReadS GetInsightRuleReportResponse # readList :: ReadS [GetInsightRuleReportResponse] # readPrec :: ReadPrec GetInsightRuleReportResponse # readListPrec :: ReadPrec [GetInsightRuleReportResponse] #
Show GetInsightRuleReportResponse Source #
Instance details Defined in Amazonka.CloudWatch.GetInsightRuleReport Methods showsPrec :: Int -> GetInsightRuleReportResponse -> ShowS # show :: GetInsightRuleReportResponse -> String # showList :: [GetInsightRuleReportResponse] -> ShowS #
NFData GetInsightRuleReportResponse Source #
Instance details Defined in Amazonka.CloudWatch.GetInsightRuleReport Methods rnf :: GetInsightRuleReportResponse -> () #
Eq GetInsightRuleReportResponse Source #
Instance details Defined in Amazonka.CloudWatch.GetInsightRuleReport Methods (==) :: GetInsightRuleReportResponse -> GetInsightRuleReportResponse -> Bool # (/=) :: GetInsightRuleReportResponse -> GetInsightRuleReportResponse -> Bool #
type Rep GetInsightRuleReportResponse Source #
Instance details Defined in Amazonka.CloudWatch.GetInsightRuleReport type Rep GetInsightRuleReportResponse = D1 ('MetaData "GetInsightRuleReportResponse" "Amazonka.CloudWatch.GetInsightRuleReport" "amazonka-cloudwatch-2.0-9xq2AWTkbYo3pEtgQNn4jD" 'False) (C1 ('MetaCons "GetInsightRuleReportResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "aggregateValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: (S1 ('MetaSel ('Just "aggregationStatistic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "approximateUniqueCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :: ((S1 ('MetaSel ('Just "contributors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InsightRuleContributor])) :: S1 ('MetaSel ('Just "keyLabels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "metricDatapoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InsightRuleMetricDatapoint])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetInsightRuleReportResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetInsightRuleReportResponse'`
-> GetInsightRuleReportResponse

Create a value of GetInsightRuleReportResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:aggregateValue:GetInsightRuleReportResponse', getInsightRuleReportResponse_aggregateValue - The sum of the values from all individual contributors that match the rule.

$sel:aggregationStatistic:GetInsightRuleReportResponse', getInsightRuleReportResponse_aggregationStatistic - Specifies whether this rule aggregates contributor data by COUNT or SUM.

$sel:approximateUniqueCount:GetInsightRuleReportResponse', getInsightRuleReportResponse_approximateUniqueCount - An approximate count of the unique contributors found by this rule in this time period.

$sel:contributors:GetInsightRuleReportResponse', getInsightRuleReportResponse_contributors - An array of the unique contributors found by this rule in this time period. If the rule contains multiple keys, each combination of values for the keys counts as a unique contributor.

$sel:keyLabels:GetInsightRuleReportResponse', getInsightRuleReportResponse_keyLabels - An array of the strings used as the keys for this rule. The keys are the dimensions used to classify contributors. If the rule contains more than one key, then each unique combination of values for the keys is counted as a unique contributor.

$sel:metricDatapoints:GetInsightRuleReportResponse', getInsightRuleReportResponse_metricDatapoints - A time series of metric data points that matches the time period in the rule request.

$sel:httpStatus:GetInsightRuleReportResponse', getInsightRuleReportResponse_httpStatus - The response's http status code.

Response Lenses

getInsightRuleReportResponse_aggregateValue :: Lens' GetInsightRuleReportResponse (Maybe Double) Source #

The sum of the values from all individual contributors that match the rule.

getInsightRuleReportResponse_aggregationStatistic :: Lens' GetInsightRuleReportResponse (Maybe Text) Source #

Specifies whether this rule aggregates contributor data by COUNT or SUM.

getInsightRuleReportResponse_approximateUniqueCount :: Lens' GetInsightRuleReportResponse (Maybe Integer) Source #

An approximate count of the unique contributors found by this rule in this time period.

getInsightRuleReportResponse_contributors :: Lens' GetInsightRuleReportResponse (Maybe [InsightRuleContributor]) Source #

An array of the unique contributors found by this rule in this time period. If the rule contains multiple keys, each combination of values for the keys counts as a unique contributor.

getInsightRuleReportResponse_keyLabels :: Lens' GetInsightRuleReportResponse (Maybe [Text]) Source #

An array of the strings used as the keys for this rule. The keys are the dimensions used to classify contributors. If the rule contains more than one key, then each unique combination of values for the keys is counted as a unique contributor.

getInsightRuleReportResponse_metricDatapoints :: Lens' GetInsightRuleReportResponse (Maybe [InsightRuleMetricDatapoint]) Source #

A time series of metric data points that matches the time period in the rule request.

getInsightRuleReportResponse_httpStatus :: Lens' GetInsightRuleReportResponse Int Source #

The response's http status code.