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.Connect.CreateRule

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a rule for the specified Amazon Connect instance.

Use the Rules Function language to code conditions for the rule.

Synopsis

data CreateRule = CreateRule' {
- clientToken :: Maybe Text
- instanceId :: Text
- name :: Text
- triggerEventSource :: RuleTriggerEventSource
- function :: Text
- actions :: [RuleAction]
- publishStatus :: RulePublishStatus
}
newCreateRule :: Text -> Text -> RuleTriggerEventSource -> Text -> RulePublishStatus -> CreateRule
createRule_clientToken :: Lens' CreateRule (Maybe Text)
createRule_instanceId :: Lens' CreateRule Text
createRule_name :: Lens' CreateRule Text
createRule_triggerEventSource :: Lens' CreateRule RuleTriggerEventSource
createRule_function :: Lens' CreateRule Text
createRule_actions :: Lens' CreateRule [RuleAction]
createRule_publishStatus :: Lens' CreateRule RulePublishStatus
data CreateRuleResponse = CreateRuleResponse' {
- httpStatus :: Int
- ruleArn :: Text
- ruleId :: Text
}
newCreateRuleResponse :: Int -> Text -> Text -> CreateRuleResponse
createRuleResponse_httpStatus :: Lens' CreateRuleResponse Int
createRuleResponse_ruleArn :: Lens' CreateRuleResponse Text
createRuleResponse_ruleId :: Lens' CreateRuleResponse Text

Creating a Request

data CreateRule Source #

See: newCreateRule smart constructor.

Constructors

CreateRule'

Fields

clientToken :: Maybe Text
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
instanceId :: Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
name :: Text
A unique name for the rule.
triggerEventSource :: RuleTriggerEventSource
The event source to trigger the rule.
function :: Text
The conditions of the rule.
actions :: [RuleAction]
A list of actions to be run when the rule is triggered.
publishStatus :: RulePublishStatus
The publish status of the rule.

Instances

Instances details

ToJSON CreateRule Source #
Instance details Defined in Amazonka.Connect.CreateRule Methods toJSON :: CreateRule -> Value # toEncoding :: CreateRule -> Encoding # toJSONList :: [CreateRule] -> Value # toEncodingList :: [CreateRule] -> Encoding #
ToHeaders CreateRule Source #
Instance details Defined in Amazonka.Connect.CreateRule Methods toHeaders :: CreateRule -> [Header] #
ToPath CreateRule Source #
Instance details Defined in Amazonka.Connect.CreateRule Methods toPath :: CreateRule -> ByteString #
ToQuery CreateRule Source #
Instance details Defined in Amazonka.Connect.CreateRule Methods toQuery :: CreateRule -> QueryString #
AWSRequest CreateRule Source #
Instance details Defined in Amazonka.Connect.CreateRule Associated Types type AWSResponse CreateRule # Methods request :: (Service -> Service) -> CreateRule -> Request CreateRule # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateRule -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateRule))) #
Generic CreateRule Source #
Instance details Defined in Amazonka.Connect.CreateRule Associated Types type Rep CreateRule :: Type -> Type # Methods from :: CreateRule -> Rep CreateRule x # to :: Rep CreateRule x -> CreateRule #
Read CreateRule Source #
Instance details Defined in Amazonka.Connect.CreateRule Methods readsPrec :: Int -> ReadS CreateRule # readList :: ReadS [CreateRule] # readPrec :: ReadPrec CreateRule # readListPrec :: ReadPrec [CreateRule] #
Show CreateRule Source #
Instance details Defined in Amazonka.Connect.CreateRule Methods showsPrec :: Int -> CreateRule -> ShowS # show :: CreateRule -> String # showList :: [CreateRule] -> ShowS #
NFData CreateRule Source #
Instance details Defined in Amazonka.Connect.CreateRule Methods rnf :: CreateRule -> () #
Eq CreateRule Source #
Instance details Defined in Amazonka.Connect.CreateRule Methods (==) :: CreateRule -> CreateRule -> Bool # (/=) :: CreateRule -> CreateRule -> Bool #
Hashable CreateRule Source #
Instance details Defined in Amazonka.Connect.CreateRule Methods hashWithSalt :: Int -> CreateRule -> Int # hash :: CreateRule -> Int #
type AWSResponse CreateRule Source #
Instance details Defined in Amazonka.Connect.CreateRule type AWSResponse CreateRule = CreateRuleResponse
type Rep CreateRule Source #
Instance details Defined in Amazonka.Connect.CreateRule type Rep CreateRule = D1 ('MetaData "CreateRule" "Amazonka.Connect.CreateRule" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "CreateRule'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "triggerEventSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RuleTriggerEventSource) :: S1 ('MetaSel ('Just "function") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "actions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [RuleAction]) :: S1 ('MetaSel ('Just "publishStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RulePublishStatus)))))

newCreateRule Source #

Arguments

:: Text	`CreateRule`
-> Text	`CreateRule`
-> RuleTriggerEventSource	`CreateRule`
-> Text	`CreateRule`
-> RulePublishStatus	`CreateRule`
-> CreateRule

Create a value of CreateRule 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:clientToken:CreateRule', createRule_clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

CreateRule, createRule_instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

CreateRule, createRule_name - A unique name for the rule.

CreateRule, createRule_triggerEventSource - The event source to trigger the rule.

CreateRule, createRule_function - The conditions of the rule.

CreateRule, createRule_actions - A list of actions to be run when the rule is triggered.

CreateRule, createRule_publishStatus - The publish status of the rule.

Request Lenses

createRule_clientToken :: Lens' CreateRule (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

createRule_instanceId :: Lens' CreateRule Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

createRule_name :: Lens' CreateRule Text Source #

A unique name for the rule.

createRule_triggerEventSource :: Lens' CreateRule RuleTriggerEventSource Source #

The event source to trigger the rule.

createRule_function :: Lens' CreateRule Text Source #

The conditions of the rule.

createRule_actions :: Lens' CreateRule [RuleAction] Source #

A list of actions to be run when the rule is triggered.

createRule_publishStatus :: Lens' CreateRule RulePublishStatus Source #

The publish status of the rule.

Destructuring the Response

data CreateRuleResponse Source #

See: newCreateRuleResponse smart constructor.

Constructors

CreateRuleResponse'
Fields httpStatus :: Int The response's http status code. ruleArn :: Text The Amazon Resource Name (ARN) of the rule. ruleId :: Text A unique identifier for the rule.

Instances

Instances details

Generic CreateRuleResponse Source #
Instance details Defined in Amazonka.Connect.CreateRule Associated Types type Rep CreateRuleResponse :: Type -> Type # Methods from :: CreateRuleResponse -> Rep CreateRuleResponse x # to :: Rep CreateRuleResponse x -> CreateRuleResponse #
Read CreateRuleResponse Source #
Instance details Defined in Amazonka.Connect.CreateRule Methods readsPrec :: Int -> ReadS CreateRuleResponse # readList :: ReadS [CreateRuleResponse] # readPrec :: ReadPrec CreateRuleResponse # readListPrec :: ReadPrec [CreateRuleResponse] #
Show CreateRuleResponse Source #
Instance details Defined in Amazonka.Connect.CreateRule Methods showsPrec :: Int -> CreateRuleResponse -> ShowS # show :: CreateRuleResponse -> String # showList :: [CreateRuleResponse] -> ShowS #
NFData CreateRuleResponse Source #
Instance details Defined in Amazonka.Connect.CreateRule Methods rnf :: CreateRuleResponse -> () #
Eq CreateRuleResponse Source #
Instance details Defined in Amazonka.Connect.CreateRule Methods (==) :: CreateRuleResponse -> CreateRuleResponse -> Bool # (/=) :: CreateRuleResponse -> CreateRuleResponse -> Bool #
type Rep CreateRuleResponse Source #
Instance details Defined in Amazonka.Connect.CreateRule type Rep CreateRuleResponse = D1 ('MetaData "CreateRuleResponse" "Amazonka.Connect.CreateRule" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "CreateRuleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "ruleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "ruleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateRuleResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateRuleResponse'`
-> Text	`CreateRuleResponse`
-> Text	`CreateRuleResponse`
-> CreateRuleResponse

Create a value of CreateRuleResponse 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:httpStatus:CreateRuleResponse', createRuleResponse_httpStatus - The response's http status code.

CreateRuleResponse, createRuleResponse_ruleArn - The Amazon Resource Name (ARN) of the rule.

CreateRuleResponse, createRuleResponse_ruleId - A unique identifier for the rule.

Response Lenses

createRuleResponse_httpStatus :: Lens' CreateRuleResponse Int Source #

The response's http status code.

createRuleResponse_ruleArn :: Lens' CreateRuleResponse Text Source #

The Amazon Resource Name (ARN) of the rule.

createRuleResponse_ruleId :: Lens' CreateRuleResponse Text Source #

A unique identifier for the rule.