Amazonka.IoT.UpdateStream

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

Requires permission to access the UpdateStream action.

Creating a Request

data UpdateStream

See: newUpdateStream smart constructor.

Constructors

UpdateStream'

Fields

• description :: Maybe Text

  The description of the stream.

• files :: Maybe (NonEmpty StreamFile)

  The files associated with 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

ToJSON UpdateStream

Defined in Amazonka.IoT.UpdateStream

Methods

toJSON :: UpdateStream -> Value

toEncoding :: UpdateStream -> Encoding

toJSONList :: [UpdateStream] -> Value

toEncodingList :: [UpdateStream] -> Encoding

ToHeaders UpdateStream

Defined in Amazonka.IoT.UpdateStream

Methods

toHeaders :: UpdateStream -> [Header]

ToPath UpdateStream

Defined in Amazonka.IoT.UpdateStream

Methods

toPath :: UpdateStream -> ByteString

ToQuery UpdateStream

Defined in Amazonka.IoT.UpdateStream

Methods

toQuery :: UpdateStream -> QueryString

AWSRequest UpdateStream

Defined in Amazonka.IoT.UpdateStream

Associated Types

type AWSResponse UpdateStream

Methods

request :: (Service -> Service) -> UpdateStream -> Request UpdateStream

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateStream -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateStream)))

Generic UpdateStream

Defined in Amazonka.IoT.UpdateStream

Associated Types

type Rep UpdateStream :: Type -> Type

Methods

from :: UpdateStream -> Rep UpdateStream x

to :: Rep UpdateStream x -> UpdateStream

Read UpdateStream

Defined in Amazonka.IoT.UpdateStream

Methods

readsPrec :: Int -> ReadS UpdateStream

readList :: ReadS [UpdateStream]

readPrec :: ReadPrec UpdateStream

readListPrec :: ReadPrec [UpdateStream]

Show UpdateStream

Defined in Amazonka.IoT.UpdateStream

Methods

showsPrec :: Int -> UpdateStream -> ShowS

show :: UpdateStream -> String

showList :: [UpdateStream] -> ShowS

NFData UpdateStream

Defined in Amazonka.IoT.UpdateStream

Methods

rnf :: UpdateStream -> ()

Eq UpdateStream

Defined in Amazonka.IoT.UpdateStream

Methods

(==) :: UpdateStream -> UpdateStream -> Bool

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

Hashable UpdateStream

Defined in Amazonka.IoT.UpdateStream

Methods

hashWithSalt :: Int -> UpdateStream -> Int

hash :: UpdateStream -> Int

type AWSResponse UpdateStream

Defined in Amazonka.IoT.UpdateStream

type AWSResponse UpdateStream = UpdateStreamResponse

type Rep UpdateStream

Defined in Amazonka.IoT.UpdateStream

type Rep UpdateStream = D1 ('MetaData "UpdateStream" "Amazonka.IoT.UpdateStream" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "UpdateStream'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "files") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty StreamFile)))) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "streamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateStream

Arguments

:: Text

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:

UpdateStream, updateStream_description - The description of the stream.

UpdateStream, updateStream_files - The files associated with the stream.

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

UpdateStream, updateStream_streamId - The stream ID.

Request Lenses

updateStream_description :: Lens' UpdateStream (Maybe Text)

The description of the stream.

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

The files associated with the stream.

updateStream_roleArn :: Lens' UpdateStream (Maybe Text)

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

updateStream_streamId :: Lens' UpdateStream Text

The stream ID.

Destructuring the Response

data UpdateStreamResponse

See: newUpdateStreamResponse smart constructor.

Constructors

UpdateStreamResponse'

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 stream version.

• httpStatus :: Int

  The response's http status code.

Instances

Generic UpdateStreamResponse

Defined in Amazonka.IoT.UpdateStream

Associated Types

type Rep UpdateStreamResponse :: Type -> Type

Methods

from :: UpdateStreamResponse -> Rep UpdateStreamResponse x

to :: Rep UpdateStreamResponse x -> UpdateStreamResponse

Read UpdateStreamResponse

Defined in Amazonka.IoT.UpdateStream

Methods

readsPrec :: Int -> ReadS UpdateStreamResponse

readList :: ReadS [UpdateStreamResponse]

readPrec :: ReadPrec UpdateStreamResponse

readListPrec :: ReadPrec [UpdateStreamResponse]

Show UpdateStreamResponse

Defined in Amazonka.IoT.UpdateStream

Methods

showsPrec :: Int -> UpdateStreamResponse -> ShowS

show :: UpdateStreamResponse -> String

showList :: [UpdateStreamResponse] -> ShowS

NFData UpdateStreamResponse

Defined in Amazonka.IoT.UpdateStream

Methods

rnf :: UpdateStreamResponse -> ()

Eq UpdateStreamResponse

Defined in Amazonka.IoT.UpdateStream

Methods

(==) :: UpdateStreamResponse -> UpdateStreamResponse -> Bool

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

type Rep UpdateStreamResponse

Defined in Amazonka.IoT.UpdateStream

type Rep UpdateStreamResponse = D1 ('MetaData "UpdateStreamResponse" "Amazonka.IoT.UpdateStream" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "UpdateStreamResponse'" '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)))))

newUpdateStreamResponse

Arguments

:: Int

$sel:httpStatus:UpdateStreamResponse'

-> UpdateStreamResponse

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

UpdateStream, updateStreamResponse_description - A description of the stream.

UpdateStreamResponse, updateStreamResponse_streamArn - The stream ARN.

UpdateStream, updateStreamResponse_streamId - The stream ID.

UpdateStreamResponse, updateStreamResponse_streamVersion - The stream version.

$sel:httpStatus:UpdateStreamResponse', updateStreamResponse_httpStatus - The response's http status code.

Response Lenses

updateStreamResponse_description :: Lens' UpdateStreamResponse (Maybe Text)

A description of the stream.

updateStreamResponse_streamArn :: Lens' UpdateStreamResponse (Maybe Text)

The stream ARN.

updateStreamResponse_streamId :: Lens' UpdateStreamResponse (Maybe Text)

The stream ID.

updateStreamResponse_streamVersion :: Lens' UpdateStreamResponse (Maybe Natural)

The stream version.

updateStreamResponse_httpStatus :: Lens' UpdateStreamResponse Int

The response's http status code.