Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IVS.DeleteChannel

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Deletes the specified channel and its associated stream keys.

If you try to delete a live channel, you will get an error (409 ConflictException). To delete a channel that is live, call StopStream, wait for the Amazon EventBridge "Stream End" event (to verify that the stream's state was changed from Live to Offline), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)

Synopsis

data DeleteChannel = DeleteChannel' {
- arn :: Text
}
newDeleteChannel :: Text -> DeleteChannel
deleteChannel_arn :: Lens' DeleteChannel Text
data DeleteChannelResponse = DeleteChannelResponse' {
}
newDeleteChannelResponse :: DeleteChannelResponse

Creating a Request

data DeleteChannel Source #

See: newDeleteChannel smart constructor.

Constructors

DeleteChannel'
Fields arn :: Text ARN of the channel to be deleted.

Instances

Instances details

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

newDeleteChannel Source #

Arguments

:: Text	`DeleteChannel`
-> DeleteChannel

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

DeleteChannel, deleteChannel_arn - ARN of the channel to be deleted.

Request Lenses

deleteChannel_arn :: Lens' DeleteChannel Text Source #

ARN of the channel to be deleted.

Destructuring the Response

data DeleteChannelResponse Source #

See: newDeleteChannelResponse smart constructor.

Constructors

DeleteChannelResponse'

Instances

Instances details

Generic DeleteChannelResponse Source #
Instance details Defined in Amazonka.IVS.DeleteChannel Associated Types type Rep DeleteChannelResponse :: Type -> Type # Methods from :: DeleteChannelResponse -> Rep DeleteChannelResponse x # to :: Rep DeleteChannelResponse x -> DeleteChannelResponse #
Read DeleteChannelResponse Source #
Instance details Defined in Amazonka.IVS.DeleteChannel Methods readsPrec :: Int -> ReadS DeleteChannelResponse # readList :: ReadS [DeleteChannelResponse] # readPrec :: ReadPrec DeleteChannelResponse # readListPrec :: ReadPrec [DeleteChannelResponse] #
Show DeleteChannelResponse Source #
Instance details Defined in Amazonka.IVS.DeleteChannel Methods showsPrec :: Int -> DeleteChannelResponse -> ShowS # show :: DeleteChannelResponse -> String # showList :: [DeleteChannelResponse] -> ShowS #
NFData DeleteChannelResponse Source #
Instance details Defined in Amazonka.IVS.DeleteChannel Methods rnf :: DeleteChannelResponse -> () #
Eq DeleteChannelResponse Source #
Instance details Defined in Amazonka.IVS.DeleteChannel Methods (==) :: DeleteChannelResponse -> DeleteChannelResponse -> Bool # (/=) :: DeleteChannelResponse -> DeleteChannelResponse -> Bool #
type Rep DeleteChannelResponse Source #
Instance details Defined in Amazonka.IVS.DeleteChannel type Rep DeleteChannelResponse = D1 ('MetaData "DeleteChannelResponse" "Amazonka.IVS.DeleteChannel" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "DeleteChannelResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteChannelResponse :: DeleteChannelResponse Source #

Create a value of DeleteChannelResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.