Skip to main content

rule

Gets an individual rule resource

Overview

Namerule
TypeResource
Descriptionrule
Idawscc.connect.rule

Fields

NameDatatypeDescription
namestringThe name of the rule.
rule_arnstringThe Amazon Resource Name (ARN) of the rule.
instance_arnstringThe Amazon Resource Name (ARN) of the instance.
trigger_event_sourceobjectThe event source that triggers the rule.
functionstringThe conditions of a rule.
actionsobjectThe list of actions that will be executed when a rule is triggered.
publish_statusstringThe publish status of a rule, either draft or published.
tagsarrayOne or more tags.
regionstringAWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
name,
rule_arn,
instance_arn,
trigger_event_source,
function,
actions,
publish_status,
tags
FROM awscc.connect.rule
WHERE data__Identifier = '<RuleArn>';

Permissions

To operate on the rule resource, the following permissions are required:

Read

connect:DescribeRule

Delete

connect:DeleteRule,
connect:UntagResource

Update

connect:UpdateRule,
cases:GetTemplate,
cases:ListFields,
cases:ListFieldOptions,
connect:TagResource,
connect:UntagResource