Amazonka.IoT.GetStatistics

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

See: newGetStatistics smart constructor.

Constructors

GetStatistics'

Fields

• aggregationField :: Maybe Text

  The aggregation field name.

• indexName :: Maybe Text

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

• queryVersion :: Maybe Text

  The version of the query used to search.

• 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

ToJSON GetStatistics

Defined in Amazonka.IoT.GetStatistics

Methods

toJSON :: GetStatistics -> Value

toEncoding :: GetStatistics -> Encoding

toJSONList :: [GetStatistics] -> Value

toEncodingList :: [GetStatistics] -> Encoding

ToHeaders GetStatistics

Defined in Amazonka.IoT.GetStatistics

Methods

toHeaders :: GetStatistics -> [Header]

ToPath GetStatistics

Defined in Amazonka.IoT.GetStatistics

Methods

toPath :: GetStatistics -> ByteString

ToQuery GetStatistics

Defined in Amazonka.IoT.GetStatistics

Methods

toQuery :: GetStatistics -> QueryString

AWSRequest GetStatistics

Defined in Amazonka.IoT.GetStatistics

Associated Types

type AWSResponse GetStatistics

Methods

request :: (Service -> Service) -> GetStatistics -> Request GetStatistics

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetStatistics -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetStatistics)))

Generic GetStatistics

Defined in Amazonka.IoT.GetStatistics

Associated Types

type Rep GetStatistics :: Type -> Type

Methods

from :: GetStatistics -> Rep GetStatistics x

to :: Rep GetStatistics x -> GetStatistics

Read GetStatistics

Defined in Amazonka.IoT.GetStatistics

Methods

readsPrec :: Int -> ReadS GetStatistics

readList :: ReadS [GetStatistics]

readPrec :: ReadPrec GetStatistics

readListPrec :: ReadPrec [GetStatistics]

Show GetStatistics

Defined in Amazonka.IoT.GetStatistics

Methods

showsPrec :: Int -> GetStatistics -> ShowS

show :: GetStatistics -> String

showList :: [GetStatistics] -> ShowS

NFData GetStatistics

Defined in Amazonka.IoT.GetStatistics

Methods

rnf :: GetStatistics -> ()

Eq GetStatistics

Defined in Amazonka.IoT.GetStatistics

Methods

(==) :: GetStatistics -> GetStatistics -> Bool

(/=) :: GetStatistics -> GetStatistics -> Bool

Hashable GetStatistics

Defined in Amazonka.IoT.GetStatistics

Methods

hashWithSalt :: Int -> GetStatistics -> Int

hash :: GetStatistics -> Int

type AWSResponse GetStatistics

Defined in Amazonka.IoT.GetStatistics

type AWSResponse GetStatistics = GetStatisticsResponse

type Rep GetStatistics

Defined in Amazonka.IoT.GetStatistics

type Rep GetStatistics = D1 ('MetaData "GetStatistics" "Amazonka.IoT.GetStatistics" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "GetStatistics'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "aggregationField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "queryVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "queryString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetStatistics

Arguments

:: Text

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

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_aggregationField :: Lens' GetStatistics (Maybe Text)

The aggregation field name.

getStatistics_indexName :: Lens' GetStatistics (Maybe Text)

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

getStatistics_queryVersion :: Lens' GetStatistics (Maybe Text)

The version of the query used to search.

getStatistics_queryString :: Lens' GetStatistics 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.

Destructuring the Response

data GetStatisticsResponse

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

Generic GetStatisticsResponse

Defined in Amazonka.IoT.GetStatistics

Associated Types

type Rep GetStatisticsResponse :: Type -> Type

Methods

from :: GetStatisticsResponse -> Rep GetStatisticsResponse x

to :: Rep GetStatisticsResponse x -> GetStatisticsResponse

Read GetStatisticsResponse

Defined in Amazonka.IoT.GetStatistics

Methods

readsPrec :: Int -> ReadS GetStatisticsResponse

readList :: ReadS [GetStatisticsResponse]

readPrec :: ReadPrec GetStatisticsResponse

readListPrec :: ReadPrec [GetStatisticsResponse]

Show GetStatisticsResponse

Defined in Amazonka.IoT.GetStatistics

Methods

showsPrec :: Int -> GetStatisticsResponse -> ShowS

show :: GetStatisticsResponse -> String

showList :: [GetStatisticsResponse] -> ShowS

NFData GetStatisticsResponse

Defined in Amazonka.IoT.GetStatistics

Methods

rnf :: GetStatisticsResponse -> ()

Eq GetStatisticsResponse

Defined in Amazonka.IoT.GetStatistics

Methods

(==) :: GetStatisticsResponse -> GetStatisticsResponse -> Bool

(/=) :: GetStatisticsResponse -> GetStatisticsResponse -> Bool

type Rep GetStatisticsResponse

Defined in Amazonka.IoT.GetStatistics

type Rep GetStatisticsResponse = D1 ('MetaData "GetStatisticsResponse" "Amazonka.IoT.GetStatistics" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" '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

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)

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

getStatisticsResponse_httpStatus :: Lens' GetStatisticsResponse Int

The response's http status code.