/AWS1/CL_BDKGETGUARDRAILRSP

GetGuardrailResponse

CONSTRUCTOR

IMPORTING

Required arguments:

iv_name TYPE /AWS1/BDKGUARDRAILNAME /AWS1/BDKGUARDRAILNAME

The name of the guardrail.

iv_guardrailid TYPE /AWS1/BDKGUARDRAILID /AWS1/BDKGUARDRAILID

The unique identifier of the guardrail.

iv_guardrailarn TYPE /AWS1/BDKGUARDRAILARN /AWS1/BDKGUARDRAILARN

The ARN of the guardrail.

iv_version TYPE /AWS1/BDKGUARDRAILVERSION /AWS1/BDKGUARDRAILVERSION

The version of the guardrail.

iv_status TYPE /AWS1/BDKGUARDRAILSTATUS /AWS1/BDKGUARDRAILSTATUS

The status of the guardrail.

iv_createdat TYPE /AWS1/BDKTIMESTAMP /AWS1/BDKTIMESTAMP

The date and time at which the guardrail was created.

iv_updatedat TYPE /AWS1/BDKTIMESTAMP /AWS1/BDKTIMESTAMP

The date and time at which the guardrail was updated.

iv_blockedinputmessaging TYPE /AWS1/BDKGUARDRAILBLKEDMESSA00 /AWS1/BDKGUARDRAILBLKEDMESSA00

The message that the guardrail returns when it blocks a prompt.

iv_blockedoutputsmessaging TYPE /AWS1/BDKGUARDRAILBLKEDMESSA00 /AWS1/BDKGUARDRAILBLKEDMESSA00

The message that the guardrail returns when it blocks a model response.

Optional arguments:

iv_description TYPE /AWS1/BDKGUARDRAILDESCRIPTION /AWS1/BDKGUARDRAILDESCRIPTION

The description of the guardrail.

io_topicpolicy TYPE REF TO /AWS1/CL_BDKGUARDRAILTOPICPLY /AWS1/CL_BDKGUARDRAILTOPICPLY

The topic policy that was configured for the guardrail.

io_contentpolicy TYPE REF TO /AWS1/CL_BDKGUARDRAILCONTPLY /AWS1/CL_BDKGUARDRAILCONTPLY

The content policy that was configured for the guardrail.

io_wordpolicy TYPE REF TO /AWS1/CL_BDKGUARDRAILWORDPLY /AWS1/CL_BDKGUARDRAILWORDPLY

The word policy that was configured for the guardrail.

io_sensitiveinformationply TYPE REF TO /AWS1/CL_BDKGUARDRAILSENSITI01 /AWS1/CL_BDKGUARDRAILSENSITI01

The sensitive information policy that was configured for the guardrail.

io_contextualgroundingpolicy TYPE REF TO /AWS1/CL_BDKGUARDRAILCTXUALG02 /AWS1/CL_BDKGUARDRAILCTXUALG02

The contextual grounding policy used in the guardrail.

io_automatedreasoningpolicy TYPE REF TO /AWS1/CL_BDKGUARDRAILAUTOMAT01 /AWS1/CL_BDKGUARDRAILAUTOMAT01

The current Automated Reasoning policy configuration for the guardrail, if any is configured.

io_crossregiondetails TYPE REF TO /AWS1/CL_BDKGUARDRAILCROSSRG00 /AWS1/CL_BDKGUARDRAILCROSSRG00

Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).

it_statusreasons TYPE /AWS1/CL_BDKGUARDRAILSTATRSN00=>TT_GUARDRAILSTATUSREASONS TT_GUARDRAILSTATUSREASONS

Appears if the status is FAILED. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.

it_failurerecommendations TYPE /AWS1/CL_BDKGUARDRAILFAILURE00=>TT_GUARDRAILFAILURERECOMMEND00 TT_GUARDRAILFAILURERECOMMEND00

Appears if the status of the guardrail is FAILED. A list of recommendations to carry out before retrying the request.

iv_kmskeyarn TYPE /AWS1/BDKKMSKEYARN /AWS1/BDKKMSKEYARN

The ARN of the KMS key that encrypts the guardrail.

---

Queryable Attributes

name

The name of the guardrail.

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

The description of the guardrail.

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

guardrailId

The unique identifier of the guardrail.

Accessible with the following methods

Method	Description
GET_GUARDRAILID()	Getter for GUARDRAILID, with configurable default
ASK_GUARDRAILID()	Getter for GUARDRAILID w/ exceptions if field has no value
HAS_GUARDRAILID()	Determine if GUARDRAILID has a value

guardrailArn

The ARN of the guardrail.

Accessible with the following methods

Method	Description
GET_GUARDRAILARN()	Getter for GUARDRAILARN, with configurable default
ASK_GUARDRAILARN()	Getter for GUARDRAILARN w/ exceptions if field has no value
HAS_GUARDRAILARN()	Determine if GUARDRAILARN has a value

version

The version of the guardrail.

Accessible with the following methods

Method	Description
GET_VERSION()	Getter for VERSION, with configurable default
ASK_VERSION()	Getter for VERSION w/ exceptions if field has no value
HAS_VERSION()	Determine if VERSION has a value

status

The status of the guardrail.

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

topicPolicy

The topic policy that was configured for the guardrail.

Accessible with the following methods

Method	Description
GET_TOPICPOLICY()	Getter for TOPICPOLICY

contentPolicy

The content policy that was configured for the guardrail.

Accessible with the following methods

Method	Description
GET_CONTENTPOLICY()	Getter for CONTENTPOLICY

wordPolicy

The word policy that was configured for the guardrail.

Accessible with the following methods

Method	Description
GET_WORDPOLICY()	Getter for WORDPOLICY

sensitiveInformationPolicy

The sensitive information policy that was configured for the guardrail.

Accessible with the following methods

Method	Description
GET_SENSITIVEINFORMATIONPLY()	Getter for SENSITIVEINFORMATIONPOLICY

contextualGroundingPolicy

The contextual grounding policy used in the guardrail.

Accessible with the following methods

Method	Description
GET_CTXUALGROUNDINGPOLICY()	Getter for CONTEXTUALGROUNDINGPOLICY

automatedReasoningPolicy

The current Automated Reasoning policy configuration for the guardrail, if any is configured.

Accessible with the following methods

Method	Description
GET_AUTOMATEDREASONINGPOLICY()	Getter for AUTOMATEDREASONINGPOLICY

crossRegionDetails

Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).

Accessible with the following methods

Method	Description
GET_CROSSREGIONDETAILS()	Getter for CROSSREGIONDETAILS

createdAt

The date and time at which the guardrail was created.

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 date and time at which the guardrail was updated.

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

statusReasons

Appears if the status is FAILED. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.

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

failureRecommendations

Appears if the status of the guardrail is FAILED. A list of recommendations to carry out before retrying the request.

Accessible with the following methods

Method	Description
GET_FAILURERECOMMENDATIONS()	Getter for FAILURERECOMMENDATIONS, with configurable default
ASK_FAILURERECOMMENDATIONS()	Getter for FAILURERECOMMENDATIONS w/ exceptions if field has
HAS_FAILURERECOMMENDATIONS()	Determine if FAILURERECOMMENDATIONS has a value

blockedInputMessaging

The message that the guardrail returns when it blocks a prompt.

Accessible with the following methods

Method	Description
GET_BLOCKEDINPUTMESSAGING()	Getter for BLOCKEDINPUTMESSAGING, with configurable default
ASK_BLOCKEDINPUTMESSAGING()	Getter for BLOCKEDINPUTMESSAGING w/ exceptions if field has
HAS_BLOCKEDINPUTMESSAGING()	Determine if BLOCKEDINPUTMESSAGING has a value

blockedOutputsMessaging

The message that the guardrail returns when it blocks a model response.

Accessible with the following methods

Method	Description
GET_BLOCKEDOUTPUTSMESSAGING()	Getter for BLOCKEDOUTPUTSMESSAGING, with configurable defaul
ASK_BLOCKEDOUTPUTSMESSAGING()	Getter for BLOCKEDOUTPUTSMESSAGING w/ exceptions if field ha
HAS_BLOCKEDOUTPUTSMESSAGING()	Determine if BLOCKEDOUTPUTSMESSAGING has a value

kmsKeyArn

The ARN of the KMS key that encrypts the guardrail.

Accessible with the following methods

Method	Description
GET_KMSKEYARN()	Getter for KMSKEYARN, with configurable default
ASK_KMSKEYARN()	Getter for KMSKEYARN w/ exceptions if field has no value
HAS_KMSKEYARN()	Determine if KMSKEYARN has a value