/AWS1/CL_BDOPOLICYENGINE¶
Represents a policy engine resource within the AgentCore Policy system. Policy engines serve as containers for grouping related policies and provide the execution context for policy evaluation and management. Each policy engine can be associated with one Gateway (one engine per Gateway), where it intercepts all agent tool calls and evaluates them against the contained policies before allowing tools to execute. The policy engine maintains the Cedar schema generated from the Gateway's tool manifest, ensuring that policies are validated against the actual tools and parameters available. Policy engines support two enforcement modes that can be configured when associating with a Gateway: log-only mode for testing (evaluates decisions without blocking) and enforce mode for production (actively allows or denies based on policy evaluation).
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_policyengineid TYPE /AWS1/BDORESOURCEID /AWS1/BDORESOURCEID¶
The unique identifier for the policy engine. This system-generated identifier consists of the user name plus a 10-character generated suffix and serves as the primary key for policy engine operations.
iv_name TYPE /AWS1/BDOPOLICYENGINENAME /AWS1/BDOPOLICYENGINENAME¶
The customer-assigned immutable name for the policy engine. This human-readable identifier must be unique within the account and cannot exceed 48 characters.
iv_createdat TYPE /AWS1/BDODATETIMESTAMP /AWS1/BDODATETIMESTAMP¶
The timestamp when the policy engine was originally created. This is automatically set by the service and used for auditing and lifecycle management.
iv_updatedat TYPE /AWS1/BDODATETIMESTAMP /AWS1/BDODATETIMESTAMP¶
The timestamp when the policy engine was last modified. This tracks the most recent changes to the policy engine configuration or metadata.
iv_policyenginearn TYPE /AWS1/BDOPOLICYENGINEARN /AWS1/BDOPOLICYENGINEARN¶
The Amazon Resource Name (ARN) of the policy engine. This globally unique identifier can be used for cross-service references and IAM policy statements.
iv_status TYPE /AWS1/BDOPOLICYENGINESTATUS /AWS1/BDOPOLICYENGINESTATUS¶
The current status of the policy engine.
it_statusreasons TYPE /AWS1/CL_BDOPLYSTATUSREASONS_W=>TT_POLICYSTATUSREASONS TT_POLICYSTATUSREASONS¶
Additional information about the policy engine status. This provides details about any failures or the current state of the policy engine lifecycle.
Optional arguments:¶
iv_description TYPE /AWS1/BDODESCRIPTION /AWS1/BDODESCRIPTION¶
A human-readable description of the policy engine's purpose and scope. Limited to 4,096 characters, this helps administrators understand the policy engine's role in the overall governance strategy.
Queryable Attributes¶
policyEngineId¶
The unique identifier for the policy engine. This system-generated identifier consists of the user name plus a 10-character generated suffix and serves as the primary key for policy engine operations.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_POLICYENGINEID() |
Getter for POLICYENGINEID, with configurable default |
ASK_POLICYENGINEID() |
Getter for POLICYENGINEID w/ exceptions if field has no valu |
HAS_POLICYENGINEID() |
Determine if POLICYENGINEID has a value |
name¶
The customer-assigned immutable name for the policy engine. This human-readable identifier must be unique within the account and cannot exceed 48 characters.
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 |
description¶
A human-readable description of the policy engine's purpose and scope. Limited to 4,096 characters, this helps administrators understand the policy engine's role in the overall governance strategy.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
createdAt¶
The timestamp when the policy engine was originally created. This is automatically set by the service and used for auditing and lifecycle management.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDAT() |
Getter for CREATEDAT, with configurable default |
ASK_CREATEDAT() |
Getter for CREATEDAT w/ exceptions if field has no value |
HAS_CREATEDAT() |
Determine if CREATEDAT has a value |
updatedAt¶
The timestamp when the policy engine was last modified. This tracks the most recent changes to the policy engine configuration or metadata.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_UPDATEDAT() |
Getter for UPDATEDAT, with configurable default |
ASK_UPDATEDAT() |
Getter for UPDATEDAT w/ exceptions if field has no value |
HAS_UPDATEDAT() |
Determine if UPDATEDAT has a value |
policyEngineArn¶
The Amazon Resource Name (ARN) of the policy engine. This globally unique identifier can be used for cross-service references and IAM policy statements.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_POLICYENGINEARN() |
Getter for POLICYENGINEARN, with configurable default |
ASK_POLICYENGINEARN() |
Getter for POLICYENGINEARN w/ exceptions if field has no val |
HAS_POLICYENGINEARN() |
Determine if POLICYENGINEARN has a value |
status¶
The current status of the policy engine.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
statusReasons¶
Additional information about the policy engine status. This provides details about any failures or the current state of the policy engine lifecycle.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUSREASONS() |
Getter for STATUSREASONS, with configurable default |
ASK_STATUSREASONS() |
Getter for STATUSREASONS w/ exceptions if field has no value |
HAS_STATUSREASONS() |
Determine if STATUSREASONS 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_POLICYENGINES¶
TYPES TT_POLICYENGINES TYPE STANDARD TABLE OF REF TO /AWS1/CL_BDOPOLICYENGINE WITH DEFAULT KEY
.