| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.ChimeSDKMessaging.AssociateChannelFlow
Description
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.
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.
Synopsis
- data AssociateChannelFlow = AssociateChannelFlow' {
- channelArn :: Text
- channelFlowArn :: Text
- chimeBearer :: Text
- newAssociateChannelFlow :: Text -> Text -> Text -> AssociateChannelFlow
- associateChannelFlow_channelArn :: Lens' AssociateChannelFlow Text
- associateChannelFlow_channelFlowArn :: Lens' AssociateChannelFlow Text
- associateChannelFlow_chimeBearer :: Lens' AssociateChannelFlow Text
- data AssociateChannelFlowResponse = AssociateChannelFlowResponse' {
- newAssociateChannelFlowResponse :: AssociateChannelFlowResponse
Creating a Request
data AssociateChannelFlow Source #
See: newAssociateChannelFlow smart constructor.
Constructors
| AssociateChannelFlow' | |
Fields
| |
Instances
newAssociateChannelFlow Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> AssociateChannelFlow |
Create a value of AssociateChannelFlow with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelArn:AssociateChannelFlow', associateChannelFlow_channelArn - The ARN of the channel.
$sel:channelFlowArn:AssociateChannelFlow', associateChannelFlow_channelFlowArn - The ARN of the channel flow.
$sel:chimeBearer:AssociateChannelFlow', associateChannelFlow_chimeBearer - The AppInstanceUserArn of the user making the API call.
Request Lenses
associateChannelFlow_channelArn :: Lens' AssociateChannelFlow Text Source #
The ARN of the channel.
associateChannelFlow_channelFlowArn :: Lens' AssociateChannelFlow Text Source #
The ARN of the channel flow.
associateChannelFlow_chimeBearer :: Lens' AssociateChannelFlow Text Source #
The AppInstanceUserArn of the user making the API call.
Destructuring the Response
data AssociateChannelFlowResponse Source #
See: newAssociateChannelFlowResponse smart constructor.
Constructors
| AssociateChannelFlowResponse' | |
Instances
newAssociateChannelFlowResponse :: AssociateChannelFlowResponse Source #
Create a value of AssociateChannelFlowResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.