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.IoTAnalytics.SampleChannelData

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be retrieved.

Creating a Request

data SampleChannelData Source #

See: newSampleChannelData smart constructor.

Constructors

SampleChannelData'
Fields endTime :: Maybe POSIX The end of the time window from which sample messages are retrieved. maxMessages :: Maybe Natural The number of sample messages to be retrieved. The limit is 10. The default is also 10. startTime :: Maybe POSIX The start of the time window from which sample messages are retrieved. channelName :: Text The name of the channel whose message samples are retrieved.

Instances

Instances details

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

newSampleChannelData Source #

Arguments

:: Text	`SampleChannelData`
-> SampleChannelData

Create a value of SampleChannelData 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:endTime:SampleChannelData', sampleChannelData_endTime - The end of the time window from which sample messages are retrieved.

$sel:maxMessages:SampleChannelData', sampleChannelData_maxMessages - The number of sample messages to be retrieved. The limit is 10. The default is also 10.

$sel:startTime:SampleChannelData', sampleChannelData_startTime - The start of the time window from which sample messages are retrieved.

SampleChannelData, sampleChannelData_channelName - The name of the channel whose message samples are retrieved.

Request Lenses

sampleChannelData_endTime :: Lens' SampleChannelData (Maybe UTCTime) Source #

The end of the time window from which sample messages are retrieved.

sampleChannelData_maxMessages :: Lens' SampleChannelData (Maybe Natural) Source #

The number of sample messages to be retrieved. The limit is 10. The default is also 10.

sampleChannelData_startTime :: Lens' SampleChannelData (Maybe UTCTime) Source #

The start of the time window from which sample messages are retrieved.

sampleChannelData_channelName :: Lens' SampleChannelData Text Source #

The name of the channel whose message samples are retrieved.

Destructuring the Response

data SampleChannelDataResponse Source #

See: newSampleChannelDataResponse smart constructor.

Constructors

SampleChannelDataResponse'
Fields payloads :: Maybe (NonEmpty Base64) The list of message samples. Each sample message is returned as a base64-encoded string. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic SampleChannelDataResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.SampleChannelData Associated Types type Rep SampleChannelDataResponse :: Type -> Type # Methods from :: SampleChannelDataResponse -> Rep SampleChannelDataResponse x # to :: Rep SampleChannelDataResponse x -> SampleChannelDataResponse #
Read SampleChannelDataResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.SampleChannelData Methods readsPrec :: Int -> ReadS SampleChannelDataResponse # readList :: ReadS [SampleChannelDataResponse] # readPrec :: ReadPrec SampleChannelDataResponse # readListPrec :: ReadPrec [SampleChannelDataResponse] #
Show SampleChannelDataResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.SampleChannelData Methods showsPrec :: Int -> SampleChannelDataResponse -> ShowS # show :: SampleChannelDataResponse -> String # showList :: [SampleChannelDataResponse] -> ShowS #
NFData SampleChannelDataResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.SampleChannelData Methods rnf :: SampleChannelDataResponse -> () #
Eq SampleChannelDataResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.SampleChannelData Methods (==) :: SampleChannelDataResponse -> SampleChannelDataResponse -> Bool # (/=) :: SampleChannelDataResponse -> SampleChannelDataResponse -> Bool #
type Rep SampleChannelDataResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.SampleChannelData type Rep SampleChannelDataResponse = D1 ('MetaData "SampleChannelDataResponse" "Amazonka.IoTAnalytics.SampleChannelData" "amazonka-iot-analytics-2.0-2pxFb0PbSzA9ccOL4CofY4" 'False) (C1 ('MetaCons "SampleChannelDataResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "payloads") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Base64))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newSampleChannelDataResponse Source #

Arguments

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

Create a value of SampleChannelDataResponse 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:payloads:SampleChannelDataResponse', sampleChannelDataResponse_payloads - The list of message samples. Each sample message is returned as a base64-encoded string.

$sel:httpStatus:SampleChannelDataResponse', sampleChannelDataResponse_httpStatus - The response's http status code.

Response Lenses

sampleChannelDataResponse_payloads :: Lens' SampleChannelDataResponse (Maybe (NonEmpty ByteString)) Source #

The list of message samples. Each sample message is returned as a base64-encoded string.

sampleChannelDataResponse_httpStatus :: Lens' SampleChannelDataResponse Int Source #

The response's http status code.