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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides details about a dimension that is defined in your Amazon Web Services accounts.

Requires permission to access the DescribeDimension action.

Synopsis

data DescribeDimension = DescribeDimension' {
- name :: Text
}
newDescribeDimension :: Text -> DescribeDimension
describeDimension_name :: Lens' DescribeDimension Text
data DescribeDimensionResponse = DescribeDimensionResponse' {
- arn :: Maybe Text
- creationDate :: Maybe POSIX
- lastModifiedDate :: Maybe POSIX
- name :: Maybe Text
- stringValues :: Maybe (NonEmpty Text)
- type' :: Maybe DimensionType
- httpStatus :: Int
}
newDescribeDimensionResponse :: Int -> DescribeDimensionResponse
describeDimensionResponse_arn :: Lens' DescribeDimensionResponse (Maybe Text)
describeDimensionResponse_creationDate :: Lens' DescribeDimensionResponse (Maybe UTCTime)
describeDimensionResponse_lastModifiedDate :: Lens' DescribeDimensionResponse (Maybe UTCTime)
describeDimensionResponse_name :: Lens' DescribeDimensionResponse (Maybe Text)
describeDimensionResponse_stringValues :: Lens' DescribeDimensionResponse (Maybe (NonEmpty Text))
describeDimensionResponse_type :: Lens' DescribeDimensionResponse (Maybe DimensionType)
describeDimensionResponse_httpStatus :: Lens' DescribeDimensionResponse Int

Creating a Request

data DescribeDimension Source #

See: newDescribeDimension smart constructor.

Constructors

DescribeDimension'
Fields name :: Text The unique identifier for the dimension.

Instances

Instances details

ToHeaders DescribeDimension Source #
Instance details Defined in Amazonka.IoT.DescribeDimension Methods toHeaders :: DescribeDimension -> [Header] #
ToPath DescribeDimension Source #
Instance details Defined in Amazonka.IoT.DescribeDimension Methods toPath :: DescribeDimension -> ByteString #
ToQuery DescribeDimension Source #
Instance details Defined in Amazonka.IoT.DescribeDimension Methods toQuery :: DescribeDimension -> QueryString #
AWSRequest DescribeDimension Source #
Instance details Defined in Amazonka.IoT.DescribeDimension Associated Types type AWSResponse DescribeDimension # Methods request :: (Service -> Service) -> DescribeDimension -> Request DescribeDimension # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDimension -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDimension))) #
Generic DescribeDimension Source #
Instance details Defined in Amazonka.IoT.DescribeDimension Associated Types type Rep DescribeDimension :: Type -> Type # Methods from :: DescribeDimension -> Rep DescribeDimension x # to :: Rep DescribeDimension x -> DescribeDimension #
Read DescribeDimension Source #
Instance details Defined in Amazonka.IoT.DescribeDimension Methods readsPrec :: Int -> ReadS DescribeDimension # readList :: ReadS [DescribeDimension] # readPrec :: ReadPrec DescribeDimension # readListPrec :: ReadPrec [DescribeDimension] #
Show DescribeDimension Source #
Instance details Defined in Amazonka.IoT.DescribeDimension Methods showsPrec :: Int -> DescribeDimension -> ShowS # show :: DescribeDimension -> String # showList :: [DescribeDimension] -> ShowS #
NFData DescribeDimension Source #
Instance details Defined in Amazonka.IoT.DescribeDimension Methods rnf :: DescribeDimension -> () #
Eq DescribeDimension Source #
Instance details Defined in Amazonka.IoT.DescribeDimension Methods (==) :: DescribeDimension -> DescribeDimension -> Bool # (/=) :: DescribeDimension -> DescribeDimension -> Bool #
Hashable DescribeDimension Source #
Instance details Defined in Amazonka.IoT.DescribeDimension Methods hashWithSalt :: Int -> DescribeDimension -> Int # hash :: DescribeDimension -> Int #
type AWSResponse DescribeDimension Source #
Instance details Defined in Amazonka.IoT.DescribeDimension type AWSResponse DescribeDimension = DescribeDimensionResponse
type Rep DescribeDimension Source #
Instance details Defined in Amazonka.IoT.DescribeDimension type Rep DescribeDimension = D1 ('MetaData "DescribeDimension" "Amazonka.IoT.DescribeDimension" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "DescribeDimension'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeDimension Source #

Arguments

:: Text	`DescribeDimension`
-> DescribeDimension

Create a value of DescribeDimension 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:

DescribeDimension, describeDimension_name - The unique identifier for the dimension.

Request Lenses

describeDimension_name :: Lens' DescribeDimension Text Source #

The unique identifier for the dimension.

Destructuring the Response

data DescribeDimensionResponse Source #

See: newDescribeDimensionResponse smart constructor.

Constructors

DescribeDimensionResponse'

Fields

arn :: Maybe Text
The Amazon Resource Name (ARN) for the dimension.
creationDate :: Maybe POSIX
The date the dimension was created.
lastModifiedDate :: Maybe POSIX
The date the dimension was last modified.
name :: Maybe Text
The unique identifier for the dimension.
stringValues :: Maybe (NonEmpty Text)
The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.
type' :: Maybe DimensionType
The type of the dimension.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeDimensionResponse Source #

Arguments

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

Create a value of DescribeDimensionResponse 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:

DescribeDimensionResponse, describeDimensionResponse_arn - The Amazon Resource Name (ARN) for the dimension.

DescribeDimensionResponse, describeDimensionResponse_creationDate - The date the dimension was created.

DescribeDimensionResponse, describeDimensionResponse_lastModifiedDate - The date the dimension was last modified.

DescribeDimension, describeDimensionResponse_name - The unique identifier for the dimension.

$sel:stringValues:DescribeDimensionResponse', describeDimensionResponse_stringValues - The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

DescribeDimensionResponse, describeDimensionResponse_type - The type of the dimension.

$sel:httpStatus:DescribeDimensionResponse', describeDimensionResponse_httpStatus - The response's http status code.

Response Lenses

describeDimensionResponse_arn :: Lens' DescribeDimensionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the dimension.

describeDimensionResponse_creationDate :: Lens' DescribeDimensionResponse (Maybe UTCTime) Source #

The date the dimension was created.

describeDimensionResponse_lastModifiedDate :: Lens' DescribeDimensionResponse (Maybe UTCTime) Source #

The date the dimension was last modified.

describeDimensionResponse_name :: Lens' DescribeDimensionResponse (Maybe Text) Source #

The unique identifier for the dimension.

describeDimensionResponse_stringValues :: Lens' DescribeDimensionResponse (Maybe (NonEmpty Text)) Source #

The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

describeDimensionResponse_type :: Lens' DescribeDimensionResponse (Maybe DimensionType) Source #

The type of the dimension.

describeDimensionResponse_httpStatus :: Lens' DescribeDimensionResponse Int Source #

The response's http status code.