Amazonka.ChimeSDKMessaging.ChannelFlowCallback

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

Creating a Request

data ChannelFlowCallback

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

ToJSON ChannelFlowCallback

Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback

Methods

toJSON :: ChannelFlowCallback -> Value

toEncoding :: ChannelFlowCallback -> Encoding

toJSONList :: [ChannelFlowCallback] -> Value

toEncodingList :: [ChannelFlowCallback] -> Encoding

ToHeaders ChannelFlowCallback

Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback

Methods

toHeaders :: ChannelFlowCallback -> [Header]

ToPath ChannelFlowCallback

Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback

Methods

toPath :: ChannelFlowCallback -> ByteString

ToQuery ChannelFlowCallback

Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback

Methods

toQuery :: ChannelFlowCallback -> QueryString

AWSRequest ChannelFlowCallback

Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback

Associated Types

type AWSResponse ChannelFlowCallback

Methods

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

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

Generic ChannelFlowCallback

Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback

Associated Types

type Rep ChannelFlowCallback :: Type -> Type

Methods

from :: ChannelFlowCallback -> Rep ChannelFlowCallback x

to :: Rep ChannelFlowCallback x -> ChannelFlowCallback

Show ChannelFlowCallback

Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback

Methods

showsPrec :: Int -> ChannelFlowCallback -> ShowS

show :: ChannelFlowCallback -> String

showList :: [ChannelFlowCallback] -> ShowS

NFData ChannelFlowCallback

Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback

Methods

rnf :: ChannelFlowCallback -> ()

Eq ChannelFlowCallback

Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback

Methods

(==) :: ChannelFlowCallback -> ChannelFlowCallback -> Bool

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

Hashable ChannelFlowCallback

Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback

Methods

hashWithSalt :: Int -> ChannelFlowCallback -> Int

hash :: ChannelFlowCallback -> Int

type AWSResponse ChannelFlowCallback

Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback

type AWSResponse ChannelFlowCallback = ChannelFlowCallbackResponse

type Rep ChannelFlowCallback

Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback

type Rep ChannelFlowCallback = D1 ('MetaData "ChannelFlowCallback" "Amazonka.ChimeSDKMessaging.ChannelFlowCallback" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" '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))))

newChannelFlowCallback

Arguments

:: Text

ChannelFlowCallback

-> Text

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.

ChannelFlowCallback, channelFlowCallback_callbackId - The identifier passed to the processor by the service when invoked. Use the identifier to call back the service.

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)

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

channelFlowCallback_callbackId :: Lens' ChannelFlowCallback Text

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

channelFlowCallback_channelArn :: Lens' ChannelFlowCallback Text

The ARN of the channel.

channelFlowCallback_channelMessage :: Lens' ChannelFlowCallback ChannelMessageCallback

Stores information about the processed message.

Destructuring the Response

data ChannelFlowCallbackResponse

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

Generic ChannelFlowCallbackResponse

Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback

Associated Types

type Rep ChannelFlowCallbackResponse :: Type -> Type

Methods

from :: ChannelFlowCallbackResponse -> Rep ChannelFlowCallbackResponse x

to :: Rep ChannelFlowCallbackResponse x -> ChannelFlowCallbackResponse

Read ChannelFlowCallbackResponse

Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback

Methods

readsPrec :: Int -> ReadS ChannelFlowCallbackResponse

readList :: ReadS [ChannelFlowCallbackResponse]

readPrec :: ReadPrec ChannelFlowCallbackResponse

readListPrec :: ReadPrec [ChannelFlowCallbackResponse]

Show ChannelFlowCallbackResponse

Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback

Methods

showsPrec :: Int -> ChannelFlowCallbackResponse -> ShowS

show :: ChannelFlowCallbackResponse -> String

showList :: [ChannelFlowCallbackResponse] -> ShowS

NFData ChannelFlowCallbackResponse

Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback

Methods

rnf :: ChannelFlowCallbackResponse -> ()

Eq ChannelFlowCallbackResponse

Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback

Methods

(==) :: ChannelFlowCallbackResponse -> ChannelFlowCallbackResponse -> Bool

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

type Rep ChannelFlowCallbackResponse

Defined in Amazonka.ChimeSDKMessaging.ChannelFlowCallback

type Rep ChannelFlowCallbackResponse = D1 ('MetaData "ChannelFlowCallbackResponse" "Amazonka.ChimeSDKMessaging.ChannelFlowCallback" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" '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

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:

ChannelFlowCallback, channelFlowCallbackResponse_callbackId - The call back ID passed in the request.

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)

The call back ID passed in the request.

channelFlowCallbackResponse_channelArn :: Lens' ChannelFlowCallbackResponse (Maybe Text)

The ARN of the channel.

channelFlowCallbackResponse_httpStatus :: Lens' ChannelFlowCallbackResponse Int

The response's http status code.