Amazonka.ChimeSDKMessaging.AssociateChannelFlow

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.

Creating a Request

data AssociateChannelFlow

See: newAssociateChannelFlow smart constructor.

Constructors

AssociateChannelFlow'

Fields

• channelArn :: Text

  The ARN of the channel.

• channelFlowArn :: Text

  The ARN of the channel flow.

• chimeBearer :: Text

  The AppInstanceUserArn of the user making the API call.

Instances

ToJSON AssociateChannelFlow

Defined in Amazonka.ChimeSDKMessaging.AssociateChannelFlow

Methods

toJSON :: AssociateChannelFlow -> Value

toEncoding :: AssociateChannelFlow -> Encoding

toJSONList :: [AssociateChannelFlow] -> Value

toEncodingList :: [AssociateChannelFlow] -> Encoding

ToHeaders AssociateChannelFlow

Defined in Amazonka.ChimeSDKMessaging.AssociateChannelFlow

Methods

toHeaders :: AssociateChannelFlow -> [Header]

ToPath AssociateChannelFlow

Defined in Amazonka.ChimeSDKMessaging.AssociateChannelFlow

Methods

toPath :: AssociateChannelFlow -> ByteString

ToQuery AssociateChannelFlow

Defined in Amazonka.ChimeSDKMessaging.AssociateChannelFlow

Methods

toQuery :: AssociateChannelFlow -> QueryString

AWSRequest AssociateChannelFlow

Defined in Amazonka.ChimeSDKMessaging.AssociateChannelFlow

Associated Types

type AWSResponse AssociateChannelFlow

Methods

request :: (Service -> Service) -> AssociateChannelFlow -> Request AssociateChannelFlow

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AssociateChannelFlow -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AssociateChannelFlow)))

Generic AssociateChannelFlow

Defined in Amazonka.ChimeSDKMessaging.AssociateChannelFlow

Associated Types

type Rep AssociateChannelFlow :: Type -> Type

Methods

from :: AssociateChannelFlow -> Rep AssociateChannelFlow x

to :: Rep AssociateChannelFlow x -> AssociateChannelFlow

Read AssociateChannelFlow

Defined in Amazonka.ChimeSDKMessaging.AssociateChannelFlow

Methods

readsPrec :: Int -> ReadS AssociateChannelFlow

readList :: ReadS [AssociateChannelFlow]

readPrec :: ReadPrec AssociateChannelFlow

readListPrec :: ReadPrec [AssociateChannelFlow]

Show AssociateChannelFlow

Defined in Amazonka.ChimeSDKMessaging.AssociateChannelFlow

Methods

showsPrec :: Int -> AssociateChannelFlow -> ShowS

show :: AssociateChannelFlow -> String

showList :: [AssociateChannelFlow] -> ShowS

NFData AssociateChannelFlow

Defined in Amazonka.ChimeSDKMessaging.AssociateChannelFlow

Methods

rnf :: AssociateChannelFlow -> ()

Eq AssociateChannelFlow

Defined in Amazonka.ChimeSDKMessaging.AssociateChannelFlow

Methods

(==) :: AssociateChannelFlow -> AssociateChannelFlow -> Bool

(/=) :: AssociateChannelFlow -> AssociateChannelFlow -> Bool

Hashable AssociateChannelFlow

Defined in Amazonka.ChimeSDKMessaging.AssociateChannelFlow

Methods

hashWithSalt :: Int -> AssociateChannelFlow -> Int

hash :: AssociateChannelFlow -> Int

type AWSResponse AssociateChannelFlow

Defined in Amazonka.ChimeSDKMessaging.AssociateChannelFlow

type AWSResponse AssociateChannelFlow = AssociateChannelFlowResponse

type Rep AssociateChannelFlow

Defined in Amazonka.ChimeSDKMessaging.AssociateChannelFlow

type Rep AssociateChannelFlow = D1 ('MetaData "AssociateChannelFlow" "Amazonka.ChimeSDKMessaging.AssociateChannelFlow" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "AssociateChannelFlow'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "channelFlowArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "chimeBearer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newAssociateChannelFlow

Arguments

:: Text

AssociateChannelFlow

-> Text

AssociateChannelFlow

-> Text

$sel:chimeBearer:AssociateChannelFlow'

-> 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:

AssociateChannelFlow, associateChannelFlow_channelArn - The ARN of the channel.

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

The ARN of the channel.

associateChannelFlow_channelFlowArn :: Lens' AssociateChannelFlow Text

The ARN of the channel flow.

associateChannelFlow_chimeBearer :: Lens' AssociateChannelFlow Text

The AppInstanceUserArn of the user making the API call.

Destructuring the Response

data AssociateChannelFlowResponse

See: newAssociateChannelFlowResponse smart constructor.

Constructors

AssociateChannelFlowResponse'

Instances

Generic AssociateChannelFlowResponse

Defined in Amazonka.ChimeSDKMessaging.AssociateChannelFlow

Associated Types

type Rep AssociateChannelFlowResponse :: Type -> Type

Methods

from :: AssociateChannelFlowResponse -> Rep AssociateChannelFlowResponse x

to :: Rep AssociateChannelFlowResponse x -> AssociateChannelFlowResponse

Read AssociateChannelFlowResponse

Defined in Amazonka.ChimeSDKMessaging.AssociateChannelFlow

Methods

readsPrec :: Int -> ReadS AssociateChannelFlowResponse

readList :: ReadS [AssociateChannelFlowResponse]

readPrec :: ReadPrec AssociateChannelFlowResponse

readListPrec :: ReadPrec [AssociateChannelFlowResponse]

Show AssociateChannelFlowResponse

Defined in Amazonka.ChimeSDKMessaging.AssociateChannelFlow

Methods

showsPrec :: Int -> AssociateChannelFlowResponse -> ShowS

show :: AssociateChannelFlowResponse -> String

showList :: [AssociateChannelFlowResponse] -> ShowS

NFData AssociateChannelFlowResponse

Defined in Amazonka.ChimeSDKMessaging.AssociateChannelFlow

Methods

rnf :: AssociateChannelFlowResponse -> ()

Eq AssociateChannelFlowResponse

Defined in Amazonka.ChimeSDKMessaging.AssociateChannelFlow

Methods

(==) :: AssociateChannelFlowResponse -> AssociateChannelFlowResponse -> Bool

(/=) :: AssociateChannelFlowResponse -> AssociateChannelFlowResponse -> Bool

type Rep AssociateChannelFlowResponse

Defined in Amazonka.ChimeSDKMessaging.AssociateChannelFlow

type Rep AssociateChannelFlowResponse = D1 ('MetaData "AssociateChannelFlowResponse" "Amazonka.ChimeSDKMessaging.AssociateChannelFlow" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "AssociateChannelFlowResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newAssociateChannelFlowResponse :: AssociateChannelFlowResponse

Create a value of AssociateChannelFlowResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.