/AWS1/CL_QQBGETDATASOURCERSP

GetDataSourceResponse

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_applicationid TYPE /AWS1/QQBAPPLICATIONID /AWS1/QQBAPPLICATIONID

The identifier of the Amazon Q Business application.

iv_indexid TYPE /AWS1/QQBINDEXID /AWS1/QQBINDEXID

The identifier of the index linked to the data source connector.

iv_datasourceid TYPE /AWS1/QQBDATASOURCEID /AWS1/QQBDATASOURCEID

The identifier of the data source connector.

iv_datasourcearn TYPE /AWS1/QQBDATASOURCEARN /AWS1/QQBDATASOURCEARN

The Amazon Resource Name (ARN) of the data source.

iv_displayname TYPE /AWS1/QQBDATASOURCENAME /AWS1/QQBDATASOURCENAME

The name for the data source connector.

iv_type TYPE /AWS1/QQBSTRING /AWS1/QQBSTRING

The type of the data source connector. For example, S3.

io_configuration TYPE REF TO /AWS1/CL_RT_DOCUMENT /AWS1/CL_RT_DOCUMENT

The details of how the data source connector is configured.

io_vpcconfiguration TYPE REF TO /AWS1/CL_QQBDATASOURCEVPCCONF /AWS1/CL_QQBDATASOURCEVPCCONF

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.

iv_createdat TYPE /AWS1/QQBTIMESTAMP /AWS1/QQBTIMESTAMP

The Unix timestamp when the data source connector was created.

iv_updatedat TYPE /AWS1/QQBTIMESTAMP /AWS1/QQBTIMESTAMP

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

iv_description TYPE /AWS1/QQBDESCRIPTION /AWS1/QQBDESCRIPTION

The description for the data source connector.

iv_status TYPE /AWS1/QQBDATASOURCESTATUS /AWS1/QQBDATASOURCESTATUS

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

iv_syncschedule TYPE /AWS1/QQBSYNCSCHEDULE /AWS1/QQBSYNCSCHEDULE

The schedule for Amazon Q Business to update the index.

iv_rolearn TYPE /AWS1/QQBROLEARN /AWS1/QQBROLEARN

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

io_error TYPE REF TO /AWS1/CL_QQBERRORDETAIL /AWS1/CL_QQBERRORDETAIL

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

io_documentenrichmentconf TYPE REF TO /AWS1/CL_QQBDOCENRICHMENTCONF /AWS1/CL_QQBDOCENRICHMENTCONF

Provides the configuration information for altering document metadata and content during the document ingestion process.

For more information, see Custom document enrichment.

io_mediaextractionconf TYPE REF TO /AWS1/CL_QQBMEDIAEXTRACTCONF /AWS1/CL_QQBMEDIAEXTRACTCONF

The configuration for extracting information from media in documents for the data source.

---

Queryable Attributes

applicationId

The identifier of the Amazon Q Business application.

Accessible with the following methods

Method	Description
GET_APPLICATIONID()	Getter for APPLICATIONID, with configurable default
ASK_APPLICATIONID()	Getter for APPLICATIONID w/ exceptions if field has no value
HAS_APPLICATIONID()	Determine if APPLICATIONID has a value

indexId

The identifier of the index linked to 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

dataSourceId

The identifier of the data source connector.

Accessible with the following methods

Method	Description
GET_DATASOURCEID()	Getter for DATASOURCEID, with configurable default
ASK_DATASOURCEID()	Getter for DATASOURCEID w/ exceptions if field has no value
HAS_DATASOURCEID()	Determine if DATASOURCEID has a value

dataSourceArn

The Amazon Resource Name (ARN) of the data source.

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

displayName

The name for the data source connector.

Accessible with the following methods

Method	Description
GET_DISPLAYNAME()	Getter for DISPLAYNAME, with configurable default
ASK_DISPLAYNAME()	Getter for DISPLAYNAME w/ exceptions if field has no value
HAS_DISPLAYNAME()	Determine if DISPLAYNAME has a value

type

The type of the data source connector. For example, S3.

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

The details of how the data source connector is configured.

Accessible with the following methods

Method	Description
GET_CONFIGURATION()	Getter for CONFIGURATION, with configurable default
ASK_CONFIGURATION()	Getter for CONFIGURATION w/ exceptions if field has no value
HAS_CONFIGURATION()	Determine if CONFIGURATION has a value

vpcConfiguration

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.

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 field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

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

syncSchedule

The schedule for Amazon Q Business to update the index.

Accessible with the following methods

Method	Description
GET_SYNCSCHEDULE()	Getter for SYNCSCHEDULE, with configurable default
ASK_SYNCSCHEDULE()	Getter for SYNCSCHEDULE w/ exceptions if field has no value
HAS_SYNCSCHEDULE()	Determine if SYNCSCHEDULE has a value

roleArn

The Amazon Resource Name (ARN) of the 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

error

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

Accessible with the following methods

Method	Description
GET_ERROR()	Getter for ERROR

documentEnrichmentConfiguration

Provides the configuration information for altering document metadata and content during the document ingestion process.

For more information, see Custom document enrichment.

Accessible with the following methods

Method	Description
GET_DOCUMENTENRICHMENTCONF()	Getter for DOCUMENTENRICHMENTCONF

mediaExtractionConfiguration

The configuration for extracting information from media in documents for the data source.

Accessible with the following methods

Method	Description
GET_MEDIAEXTRACTIONCONF()	Getter for MEDIAEXTRACTIONCONFIGURATION