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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about the specified thing.

Requires permission to access the DescribeThing action.

Synopsis

data DescribeThing = DescribeThing' {
- thingName :: Text
}
newDescribeThing :: Text -> DescribeThing
describeThing_thingName :: Lens' DescribeThing Text
data DescribeThingResponse = DescribeThingResponse' {
- attributes :: Maybe (HashMap Text Text)
- billingGroupName :: Maybe Text
- defaultClientId :: Maybe Text
- thingArn :: Maybe Text
- thingId :: Maybe Text
- thingName :: Maybe Text
- thingTypeName :: Maybe Text
- version :: Maybe Integer
- httpStatus :: Int
}
newDescribeThingResponse :: Int -> DescribeThingResponse
describeThingResponse_attributes :: Lens' DescribeThingResponse (Maybe (HashMap Text Text))
describeThingResponse_billingGroupName :: Lens' DescribeThingResponse (Maybe Text)
describeThingResponse_defaultClientId :: Lens' DescribeThingResponse (Maybe Text)
describeThingResponse_thingArn :: Lens' DescribeThingResponse (Maybe Text)
describeThingResponse_thingId :: Lens' DescribeThingResponse (Maybe Text)
describeThingResponse_thingName :: Lens' DescribeThingResponse (Maybe Text)
describeThingResponse_thingTypeName :: Lens' DescribeThingResponse (Maybe Text)
describeThingResponse_version :: Lens' DescribeThingResponse (Maybe Integer)
describeThingResponse_httpStatus :: Lens' DescribeThingResponse Int

Creating a Request

data DescribeThing Source #

The input for the DescribeThing operation.

See: newDescribeThing smart constructor.

Constructors

DescribeThing'
Fields thingName :: Text The name of the thing.

Instances

Instances details

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

newDescribeThing Source #

Arguments

:: Text	`DescribeThing`
-> DescribeThing

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

DescribeThing, describeThing_thingName - The name of the thing.

Request Lenses

describeThing_thingName :: Lens' DescribeThing Text Source #

The name of the thing.

Destructuring the Response

data DescribeThingResponse Source #

The output from the DescribeThing operation.

See: newDescribeThingResponse smart constructor.

Constructors

DescribeThingResponse'

Fields

attributes :: Maybe (HashMap Text Text)
The thing attributes.
billingGroupName :: Maybe Text
The name of the billing group the thing belongs to.
defaultClientId :: Maybe Text
The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.
This lets you better organize your IoT fleet without removing the flexibility of the underlying device certificate model or shadows.
thingArn :: Maybe Text
The ARN of the thing to describe.
thingId :: Maybe Text
The ID of the thing to describe.
thingName :: Maybe Text
The name of the thing.
thingTypeName :: Maybe Text
The thing type name.
version :: Maybe Integer
The current version of the thing record in the registry.
To avoid unintentional changes to the information in the registry, you can pass the version information in the expectedVersion parameter of the UpdateThing and DeleteThing calls.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeThingResponse Source #

Arguments

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

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

DescribeThingResponse, describeThingResponse_attributes - The thing attributes.

$sel:billingGroupName:DescribeThingResponse', describeThingResponse_billingGroupName - The name of the billing group the thing belongs to.

$sel:defaultClientId:DescribeThingResponse', describeThingResponse_defaultClientId - The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.

This lets you better organize your IoT fleet without removing the flexibility of the underlying device certificate model or shadows.

DescribeThingResponse, describeThingResponse_thingArn - The ARN of the thing to describe.

DescribeThingResponse, describeThingResponse_thingId - The ID of the thing to describe.

DescribeThing, describeThingResponse_thingName - The name of the thing.

DescribeThingResponse, describeThingResponse_thingTypeName - The thing type name.

DescribeThingResponse, describeThingResponse_version - The current version of the thing record in the registry.

To avoid unintentional changes to the information in the registry, you can pass the version information in the expectedVersion parameter of the UpdateThing and DeleteThing calls.

$sel:httpStatus:DescribeThingResponse', describeThingResponse_httpStatus - The response's http status code.

Response Lenses

describeThingResponse_attributes :: Lens' DescribeThingResponse (Maybe (HashMap Text Text)) Source #

The thing attributes.

describeThingResponse_billingGroupName :: Lens' DescribeThingResponse (Maybe Text) Source #

The name of the billing group the thing belongs to.

describeThingResponse_defaultClientId :: Lens' DescribeThingResponse (Maybe Text) Source #

The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.

This lets you better organize your IoT fleet without removing the flexibility of the underlying device certificate model or shadows.

describeThingResponse_thingArn :: Lens' DescribeThingResponse (Maybe Text) Source #

The ARN of the thing to describe.

describeThingResponse_thingId :: Lens' DescribeThingResponse (Maybe Text) Source #

The ID of the thing to describe.

describeThingResponse_thingName :: Lens' DescribeThingResponse (Maybe Text) Source #

The name of the thing.

describeThingResponse_thingTypeName :: Lens' DescribeThingResponse (Maybe Text) Source #

The thing type name.

describeThingResponse_version :: Lens' DescribeThingResponse (Maybe Integer) Source #

The current version of the thing record in the registry.

To avoid unintentional changes to the information in the registry, you can pass the version information in the expectedVersion parameter of the UpdateThing and DeleteThing calls.

describeThingResponse_httpStatus :: Lens' DescribeThingResponse Int Source #

The response's http status code.