aws.connect.describe_rule

Example SQL Queries

SELECT * FROM
aws.connect.describe_rule
WHERE
"instance_id" = 'VALUE'
AND "rule_id" = 'VALUE';

Description

Describes a rule for the specified Amazon Connect instance.

• View All Connect Tables
• Boto3 Reference

Table Definition

Column Name	Column Data Type
instance_id Required Input Column The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.	VARCHAR
rule_id Required Input Column A unique identifier for the rule.	VARCHAR
_aws_profile Input Column The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.	STRUCT( "type" VARCHAR, "name" VARCHAR, "account_id" VARCHAR, "via_profile_name" VARCHAR, "assumed_role_arn" VARCHAR, "organization" STRUCT( "account_name" VARCHAR, "id" VARCHAR, "tags" STRUCT( "key" VARCHAR, "value" VARCHAR )[], "master_account" STRUCT( "id" VARCHAR, "email" VARCHAR ), "parents" STRUCT( "type" VARCHAR, "id" VARCHAR, "name" VARCHAR, "tags" STRUCT( "key" VARCHAR, "value" VARCHAR )[] )[] ) )
Show child fields _aws_profile.account_id The AWS account id _aws_profile.assumed_role_arn The ARN of the assumed role _aws_profile.name The unique name of the profile. _aws_profile.organization Information about this profile's membership in the AWS organization. Show child fields _aws_profile.organization.account_name The name of account speciifed by the organization _aws_profile.organization.id The organization id _aws_profile.organization.master_account Show child fields _aws_profile.organization.master_account.email The organization master account email address _aws_profile.organization.master_account.id The organization master account id _aws_profile.organization.parents[] Show child fields _aws_profile.organization.parents[].id The id of the parent _aws_profile.organization.parents[].name The name of the parent _aws_profile.organization.parents[].tags[] Show child fields _aws_profile.organization.parents[].tags[].key _aws_profile.organization.parents[].tags[].value _aws_profile.organization.parents[].type The type of parent can be an organization unit or a root _aws_profile.organization.tags[] Show child fields _aws_profile.organization.tags[].key _aws_profile.organization.tags[].value _aws_profile.type The type of profile, either 'credentials' or 'assumed_role' _aws_profile.via_profile_name This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
_aws_region Input Column The AWS region to use.	VARCHAR
rule Information about the rule.	STRUCT( "name" VARCHAR, "rule_id" VARCHAR, "rule_arn" VARCHAR, "trigger_event_source" STRUCT( "event_source_name" VARCHAR, "integration_association_id" VARCHAR ), "function" VARCHAR, "actions" STRUCT( "action_type" VARCHAR, "task_action" STRUCT( "name" VARCHAR, "description" VARCHAR, "contact_flow_id" VARCHAR, "references" MAP(VARCHAR, STRUCT( "value" VARCHAR, "type" VARCHAR )) ), "event_bridge_action" STRUCT( "name" VARCHAR ), "assign_contact_category_action" BOOLEAN, "send_notification_action" STRUCT( "delivery_method" VARCHAR, "subject" VARCHAR, "content" VARCHAR, "content_type" VARCHAR, "recipient" STRUCT( "user_tags" MAP(VARCHAR, VARCHAR), "user_ids" VARCHAR[] ) ), "create_case_action" STRUCT( "fields" STRUCT( "id" VARCHAR, "value" STRUCT( "boolean_value" BOOLEAN, "double_value" DOUBLE, "empty_value" BOOLEAN, "string_value" VARCHAR ) )[], "template_id" VARCHAR ), "update_case_action" STRUCT( "fields" STRUCT( "id" VARCHAR, "value" STRUCT( "boolean_value" BOOLEAN, "double_value" DOUBLE, "empty_value" BOOLEAN, "string_value" VARCHAR ) )[] ), "end_associated_tasks_action" BOOLEAN, "submit_auto_evaluation_action" STRUCT( "evaluation_form_id" VARCHAR ) )[], "publish_status" VARCHAR, "created_time" TIMESTAMP_S, "last_updated_time" TIMESTAMP_S, "last_updated_by" VARCHAR, "tags" MAP(VARCHAR, VARCHAR) )
Show child fields rule.actions[] Show child fields rule.actions[].action_type The type of action that creates a rule. rule.actions[].assign_contact_category_action Information about the contact category action. Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate rule.actions[].create_case_action Information about the create case action. Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnPostChatAnalysisAvailable. Show child fields rule.actions[].create_case_action.fields[] Show child fields rule.actions[].create_case_action.fields[].id Unique identifier of a field. rule.actions[].create_case_action.fields[].value Union of potential field value types. Show child fields rule.actions[].create_case_action.fields[].value.boolean_value A Boolean number value type. rule.actions[].create_case_action.fields[].value.double_value A Double number value type. rule.actions[].create_case_action.fields[].value.empty_value An empty value. rule.actions[].create_case_action.fields[].value.string_value String value type. rule.actions[].create_case_action.template_id A unique identifier of a template. rule.actions[].end_associated_tasks_action Information about the end associated tasks action. Supported only for TriggerEventSource values: OnCaseUpdate. rule.actions[].event_bridge_action Information about the EventBridge action. Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate Show child fields rule.actions[].event_bridge_action.name The name. rule.actions[].send_notification_action Information about the send notification action. Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate Show child fields rule.actions[].send_notification_action.content Notification content. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide. rule.actions[].send_notification_action.content_type Content type format. rule.actions[].send_notification_action.delivery_method Notification delivery method. rule.actions[].send_notification_action.recipient Notification recipient. Show child fields rule.actions[].send_notification_action.recipient.user_ids[] rule.actions[].send_notification_action.recipient.user_tags The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. Amazon Connect users with the specified tags will be notified. rule.actions[].send_notification_action.subject The subject of the email if the delivery method is EMAIL. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide. rule.actions[].submit_auto_evaluation_action Information about the submit automated evaluation action. Show child fields rule.actions[].submit_auto_evaluation_action.evaluation_form_id The identifier of the auto-evaluation enabled form. rule.actions[].task_action Information about the task action. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate Show child fields rule.actions[].task_action.contact_flow_id The identifier of the flow. rule.actions[].task_action.description The description. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide. rule.actions[].task_action.name The name. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide. rule.actions[].task_action.references Information about the reference when the referenceType is URL. Otherwise, null. (Supports variable injection in the Value field.) rule.actions[].update_case_action Information about the update case action. Supported only for TriggerEventSource values: OnCaseCreate | OnCaseUpdate. Show child fields rule.actions[].update_case_action.fields[] Show child fields rule.actions[].update_case_action.fields[].id Unique identifier of a field. rule.actions[].update_case_action.fields[].value Union of potential field value types. Show child fields rule.actions[].update_case_action.fields[].value.boolean_value A Boolean number value type. rule.actions[].update_case_action.fields[].value.double_value A Double number value type. rule.actions[].update_case_action.fields[].value.empty_value An empty value. rule.actions[].update_case_action.fields[].value.string_value String value type. rule.created_time The timestamp for when the rule was created. rule.function The conditions of the rule. rule.last_updated_by The Amazon Resource Name (ARN) of the user who last updated the rule. rule.last_updated_time The timestamp for the when the rule was last updated. rule.name The name of the rule. rule.publish_status The publish status of the rule. rule.rule_arn The Amazon Resource Name (ARN) of the rule. rule.rule_id A unique identifier for the rule. rule.tags The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. rule.trigger_event_source The event source to trigger the rule. Show child fields rule.trigger_event_source.event_source_name The name of the event source. rule.trigger_event_source.integration_association_id The identifier for the integration association.

Note

Tables may require input columns to have values specified before the table can return it’s rows. The values for input parameters are set in the where clause of the query typically using = or IN.