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.IoT.CreateStream

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Requires permission to access the CreateStream action.

Synopsis

data CreateStream = CreateStream' {
- description :: Maybe Text
- tags :: Maybe [Tag]
- streamId :: Text
- files :: NonEmpty StreamFile
- roleArn :: Text
}
newCreateStream :: Text -> NonEmpty StreamFile -> Text -> CreateStream
createStream_description :: Lens' CreateStream (Maybe Text)
createStream_tags :: Lens' CreateStream (Maybe [Tag])
createStream_streamId :: Lens' CreateStream Text
createStream_files :: Lens' CreateStream (NonEmpty StreamFile)
createStream_roleArn :: Lens' CreateStream Text
data CreateStreamResponse = CreateStreamResponse' {
- description :: Maybe Text
- streamArn :: Maybe Text
- streamId :: Maybe Text
- streamVersion :: Maybe Natural
- httpStatus :: Int
}
newCreateStreamResponse :: Int -> CreateStreamResponse
createStreamResponse_description :: Lens' CreateStreamResponse (Maybe Text)
createStreamResponse_streamArn :: Lens' CreateStreamResponse (Maybe Text)
createStreamResponse_streamId :: Lens' CreateStreamResponse (Maybe Text)
createStreamResponse_streamVersion :: Lens' CreateStreamResponse (Maybe Natural)
createStreamResponse_httpStatus :: Lens' CreateStreamResponse Int

Creating a Request

data CreateStream Source #

See: newCreateStream smart constructor.

Constructors

CreateStream'
Fields description :: Maybe Text A description of the stream. tags :: Maybe [Tag] Metadata which can be used to manage streams. streamId :: Text The stream ID. files :: NonEmpty StreamFile The files to stream. roleArn :: Text An IAM role that allows the IoT service principal to access your S3 files.

Instances

Instances details

ToJSON CreateStream Source #
Instance details Defined in Amazonka.IoT.CreateStream Methods toJSON :: CreateStream -> Value # toEncoding :: CreateStream -> Encoding # toJSONList :: [CreateStream] -> Value # toEncodingList :: [CreateStream] -> Encoding #
ToHeaders CreateStream Source #
Instance details Defined in Amazonka.IoT.CreateStream Methods toHeaders :: CreateStream -> [Header] #
ToPath CreateStream Source #
Instance details Defined in Amazonka.IoT.CreateStream Methods toPath :: CreateStream -> ByteString #
ToQuery CreateStream Source #
Instance details Defined in Amazonka.IoT.CreateStream Methods toQuery :: CreateStream -> QueryString #
AWSRequest CreateStream Source #
Instance details Defined in Amazonka.IoT.CreateStream Associated Types type AWSResponse CreateStream # Methods request :: (Service -> Service) -> CreateStream -> Request CreateStream # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateStream -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateStream))) #
Generic CreateStream Source #
Instance details Defined in Amazonka.IoT.CreateStream Associated Types type Rep CreateStream :: Type -> Type # Methods from :: CreateStream -> Rep CreateStream x # to :: Rep CreateStream x -> CreateStream #
Read CreateStream Source #
Instance details Defined in Amazonka.IoT.CreateStream Methods readsPrec :: Int -> ReadS CreateStream # readList :: ReadS [CreateStream] # readPrec :: ReadPrec CreateStream # readListPrec :: ReadPrec [CreateStream] #
Show CreateStream Source #
Instance details Defined in Amazonka.IoT.CreateStream Methods showsPrec :: Int -> CreateStream -> ShowS # show :: CreateStream -> String # showList :: [CreateStream] -> ShowS #
NFData CreateStream Source #
Instance details Defined in Amazonka.IoT.CreateStream Methods rnf :: CreateStream -> () #
Eq CreateStream Source #
Instance details Defined in Amazonka.IoT.CreateStream Methods (==) :: CreateStream -> CreateStream -> Bool # (/=) :: CreateStream -> CreateStream -> Bool #
Hashable CreateStream Source #
Instance details Defined in Amazonka.IoT.CreateStream Methods hashWithSalt :: Int -> CreateStream -> Int # hash :: CreateStream -> Int #
type AWSResponse CreateStream Source #
Instance details Defined in Amazonka.IoT.CreateStream type AWSResponse CreateStream = CreateStreamResponse
type Rep CreateStream Source #
Instance details Defined in Amazonka.IoT.CreateStream type Rep CreateStream = D1 ('MetaData "CreateStream" "Amazonka.IoT.CreateStream" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "CreateStream'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :: (S1 ('MetaSel ('Just "streamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "files") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty StreamFile)) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateStream Source #

Arguments

:: Text	`CreateStream`
-> NonEmpty StreamFile	`CreateStream`
-> Text	`CreateStream`
-> CreateStream

Create a value of CreateStream 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:

CreateStream, createStream_description - A description of the stream.

$sel:tags:CreateStream', createStream_tags - Metadata which can be used to manage streams.

CreateStream, createStream_streamId - The stream ID.

CreateStream, createStream_files - The files to stream.

CreateStream, createStream_roleArn - An IAM role that allows the IoT service principal to access your S3 files.

Request Lenses

createStream_description :: Lens' CreateStream (Maybe Text) Source #

A description of the stream.

createStream_tags :: Lens' CreateStream (Maybe [Tag]) Source #

Metadata which can be used to manage streams.

createStream_streamId :: Lens' CreateStream Text Source #

The stream ID.

createStream_files :: Lens' CreateStream (NonEmpty StreamFile) Source #

The files to stream.

createStream_roleArn :: Lens' CreateStream Text Source #

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

Destructuring the Response

data CreateStreamResponse Source #

See: newCreateStreamResponse smart constructor.

Constructors

CreateStreamResponse'
Fields description :: Maybe Text A description of the stream. streamArn :: Maybe Text The stream ARN. streamId :: Maybe Text The stream ID. streamVersion :: Maybe Natural The version of the stream. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateStreamResponse Source #
Instance details Defined in Amazonka.IoT.CreateStream Associated Types type Rep CreateStreamResponse :: Type -> Type # Methods from :: CreateStreamResponse -> Rep CreateStreamResponse x # to :: Rep CreateStreamResponse x -> CreateStreamResponse #
Read CreateStreamResponse Source #
Instance details Defined in Amazonka.IoT.CreateStream Methods readsPrec :: Int -> ReadS CreateStreamResponse # readList :: ReadS [CreateStreamResponse] # readPrec :: ReadPrec CreateStreamResponse # readListPrec :: ReadPrec [CreateStreamResponse] #
Show CreateStreamResponse Source #
Instance details Defined in Amazonka.IoT.CreateStream Methods showsPrec :: Int -> CreateStreamResponse -> ShowS # show :: CreateStreamResponse -> String # showList :: [CreateStreamResponse] -> ShowS #
NFData CreateStreamResponse Source #
Instance details Defined in Amazonka.IoT.CreateStream Methods rnf :: CreateStreamResponse -> () #
Eq CreateStreamResponse Source #
Instance details Defined in Amazonka.IoT.CreateStream Methods (==) :: CreateStreamResponse -> CreateStreamResponse -> Bool # (/=) :: CreateStreamResponse -> CreateStreamResponse -> Bool #
type Rep CreateStreamResponse Source #
Instance details Defined in Amazonka.IoT.CreateStream type Rep CreateStreamResponse = D1 ('MetaData "CreateStreamResponse" "Amazonka.IoT.CreateStream" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "CreateStreamResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "streamArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "streamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "streamVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))