Copyright	(c) 2013-2021 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

Amazonka.IoT.UpdateStream

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an existing stream. The stream version will be incremented by one.

Requires permission to access the UpdateStream action.

Synopsis

data UpdateStream = UpdateStream' {
- files :: Maybe (NonEmpty StreamFile)
- description :: Maybe Text
- roleArn :: Maybe Text
- streamId :: Text
}
newUpdateStream :: Text -> UpdateStream
updateStream_files :: Lens' UpdateStream (Maybe (NonEmpty StreamFile))
updateStream_description :: Lens' UpdateStream (Maybe Text)
updateStream_roleArn :: Lens' UpdateStream (Maybe Text)
updateStream_streamId :: Lens' UpdateStream Text
data UpdateStreamResponse = UpdateStreamResponse' {
- streamVersion :: Maybe Natural
- streamArn :: Maybe Text
- description :: Maybe Text
- streamId :: Maybe Text
- httpStatus :: Int
}
newUpdateStreamResponse :: Int -> UpdateStreamResponse
updateStreamResponse_streamVersion :: Lens' UpdateStreamResponse (Maybe Natural)
updateStreamResponse_streamArn :: Lens' UpdateStreamResponse (Maybe Text)
updateStreamResponse_description :: Lens' UpdateStreamResponse (Maybe Text)
updateStreamResponse_streamId :: Lens' UpdateStreamResponse (Maybe Text)
updateStreamResponse_httpStatus :: Lens' UpdateStreamResponse Int

Creating a Request

data UpdateStream Source #

See: newUpdateStream smart constructor.

Constructors

UpdateStream'
Fields files :: Maybe (NonEmpty StreamFile) The files associated with the stream. description :: Maybe Text The description of the stream. roleArn :: Maybe Text An IAM role that allows the IoT service principal assumes to access your S3 files. streamId :: Text The stream ID.

Instances

Instances details

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

newUpdateStream Source #

Arguments

:: Text	`$sel:streamId:UpdateStream'`
-> UpdateStream

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

$sel:files:UpdateStream', updateStream_files - The files associated with the stream.

$sel:description:UpdateStream', updateStream_description - The description of the stream.

$sel:roleArn:UpdateStream', updateStream_roleArn - An IAM role that allows the IoT service principal assumes to access your S3 files.

$sel:streamId:UpdateStream', updateStream_streamId - The stream ID.

Request Lenses

updateStream_files :: Lens' UpdateStream (Maybe (NonEmpty StreamFile)) Source #

The files associated with the stream.

updateStream_description :: Lens' UpdateStream (Maybe Text) Source #

The description of the stream.

updateStream_roleArn :: Lens' UpdateStream (Maybe Text) Source #

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

updateStream_streamId :: Lens' UpdateStream Text Source #

The stream ID.

Destructuring the Response

data UpdateStreamResponse Source #

See: newUpdateStreamResponse smart constructor.

Constructors

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

Instances

Instances details

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