Amazonka.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.

Requires permission to access the CreateStream action.

Creating a Request

data CreateStream

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

ToJSON CreateStream

Defined in Amazonka.IoT.CreateStream

Methods

toJSON :: CreateStream -> Value

toEncoding :: CreateStream -> Encoding

toJSONList :: [CreateStream] -> Value

toEncodingList :: [CreateStream] -> Encoding

ToHeaders CreateStream

Defined in Amazonka.IoT.CreateStream

Methods

toHeaders :: CreateStream -> [Header]

ToPath CreateStream

Defined in Amazonka.IoT.CreateStream

Methods

toPath :: CreateStream -> ByteString

ToQuery CreateStream

Defined in Amazonka.IoT.CreateStream

Methods

toQuery :: CreateStream -> QueryString

AWSRequest CreateStream

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

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

Defined in Amazonka.IoT.CreateStream

Methods

readsPrec :: Int -> ReadS CreateStream

readList :: ReadS [CreateStream]

readPrec :: ReadPrec CreateStream

readListPrec :: ReadPrec [CreateStream]

Show CreateStream

Defined in Amazonka.IoT.CreateStream

Methods

showsPrec :: Int -> CreateStream -> ShowS

show :: CreateStream -> String

showList :: [CreateStream] -> ShowS

NFData CreateStream

Defined in Amazonka.IoT.CreateStream

Methods

rnf :: CreateStream -> ()

Eq CreateStream

Defined in Amazonka.IoT.CreateStream

Methods

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

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

Hashable CreateStream

Defined in Amazonka.IoT.CreateStream

Methods

hashWithSalt :: Int -> CreateStream -> Int

hash :: CreateStream -> Int

type AWSResponse CreateStream

Defined in Amazonka.IoT.CreateStream

type AWSResponse CreateStream = CreateStreamResponse

type Rep CreateStream

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

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)

A description of the stream.

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

Metadata which can be used to manage streams.

createStream_streamId :: Lens' CreateStream Text

The stream ID.

createStream_files :: Lens' CreateStream (NonEmpty StreamFile)

The files to stream.

createStream_roleArn :: Lens' CreateStream Text

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

Destructuring the Response

data CreateStreamResponse

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

Generic CreateStreamResponse

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

Defined in Amazonka.IoT.CreateStream

Methods

readsPrec :: Int -> ReadS CreateStreamResponse

readList :: ReadS [CreateStreamResponse]

readPrec :: ReadPrec CreateStreamResponse

readListPrec :: ReadPrec [CreateStreamResponse]

Show CreateStreamResponse

Defined in Amazonka.IoT.CreateStream

Methods

showsPrec :: Int -> CreateStreamResponse -> ShowS

show :: CreateStreamResponse -> String

showList :: [CreateStreamResponse] -> ShowS

NFData CreateStreamResponse

Defined in Amazonka.IoT.CreateStream

Methods

rnf :: CreateStreamResponse -> ()

Eq CreateStreamResponse

Defined in Amazonka.IoT.CreateStream

Methods

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

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

type Rep CreateStreamResponse

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)))))

newCreateStreamResponse

Arguments

:: Int

$sel:httpStatus:CreateStreamResponse'

-> CreateStreamResponse

Create a value of CreateStreamResponse 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, createStreamResponse_description - A description of the stream.

CreateStreamResponse, createStreamResponse_streamArn - The stream ARN.

CreateStream, createStreamResponse_streamId - The stream ID.

CreateStreamResponse, createStreamResponse_streamVersion - The version of the stream.

$sel:httpStatus:CreateStreamResponse', createStreamResponse_httpStatus - The response's http status code.

Response Lenses

createStreamResponse_description :: Lens' CreateStreamResponse (Maybe Text)

A description of the stream.

createStreamResponse_streamArn :: Lens' CreateStreamResponse (Maybe Text)

The stream ARN.

createStreamResponse_streamId :: Lens' CreateStreamResponse (Maybe Text)

The stream ID.

createStreamResponse_streamVersion :: Lens' CreateStreamResponse (Maybe Natural)

The version of the stream.

createStreamResponse_httpStatus :: Lens' CreateStreamResponse Int

The response's http status code.