ChimeSDKMessaging / Client / delete_channel_flow

delete_channel_flow#

ChimeSDKMessaging.Client.delete_channel_flow(**kwargs)#

Deletes a channel flow, an irreversible process. This is a developer API.

Note

This API works only when the channel flow is not associated with any channel. To get a list of all channels that a channel flow is associated with, use the ListChannelsAssociatedWithChannelFlow API. Use the DisassociateChannelFlow API to disassociate a channel flow from all channels.

See also: AWS API Documentation

Request Syntax

response = client.delete_channel_flow(
    ChannelFlowArn='string'
)
Parameters:

ChannelFlowArn (string) –

[REQUIRED]

The ARN of the channel flow.

Returns:

None

Exceptions

  • ChimeSDKMessaging.Client.exceptions.BadRequestException

  • ChimeSDKMessaging.Client.exceptions.ForbiddenException

  • ChimeSDKMessaging.Client.exceptions.UnauthorizedClientException

  • ChimeSDKMessaging.Client.exceptions.ThrottledClientException

  • ChimeSDKMessaging.Client.exceptions.ConflictException

  • ChimeSDKMessaging.Client.exceptions.ServiceUnavailableException

  • ChimeSDKMessaging.Client.exceptions.ServiceFailureException