Amazonka.ChimeSDKMessaging.DeleteChannel

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.

Creating a Request

data DeleteChannel

See: newDeleteChannel smart constructor.

Constructors

DeleteChannel'

Fields

• subChannelId :: Maybe Text

  The ID of the SubChannel in the request.

• channelArn :: Text

  The ARN of the channel being deleted.

• chimeBearer :: Text

  The AppInstanceUserArn of the user that makes the API call.

Instances

ToHeaders DeleteChannel

Defined in Amazonka.ChimeSDKMessaging.DeleteChannel

Methods

toHeaders :: DeleteChannel -> [Header]

ToPath DeleteChannel

Defined in Amazonka.ChimeSDKMessaging.DeleteChannel

Methods

toPath :: DeleteChannel -> ByteString

ToQuery DeleteChannel

Defined in Amazonka.ChimeSDKMessaging.DeleteChannel

Methods

toQuery :: DeleteChannel -> QueryString

AWSRequest DeleteChannel

Defined in Amazonka.ChimeSDKMessaging.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

Defined in Amazonka.ChimeSDKMessaging.DeleteChannel

Associated Types

type Rep DeleteChannel :: Type -> Type

Methods

from :: DeleteChannel -> Rep DeleteChannel x

to :: Rep DeleteChannel x -> DeleteChannel

Read DeleteChannel

Defined in Amazonka.ChimeSDKMessaging.DeleteChannel

Methods

readsPrec :: Int -> ReadS DeleteChannel

readList :: ReadS [DeleteChannel]

readPrec :: ReadPrec DeleteChannel

readListPrec :: ReadPrec [DeleteChannel]

Show DeleteChannel

Defined in Amazonka.ChimeSDKMessaging.DeleteChannel

Methods

showsPrec :: Int -> DeleteChannel -> ShowS

show :: DeleteChannel -> String

showList :: [DeleteChannel] -> ShowS

NFData DeleteChannel

Defined in Amazonka.ChimeSDKMessaging.DeleteChannel

Methods

rnf :: DeleteChannel -> ()

Eq DeleteChannel

Defined in Amazonka.ChimeSDKMessaging.DeleteChannel

Methods

(==) :: DeleteChannel -> DeleteChannel -> Bool

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

Hashable DeleteChannel

Defined in Amazonka.ChimeSDKMessaging.DeleteChannel

Methods

hashWithSalt :: Int -> DeleteChannel -> Int

hash :: DeleteChannel -> Int

type AWSResponse DeleteChannel

Defined in Amazonka.ChimeSDKMessaging.DeleteChannel

type AWSResponse DeleteChannel = DeleteChannelResponse

type Rep DeleteChannel

Defined in Amazonka.ChimeSDKMessaging.DeleteChannel

type Rep DeleteChannel = D1 ('MetaData "DeleteChannel" "Amazonka.ChimeSDKMessaging.DeleteChannel" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "DeleteChannel'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subChannelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "chimeBearer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDeleteChannel

Arguments

:: Text

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:

DeleteChannel, deleteChannel_subChannelId - The ID of the SubChannel in the request.

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_subChannelId :: Lens' DeleteChannel (Maybe Text)

The ID of the SubChannel in the request.

deleteChannel_channelArn :: Lens' DeleteChannel Text

The ARN of the channel being deleted.

deleteChannel_chimeBearer :: Lens' DeleteChannel Text

The AppInstanceUserArn of the user that makes the API call.

Destructuring the Response

data DeleteChannelResponse

See: newDeleteChannelResponse smart constructor.

Constructors

DeleteChannelResponse'

Instances

Generic DeleteChannelResponse

Defined in Amazonka.ChimeSDKMessaging.DeleteChannel

Associated Types

type Rep DeleteChannelResponse :: Type -> Type

Methods

from :: DeleteChannelResponse -> Rep DeleteChannelResponse x

to :: Rep DeleteChannelResponse x -> DeleteChannelResponse

Read DeleteChannelResponse

Defined in Amazonka.ChimeSDKMessaging.DeleteChannel

Methods

readsPrec :: Int -> ReadS DeleteChannelResponse

readList :: ReadS [DeleteChannelResponse]

readPrec :: ReadPrec DeleteChannelResponse

readListPrec :: ReadPrec [DeleteChannelResponse]

Show DeleteChannelResponse

Defined in Amazonka.ChimeSDKMessaging.DeleteChannel

Methods

showsPrec :: Int -> DeleteChannelResponse -> ShowS

show :: DeleteChannelResponse -> String

showList :: [DeleteChannelResponse] -> ShowS

NFData DeleteChannelResponse

Defined in Amazonka.ChimeSDKMessaging.DeleteChannel

Methods

rnf :: DeleteChannelResponse -> ()

Eq DeleteChannelResponse

Defined in Amazonka.ChimeSDKMessaging.DeleteChannel

Methods

(==) :: DeleteChannelResponse -> DeleteChannelResponse -> Bool

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

type Rep DeleteChannelResponse

Defined in Amazonka.ChimeSDKMessaging.DeleteChannel

type Rep DeleteChannelResponse = D1 ('MetaData "DeleteChannelResponse" "Amazonka.ChimeSDKMessaging.DeleteChannel" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "DeleteChannelResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteChannelResponse :: DeleteChannelResponse

Create a value of DeleteChannelResponse with all optional fields omitted.

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