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

Description

List the set of dimensions that are defined for your Amazon Web Services accounts.

Requires permission to access the ListDimensions action.

This operation returns paginated results.

Synopsis

Creating a Request

data ListDimensions Source #

See: newListDimensions smart constructor.

Constructors

ListDimensions' 

Fields

Instances

Instances details
ToHeaders ListDimensions Source # 
Instance details

Defined in Amazonka.IoT.ListDimensions

ToPath ListDimensions Source # 
Instance details

Defined in Amazonka.IoT.ListDimensions

ToQuery ListDimensions Source # 
Instance details

Defined in Amazonka.IoT.ListDimensions

AWSPager ListDimensions Source # 
Instance details

Defined in Amazonka.IoT.ListDimensions

AWSRequest ListDimensions Source # 
Instance details

Defined in Amazonka.IoT.ListDimensions

Associated Types

type AWSResponse ListDimensions #

Generic ListDimensions Source # 
Instance details

Defined in Amazonka.IoT.ListDimensions

Associated Types

type Rep ListDimensions :: Type -> Type #

Read ListDimensions Source # 
Instance details

Defined in Amazonka.IoT.ListDimensions

Show ListDimensions Source # 
Instance details

Defined in Amazonka.IoT.ListDimensions

NFData ListDimensions Source # 
Instance details

Defined in Amazonka.IoT.ListDimensions

Methods

rnf :: ListDimensions -> () #

Eq ListDimensions Source # 
Instance details

Defined in Amazonka.IoT.ListDimensions

Hashable ListDimensions Source # 
Instance details

Defined in Amazonka.IoT.ListDimensions

type AWSResponse ListDimensions Source # 
Instance details

Defined in Amazonka.IoT.ListDimensions

type Rep ListDimensions Source # 
Instance details

Defined in Amazonka.IoT.ListDimensions

type Rep ListDimensions = D1 ('MetaData "ListDimensions" "Amazonka.IoT.ListDimensions" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "ListDimensions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListDimensions :: ListDimensions Source #

Create a value of ListDimensions 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:maxResults:ListDimensions', listDimensions_maxResults - The maximum number of results to retrieve at one time.

ListDimensions, listDimensions_nextToken - The token for the next set of results.

Request Lenses

listDimensions_maxResults :: Lens' ListDimensions (Maybe Natural) Source #

The maximum number of results to retrieve at one time.

listDimensions_nextToken :: Lens' ListDimensions (Maybe Text) Source #

The token for the next set of results.

Destructuring the Response

data ListDimensionsResponse Source #

See: newListDimensionsResponse smart constructor.

Constructors

ListDimensionsResponse' 

Fields

  • dimensionNames :: Maybe [Text]

    A list of the names of the defined dimensions. Use DescribeDimension to get details for a dimension.

  • nextToken :: Maybe Text

    A token that can be used to retrieve the next set of results, or null if there are no additional results.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListDimensionsResponse Source # 
Instance details

Defined in Amazonka.IoT.ListDimensions

Associated Types

type Rep ListDimensionsResponse :: Type -> Type #

Read ListDimensionsResponse Source # 
Instance details

Defined in Amazonka.IoT.ListDimensions

Show ListDimensionsResponse Source # 
Instance details

Defined in Amazonka.IoT.ListDimensions

NFData ListDimensionsResponse Source # 
Instance details

Defined in Amazonka.IoT.ListDimensions

Methods

rnf :: ListDimensionsResponse -> () #

Eq ListDimensionsResponse Source # 
Instance details

Defined in Amazonka.IoT.ListDimensions

type Rep ListDimensionsResponse Source # 
Instance details

Defined in Amazonka.IoT.ListDimensions

type Rep ListDimensionsResponse = D1 ('MetaData "ListDimensionsResponse" "Amazonka.IoT.ListDimensions" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "ListDimensionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dimensionNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDimensionsResponse Source #

Create a value of ListDimensionsResponse 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:dimensionNames:ListDimensionsResponse', listDimensionsResponse_dimensionNames - A list of the names of the defined dimensions. Use DescribeDimension to get details for a dimension.

ListDimensions, listDimensionsResponse_nextToken - A token that can be used to retrieve the next set of results, or null if there are no additional results.

$sel:httpStatus:ListDimensionsResponse', listDimensionsResponse_httpStatus - The response's http status code.

Response Lenses

listDimensionsResponse_dimensionNames :: Lens' ListDimensionsResponse (Maybe [Text]) Source #

A list of the names of the defined dimensions. Use DescribeDimension to get details for a dimension.

listDimensionsResponse_nextToken :: Lens' ListDimensionsResponse (Maybe Text) Source #

A token that can be used to retrieve the next set of results, or null if there are no additional results.