Network.AWS.IoT.CreateStream

Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream. The total size of a file associated with the stream cannot exceed more than 2 MB. The stream will be created with version 0. If a stream is created with the same streamID as a stream that existed and was deleted within last 90 days, we will resurrect that old stream by incrementing the version by 1.

Creating a Request

createStream

Arguments

:: Text

csStreamId

-> NonEmpty StreamFile

csFiles

-> Text

csRoleARN

-> CreateStream

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

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

• csDescription - A description of the stream.
• csStreamId - The stream ID.
• csFiles - The files to stream.
• csRoleARN - An IAM role that allows the IoT service principal assumes to access your S3 files.

data CreateStream

See: createStream smart constructor.

Instances

Eq CreateStream

Methods

(==) :: CreateStream -> CreateStream -> Bool

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

Data CreateStream

Methods

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

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

toConstr :: CreateStream -> Constr

dataTypeOf :: CreateStream -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreateStream

Methods

readsPrec :: Int -> ReadS CreateStream

readList :: ReadS [CreateStream]

readPrec :: ReadPrec CreateStream

readListPrec :: ReadPrec [CreateStream]

Show CreateStream

Methods

showsPrec :: Int -> CreateStream -> ShowS

show :: CreateStream -> String

showList :: [CreateStream] -> ShowS

Generic CreateStream

Associated Types

type Rep CreateStream :: * -> *

Methods

from :: CreateStream -> Rep CreateStream x

to :: Rep CreateStream x -> CreateStream

Hashable CreateStream

Methods

hashWithSalt :: Int -> CreateStream -> Int

hash :: CreateStream -> Int

ToJSON CreateStream

Methods

toJSON :: CreateStream -> Value

toEncoding :: CreateStream -> Encoding

toJSONList :: [CreateStream] -> Value

toEncodingList :: [CreateStream] -> Encoding

NFData CreateStream

Methods

rnf :: CreateStream -> ()

AWSRequest CreateStream

Associated Types

type Rs CreateStream :: *

Methods

request :: CreateStream -> Request CreateStream

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

ToHeaders CreateStream

Methods

toHeaders :: CreateStream -> [Header]

ToPath CreateStream

Methods

toPath :: CreateStream -> ByteString

ToQuery CreateStream

Methods

toQuery :: CreateStream -> QueryString

type Rep CreateStream

type Rep CreateStream = D1 * (MetaData "CreateStream" "Network.AWS.IoT.CreateStream" "amazonka-iot-1.6.0-GZYdsKS1TEjHFZo6BqaYJk" False) (C1 * (MetaCons "CreateStream'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_csDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_csStreamId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_csFiles") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (List1 StreamFile))) (S1 * (MetaSel (Just Symbol "_csRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

type Rs CreateStream

type Rs CreateStream = CreateStreamResponse

Request Lenses

csDescription :: Lens' CreateStream (Maybe Text)

A description of the stream.

csStreamId :: Lens' CreateStream Text

The stream ID.

csFiles :: Lens' CreateStream (NonEmpty StreamFile)

The files to stream.

csRoleARN :: Lens' CreateStream Text

An IAM role that allows the IoT service principal assumes to access your S3 files.

Destructuring the Response

createStreamResponse

Arguments

:: Int

csrsResponseStatus

-> CreateStreamResponse

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

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

• csrsStreamVersion - The version of the stream.
• csrsStreamARN - The stream ARN.
• csrsDescription - A description of the stream.
• csrsStreamId - The stream ID.
• csrsResponseStatus - -- | The response status code.

data CreateStreamResponse

See: createStreamResponse smart constructor.

Instances

Eq CreateStreamResponse

Methods

(==) :: CreateStreamResponse -> CreateStreamResponse -> Bool

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

Data CreateStreamResponse

Methods

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

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

toConstr :: CreateStreamResponse -> Constr

dataTypeOf :: CreateStreamResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreateStreamResponse

Methods

readsPrec :: Int -> ReadS CreateStreamResponse

readList :: ReadS [CreateStreamResponse]

readPrec :: ReadPrec CreateStreamResponse

readListPrec :: ReadPrec [CreateStreamResponse]

Show CreateStreamResponse

Methods

showsPrec :: Int -> CreateStreamResponse -> ShowS

show :: CreateStreamResponse -> String

showList :: [CreateStreamResponse] -> ShowS

Generic CreateStreamResponse

Associated Types

type Rep CreateStreamResponse :: * -> *

Methods

from :: CreateStreamResponse -> Rep CreateStreamResponse x

to :: Rep CreateStreamResponse x -> CreateStreamResponse

NFData CreateStreamResponse

Methods

rnf :: CreateStreamResponse -> ()

type Rep CreateStreamResponse

type Rep CreateStreamResponse = D1 * (MetaData "CreateStreamResponse" "Network.AWS.IoT.CreateStream" "amazonka-iot-1.6.0-GZYdsKS1TEjHFZo6BqaYJk" False) (C1 * (MetaCons "CreateStreamResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_csrsStreamVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) (S1 * (MetaSel (Just Symbol "_csrsStreamARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_csrsDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_csrsStreamId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_csrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))))

Response Lenses

csrsStreamVersion :: Lens' CreateStreamResponse (Maybe Natural)

The version of the stream.

csrsStreamARN :: Lens' CreateStreamResponse (Maybe Text)

The stream ARN.

csrsDescription :: Lens' CreateStreamResponse (Maybe Text)

A description of the stream.

csrsStreamId :: Lens' CreateStreamResponse (Maybe Text)

The stream ID.

csrsResponseStatus :: Lens' CreateStreamResponse Int

• - | The response status code.