Network.AWS.IoTAnalytics.SampleChannelData

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

Creating a Request

sampleChannelData

Arguments

:: Text

scdChannelName

-> SampleChannelData

Creates a value of SampleChannelData with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• scdStartTime - The start of the time window from which sample messages are retrieved.
• scdMaxMessages - The number of sample messages to be retrieved. The limit is 10, the default is also 10.
• scdEndTime - The end of the time window from which sample messages are retrieved.
• scdChannelName - The name of the channel whose message samples are retrieved.

data SampleChannelData

See: sampleChannelData smart constructor.

Instances

Eq SampleChannelData

Methods

(==) :: SampleChannelData -> SampleChannelData -> Bool

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

Data SampleChannelData

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SampleChannelData -> c SampleChannelData

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SampleChannelData

toConstr :: SampleChannelData -> Constr

dataTypeOf :: SampleChannelData -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SampleChannelData)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SampleChannelData)

gmapT :: (forall b. Data b => b -> b) -> SampleChannelData -> SampleChannelData

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SampleChannelData -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SampleChannelData -> r

gmapQ :: (forall d. Data d => d -> u) -> SampleChannelData -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SampleChannelData -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SampleChannelData -> m SampleChannelData

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SampleChannelData -> m SampleChannelData

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SampleChannelData -> m SampleChannelData

Read SampleChannelData

Methods

readsPrec :: Int -> ReadS SampleChannelData

readList :: ReadS [SampleChannelData]

readPrec :: ReadPrec SampleChannelData

readListPrec :: ReadPrec [SampleChannelData]

Show SampleChannelData

Methods

showsPrec :: Int -> SampleChannelData -> ShowS

show :: SampleChannelData -> String

showList :: [SampleChannelData] -> ShowS

Generic SampleChannelData

Associated Types

type Rep SampleChannelData :: * -> *

Methods

from :: SampleChannelData -> Rep SampleChannelData x

to :: Rep SampleChannelData x -> SampleChannelData

Hashable SampleChannelData

Methods

hashWithSalt :: Int -> SampleChannelData -> Int

hash :: SampleChannelData -> Int

NFData SampleChannelData

Methods

rnf :: SampleChannelData -> ()

AWSRequest SampleChannelData

Associated Types

type Rs SampleChannelData :: *

Methods

request :: SampleChannelData -> Request SampleChannelData

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * SampleChannelData -> ClientResponse -> m (Response SampleChannelData)

ToHeaders SampleChannelData

Methods

toHeaders :: SampleChannelData -> [Header]

ToPath SampleChannelData

Methods

toPath :: SampleChannelData -> ByteString

ToQuery SampleChannelData

Methods

toQuery :: SampleChannelData -> QueryString

type Rep SampleChannelData

type Rep SampleChannelData = D1 * (MetaData "SampleChannelData" "Network.AWS.IoTAnalytics.SampleChannelData" "amazonka-iot-analytics-1.6.0-J5q8AVx26VCAr48eVqZbw0" False) (C1 * (MetaCons "SampleChannelData'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_scdStartTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) (S1 * (MetaSel (Just Symbol "_scdMaxMessages") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_scdEndTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) (S1 * (MetaSel (Just Symbol "_scdChannelName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

type Rs SampleChannelData

type Rs SampleChannelData = SampleChannelDataResponse

Request Lenses

scdStartTime :: Lens' SampleChannelData (Maybe UTCTime)

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

scdMaxMessages :: Lens' SampleChannelData (Maybe Natural)

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

scdEndTime :: Lens' SampleChannelData (Maybe UTCTime)

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

scdChannelName :: Lens' SampleChannelData Text

The name of the channel whose message samples are retrieved.

Destructuring the Response

sampleChannelDataResponse

Arguments

:: Int

scdrsResponseStatus

-> SampleChannelDataResponse

Creates a value of SampleChannelDataResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• scdrsPayloads - The list of message samples. Each sample message is returned as a base64-encoded string.
• scdrsResponseStatus - -- | The response status code.

data SampleChannelDataResponse

See: sampleChannelDataResponse smart constructor.

Instances

Eq SampleChannelDataResponse

Methods

(==) :: SampleChannelDataResponse -> SampleChannelDataResponse -> Bool

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

Data SampleChannelDataResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SampleChannelDataResponse -> c SampleChannelDataResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SampleChannelDataResponse

toConstr :: SampleChannelDataResponse -> Constr

dataTypeOf :: SampleChannelDataResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SampleChannelDataResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SampleChannelDataResponse)

gmapT :: (forall b. Data b => b -> b) -> SampleChannelDataResponse -> SampleChannelDataResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SampleChannelDataResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SampleChannelDataResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> SampleChannelDataResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SampleChannelDataResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SampleChannelDataResponse -> m SampleChannelDataResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SampleChannelDataResponse -> m SampleChannelDataResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SampleChannelDataResponse -> m SampleChannelDataResponse

Read SampleChannelDataResponse

Methods

readsPrec :: Int -> ReadS SampleChannelDataResponse

readList :: ReadS [SampleChannelDataResponse]

readPrec :: ReadPrec SampleChannelDataResponse

readListPrec :: ReadPrec [SampleChannelDataResponse]

Show SampleChannelDataResponse

Methods

showsPrec :: Int -> SampleChannelDataResponse -> ShowS

show :: SampleChannelDataResponse -> String

showList :: [SampleChannelDataResponse] -> ShowS

Generic SampleChannelDataResponse

Associated Types

type Rep SampleChannelDataResponse :: * -> *

Methods

from :: SampleChannelDataResponse -> Rep SampleChannelDataResponse x

to :: Rep SampleChannelDataResponse x -> SampleChannelDataResponse

NFData SampleChannelDataResponse

Methods

rnf :: SampleChannelDataResponse -> ()

type Rep SampleChannelDataResponse

type Rep SampleChannelDataResponse = D1 * (MetaData "SampleChannelDataResponse" "Network.AWS.IoTAnalytics.SampleChannelData" "amazonka-iot-analytics-1.6.0-J5q8AVx26VCAr48eVqZbw0" False) (C1 * (MetaCons "SampleChannelDataResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_scdrsPayloads") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (List1 Base64)))) (S1 * (MetaSel (Just Symbol "_scdrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

scdrsPayloads :: Lens' SampleChannelDataResponse (Maybe (NonEmpty ByteString))

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

scdrsResponseStatus :: Lens' SampleChannelDataResponse Int

• - | The response status code.