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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field. If the aggregation field is of type String, only the count statistic is returned.

Requires permission to access the GetStatistics action.

Creating a Request

data GetStatistics Source #

See: newGetStatistics smart constructor.

Constructors

GetStatistics'
Fields queryVersion :: Maybe Text The version of the query used to search. aggregationField :: Maybe Text The aggregation field name. indexName :: Maybe Text The name of the index to search. The default value is `AWS_Things`. queryString :: Text The query used to search. You can specify "*" for the query string to get the count of all indexed things in your Amazon Web Services account.

Instances

Instances details

Eq GetStatistics Source #
Instance details Defined in Amazonka.IoT.GetStatistics Methods (==) :: GetStatistics -> GetStatistics -> Bool # (/=) :: GetStatistics -> GetStatistics -> Bool #
Read GetStatistics Source #
Instance details Defined in Amazonka.IoT.GetStatistics Methods readsPrec :: Int -> ReadS GetStatistics # readList :: ReadS [GetStatistics] # readPrec :: ReadPrec GetStatistics # readListPrec :: ReadPrec [GetStatistics] #
Show GetStatistics Source #
Instance details Defined in Amazonka.IoT.GetStatistics Methods showsPrec :: Int -> GetStatistics -> ShowS # show :: GetStatistics -> String # showList :: [GetStatistics] -> ShowS #
Generic GetStatistics Source #
Instance details Defined in Amazonka.IoT.GetStatistics Associated Types type Rep GetStatistics :: Type -> Type # Methods from :: GetStatistics -> Rep GetStatistics x # to :: Rep GetStatistics x -> GetStatistics #
NFData GetStatistics Source #
Instance details Defined in Amazonka.IoT.GetStatistics Methods rnf :: GetStatistics -> () #
Hashable GetStatistics Source #
Instance details Defined in Amazonka.IoT.GetStatistics Methods hashWithSalt :: Int -> GetStatistics -> Int # hash :: GetStatistics -> Int #
ToJSON GetStatistics Source #
Instance details Defined in Amazonka.IoT.GetStatistics Methods toJSON :: GetStatistics -> Value # toEncoding :: GetStatistics -> Encoding # toJSONList :: [GetStatistics] -> Value # toEncodingList :: [GetStatistics] -> Encoding #
AWSRequest GetStatistics Source #
Instance details Defined in Amazonka.IoT.GetStatistics Associated Types type AWSResponse GetStatistics # Methods request :: GetStatistics -> Request GetStatistics # response :: MonadResource m => Logger -> Service -> Proxy GetStatistics -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetStatistics))) #
ToHeaders GetStatistics Source #
Instance details Defined in Amazonka.IoT.GetStatistics Methods toHeaders :: GetStatistics -> [Header] #
ToPath GetStatistics Source #
Instance details Defined in Amazonka.IoT.GetStatistics Methods toPath :: GetStatistics -> ByteString #
ToQuery GetStatistics Source #
Instance details Defined in Amazonka.IoT.GetStatistics Methods toQuery :: GetStatistics -> QueryString #
type Rep GetStatistics Source #
Instance details Defined in Amazonka.IoT.GetStatistics type Rep GetStatistics = D1 ('MetaData "GetStatistics" "Amazonka.IoT.GetStatistics" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "GetStatistics'" 'PrefixI 'True) ((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 GetStatistics Source #
Instance details Defined in Amazonka.IoT.GetStatistics type AWSResponse GetStatistics = GetStatisticsResponse

newGetStatistics Source #

Arguments

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

Create a value of GetStatistics 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:queryVersion:GetStatistics', getStatistics_queryVersion - The version of the query used to search.

$sel:aggregationField:GetStatistics', getStatistics_aggregationField - The aggregation field name.

$sel:indexName:GetStatistics', getStatistics_indexName - The name of the index to search. The default value is AWS_Things.

$sel:queryString:GetStatistics', getStatistics_queryString - The query used to search. You can specify "*" for the query string to get the count of all indexed things in your Amazon Web Services account.

Request Lenses

getStatistics_queryVersion :: Lens' GetStatistics (Maybe Text) Source #

The version of the query used to search.

getStatistics_aggregationField :: Lens' GetStatistics (Maybe Text) Source #

The aggregation field name.

getStatistics_indexName :: Lens' GetStatistics (Maybe Text) Source #

The name of the index to search. The default value is AWS_Things.

getStatistics_queryString :: Lens' GetStatistics Text Source #

The query used to search. You can specify "*" for the query string to get the count of all indexed things in your Amazon Web Services account.

Destructuring the Response

data GetStatisticsResponse Source #

See: newGetStatisticsResponse smart constructor.

Constructors

GetStatisticsResponse'
Fields statistics :: Maybe Statistics The statistics returned by the Fleet Indexing service based on the query and aggregation field. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetStatisticsResponse Source #

Arguments

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

Create a value of GetStatisticsResponse 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:statistics:GetStatisticsResponse', getStatisticsResponse_statistics - The statistics returned by the Fleet Indexing service based on the query and aggregation field.

$sel:httpStatus:GetStatisticsResponse', getStatisticsResponse_httpStatus - The response's http status code.

Response Lenses

getStatisticsResponse_statistics :: Lens' GetStatisticsResponse (Maybe Statistics) Source #

The statistics returned by the Fleet Indexing service based on the query and aggregation field.

getStatisticsResponse_httpStatus :: Lens' GetStatisticsResponse Int Source #

The response's http status code.