/AWS1/CL_CNTRULESEARCHSUMMARY¶
A summary of information about a rule, returned as part of the response to a SearchRules
operation.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_name TYPE /AWS1/CNTRULENAME /AWS1/CNTRULENAME¶
The name of the rule.
iv_ruleid TYPE /AWS1/CNTRULEID /AWS1/CNTRULEID¶
A unique identifier for the rule.
iv_rulearn TYPE /AWS1/CNTARN /AWS1/CNTARN¶
The Amazon Resource Name (ARN) of the rule.
io_triggereventsource TYPE REF TO /AWS1/CL_CNTRULETRIGGEREVSRC /AWS1/CL_CNTRULETRIGGEREVSRC¶
The event source to trigger the rule.
it_actionsummaries TYPE /AWS1/CL_CNTACTIONSUMMARY=>TT_ACTIONSUMMARIES TT_ACTIONSUMMARIES¶
A list of
ActionTypesassociated with a rule.
iv_publishstatus TYPE /AWS1/CNTRULEPUBLISHSTATUS /AWS1/CNTRULEPUBLISHSTATUS¶
The publish status of the rule.
iv_createdtime TYPE /AWS1/CNTTIMESTAMP /AWS1/CNTTIMESTAMP¶
The timestamp for when the rule was created.
iv_lastupdatedtime TYPE /AWS1/CNTTIMESTAMP /AWS1/CNTTIMESTAMP¶
The timestamp for when the rule was last updated.
iv_lastupdatedby TYPE /AWS1/CNTARN /AWS1/CNTARN¶
The Amazon Resource Name (ARN) of the user who last updated the rule.
Optional arguments:¶
it_rulecapabilitytiers TYPE /AWS1/CL_CNTRULECAPABTIERS_W=>TT_RULECAPABILITYTIERS TT_RULECAPABILITYTIERS¶
The list of capability tiers associated with the rule. Used for categorizing rules by capability (for example,
GenerativeAI).
it_tags TYPE /AWS1/CL_CNTTAGMAP_W=>TT_TAGMAP TT_TAGMAP¶
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Queryable Attributes¶
Name¶
The name of the rule.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
RuleId¶
A unique identifier for the rule.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RULEID() |
Getter for RULEID, with configurable default |
ASK_RULEID() |
Getter for RULEID w/ exceptions if field has no value |
HAS_RULEID() |
Determine if RULEID has a value |
RuleArn¶
The Amazon Resource Name (ARN) of the rule.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RULEARN() |
Getter for RULEARN, with configurable default |
ASK_RULEARN() |
Getter for RULEARN w/ exceptions if field has no value |
HAS_RULEARN() |
Determine if RULEARN has a value |
TriggerEventSource¶
The event source to trigger the rule.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TRIGGEREVENTSOURCE() |
Getter for TRIGGEREVENTSOURCE |
ActionSummaries¶
A list of
ActionTypesassociated with a rule.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ACTIONSUMMARIES() |
Getter for ACTIONSUMMARIES, with configurable default |
ASK_ACTIONSUMMARIES() |
Getter for ACTIONSUMMARIES w/ exceptions if field has no val |
HAS_ACTIONSUMMARIES() |
Determine if ACTIONSUMMARIES has a value |
RuleCapabilityTiers¶
The list of capability tiers associated with the rule. Used for categorizing rules by capability (for example,
GenerativeAI).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RULECAPABILITYTIERS() |
Getter for RULECAPABILITYTIERS, with configurable default |
ASK_RULECAPABILITYTIERS() |
Getter for RULECAPABILITYTIERS w/ exceptions if field has no |
HAS_RULECAPABILITYTIERS() |
Determine if RULECAPABILITYTIERS has a value |
PublishStatus¶
The publish status of the rule.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PUBLISHSTATUS() |
Getter for PUBLISHSTATUS, with configurable default |
ASK_PUBLISHSTATUS() |
Getter for PUBLISHSTATUS w/ exceptions if field has no value |
HAS_PUBLISHSTATUS() |
Determine if PUBLISHSTATUS has a value |
CreatedTime¶
The timestamp for when the rule was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDTIME() |
Getter for CREATEDTIME, with configurable default |
ASK_CREATEDTIME() |
Getter for CREATEDTIME w/ exceptions if field has no value |
HAS_CREATEDTIME() |
Determine if CREATEDTIME has a value |
LastUpdatedTime¶
The timestamp for when the rule was last updated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTUPDATEDTIME() |
Getter for LASTUPDATEDTIME, with configurable default |
ASK_LASTUPDATEDTIME() |
Getter for LASTUPDATEDTIME w/ exceptions if field has no val |
HAS_LASTUPDATEDTIME() |
Determine if LASTUPDATEDTIME has a value |
LastUpdatedBy¶
The Amazon Resource Name (ARN) of the user who last updated the rule.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTUPDATEDBY() |
Getter for LASTUPDATEDBY, with configurable default |
ASK_LASTUPDATEDBY() |
Getter for LASTUPDATEDBY w/ exceptions if field has no value |
HAS_LASTUPDATEDBY() |
Determine if LASTUPDATEDBY has a value |
Tags¶
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAGS() |
Getter for TAGS, with configurable default |
ASK_TAGS() |
Getter for TAGS w/ exceptions if field has no value |
HAS_TAGS() |
Determine if TAGS has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_RULESEARCHSUMMARYLIST¶
TYPES TT_RULESEARCHSUMMARYLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_CNTRULESEARCHSUMMARY WITH DEFAULT KEY
.