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 |
Creates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
Synopsis
- data CreateRule = CreateRule' {}
- 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' {}
- 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.
CreateRule' | |
|
Instances
:: Text | |
-> Text | |
-> RuleTriggerEventSource | |
-> Text | |
-> RulePublishStatus | |
-> 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.
Instances
newCreateRuleResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> 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.