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.ChimeSDKMessaging.DeleteChannel

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Synopsis

Creating a Request

data DeleteChannel Source #

See: newDeleteChannel smart constructor.

Constructors

DeleteChannel'
Fields channelArn :: Text The ARN of the channel being deleted. chimeBearer :: Text The `AppInstanceUserArn` of the user that makes the API call.

Instances

Instances details

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

newDeleteChannel Source #

Arguments

:: Text	`$sel:channelArn:DeleteChannel'`
-> Text	`$sel:chimeBearer: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:

$sel:channelArn:DeleteChannel', deleteChannel_channelArn - The ARN of the channel being deleted.

$sel:chimeBearer:DeleteChannel', deleteChannel_chimeBearer - The AppInstanceUserArn of the user that makes the API call.

Request Lenses

deleteChannel_channelArn :: Lens' DeleteChannel Text Source #

The ARN of the channel being deleted.

deleteChannel_chimeBearer :: Lens' DeleteChannel Text Source #

The AppInstanceUserArn of the user that makes the API call.

Destructuring the Response

data DeleteChannelResponse Source #

See: newDeleteChannelResponse smart constructor.

Constructors

DeleteChannelResponse'

Instances

Instances details

Eq DeleteChannelResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.DeleteChannel Methods (==) :: DeleteChannelResponse -> DeleteChannelResponse -> Bool # (/=) :: DeleteChannelResponse -> DeleteChannelResponse -> Bool #
Read DeleteChannelResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.DeleteChannel Methods readsPrec :: Int -> ReadS DeleteChannelResponse # readList :: ReadS [DeleteChannelResponse] # readPrec :: ReadPrec DeleteChannelResponse # readListPrec :: ReadPrec [DeleteChannelResponse] #
Show DeleteChannelResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.DeleteChannel Methods showsPrec :: Int -> DeleteChannelResponse -> ShowS # show :: DeleteChannelResponse -> String # showList :: [DeleteChannelResponse] -> ShowS #
Generic DeleteChannelResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.DeleteChannel Associated Types type Rep DeleteChannelResponse :: Type -> Type # Methods from :: DeleteChannelResponse -> Rep DeleteChannelResponse x # to :: Rep DeleteChannelResponse x -> DeleteChannelResponse #
NFData DeleteChannelResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.DeleteChannel Methods rnf :: DeleteChannelResponse -> () #
type Rep DeleteChannelResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.DeleteChannel type Rep DeleteChannelResponse = D1 ('MetaData "DeleteChannelResponse" "Amazonka.ChimeSDKMessaging.DeleteChannel" "libZSservicesZSamazonka-chime-sdk-messagingZSamazonka-chime-sdk-messaging" '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.