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.ChannelFlowCallback

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Calls back Chime SDK Messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.

You can return one of the following processing responses:

Update message content or metadata
Deny a message
Make no changes to the message

Synopsis

data ChannelFlowCallback = ChannelFlowCallback' {
- deleteResource :: Maybe Bool
- callbackId :: Text
- channelArn :: Text
- channelMessage :: ChannelMessageCallback
}
newChannelFlowCallback :: Text -> Text -> ChannelMessageCallback -> ChannelFlowCallback
channelFlowCallback_deleteResource :: Lens' ChannelFlowCallback (Maybe Bool)
channelFlowCallback_callbackId :: Lens' ChannelFlowCallback Text
channelFlowCallback_channelArn :: Lens' ChannelFlowCallback Text
channelFlowCallback_channelMessage :: Lens' ChannelFlowCallback ChannelMessageCallback
data ChannelFlowCallbackResponse = ChannelFlowCallbackResponse' {
- callbackId :: Maybe Text
- channelArn :: Maybe Text
- httpStatus :: Int
}
newChannelFlowCallbackResponse :: Int -> ChannelFlowCallbackResponse
channelFlowCallbackResponse_callbackId :: Lens' ChannelFlowCallbackResponse (Maybe Text)
channelFlowCallbackResponse_channelArn :: Lens' ChannelFlowCallbackResponse (Maybe Text)
channelFlowCallbackResponse_httpStatus :: Lens' ChannelFlowCallbackResponse Int

Creating a Request

data ChannelFlowCallback Source #

See: newChannelFlowCallback smart constructor.

Constructors

ChannelFlowCallback'

Fields

deleteResource :: Maybe Bool
When a processor determines that a message needs to be DENIED, pass this parameter with a value of true.
callbackId :: Text
The identifier passed to the processor by the service when invoked. Use the identifier to call back the service.
channelArn :: Text
The ARN of the channel.
channelMessage :: ChannelMessageCallback
Stores information about the processed message.

Instances

Instances details

Eq ChannelFlowCallback Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback Methods (==) :: ChannelFlowCallback -> ChannelFlowCallback -> Bool # (/=) :: ChannelFlowCallback -> ChannelFlowCallback -> Bool #
Show ChannelFlowCallback Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback Methods showsPrec :: Int -> ChannelFlowCallback -> ShowS # show :: ChannelFlowCallback -> String # showList :: [ChannelFlowCallback] -> ShowS #
Generic ChannelFlowCallback Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback Associated Types type Rep ChannelFlowCallback :: Type -> Type # Methods from :: ChannelFlowCallback -> Rep ChannelFlowCallback x # to :: Rep ChannelFlowCallback x -> ChannelFlowCallback #
NFData ChannelFlowCallback Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback Methods rnf :: ChannelFlowCallback -> () #
Hashable ChannelFlowCallback Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback Methods hashWithSalt :: Int -> ChannelFlowCallback -> Int # hash :: ChannelFlowCallback -> Int #
ToJSON ChannelFlowCallback Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback Methods toJSON :: ChannelFlowCallback -> Value # toEncoding :: ChannelFlowCallback -> Encoding # toJSONList :: [ChannelFlowCallback] -> Value # toEncodingList :: [ChannelFlowCallback] -> Encoding #
AWSRequest ChannelFlowCallback Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback Associated Types type AWSResponse ChannelFlowCallback # Methods request :: ChannelFlowCallback -> Request ChannelFlowCallback # response :: MonadResource m => Logger -> Service -> Proxy ChannelFlowCallback -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ChannelFlowCallback))) #
ToHeaders ChannelFlowCallback Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback Methods toHeaders :: ChannelFlowCallback -> [Header] #
ToPath ChannelFlowCallback Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback Methods toPath :: ChannelFlowCallback -> ByteString #
ToQuery ChannelFlowCallback Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback Methods toQuery :: ChannelFlowCallback -> QueryString #
type Rep ChannelFlowCallback Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback type Rep ChannelFlowCallback = D1 ('MetaData "ChannelFlowCallback" "Amazonka.ChimeSDKMessaging.ChannelFlowCallback" "libZSservicesZSamazonka-chime-sdk-messagingZSamazonka-chime-sdk-messaging" 'False) (C1 ('MetaCons "ChannelFlowCallback'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "deleteResource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "callbackId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "channelMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChannelMessageCallback))))
type AWSResponse ChannelFlowCallback Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback type AWSResponse ChannelFlowCallback = ChannelFlowCallbackResponse

newChannelFlowCallback Source #

Arguments

:: Text	`$sel:callbackId:ChannelFlowCallback'`
-> Text	`$sel:channelArn:ChannelFlowCallback'`
-> ChannelMessageCallback	`$sel:channelMessage:ChannelFlowCallback'`
-> ChannelFlowCallback

Create a value of ChannelFlowCallback 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:deleteResource:ChannelFlowCallback', channelFlowCallback_deleteResource - When a processor determines that a message needs to be DENIED, pass this parameter with a value of true.

$sel:callbackId:ChannelFlowCallback', channelFlowCallback_callbackId - The identifier passed to the processor by the service when invoked. Use the identifier to call back the service.

$sel:channelArn:ChannelFlowCallback', channelFlowCallback_channelArn - The ARN of the channel.

$sel:channelMessage:ChannelFlowCallback', channelFlowCallback_channelMessage - Stores information about the processed message.

Request Lenses

channelFlowCallback_deleteResource :: Lens' ChannelFlowCallback (Maybe Bool) Source #

When a processor determines that a message needs to be DENIED, pass this parameter with a value of true.

channelFlowCallback_callbackId :: Lens' ChannelFlowCallback Text Source #

The identifier passed to the processor by the service when invoked. Use the identifier to call back the service.

channelFlowCallback_channelArn :: Lens' ChannelFlowCallback Text Source #

The ARN of the channel.

channelFlowCallback_channelMessage :: Lens' ChannelFlowCallback ChannelMessageCallback Source #

Stores information about the processed message.

Destructuring the Response

data ChannelFlowCallbackResponse Source #

See: newChannelFlowCallbackResponse smart constructor.

Constructors

ChannelFlowCallbackResponse'
Fields callbackId :: Maybe Text The call back ID passed in the request. channelArn :: Maybe Text The ARN of the channel. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ChannelFlowCallbackResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback Methods (==) :: ChannelFlowCallbackResponse -> ChannelFlowCallbackResponse -> Bool # (/=) :: ChannelFlowCallbackResponse -> ChannelFlowCallbackResponse -> Bool #
Read ChannelFlowCallbackResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback Methods readsPrec :: Int -> ReadS ChannelFlowCallbackResponse # readList :: ReadS [ChannelFlowCallbackResponse] # readPrec :: ReadPrec ChannelFlowCallbackResponse # readListPrec :: ReadPrec [ChannelFlowCallbackResponse] #
Show ChannelFlowCallbackResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback Methods showsPrec :: Int -> ChannelFlowCallbackResponse -> ShowS # show :: ChannelFlowCallbackResponse -> String # showList :: [ChannelFlowCallbackResponse] -> ShowS #
Generic ChannelFlowCallbackResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback Associated Types type Rep ChannelFlowCallbackResponse :: Type -> Type # Methods from :: ChannelFlowCallbackResponse -> Rep ChannelFlowCallbackResponse x # to :: Rep ChannelFlowCallbackResponse x -> ChannelFlowCallbackResponse #
NFData ChannelFlowCallbackResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback Methods rnf :: ChannelFlowCallbackResponse -> () #
type Rep ChannelFlowCallbackResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback type Rep ChannelFlowCallbackResponse = D1 ('MetaData "ChannelFlowCallbackResponse" "Amazonka.ChimeSDKMessaging.ChannelFlowCallback" "libZSservicesZSamazonka-chime-sdk-messagingZSamazonka-chime-sdk-messaging" 'False) (C1 ('MetaCons "ChannelFlowCallbackResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "callbackId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newChannelFlowCallbackResponse Source #

Arguments

:: Int	`$sel:httpStatus:ChannelFlowCallbackResponse'`
-> ChannelFlowCallbackResponse

Create a value of ChannelFlowCallbackResponse 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:callbackId:ChannelFlowCallback', channelFlowCallbackResponse_callbackId - The call back ID passed in the request.

$sel:channelArn:ChannelFlowCallback', channelFlowCallbackResponse_channelArn - The ARN of the channel.

$sel:httpStatus:ChannelFlowCallbackResponse', channelFlowCallbackResponse_httpStatus - The response's http status code.

Response Lenses

channelFlowCallbackResponse_callbackId :: Lens' ChannelFlowCallbackResponse (Maybe Text) Source #

The call back ID passed in the request.

channelFlowCallbackResponse_channelArn :: Lens' ChannelFlowCallbackResponse (Maybe Text) Source #

The ARN of the channel.

channelFlowCallbackResponse_httpStatus :: Lens' ChannelFlowCallbackResponse Int Source #

The response's http status code.