/AWS1/CL_QSTKNOWLEDGEBASE¶
A knowledge base resource that provides data from connected sources for AI-powered experiences in Amazon QuickSight.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_knowledgebasearn TYPE /AWS1/QSTKNOWLEDGEBASEARN /AWS1/QSTKNOWLEDGEBASEARN¶
The Amazon Resource Name (ARN) of the knowledge base.
iv_knowledgebaseid TYPE /AWS1/QSTKNOWLEDGEBASEID /AWS1/QSTKNOWLEDGEBASEID¶
The unique identifier for the knowledge base.
iv_name TYPE /AWS1/QSTKNOWLEDGEBASENAME /AWS1/QSTKNOWLEDGEBASENAME¶
The name of the knowledge base.
iv_status TYPE /AWS1/QSTDATASETSTATUS /AWS1/QSTDATASETSTATUS¶
The status of the knowledge base.
iv_datasourcearn TYPE /AWS1/QSTDATASOURCEARN /AWS1/QSTDATASOURCEARN¶
The ARN of the data source associated with the knowledge base.
io_knowledgebaseconf TYPE REF TO /AWS1/CL_QSTKNOWLEDGEBASECONF /AWS1/CL_QSTKNOWLEDGEBASECONF¶
The configuration settings for the knowledge base.
Optional arguments:¶
io_mediaextractionconf TYPE REF TO /AWS1/CL_QSTMEDIAEXTCONF /AWS1/CL_QSTMEDIAEXTCONF¶
The media extraction configuration for the knowledge base.
iv_type TYPE /AWS1/QSTSTRING00 /AWS1/QSTSTRING00¶
The type of the knowledge base.
iv_createdat TYPE /AWS1/QSTTIMESTAMP00 /AWS1/QSTTIMESTAMP00¶
The date and time that the knowledge base was created.
iv_updatedat TYPE /AWS1/QSTTIMESTAMP00 /AWS1/QSTTIMESTAMP00¶
The date and time that the knowledge base was last updated.
iv_description TYPE /AWS1/QSTKNOWLEDGEBASEDESC /AWS1/QSTKNOWLEDGEBASEDESC¶
The description of the knowledge base.
iv_ismailnotifoptdforingstfl TYPE /AWS1/QSTBOOLEAN /AWS1/QSTBOOLEAN¶
Indicates whether email notifications are enabled for ingestion failures.
io_firstcompltdingestsummary TYPE REF TO /AWS1/CL_QSTKNOWBASEINGSUMMARY /AWS1/CL_QSTKNOWBASEINGSUMMARY¶
A summary of the first completed ingestion for the knowledge base.
io_firstincmplingestsummary TYPE REF TO /AWS1/CL_QSTKNOWBASEINGSUMMARY /AWS1/CL_QSTKNOWBASEINGSUMMARY¶
A summary of the first incomplete ingestion for the knowledge base.
io_latestingestionsummary TYPE REF TO /AWS1/CL_QSTKNOWBASEINGSUMMARY /AWS1/CL_QSTKNOWBASEINGSUMMARY¶
A summary of the most recent ingestion for the knowledge base.
iv_knowledgebasesizebytes TYPE /AWS1/QSTLONG /AWS1/QSTLONG¶
The size of the knowledge base in bytes.
iv_documentcount TYPE /AWS1/QSTLONG /AWS1/QSTLONG¶
The number of documents in the knowledge base.
iv_primaryownerarn TYPE /AWS1/QSTSTRING00 /AWS1/QSTSTRING00¶
The ARN of the primary owner of the knowledge base.
iv_primaryownerusername TYPE /AWS1/QSTSENSITIVESTRING /AWS1/QSTSENSITIVESTRING¶
The username of the primary owner of the knowledge base.
Queryable Attributes¶
KnowledgeBaseArn¶
The Amazon Resource Name (ARN) of the knowledge base.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KNOWLEDGEBASEARN() |
Getter for KNOWLEDGEBASEARN, with configurable default |
ASK_KNOWLEDGEBASEARN() |
Getter for KNOWLEDGEBASEARN w/ exceptions if field has no va |
HAS_KNOWLEDGEBASEARN() |
Determine if KNOWLEDGEBASEARN has a value |
KnowledgeBaseId¶
The unique identifier for the knowledge base.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KNOWLEDGEBASEID() |
Getter for KNOWLEDGEBASEID, with configurable default |
ASK_KNOWLEDGEBASEID() |
Getter for KNOWLEDGEBASEID w/ exceptions if field has no val |
HAS_KNOWLEDGEBASEID() |
Determine if KNOWLEDGEBASEID has a value |
Name¶
The name of the knowledge base.
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 |
Status¶
The status of the knowledge base.
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 |
DataSourceArn¶
The ARN of the data source associated with the knowledge base.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DATASOURCEARN() |
Getter for DATASOURCEARN, with configurable default |
ASK_DATASOURCEARN() |
Getter for DATASOURCEARN w/ exceptions if field has no value |
HAS_DATASOURCEARN() |
Determine if DATASOURCEARN has a value |
KnowledgeBaseConfiguration¶
The configuration settings for the knowledge base.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KNOWLEDGEBASECONF() |
Getter for KNOWLEDGEBASECONFIGURATION |
MediaExtractionConfiguration¶
The media extraction configuration for the knowledge base.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MEDIAEXTRACTIONCONF() |
Getter for MEDIAEXTRACTIONCONFIGURATION |
Type¶
The type of the knowledge base.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TYPE() |
Getter for TYPE, with configurable default |
ASK_TYPE() |
Getter for TYPE w/ exceptions if field has no value |
HAS_TYPE() |
Determine if TYPE has a value |
CreatedAt¶
The date and time that the knowledge base 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 that the knowledge base 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¶
The description of the knowledge base.
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 |
IsEmailNotificationOptedForIngestionFailures¶
Indicates whether email notifications are enabled for ingestion failures.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ISMAILNOTIFOPTDFRINGSTFL() |
Getter for ISEMAILNOTIFOPTDFORINGSTFAIL, with configurable d |
ASK_ISMAILNOTIFOPTDFRINGSTFL() |
Getter for ISEMAILNOTIFOPTDFORINGSTFAIL w/ exceptions if fie |
HAS_ISMAILNOTIFOPTDFRINGSTFL() |
Determine if ISEMAILNOTIFOPTDFORINGSTFAIL has a value |
FirstCompletedIngestionSummary¶
A summary of the first completed ingestion for the knowledge base.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FIRSTCOMPLTDINGESTSUMM() |
Getter for FIRSTCOMPLETEDINGESTSUMMARY |
FirstIncompleteIngestionSummary¶
A summary of the first incomplete ingestion for the knowledge base.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FIRSTINCMPLINGESTSUMMARY() |
Getter for FIRSTINCMPLINGESTIONSUMMARY |
LatestIngestionSummary¶
A summary of the most recent ingestion for the knowledge base.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LATESTINGESTIONSUMMARY() |
Getter for LATESTINGESTIONSUMMARY |
KnowledgeBaseSizeBytes¶
The size of the knowledge base in bytes.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KNOWLEDGEBASESIZEBYTES() |
Getter for KNOWLEDGEBASESIZEBYTES, with configurable default |
ASK_KNOWLEDGEBASESIZEBYTES() |
Getter for KNOWLEDGEBASESIZEBYTES w/ exceptions if field has |
HAS_KNOWLEDGEBASESIZEBYTES() |
Determine if KNOWLEDGEBASESIZEBYTES has a value |
DocumentCount¶
The number of documents in the knowledge base.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DOCUMENTCOUNT() |
Getter for DOCUMENTCOUNT, with configurable default |
ASK_DOCUMENTCOUNT() |
Getter for DOCUMENTCOUNT w/ exceptions if field has no value |
HAS_DOCUMENTCOUNT() |
Determine if DOCUMENTCOUNT has a value |
PrimaryOwnerArn¶
The ARN of the primary owner of the knowledge base.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PRIMARYOWNERARN() |
Getter for PRIMARYOWNERARN, with configurable default |
ASK_PRIMARYOWNERARN() |
Getter for PRIMARYOWNERARN w/ exceptions if field has no val |
HAS_PRIMARYOWNERARN() |
Determine if PRIMARYOWNERARN has a value |
PrimaryOwnerUsername¶
The username of the primary owner of the knowledge base.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PRIMARYOWNERUSERNAME() |
Getter for PRIMARYOWNERUSERNAME, with configurable default |
ASK_PRIMARYOWNERUSERNAME() |
Getter for PRIMARYOWNERUSERNAME w/ exceptions if field has n |
HAS_PRIMARYOWNERUSERNAME() |
Determine if PRIMARYOWNERUSERNAME has a value |