ChimeSDKMessaging / Client / delete_channel

delete_channel#

ChimeSDKMessaging.Client.delete_channel(**kwargs)#

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

Note

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.

Request Syntax

response = client.delete_channel(
    ChannelArn='string',
    ChimeBearer='string',
    SubChannelId='string'
)

Parameters:

ChannelArn (string) –
[REQUIRED]

The ARN of the channel being deleted.
ChimeBearer (string) –
[REQUIRED]

The AppInstanceUserArn of the user that makes the API call.
SubChannelId (string) – The ID of the SubChannel in the request.

Returns:

None

Exceptions