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.IVS.StopStream

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.

Many streaming client-software libraries automatically reconnect a dropped RTMPS session, so to stop the stream permanently, you may want to first revoke the streamKey attached to the channel.

Synopsis

data StopStream = StopStream' {
- channelArn :: Text
}
newStopStream :: Text -> StopStream
stopStream_channelArn :: Lens' StopStream Text
data StopStreamResponse = StopStreamResponse' {
- httpStatus :: Int
}
newStopStreamResponse :: Int -> StopStreamResponse
stopStreamResponse_httpStatus :: Lens' StopStreamResponse Int

Creating a Request

data StopStream Source #

See: newStopStream smart constructor.

Constructors

StopStream'
Fields channelArn :: Text ARN of the channel for which the stream is to be stopped.

Instances

Instances details

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

newStopStream Source #

Arguments

:: Text	`$sel:channelArn:StopStream'`
-> StopStream

Create a value of StopStream 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:channelArn:StopStream', stopStream_channelArn - ARN of the channel for which the stream is to be stopped.

Request Lenses

stopStream_channelArn :: Lens' StopStream Text Source #

ARN of the channel for which the stream is to be stopped.

Destructuring the Response

data StopStreamResponse Source #

See: newStopStreamResponse smart constructor.

Constructors

StopStreamResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Eq StopStreamResponse Source #
Instance details Defined in Amazonka.IVS.StopStream Methods (==) :: StopStreamResponse -> StopStreamResponse -> Bool # (/=) :: StopStreamResponse -> StopStreamResponse -> Bool #
Read StopStreamResponse Source #
Instance details Defined in Amazonka.IVS.StopStream Methods readsPrec :: Int -> ReadS StopStreamResponse # readList :: ReadS [StopStreamResponse] # readPrec :: ReadPrec StopStreamResponse # readListPrec :: ReadPrec [StopStreamResponse] #
Show StopStreamResponse Source #
Instance details Defined in Amazonka.IVS.StopStream Methods showsPrec :: Int -> StopStreamResponse -> ShowS # show :: StopStreamResponse -> String # showList :: [StopStreamResponse] -> ShowS #
Generic StopStreamResponse Source #
Instance details Defined in Amazonka.IVS.StopStream Associated Types type Rep StopStreamResponse :: Type -> Type # Methods from :: StopStreamResponse -> Rep StopStreamResponse x # to :: Rep StopStreamResponse x -> StopStreamResponse #
NFData StopStreamResponse Source #
Instance details Defined in Amazonka.IVS.StopStream Methods rnf :: StopStreamResponse -> () #
type Rep StopStreamResponse Source #
Instance details Defined in Amazonka.IVS.StopStream type Rep StopStreamResponse = D1 ('MetaData "StopStreamResponse" "Amazonka.IVS.StopStream" "libZSservicesZSamazonka-ivsZSamazonka-ivs" 'False) (C1 ('MetaCons "StopStreamResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStopStreamResponse Source #

Arguments

:: Int	`$sel:httpStatus:StopStreamResponse'`
-> StopStreamResponse

Create a value of StopStreamResponse 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:httpStatus:StopStreamResponse', stopStreamResponse_httpStatus - The response's http status code.

Response Lenses

stopStreamResponse_httpStatus :: Lens' StopStreamResponse Int Source #

The response's http status code.