libZSservicesZSamazonka-iotZSamazonka-iot
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoT.GetBucketsAggregation

Description

Aggregates on indexed data with search queries pertaining to particular fields.

Requires permission to access the GetBucketsAggregation action.

Synopsis

Creating a Request

data GetBucketsAggregation Source #

See: newGetBucketsAggregation smart constructor.

Constructors

GetBucketsAggregation' 

Fields

Instances

Instances details
Eq GetBucketsAggregation Source # 
Instance details

Defined in Amazonka.IoT.GetBucketsAggregation

Methods

(==) :: GetBucketsAggregation -> GetBucketsAggregation -> Bool #

(/=) :: GetBucketsAggregation -> GetBucketsAggregation -> Bool #

Read GetBucketsAggregation Source # 
Instance details

Defined in Amazonka.IoT.GetBucketsAggregation

Methods

readsPrec :: Int -> ReadS GetBucketsAggregation #

readList :: ReadS [GetBucketsAggregation] #

readPrec :: ReadPrec GetBucketsAggregation #

readListPrec :: ReadPrec [GetBucketsAggregation] #

Show GetBucketsAggregation Source # 
Instance details

Defined in Amazonka.IoT.GetBucketsAggregation

Methods

showsPrec :: Int -> GetBucketsAggregation -> ShowS #

show :: GetBucketsAggregation -> String #

showList :: [GetBucketsAggregation] -> ShowS #

Generic GetBucketsAggregation Source # 
Instance details

Defined in Amazonka.IoT.GetBucketsAggregation

Associated Types

type Rep GetBucketsAggregation :: Type -> Type #

Methods

from :: GetBucketsAggregation -> Rep GetBucketsAggregation x #

to :: Rep GetBucketsAggregation x -> GetBucketsAggregation #

NFData GetBucketsAggregation Source # 
Instance details

Defined in Amazonka.IoT.GetBucketsAggregation

Methods

rnf :: GetBucketsAggregation -> () #

Hashable GetBucketsAggregation Source # 
Instance details

Defined in Amazonka.IoT.GetBucketsAggregation

Methods

hashWithSalt :: Int -> GetBucketsAggregation -> Int #

hash :: GetBucketsAggregation -> Int #

ToJSON GetBucketsAggregation Source # 
Instance details

Defined in Amazonka.IoT.GetBucketsAggregation

Methods

toJSON :: GetBucketsAggregation -> Value #

toEncoding :: GetBucketsAggregation -> Encoding #

toJSONList :: [GetBucketsAggregation] -> Value #

toEncodingList :: [GetBucketsAggregation] -> Encoding #

AWSRequest GetBucketsAggregation Source # 
Instance details

Defined in Amazonka.IoT.GetBucketsAggregation

Associated Types

type AWSResponse GetBucketsAggregation #

Methods

request :: GetBucketsAggregation -> Request GetBucketsAggregation #

response :: MonadResource m => Logger -> Service -> Proxy GetBucketsAggregation -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetBucketsAggregation))) #

ToHeaders GetBucketsAggregation Source # 
Instance details

Defined in Amazonka.IoT.GetBucketsAggregation

Methods

toHeaders :: GetBucketsAggregation -> [Header] #

ToPath GetBucketsAggregation Source # 
Instance details

Defined in Amazonka.IoT.GetBucketsAggregation

Methods

toPath :: GetBucketsAggregation -> ByteString #

ToQuery GetBucketsAggregation Source # 
Instance details

Defined in Amazonka.IoT.GetBucketsAggregation

Methods

toQuery :: GetBucketsAggregation -> QueryString #

type Rep GetBucketsAggregation Source # 
Instance details

Defined in Amazonka.IoT.GetBucketsAggregation

type Rep GetBucketsAggregation = D1 ('MetaData "GetBucketsAggregation" "Amazonka.IoT.GetBucketsAggregation" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "GetBucketsAggregation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "queryVersion") '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) :*: (S1 ('MetaSel ('Just "aggregationField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "bucketsAggregationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BucketsAggregationType)))))
type AWSResponse GetBucketsAggregation Source # 
Instance details

Defined in Amazonka.IoT.GetBucketsAggregation

type AWSResponse GetBucketsAggregation = GetBucketsAggregationResponse

newGetBucketsAggregation Source #

Arguments

:: Text

$sel:queryString:GetBucketsAggregation'

-> Text

$sel:aggregationField:GetBucketsAggregation'

-> BucketsAggregationType

$sel:bucketsAggregationType:GetBucketsAggregation'

-> GetBucketsAggregation 

Create a value of GetBucketsAggregation 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:GetBucketsAggregation', getBucketsAggregation_queryVersion - The version of the query.

$sel:indexName:GetBucketsAggregation', getBucketsAggregation_indexName - The name of the index to search.

$sel:queryString:GetBucketsAggregation', getBucketsAggregation_queryString - The search query string.

$sel:aggregationField:GetBucketsAggregation', getBucketsAggregation_aggregationField - The aggregation field.

$sel:bucketsAggregationType:GetBucketsAggregation', getBucketsAggregation_bucketsAggregationType - The basic control of the response shape and the bucket aggregation type to perform.

Request Lenses

getBucketsAggregation_queryVersion :: Lens' GetBucketsAggregation (Maybe Text) Source #

The version of the query.

getBucketsAggregation_indexName :: Lens' GetBucketsAggregation (Maybe Text) Source #

The name of the index to search.

getBucketsAggregation_queryString :: Lens' GetBucketsAggregation Text Source #

The search query string.

getBucketsAggregation_aggregationField :: Lens' GetBucketsAggregation Text Source #

The aggregation field.

getBucketsAggregation_bucketsAggregationType :: Lens' GetBucketsAggregation BucketsAggregationType Source #

The basic control of the response shape and the bucket aggregation type to perform.

Destructuring the Response

data GetBucketsAggregationResponse Source #

See: newGetBucketsAggregationResponse smart constructor.

Constructors

GetBucketsAggregationResponse' 

Fields

  • buckets :: Maybe [Bucket]

    The main part of the response with a list of buckets. Each bucket contains a keyValue and a count.

    keyValue: The aggregation field value counted for the particular bucket.

    count: The number of documents that have that value.

  • totalCount :: Maybe Int

    The total number of documents that fit the query string criteria and contain a value for the Aggregation field targeted in the request.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq GetBucketsAggregationResponse Source # 
Instance details

Defined in Amazonka.IoT.GetBucketsAggregation

Methods

(==) :: GetBucketsAggregationResponse -> GetBucketsAggregationResponse -> Bool #

(/=) :: GetBucketsAggregationResponse -> GetBucketsAggregationResponse -> Bool #

Read GetBucketsAggregationResponse Source # 
Instance details

Defined in Amazonka.IoT.GetBucketsAggregation

Methods

readsPrec :: Int -> ReadS GetBucketsAggregationResponse #

readList :: ReadS [GetBucketsAggregationResponse] #

readPrec :: ReadPrec GetBucketsAggregationResponse #

readListPrec :: ReadPrec [GetBucketsAggregationResponse] #

Show GetBucketsAggregationResponse Source # 
Instance details

Defined in Amazonka.IoT.GetBucketsAggregation

Methods

showsPrec :: Int -> GetBucketsAggregationResponse -> ShowS #

show :: GetBucketsAggregationResponse -> String #

showList :: [GetBucketsAggregationResponse] -> ShowS #

Generic GetBucketsAggregationResponse Source # 
Instance details

Defined in Amazonka.IoT.GetBucketsAggregation

Associated Types

type Rep GetBucketsAggregationResponse :: Type -> Type #

Methods

from :: GetBucketsAggregationResponse -> Rep GetBucketsAggregationResponse x #

to :: Rep GetBucketsAggregationResponse x -> GetBucketsAggregationResponse #

NFData GetBucketsAggregationResponse Source # 
Instance details

Defined in Amazonka.IoT.GetBucketsAggregation

Methods

rnf :: GetBucketsAggregationResponse -> () #

type Rep GetBucketsAggregationResponse Source # 
Instance details

Defined in Amazonka.IoT.GetBucketsAggregation

type Rep GetBucketsAggregationResponse = D1 ('MetaData "GetBucketsAggregationResponse" "Amazonka.IoT.GetBucketsAggregation" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "GetBucketsAggregationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "buckets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Bucket])) :*: (S1 ('MetaSel ('Just "totalCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetBucketsAggregationResponse Source #

Arguments

:: Int

$sel:httpStatus:GetBucketsAggregationResponse'

-> GetBucketsAggregationResponse 

Create a value of GetBucketsAggregationResponse 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:buckets:GetBucketsAggregationResponse', getBucketsAggregationResponse_buckets - The main part of the response with a list of buckets. Each bucket contains a keyValue and a count.

keyValue: The aggregation field value counted for the particular bucket.

count: The number of documents that have that value.

$sel:totalCount:GetBucketsAggregationResponse', getBucketsAggregationResponse_totalCount - The total number of documents that fit the query string criteria and contain a value for the Aggregation field targeted in the request.

$sel:httpStatus:GetBucketsAggregationResponse', getBucketsAggregationResponse_httpStatus - The response's http status code.

Response Lenses

getBucketsAggregationResponse_buckets :: Lens' GetBucketsAggregationResponse (Maybe [Bucket]) Source #

The main part of the response with a list of buckets. Each bucket contains a keyValue and a count.

keyValue: The aggregation field value counted for the particular bucket.

count: The number of documents that have that value.

getBucketsAggregationResponse_totalCount :: Lens' GetBucketsAggregationResponse (Maybe Int) Source #

The total number of documents that fit the query string criteria and contain a value for the Aggregation field targeted in the request.

getBucketsAggregationResponse_httpStatus :: Lens' GetBucketsAggregationResponse Int Source #

The response's http status code.