/AWS1/CL_KNDDESCRDATASOURCERSP

DescribeDataSourceResponse

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_id TYPE /AWS1/KNDDATASOURCEID /AWS1/KNDDATASOURCEID

The identifier of the data source connector.

iv_indexid TYPE /AWS1/KNDINDEXID /AWS1/KNDINDEXID

The identifier of the index used with the data source connector.

iv_name TYPE /AWS1/KNDDATASOURCENAME /AWS1/KNDDATASOURCENAME

The name for the data source connector.

iv_type TYPE /AWS1/KNDDATASOURCETYPE /AWS1/KNDDATASOURCETYPE

The type of the data source. For example, SHAREPOINT.

io_configuration TYPE REF TO /AWS1/CL_KNDDATASOURCECONF /AWS1/CL_KNDDATASOURCECONF

Configuration details for the data source connector. This shows how the data source is configured. The configuration options for a data source depend on the data source provider.

io_vpcconfiguration TYPE REF TO /AWS1/CL_KNDDATASOURCEVPCCONF /AWS1/CL_KNDDATASOURCEVPCCONF

Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.

iv_createdat TYPE /AWS1/KNDTIMESTAMP /AWS1/KNDTIMESTAMP

The Unix timestamp when the data source connector was created.

iv_updatedat TYPE /AWS1/KNDTIMESTAMP /AWS1/KNDTIMESTAMP

The Unix timestamp when the data source connector was last updated.

iv_description TYPE /AWS1/KNDDESCRIPTION /AWS1/KNDDESCRIPTION

The description for the data source connector.

iv_status TYPE /AWS1/KNDDATASOURCESTATUS /AWS1/KNDDATASOURCESTATUS

The current status of the data source connector. When the status is ACTIVE the data source is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that the data source failed.

iv_schedule TYPE /AWS1/KNDSCANSCHEDULE /AWS1/KNDSCANSCHEDULE

The schedule for Amazon Kendra to update the index.

iv_rolearn TYPE /AWS1/KNDROLEARN /AWS1/KNDROLEARN

The Amazon Resource Name (ARN) of the IAM role with permission to access the data source and required resources.

iv_errormessage TYPE /AWS1/KNDERRORMESSAGE /AWS1/KNDERRORMESSAGE

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source to fail.

iv_languagecode TYPE /AWS1/KNDLANGUAGECODE /AWS1/KNDLANGUAGECODE

The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

io_customdocenrichmentconf TYPE REF TO /AWS1/CL_KNDCUSTDOCENRICHMEN00 /AWS1/CL_KNDCUSTDOCENRICHMEN00

Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

---

Queryable Attributes

Id

The identifier of the data source connector.

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

The identifier of the index used with the data source connector.

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

The name for the data source connector.

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

Type

The type of the data source. For example, SHAREPOINT.

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

Configuration

Configuration details for the data source connector. This shows how the data source is configured. The configuration options for a data source depend on the data source provider.

Accessible with the following methods

Method	Description
GET_CONFIGURATION()	Getter for CONFIGURATION

VpcConfiguration

Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.

Accessible with the following methods

Method	Description
GET_VPCCONFIGURATION()	Getter for VPCCONFIGURATION

CreatedAt

The Unix timestamp when the data source connector 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 the data source connector 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 for the data source connector.

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 status of the data source connector. When the status is ACTIVE the data source is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that the data source 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

Schedule

The schedule for Amazon Kendra to update the index.

Accessible with the following methods

Method	Description
GET_SCHEDULE()	Getter for SCHEDULE, with configurable default
ASK_SCHEDULE()	Getter for SCHEDULE w/ exceptions if field has no value
HAS_SCHEDULE()	Determine if SCHEDULE has a value

RoleArn

The Amazon Resource Name (ARN) of the IAM role with permission to access the data source and required resources.

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

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source to fail.

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

LanguageCode

The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

Accessible with the following methods

Method	Description
GET_LANGUAGECODE()	Getter for LANGUAGECODE, with configurable default
ASK_LANGUAGECODE()	Getter for LANGUAGECODE w/ exceptions if field has no value
HAS_LANGUAGECODE()	Determine if LANGUAGECODE has a value

CustomDocumentEnrichmentConfiguration

Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

Accessible with the following methods

Method	Description
GET_CUSTOMDOCENRICHMENTCONF()	Getter for CUSTOMDOCUMENTENRICHMENTCONF