Class: Aws::Connect::Types::Rule

Inherits:

Struct

• Object
• Struct
• Aws::Connect::Types::Rule

Defined in:

gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb

Overview

Information about a rule.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #actions ⇒ Array<Types::RuleAction>

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

• #created_time ⇒ Time

  The timestamp for when the rule was created.

• #function ⇒ String

  The conditions of the rule.

• #last_updated_by ⇒ String

  The Amazon Resource Name (ARN) of the user who last updated the rule.

• #last_updated_time ⇒ Time

  The timestamp for the when the rule was last updated.

• #name ⇒ String

  The name of the rule.

• #pre_evaluation_filters ⇒ Types::PreEvaluationFilters

  The pre-evaluation filters for the rule, that restrict the rule to be applied to only certain resources based on the resource's attributes, such as tags assigned to a contact.

• #publish_status ⇒ String

  The publish status of the rule.

• #rule_arn ⇒ String

  The Amazon Resource Name (ARN) of the rule.

• #rule_capability_tiers ⇒ Array<String>

  The list of capability tiers associated with the rule.

• #rule_id ⇒ String

  A unique identifier for the rule.

• #tags ⇒ Hash<String,String>

  The tags used to organize, track, or control access for this resource.

• #trigger_event_source ⇒ Types::RuleTriggerEventSource

  The event source to trigger the rule.

Instance Attribute Details

#actions ⇒ Array<Types::RuleAction>

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

Returns:

• (Array<Types::RuleAction>)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 30845

class Rule < Struct.new(
  :name,
  :rule_id,
  :rule_arn,
  :trigger_event_source,
  :rule_capability_tiers,
  :function,
  :actions,
  :publish_status,
  :pre_evaluation_filters,
  :created_time,
  :last_updated_time,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#created_time ⇒ Time

The timestamp for when the rule was created.

Returns:

• (Time)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 30845

class Rule < Struct.new(
  :name,
  :rule_id,
  :rule_arn,
  :trigger_event_source,
  :rule_capability_tiers,
  :function,
  :actions,
  :publish_status,
  :pre_evaluation_filters,
  :created_time,
  :last_updated_time,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#function ⇒ String

The conditions of the rule.

Returns:

• (String)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 30845

class Rule < Struct.new(
  :name,
  :rule_id,
  :rule_arn,
  :trigger_event_source,
  :rule_capability_tiers,
  :function,
  :actions,
  :publish_status,
  :pre_evaluation_filters,
  :created_time,
  :last_updated_time,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_by ⇒ String

The Amazon Resource Name (ARN) of the user who last updated the rule.

Returns:

• (String)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 30845

class Rule < Struct.new(
  :name,
  :rule_id,
  :rule_arn,
  :trigger_event_source,
  :rule_capability_tiers,
  :function,
  :actions,
  :publish_status,
  :pre_evaluation_filters,
  :created_time,
  :last_updated_time,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_time ⇒ Time

The timestamp for the when the rule was last updated.

Returns:

• (Time)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 30845

class Rule < Struct.new(
  :name,
  :rule_id,
  :rule_arn,
  :trigger_event_source,
  :rule_capability_tiers,
  :function,
  :actions,
  :publish_status,
  :pre_evaluation_filters,
  :created_time,
  :last_updated_time,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the rule.

Returns:

• (String)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 30845

class Rule < Struct.new(
  :name,
  :rule_id,
  :rule_arn,
  :trigger_event_source,
  :rule_capability_tiers,
  :function,
  :actions,
  :publish_status,
  :pre_evaluation_filters,
  :created_time,
  :last_updated_time,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#pre_evaluation_filters ⇒ Types::PreEvaluationFilters

The pre-evaluation filters for the rule, that restrict the rule to be applied to only certain resources based on the resource's attributes, such as tags assigned to a contact. The pre-evaluation filters are applied even before rule conditions are evaluated and are used to enforce tag-based-access-control while applying rules.

Returns:

• (Types::PreEvaluationFilters)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 30845

class Rule < Struct.new(
  :name,
  :rule_id,
  :rule_arn,
  :trigger_event_source,
  :rule_capability_tiers,
  :function,
  :actions,
  :publish_status,
  :pre_evaluation_filters,
  :created_time,
  :last_updated_time,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#publish_status ⇒ String

The publish status of the rule.

Returns:

• (String)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 30845

class Rule < Struct.new(
  :name,
  :rule_id,
  :rule_arn,
  :trigger_event_source,
  :rule_capability_tiers,
  :function,
  :actions,
  :publish_status,
  :pre_evaluation_filters,
  :created_time,
  :last_updated_time,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#rule_arn ⇒ String

The Amazon Resource Name (ARN) of the rule.

Returns:

• (String)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 30845

class Rule < Struct.new(
  :name,
  :rule_id,
  :rule_arn,
  :trigger_event_source,
  :rule_capability_tiers,
  :function,
  :actions,
  :publish_status,
  :pre_evaluation_filters,
  :created_time,
  :last_updated_time,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#rule_capability_tiers ⇒ Array<String>

The list of capability tiers associated with the rule. Used for categorizing rules by capability (for example, GenerativeAI).

Returns:

• (Array<String>)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 30845

class Rule < Struct.new(
  :name,
  :rule_id,
  :rule_arn,
  :trigger_event_source,
  :rule_capability_tiers,
  :function,
  :actions,
  :publish_status,
  :pre_evaluation_filters,
  :created_time,
  :last_updated_time,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#rule_id ⇒ String

A unique identifier for the rule.

Returns:

• (String)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 30845

class Rule < Struct.new(
  :name,
  :rule_id,
  :rule_arn,
  :trigger_event_source,
  :rule_capability_tiers,
  :function,
  :actions,
  :publish_status,
  :pre_evaluation_filters,
  :created_time,
  :last_updated_time,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 30845

class Rule < Struct.new(
  :name,
  :rule_id,
  :rule_arn,
  :trigger_event_source,
  :rule_capability_tiers,
  :function,
  :actions,
  :publish_status,
  :pre_evaluation_filters,
  :created_time,
  :last_updated_time,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#trigger_event_source ⇒ Types::RuleTriggerEventSource

The event source to trigger the rule.

Returns:

• (Types::RuleTriggerEventSource)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 30845

class Rule < Struct.new(
  :name,
  :rule_id,
  :rule_arn,
  :trigger_event_source,
  :rule_capability_tiers,
  :function,
  :actions,
  :publish_status,
  :pre_evaluation_filters,
  :created_time,
  :last_updated_time,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end