Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ChimeSDKMessaging.CreateChannelFlow

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors in the channel flow then take action on all messages sent to that channel. This is a developer API.

Channel flows process the following items:

New and updated messages
Persistent and non-persistent messages
The Standard message type

Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK Messaging, refer to Message types in the Amazon Chime developer guide.

Synopsis

data CreateChannelFlow = CreateChannelFlow' {
- tags :: Maybe (NonEmpty Tag)
- appInstanceArn :: Text
- processors :: NonEmpty Processor
- name :: Sensitive Text
- clientRequestToken :: Sensitive Text
}
newCreateChannelFlow :: Text -> NonEmpty Processor -> Text -> Text -> CreateChannelFlow
createChannelFlow_tags :: Lens' CreateChannelFlow (Maybe (NonEmpty Tag))
createChannelFlow_appInstanceArn :: Lens' CreateChannelFlow Text
createChannelFlow_processors :: Lens' CreateChannelFlow (NonEmpty Processor)
createChannelFlow_name :: Lens' CreateChannelFlow Text
createChannelFlow_clientRequestToken :: Lens' CreateChannelFlow Text
data CreateChannelFlowResponse = CreateChannelFlowResponse' {
- channelFlowArn :: Maybe Text
- httpStatus :: Int
}
newCreateChannelFlowResponse :: Int -> CreateChannelFlowResponse
createChannelFlowResponse_channelFlowArn :: Lens' CreateChannelFlowResponse (Maybe Text)
createChannelFlowResponse_httpStatus :: Lens' CreateChannelFlowResponse Int

Creating a Request

data CreateChannelFlow Source #

See: newCreateChannelFlow smart constructor.

Constructors

CreateChannelFlow'
Fields tags :: Maybe (NonEmpty Tag) The tags for the creation request. appInstanceArn :: Text The ARN of the channel flow request. processors :: NonEmpty Processor Information about the processor Lambda functions. name :: Sensitive Text The name of the channel flow. clientRequestToken :: Sensitive Text The client token for the request. An Idempotency token.

Instances

Instances details

ToJSON CreateChannelFlow Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.CreateChannelFlow Methods toJSON :: CreateChannelFlow -> Value # toEncoding :: CreateChannelFlow -> Encoding # toJSONList :: [CreateChannelFlow] -> Value # toEncodingList :: [CreateChannelFlow] -> Encoding #
ToHeaders CreateChannelFlow Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.CreateChannelFlow Methods toHeaders :: CreateChannelFlow -> [Header] #
ToPath CreateChannelFlow Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.CreateChannelFlow Methods toPath :: CreateChannelFlow -> ByteString #
ToQuery CreateChannelFlow Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.CreateChannelFlow Methods toQuery :: CreateChannelFlow -> QueryString #
AWSRequest CreateChannelFlow Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.CreateChannelFlow Associated Types type AWSResponse CreateChannelFlow # Methods request :: (Service -> Service) -> CreateChannelFlow -> Request CreateChannelFlow # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateChannelFlow -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateChannelFlow))) #
Generic CreateChannelFlow Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.CreateChannelFlow Associated Types type Rep CreateChannelFlow :: Type -> Type # Methods from :: CreateChannelFlow -> Rep CreateChannelFlow x # to :: Rep CreateChannelFlow x -> CreateChannelFlow #
Show CreateChannelFlow Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.CreateChannelFlow Methods showsPrec :: Int -> CreateChannelFlow -> ShowS # show :: CreateChannelFlow -> String # showList :: [CreateChannelFlow] -> ShowS #
NFData CreateChannelFlow Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.CreateChannelFlow Methods rnf :: CreateChannelFlow -> () #
Eq CreateChannelFlow Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.CreateChannelFlow Methods (==) :: CreateChannelFlow -> CreateChannelFlow -> Bool # (/=) :: CreateChannelFlow -> CreateChannelFlow -> Bool #
Hashable CreateChannelFlow Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.CreateChannelFlow Methods hashWithSalt :: Int -> CreateChannelFlow -> Int # hash :: CreateChannelFlow -> Int #
type AWSResponse CreateChannelFlow Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.CreateChannelFlow type AWSResponse CreateChannelFlow = CreateChannelFlowResponse
type Rep CreateChannelFlow Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.CreateChannelFlow type Rep CreateChannelFlow = D1 ('MetaData "CreateChannelFlow" "Amazonka.ChimeSDKMessaging.CreateChannelFlow" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "CreateChannelFlow'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :: S1 ('MetaSel ('Just "appInstanceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "processors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Processor)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))))

newCreateChannelFlow Source #

Arguments

:: Text	`$sel:appInstanceArn:CreateChannelFlow'`
-> NonEmpty Processor	`CreateChannelFlow`
-> Text	`CreateChannelFlow`
-> Text	`$sel:clientRequestToken:CreateChannelFlow'`
-> CreateChannelFlow

Create a value of CreateChannelFlow 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:tags:CreateChannelFlow', createChannelFlow_tags - The tags for the creation request.

$sel:appInstanceArn:CreateChannelFlow', createChannelFlow_appInstanceArn - The ARN of the channel flow request.

CreateChannelFlow, createChannelFlow_processors - Information about the processor Lambda functions.

CreateChannelFlow, createChannelFlow_name - The name of the channel flow.

$sel:clientRequestToken:CreateChannelFlow', createChannelFlow_clientRequestToken - The client token for the request. An Idempotency token.

Request Lenses

createChannelFlow_tags :: Lens' CreateChannelFlow (Maybe (NonEmpty Tag)) Source #

The tags for the creation request.

createChannelFlow_appInstanceArn :: Lens' CreateChannelFlow Text Source #

The ARN of the channel flow request.

createChannelFlow_processors :: Lens' CreateChannelFlow (NonEmpty Processor) Source #

Information about the processor Lambda functions.

createChannelFlow_name :: Lens' CreateChannelFlow Text Source #

The name of the channel flow.

createChannelFlow_clientRequestToken :: Lens' CreateChannelFlow Text Source #

The client token for the request. An Idempotency token.

Destructuring the Response

data CreateChannelFlowResponse Source #

See: newCreateChannelFlowResponse smart constructor.

Constructors

CreateChannelFlowResponse'
Fields channelFlowArn :: Maybe Text The ARN of the channel flow. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateChannelFlowResponse Source #

Arguments

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

Create a value of CreateChannelFlowResponse 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:

CreateChannelFlowResponse, createChannelFlowResponse_channelFlowArn - The ARN of the channel flow.

$sel:httpStatus:CreateChannelFlowResponse', createChannelFlowResponse_httpStatus - The response's http status code.

Response Lenses

createChannelFlowResponse_channelFlowArn :: Lens' CreateChannelFlowResponse (Maybe Text) Source #

The ARN of the channel flow.

createChannelFlowResponse_httpStatus :: Lens' CreateChannelFlowResponse Int Source #

The response's http status code.