Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
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.
Synopsis
- createStream :: Text -> NonEmpty StreamFile -> Text -> CreateStream
- data CreateStream
- csDescription :: Lens' CreateStream (Maybe Text)
- csStreamId :: Lens' CreateStream Text
- csFiles :: Lens' CreateStream (NonEmpty StreamFile)
- csRoleARN :: Lens' CreateStream Text
- createStreamResponse :: Int -> CreateStreamResponse
- data CreateStreamResponse
- csrsStreamVersion :: Lens' CreateStreamResponse (Maybe Natural)
- csrsStreamARN :: Lens' CreateStreamResponse (Maybe Text)
- csrsDescription :: Lens' CreateStreamResponse (Maybe Text)
- csrsStreamId :: Lens' CreateStreamResponse (Maybe Text)
- csrsResponseStatus :: Lens' CreateStreamResponse Int
Creating a Request
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 Source #
See: createStream
smart constructor.
Instances
Request Lenses
csDescription :: Lens' CreateStream (Maybe Text) Source #
A description of the stream.
csStreamId :: Lens' CreateStream Text Source #
The stream ID.
csFiles :: Lens' CreateStream (NonEmpty StreamFile) Source #
The files to stream.
csRoleARN :: Lens' CreateStream Text Source #
An IAM role that allows the IoT service principal assumes to access your S3 files.
Destructuring the Response
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 Source #
See: createStreamResponse
smart constructor.
Instances
Response Lenses
csrsStreamVersion :: Lens' CreateStreamResponse (Maybe Natural) Source #
The version of the stream.
csrsStreamARN :: Lens' CreateStreamResponse (Maybe Text) Source #
The stream ARN.
csrsDescription :: Lens' CreateStreamResponse (Maybe Text) Source #
A description of the stream.
csrsStreamId :: Lens' CreateStreamResponse (Maybe Text) Source #
The stream ID.
csrsResponseStatus :: Lens' CreateStreamResponse Int Source #
- - | The response status code.