/AWS1/CL_KNDDESCREXPERIENCERSP

DescribeExperienceResponse

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_id TYPE /AWS1/KNDEXPERIENCEID /AWS1/KNDEXPERIENCEID

Shows the identifier of your Amazon Kendra experience.

iv_indexid TYPE /AWS1/KNDINDEXID /AWS1/KNDINDEXID

Shows the identifier of the index for your Amazon Kendra experience.

iv_name TYPE /AWS1/KNDEXPERIENCENAME /AWS1/KNDEXPERIENCENAME

Shows the name of your Amazon Kendra experience.

it_endpoints TYPE /AWS1/CL_KNDEXPERIENCEENDPOINT=>TT_EXPERIENCEENDPOINTS TT_EXPERIENCEENDPOINTS

Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.

io_configuration TYPE REF TO /AWS1/CL_KNDEXPERIENCECONF /AWS1/CL_KNDEXPERIENCECONF

Shows the configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.

iv_createdat TYPE /AWS1/KNDTIMESTAMP /AWS1/KNDTIMESTAMP

The Unix timestamp when your Amazon Kendra experience was created.

iv_updatedat TYPE /AWS1/KNDTIMESTAMP /AWS1/KNDTIMESTAMP

The Unix timestamp when your Amazon Kendra experience was last updated.

iv_description TYPE /AWS1/KNDDESCRIPTION /AWS1/KNDDESCRIPTION

Shows the description for your Amazon Kendra experience.

iv_status TYPE /AWS1/KNDEXPERIENCESTATUS /AWS1/KNDEXPERIENCESTATUS

The current processing status of your Amazon Kendra experience. When the status is ACTIVE, your Amazon Kendra experience is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that this failed.

iv_rolearn TYPE /AWS1/KNDROLEARN /AWS1/KNDROLEARN

The Amazon Resource Name (ARN) of the IAM role with permission to access the Query API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that stores your users and groups information.

iv_errormessage TYPE /AWS1/KNDERRORMESSAGE /AWS1/KNDERRORMESSAGE

The reason your Amazon Kendra experience could not properly process.

---

Queryable Attributes

Id

Shows the identifier of your Amazon Kendra experience.

Accessible with the following methods

Method	Description
GET_ID()	Getter for ID, with configurable default
ASK_ID()	Getter for ID w/ exceptions if field has no value
HAS_ID()	Determine if ID has a value

IndexId

Shows the identifier of the index for your Amazon Kendra experience.

Accessible with the following methods

Method	Description
GET_INDEXID()	Getter for INDEXID, with configurable default
ASK_INDEXID()	Getter for INDEXID w/ exceptions if field has no value
HAS_INDEXID()	Determine if INDEXID has a value

Name

Shows the name of your Amazon Kendra experience.

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

Endpoints

Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.

Accessible with the following methods

Method	Description
GET_ENDPOINTS()	Getter for ENDPOINTS, with configurable default
ASK_ENDPOINTS()	Getter for ENDPOINTS w/ exceptions if field has no value
HAS_ENDPOINTS()	Determine if ENDPOINTS has a value

Configuration

Shows the configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.

Accessible with the following methods

Method	Description
GET_CONFIGURATION()	Getter for CONFIGURATION

CreatedAt

The Unix timestamp when your Amazon Kendra experience 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 Unix timestamp when your Amazon Kendra experience was last 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

Description

Shows the description for your Amazon Kendra experience.

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

Status

The current processing status of your Amazon Kendra experience. When the status is ACTIVE, your Amazon Kendra experience is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that this failed.

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

RoleArn

The Amazon Resource Name (ARN) of the IAM role with permission to access the Query API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that stores your users and groups information.

Accessible with the following methods

Method	Description
GET_ROLEARN()	Getter for ROLEARN, with configurable default
ASK_ROLEARN()	Getter for ROLEARN w/ exceptions if field has no value
HAS_ROLEARN()	Determine if ROLEARN has a value

ErrorMessage

The reason your Amazon Kendra experience could not properly process.

Accessible with the following methods

Method	Description
GET_ERRORMESSAGE()	Getter for ERRORMESSAGE, with configurable default
ASK_ERRORMESSAGE()	Getter for ERRORMESSAGE w/ exceptions if field has no value
HAS_ERRORMESSAGE()	Determine if ERRORMESSAGE has a value