Amazonka.IVS.StopStream

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.

Creating a Request

data StopStream

See: newStopStream smart constructor.

Constructors

StopStream'

Fields

• channelArn :: Text

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

Instances

ToJSON StopStream

Defined in Amazonka.IVS.StopStream

Methods

toJSON :: StopStream -> Value

toEncoding :: StopStream -> Encoding

toJSONList :: [StopStream] -> Value

toEncodingList :: [StopStream] -> Encoding

ToHeaders StopStream

Defined in Amazonka.IVS.StopStream

Methods

toHeaders :: StopStream -> [Header]

ToPath StopStream

Defined in Amazonka.IVS.StopStream

Methods

toPath :: StopStream -> ByteString

ToQuery StopStream

Defined in Amazonka.IVS.StopStream

Methods

toQuery :: StopStream -> QueryString

AWSRequest StopStream

Defined in Amazonka.IVS.StopStream

Associated Types

type AWSResponse StopStream

Methods

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

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

Generic StopStream

Defined in Amazonka.IVS.StopStream

Associated Types

type Rep StopStream :: Type -> Type

Methods

from :: StopStream -> Rep StopStream x

to :: Rep StopStream x -> StopStream

Read StopStream

Defined in Amazonka.IVS.StopStream

Methods

readsPrec :: Int -> ReadS StopStream

readList :: ReadS [StopStream]

readPrec :: ReadPrec StopStream

readListPrec :: ReadPrec [StopStream]

Show StopStream

Defined in Amazonka.IVS.StopStream

Methods

showsPrec :: Int -> StopStream -> ShowS

show :: StopStream -> String

showList :: [StopStream] -> ShowS

NFData StopStream

Defined in Amazonka.IVS.StopStream

Methods

rnf :: StopStream -> ()

Eq StopStream

Defined in Amazonka.IVS.StopStream

Methods

(==) :: StopStream -> StopStream -> Bool

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

Hashable StopStream

Defined in Amazonka.IVS.StopStream

Methods

hashWithSalt :: Int -> StopStream -> Int

hash :: StopStream -> Int

type AWSResponse StopStream

Defined in Amazonka.IVS.StopStream

type AWSResponse StopStream = StopStreamResponse

type Rep StopStream

Defined in Amazonka.IVS.StopStream

type Rep StopStream = D1 ('MetaData "StopStream" "Amazonka.IVS.StopStream" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "StopStream'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStopStream

Arguments

:: Text

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:

StopStream, stopStream_channelArn - ARN of the channel for which the stream is to be stopped.

Request Lenses

stopStream_channelArn :: Lens' StopStream Text

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

Destructuring the Response

data StopStreamResponse

See: newStopStreamResponse smart constructor.

Constructors

StopStreamResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic StopStreamResponse

Defined in Amazonka.IVS.StopStream

Associated Types

type Rep StopStreamResponse :: Type -> Type

Methods

from :: StopStreamResponse -> Rep StopStreamResponse x

to :: Rep StopStreamResponse x -> StopStreamResponse

Read StopStreamResponse

Defined in Amazonka.IVS.StopStream

Methods

readsPrec :: Int -> ReadS StopStreamResponse

readList :: ReadS [StopStreamResponse]

readPrec :: ReadPrec StopStreamResponse

readListPrec :: ReadPrec [StopStreamResponse]

Show StopStreamResponse

Defined in Amazonka.IVS.StopStream

Methods

showsPrec :: Int -> StopStreamResponse -> ShowS

show :: StopStreamResponse -> String

showList :: [StopStreamResponse] -> ShowS

NFData StopStreamResponse

Defined in Amazonka.IVS.StopStream

Methods

rnf :: StopStreamResponse -> ()

Eq StopStreamResponse

Defined in Amazonka.IVS.StopStream

Methods

(==) :: StopStreamResponse -> StopStreamResponse -> Bool

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

type Rep StopStreamResponse

Defined in Amazonka.IVS.StopStream

type Rep StopStreamResponse = D1 ('MetaData "StopStreamResponse" "Amazonka.IVS.StopStream" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "StopStreamResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStopStreamResponse

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

The response's http status code.