associate_channel_flow

ChimeSDKMessaging.Client.associate_channel_flow(**kwargs)

Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the DisassociateChannelFlow API.

Note

Only administrators or channel moderators can associate a channel flow. 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.

See also: AWS API Documentation

Request Syntax

response = client.associate_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