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.IoT.GetCardinality

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the approximate count of unique values that match the query.

Requires permission to access the GetCardinality action.

Creating a Request

data GetCardinality Source #

See: newGetCardinality smart constructor.

Constructors

GetCardinality'
Fields aggregationField :: Maybe Text The field to aggregate. indexName :: Maybe Text The name of the index to search. queryVersion :: Maybe Text The query version. queryString :: Text The search query string.

Instances

Instances details

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

newGetCardinality Source #

Arguments

:: Text	`GetCardinality`
-> GetCardinality

Create a value of GetCardinality 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:GetCardinality', getCardinality_aggregationField - The field to aggregate.

$sel:indexName:GetCardinality', getCardinality_indexName - The name of the index to search.

$sel:queryVersion:GetCardinality', getCardinality_queryVersion - The query version.

GetCardinality, getCardinality_queryString - The search query string.

Request Lenses

getCardinality_aggregationField :: Lens' GetCardinality (Maybe Text) Source #

The field to aggregate.

getCardinality_indexName :: Lens' GetCardinality (Maybe Text) Source #

The name of the index to search.

getCardinality_queryVersion :: Lens' GetCardinality (Maybe Text) Source #

The query version.

getCardinality_queryString :: Lens' GetCardinality Text Source #

The search query string.

Destructuring the Response

data GetCardinalityResponse Source #

See: newGetCardinalityResponse smart constructor.

Constructors

GetCardinalityResponse'
Fields cardinality :: Maybe Int The approximate count of unique values that match the query. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetCardinalityResponse Source #

Arguments

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

Create a value of GetCardinalityResponse 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:cardinality:GetCardinalityResponse', getCardinalityResponse_cardinality - The approximate count of unique values that match the query.

$sel:httpStatus:GetCardinalityResponse', getCardinalityResponse_httpStatus - The response's http status code.

Response Lenses

getCardinalityResponse_cardinality :: Lens' GetCardinalityResponse (Maybe Int) Source #

The approximate count of unique values that match the query.

getCardinalityResponse_httpStatus :: Lens' GetCardinalityResponse Int Source #

The response's http status code.