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 ARN of the AppInstanceUserArn or AppInstanceBot that makes the API call as the value in the header.

See also: AWS API Documentation

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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

  • SubChannelId (string) – The ID of the SubChannel in the request.

Returns:

None

Exceptions

  • ChimeSDKMessaging.Client.exceptions.BadRequestException

  • ChimeSDKMessaging.Client.exceptions.ForbiddenException

  • ChimeSDKMessaging.Client.exceptions.UnauthorizedClientException

  • ChimeSDKMessaging.Client.exceptions.ThrottledClientException

  • ChimeSDKMessaging.Client.exceptions.ServiceUnavailableException

  • ChimeSDKMessaging.Client.exceptions.ServiceFailureException