Amazonka.IoTData.GetThingShadow

Gets the shadow for the specified thing.

Requires permission to access the GetThingShadow action.

For more information, see GetThingShadow in the IoT Developer Guide.

Creating a Request

data GetThingShadow

The input for the GetThingShadow operation.

See: newGetThingShadow smart constructor.

Constructors

GetThingShadow'

Fields

• shadowName :: Maybe Text

  The name of the shadow.

• thingName :: Text

  The name of the thing.

Instances

ToHeaders GetThingShadow

Defined in Amazonka.IoTData.GetThingShadow

Methods

toHeaders :: GetThingShadow -> [Header]

ToPath GetThingShadow

Defined in Amazonka.IoTData.GetThingShadow

Methods

toPath :: GetThingShadow -> ByteString

ToQuery GetThingShadow

Defined in Amazonka.IoTData.GetThingShadow

Methods

toQuery :: GetThingShadow -> QueryString

AWSRequest GetThingShadow

Defined in Amazonka.IoTData.GetThingShadow

Associated Types

type AWSResponse GetThingShadow

Methods

request :: (Service -> Service) -> GetThingShadow -> Request GetThingShadow

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetThingShadow -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetThingShadow)))

Generic GetThingShadow

Defined in Amazonka.IoTData.GetThingShadow

Associated Types

type Rep GetThingShadow :: Type -> Type

Methods

from :: GetThingShadow -> Rep GetThingShadow x

to :: Rep GetThingShadow x -> GetThingShadow

Read GetThingShadow

Defined in Amazonka.IoTData.GetThingShadow

Methods

readsPrec :: Int -> ReadS GetThingShadow

readList :: ReadS [GetThingShadow]

readPrec :: ReadPrec GetThingShadow

readListPrec :: ReadPrec [GetThingShadow]

Show GetThingShadow

Defined in Amazonka.IoTData.GetThingShadow

Methods

showsPrec :: Int -> GetThingShadow -> ShowS

show :: GetThingShadow -> String

showList :: [GetThingShadow] -> ShowS

NFData GetThingShadow

Defined in Amazonka.IoTData.GetThingShadow

Methods

rnf :: GetThingShadow -> ()

Eq GetThingShadow

Defined in Amazonka.IoTData.GetThingShadow

Methods

(==) :: GetThingShadow -> GetThingShadow -> Bool

(/=) :: GetThingShadow -> GetThingShadow -> Bool

Hashable GetThingShadow

Defined in Amazonka.IoTData.GetThingShadow

Methods

hashWithSalt :: Int -> GetThingShadow -> Int

hash :: GetThingShadow -> Int

type AWSResponse GetThingShadow

Defined in Amazonka.IoTData.GetThingShadow

type AWSResponse GetThingShadow = GetThingShadowResponse

type Rep GetThingShadow

Defined in Amazonka.IoTData.GetThingShadow

type Rep GetThingShadow = D1 ('MetaData "GetThingShadow" "Amazonka.IoTData.GetThingShadow" "amazonka-iot-dataplane-2.0-Fdc9p3E1INX2O9pOv9RFV7" 'False) (C1 ('MetaCons "GetThingShadow'" 'PrefixI 'True) (S1 ('MetaSel ('Just "shadowName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "thingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetThingShadow

Arguments

:: Text

$sel:thingName:GetThingShadow'

-> GetThingShadow

Create a value of GetThingShadow 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:shadowName:GetThingShadow', getThingShadow_shadowName - The name of the shadow.

$sel:thingName:GetThingShadow', getThingShadow_thingName - The name of the thing.

Request Lenses

getThingShadow_shadowName :: Lens' GetThingShadow (Maybe Text)

The name of the shadow.

getThingShadow_thingName :: Lens' GetThingShadow Text

The name of the thing.

Destructuring the Response

data GetThingShadowResponse

The output from the GetThingShadow operation.

See: newGetThingShadowResponse smart constructor.

Constructors

GetThingShadowResponse'

Fields

• payload :: Maybe ByteString

  The state information, in JSON format.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetThingShadowResponse

Defined in Amazonka.IoTData.GetThingShadow

Associated Types

type Rep GetThingShadowResponse :: Type -> Type

Methods

from :: GetThingShadowResponse -> Rep GetThingShadowResponse x

to :: Rep GetThingShadowResponse x -> GetThingShadowResponse

Show GetThingShadowResponse

Defined in Amazonka.IoTData.GetThingShadow

Methods

showsPrec :: Int -> GetThingShadowResponse -> ShowS

show :: GetThingShadowResponse -> String

showList :: [GetThingShadowResponse] -> ShowS

NFData GetThingShadowResponse

Defined in Amazonka.IoTData.GetThingShadow

Methods

rnf :: GetThingShadowResponse -> ()

Eq GetThingShadowResponse

Defined in Amazonka.IoTData.GetThingShadow

Methods

(==) :: GetThingShadowResponse -> GetThingShadowResponse -> Bool

(/=) :: GetThingShadowResponse -> GetThingShadowResponse -> Bool

type Rep GetThingShadowResponse

Defined in Amazonka.IoTData.GetThingShadow

type Rep GetThingShadowResponse = D1 ('MetaData "GetThingShadowResponse" "Amazonka.IoTData.GetThingShadow" "amazonka-iot-dataplane-2.0-Fdc9p3E1INX2O9pOv9RFV7" 'False) (C1 ('MetaCons "GetThingShadowResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "payload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ByteString)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetThingShadowResponse

Arguments

:: Int

$sel:httpStatus:GetThingShadowResponse'

-> GetThingShadowResponse

Create a value of GetThingShadowResponse 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:payload:GetThingShadowResponse', getThingShadowResponse_payload - The state information, in JSON format.

$sel:httpStatus:GetThingShadowResponse', getThingShadowResponse_httpStatus - The response's http status code.

Response Lenses

getThingShadowResponse_payload :: Lens' GetThingShadowResponse (Maybe ByteString)

The state information, in JSON format.

getThingShadowResponse_httpStatus :: Lens' GetThingShadowResponse Int

The response's http status code.