amazonka-iot-2.0: Amazon IoT SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoT.GetCardinality

Description

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

Requires permission to access the GetCardinality action.

Synopsis

Creating a Request

data GetCardinality Source #

See: newGetCardinality smart constructor.

Constructors

GetCardinality' 

Fields

Instances

Instances details
ToJSON GetCardinality Source # 
Instance details

Defined in Amazonka.IoT.GetCardinality

ToHeaders GetCardinality Source # 
Instance details

Defined in Amazonka.IoT.GetCardinality

ToPath GetCardinality Source # 
Instance details

Defined in Amazonka.IoT.GetCardinality

ToQuery GetCardinality Source # 
Instance details

Defined in Amazonka.IoT.GetCardinality

AWSRequest GetCardinality Source # 
Instance details

Defined in Amazonka.IoT.GetCardinality

Associated Types

type AWSResponse GetCardinality #

Generic GetCardinality Source # 
Instance details

Defined in Amazonka.IoT.GetCardinality

Associated Types

type Rep GetCardinality :: Type -> Type #

Read GetCardinality Source # 
Instance details

Defined in Amazonka.IoT.GetCardinality

Show GetCardinality Source # 
Instance details

Defined in Amazonka.IoT.GetCardinality

NFData GetCardinality Source # 
Instance details

Defined in Amazonka.IoT.GetCardinality

Methods

rnf :: GetCardinality -> () #

Eq GetCardinality Source # 
Instance details

Defined in Amazonka.IoT.GetCardinality

Hashable GetCardinality Source # 
Instance details

Defined in Amazonka.IoT.GetCardinality

type AWSResponse GetCardinality Source # 
Instance details

Defined in Amazonka.IoT.GetCardinality

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 #

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_indexName :: Lens' GetCardinality (Maybe Text) Source #

The name of the index to search.

Destructuring the Response

data GetCardinalityResponse Source #

See: newGetCardinalityResponse smart constructor.

Constructors

GetCardinalityResponse' 

Fields

Instances

Instances details
Generic GetCardinalityResponse Source # 
Instance details

Defined in Amazonka.IoT.GetCardinality

Associated Types

type Rep GetCardinalityResponse :: Type -> Type #

Read GetCardinalityResponse Source # 
Instance details

Defined in Amazonka.IoT.GetCardinality

Show GetCardinalityResponse Source # 
Instance details

Defined in Amazonka.IoT.GetCardinality

NFData GetCardinalityResponse Source # 
Instance details

Defined in Amazonka.IoT.GetCardinality

Methods

rnf :: GetCardinalityResponse -> () #

Eq GetCardinalityResponse Source # 
Instance details

Defined in Amazonka.IoT.GetCardinality

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 #

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.