Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoTData.GetRetainedMessage

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the details of a single retained message for the specified topic.

This action returns the message payload of the retained message, which can incur messaging costs. To list only the topic names of the retained messages, call ListRetainedMessages.

Requires permission to access the GetRetainedMessage action.

For more information about messaging costs, see IoT Core pricing - Messaging.

Synopsis

Creating a Request

data GetRetainedMessage Source #

The input for the GetRetainedMessage operation.

See: newGetRetainedMessage smart constructor.

Constructors

GetRetainedMessage'
Fields topic :: Text The topic name of the retained message to retrieve.

Instances

Instances details

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

newGetRetainedMessage Source #

Arguments

:: Text	`$sel:topic:GetRetainedMessage'`
-> GetRetainedMessage

Create a value of GetRetainedMessage 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:topic:GetRetainedMessage', getRetainedMessage_topic - The topic name of the retained message to retrieve.

Request Lenses

getRetainedMessage_topic :: Lens' GetRetainedMessage Text Source #

The topic name of the retained message to retrieve.

Destructuring the Response

data GetRetainedMessageResponse Source #

The output from the GetRetainedMessage operation.

See: newGetRetainedMessageResponse smart constructor.

Constructors

GetRetainedMessageResponse'

Fields

lastModifiedTime :: Maybe Integer
The Epoch date and time, in milliseconds, when the retained message was stored by IoT.
payload :: Maybe Base64
The Base64-encoded message payload of the retained message body.
topic :: Maybe Text
The topic name to which the retained message was published.
qos :: Maybe Natural
The quality of service (QoS) level used to publish the retained message.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq GetRetainedMessageResponse Source #
Instance details Defined in Amazonka.IoTData.GetRetainedMessage Methods (==) :: GetRetainedMessageResponse -> GetRetainedMessageResponse -> Bool # (/=) :: GetRetainedMessageResponse -> GetRetainedMessageResponse -> Bool #
Read GetRetainedMessageResponse Source #
Instance details Defined in Amazonka.IoTData.GetRetainedMessage Methods readsPrec :: Int -> ReadS GetRetainedMessageResponse # readList :: ReadS [GetRetainedMessageResponse] # readPrec :: ReadPrec GetRetainedMessageResponse # readListPrec :: ReadPrec [GetRetainedMessageResponse] #
Show GetRetainedMessageResponse Source #
Instance details Defined in Amazonka.IoTData.GetRetainedMessage Methods showsPrec :: Int -> GetRetainedMessageResponse -> ShowS # show :: GetRetainedMessageResponse -> String # showList :: [GetRetainedMessageResponse] -> ShowS #
Generic GetRetainedMessageResponse Source #
Instance details Defined in Amazonka.IoTData.GetRetainedMessage Associated Types type Rep GetRetainedMessageResponse :: Type -> Type # Methods from :: GetRetainedMessageResponse -> Rep GetRetainedMessageResponse x # to :: Rep GetRetainedMessageResponse x -> GetRetainedMessageResponse #
NFData GetRetainedMessageResponse Source #
Instance details Defined in Amazonka.IoTData.GetRetainedMessage Methods rnf :: GetRetainedMessageResponse -> () #
type Rep GetRetainedMessageResponse Source #
Instance details Defined in Amazonka.IoTData.GetRetainedMessage type Rep GetRetainedMessageResponse = D1 ('MetaData "GetRetainedMessageResponse" "Amazonka.IoTData.GetRetainedMessage" "libZSservicesZSamazonka-iot-dataplaneZSamazonka-iot-dataplane" 'False) (C1 ('MetaCons "GetRetainedMessageResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "payload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64))) :: (S1 ('MetaSel ('Just "topic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "qos") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetRetainedMessageResponse Source #

Arguments

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

Create a value of GetRetainedMessageResponse 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:lastModifiedTime:GetRetainedMessageResponse', getRetainedMessageResponse_lastModifiedTime - The Epoch date and time, in milliseconds, when the retained message was stored by IoT.

$sel:payload:GetRetainedMessageResponse', getRetainedMessageResponse_payload - The Base64-encoded message payload of the retained message body.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:topic:GetRetainedMessage', getRetainedMessageResponse_topic - The topic name to which the retained message was published.

$sel:qos:GetRetainedMessageResponse', getRetainedMessageResponse_qos - The quality of service (QoS) level used to publish the retained message.

$sel:httpStatus:GetRetainedMessageResponse', getRetainedMessageResponse_httpStatus - The response's http status code.

Response Lenses

getRetainedMessageResponse_lastModifiedTime :: Lens' GetRetainedMessageResponse (Maybe Integer) Source #

The Epoch date and time, in milliseconds, when the retained message was stored by IoT.

getRetainedMessageResponse_payload :: Lens' GetRetainedMessageResponse (Maybe ByteString) Source #

The Base64-encoded message payload of the retained message body.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

getRetainedMessageResponse_topic :: Lens' GetRetainedMessageResponse (Maybe Text) Source #

The topic name to which the retained message was published.

getRetainedMessageResponse_qos :: Lens' GetRetainedMessageResponse (Maybe Natural) Source #

The quality of service (QoS) level used to publish the retained message.

getRetainedMessageResponse_httpStatus :: Lens' GetRetainedMessageResponse Int Source #

The response's http status code.