ChimeSDKMessaging / Client / disassociate_channel_flow

disassociate_channel_flow#

ChimeSDKMessaging.Client.disassociate_channel_flow(**kwargs)#

Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going through the channel flow processor.

Note

Only administrators or channel moderators can disassociate a channel flow.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_channel_flow(
    ChannelArn='string',
    ChannelFlowArn='string',
    ChimeBearer='string'
)
Parameters:

  • ChannelArn (string) –

    [REQUIRED]

    The ARN of the channel.

  • ChannelFlowArn (string) –

    [REQUIRED]

    The ARN of the channel flow.

  • ChimeBearer (string) –

    [REQUIRED]

    The AppInstanceUserArn of the user making the API call.

Returns:

None

Exceptions

  • ChimeSDKMessaging.Client.exceptions.BadRequestException

  • ChimeSDKMessaging.Client.exceptions.ForbiddenException

  • ChimeSDKMessaging.Client.exceptions.NotFoundException

  • ChimeSDKMessaging.Client.exceptions.UnauthorizedClientException

  • ChimeSDKMessaging.Client.exceptions.ConflictException

  • ChimeSDKMessaging.Client.exceptions.ThrottledClientException

  • ChimeSDKMessaging.Client.exceptions.ServiceUnavailableException

  • ChimeSDKMessaging.Client.exceptions.ServiceFailureException