Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoT.GetPercentiles

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Groups the aggregated values that match the query into percentile groupings. The default percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own when you call GetPercentiles. This function returns a value for each percentile group specified (or the default percentile groupings). The percentile group "1" contains the aggregated field value that occurs in approximately one percent of the values that match the query. The percentile group "5" contains the aggregated field value that occurs in approximately five percent of the values that match the query, and so on. The result is an approximation, the more values that match the query, the more accurate the percentile values.

Requires permission to access the GetPercentiles action.

Synopsis

data GetPercentiles = GetPercentiles' {
- percents :: Maybe [Double]
- queryVersion :: Maybe Text
- aggregationField :: Maybe Text
- indexName :: Maybe Text
- queryString :: Text
}
newGetPercentiles :: Text -> GetPercentiles
getPercentiles_percents :: Lens' GetPercentiles (Maybe [Double])
getPercentiles_queryVersion :: Lens' GetPercentiles (Maybe Text)
getPercentiles_aggregationField :: Lens' GetPercentiles (Maybe Text)
getPercentiles_indexName :: Lens' GetPercentiles (Maybe Text)
getPercentiles_queryString :: Lens' GetPercentiles Text
data GetPercentilesResponse = GetPercentilesResponse' {
- percentiles :: Maybe [PercentPair]
- httpStatus :: Int
}
newGetPercentilesResponse :: Int -> GetPercentilesResponse
getPercentilesResponse_percentiles :: Lens' GetPercentilesResponse (Maybe [PercentPair])
getPercentilesResponse_httpStatus :: Lens' GetPercentilesResponse Int

Creating a Request

data GetPercentiles Source #

See: newGetPercentiles smart constructor.

Constructors

GetPercentiles'
Fields percents :: Maybe [Double] The percentile groups returned. queryVersion :: Maybe Text The query version. aggregationField :: Maybe Text The field to aggregate. indexName :: Maybe Text The name of the index to search. queryString :: Text The search query string.

Instances

Instances details

Eq GetPercentiles Source #
Instance details Defined in Amazonka.IoT.GetPercentiles Methods (==) :: GetPercentiles -> GetPercentiles -> Bool # (/=) :: GetPercentiles -> GetPercentiles -> Bool #
Read GetPercentiles Source #
Instance details Defined in Amazonka.IoT.GetPercentiles Methods readsPrec :: Int -> ReadS GetPercentiles # readList :: ReadS [GetPercentiles] # readPrec :: ReadPrec GetPercentiles # readListPrec :: ReadPrec [GetPercentiles] #
Show GetPercentiles Source #
Instance details Defined in Amazonka.IoT.GetPercentiles Methods showsPrec :: Int -> GetPercentiles -> ShowS # show :: GetPercentiles -> String # showList :: [GetPercentiles] -> ShowS #
Generic GetPercentiles Source #
Instance details Defined in Amazonka.IoT.GetPercentiles Associated Types type Rep GetPercentiles :: Type -> Type # Methods from :: GetPercentiles -> Rep GetPercentiles x # to :: Rep GetPercentiles x -> GetPercentiles #
NFData GetPercentiles Source #
Instance details Defined in Amazonka.IoT.GetPercentiles Methods rnf :: GetPercentiles -> () #
Hashable GetPercentiles Source #
Instance details Defined in Amazonka.IoT.GetPercentiles Methods hashWithSalt :: Int -> GetPercentiles -> Int # hash :: GetPercentiles -> Int #
ToJSON GetPercentiles Source #
Instance details Defined in Amazonka.IoT.GetPercentiles Methods toJSON :: GetPercentiles -> Value # toEncoding :: GetPercentiles -> Encoding # toJSONList :: [GetPercentiles] -> Value # toEncodingList :: [GetPercentiles] -> Encoding #
AWSRequest GetPercentiles Source #
Instance details Defined in Amazonka.IoT.GetPercentiles Associated Types type AWSResponse GetPercentiles # Methods request :: GetPercentiles -> Request GetPercentiles # response :: MonadResource m => Logger -> Service -> Proxy GetPercentiles -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetPercentiles))) #
ToHeaders GetPercentiles Source #
Instance details Defined in Amazonka.IoT.GetPercentiles Methods toHeaders :: GetPercentiles -> [Header] #
ToPath GetPercentiles Source #
Instance details Defined in Amazonka.IoT.GetPercentiles Methods toPath :: GetPercentiles -> ByteString #
ToQuery GetPercentiles Source #
Instance details Defined in Amazonka.IoT.GetPercentiles Methods toQuery :: GetPercentiles -> QueryString #
type Rep GetPercentiles Source #
Instance details Defined in Amazonka.IoT.GetPercentiles type Rep GetPercentiles = D1 ('MetaData "GetPercentiles" "Amazonka.IoT.GetPercentiles" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "GetPercentiles'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "percents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Double])) :: S1 ('MetaSel ('Just "queryVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "aggregationField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "queryString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse GetPercentiles Source #
Instance details Defined in Amazonka.IoT.GetPercentiles type AWSResponse GetPercentiles = GetPercentilesResponse

newGetPercentiles Source #

Arguments

:: Text	`$sel:queryString:GetPercentiles'`
-> GetPercentiles

Create a value of GetPercentiles 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:percents:GetPercentiles', getPercentiles_percents - The percentile groups returned.

$sel:queryVersion:GetPercentiles', getPercentiles_queryVersion - The query version.

$sel:aggregationField:GetPercentiles', getPercentiles_aggregationField - The field to aggregate.

$sel:indexName:GetPercentiles', getPercentiles_indexName - The name of the index to search.

$sel:queryString:GetPercentiles', getPercentiles_queryString - The search query string.

Request Lenses

getPercentiles_percents :: Lens' GetPercentiles (Maybe [Double]) Source #

The percentile groups returned.

getPercentiles_queryVersion :: Lens' GetPercentiles (Maybe Text) Source #

The query version.

getPercentiles_aggregationField :: Lens' GetPercentiles (Maybe Text) Source #

The field to aggregate.

getPercentiles_indexName :: Lens' GetPercentiles (Maybe Text) Source #

The name of the index to search.

getPercentiles_queryString :: Lens' GetPercentiles Text Source #

The search query string.

Destructuring the Response

data GetPercentilesResponse Source #

See: newGetPercentilesResponse smart constructor.

Constructors

GetPercentilesResponse'
Fields percentiles :: Maybe [PercentPair] The percentile values of the aggregated fields. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq GetPercentilesResponse Source #
Instance details Defined in Amazonka.IoT.GetPercentiles Methods (==) :: GetPercentilesResponse -> GetPercentilesResponse -> Bool # (/=) :: GetPercentilesResponse -> GetPercentilesResponse -> Bool #
Read GetPercentilesResponse Source #
Instance details Defined in Amazonka.IoT.GetPercentiles Methods readsPrec :: Int -> ReadS GetPercentilesResponse # readList :: ReadS [GetPercentilesResponse] # readPrec :: ReadPrec GetPercentilesResponse # readListPrec :: ReadPrec [GetPercentilesResponse] #
Show GetPercentilesResponse Source #
Instance details Defined in Amazonka.IoT.GetPercentiles Methods showsPrec :: Int -> GetPercentilesResponse -> ShowS # show :: GetPercentilesResponse -> String # showList :: [GetPercentilesResponse] -> ShowS #
Generic GetPercentilesResponse Source #
Instance details Defined in Amazonka.IoT.GetPercentiles Associated Types type Rep GetPercentilesResponse :: Type -> Type # Methods from :: GetPercentilesResponse -> Rep GetPercentilesResponse x # to :: Rep GetPercentilesResponse x -> GetPercentilesResponse #
NFData GetPercentilesResponse Source #
Instance details Defined in Amazonka.IoT.GetPercentiles Methods rnf :: GetPercentilesResponse -> () #
type Rep GetPercentilesResponse Source #
Instance details Defined in Amazonka.IoT.GetPercentiles type Rep GetPercentilesResponse = D1 ('MetaData "GetPercentilesResponse" "Amazonka.IoT.GetPercentiles" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "GetPercentilesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "percentiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PercentPair])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetPercentilesResponse Source #

Arguments

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

Create a value of GetPercentilesResponse 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:percentiles:GetPercentilesResponse', getPercentilesResponse_percentiles - The percentile values of the aggregated fields.

$sel:httpStatus:GetPercentilesResponse', getPercentilesResponse_httpStatus - The response's http status code.

Response Lenses

getPercentilesResponse_percentiles :: Lens' GetPercentilesResponse (Maybe [PercentPair]) Source #

The percentile values of the aggregated fields.

getPercentilesResponse_httpStatus :: Lens' GetPercentilesResponse Int Source #

The response's http status code.