get_data_source¶
Operation¶
async
¶
get_data_source(input: GetDataSourceInput, plugins: list[Plugin] | None = None) -> GetDataSourceOutput
Gets information about an existing Amazon Q Business data source connector.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetDataSourceInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
GetDataSourceOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for GetDataSourceInput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_id: str | None = None
The identifier of the Amazon Q Business application.
class-attribute
instance-attribute
¶
data_source_id: str | None = None
The identifier of the data source connector.
class-attribute
instance-attribute
¶
index_id: str | None = None
The identfier of the index used with the data source connector.
Output¶
dataclass
¶
Dataclass for GetDataSourceOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_id: str | None = None
The identifier of the Amazon Q Business application.
class-attribute
instance-attribute
¶
configuration: Document | None = None
The details of how the data source connector is configured.
class-attribute
instance-attribute
¶
created_at: datetime | None = None
The Unix timestamp when the data source connector was created.
class-attribute
instance-attribute
¶
data_source_arn: str | None = None
The Amazon Resource Name (ARN) of the data source.
class-attribute
instance-attribute
¶
data_source_id: str | None = None
The identifier of the data source connector.
class-attribute
instance-attribute
¶
description: str | None = None
The description for the data source connector.
class-attribute
instance-attribute
¶
display_name: str | None = None
The name for the data source connector.
class-attribute
instance-attribute
¶
document_enrichment_configuration: DocumentEnrichmentConfiguration | None = None
Provides the configuration information for altering document metadata and content during the document ingestion process.
For more information, see Custom document enrichment.
class-attribute
instance-attribute
¶
error: ErrorDetail | None = None
When the Status field value is FAILED, the ErrorMessage field
contains a description of the error that caused the data source
connector to fail.
class-attribute
instance-attribute
¶
index_id: str | None = None
The identifier of the index linked to the data source connector.
class-attribute
instance-attribute
¶
media_extraction_configuration: MediaExtractionConfiguration | None = None
The configuration for extracting information from media in documents for the data source.
class-attribute
instance-attribute
¶
role_arn: str | None = None
The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.
class-attribute
instance-attribute
¶
status: DataSourceStatus | None = None
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.
class-attribute
instance-attribute
¶
sync_schedule: str | None = None
The schedule for Amazon Q Business to update the index.
class-attribute
instance-attribute
¶
type: str | None = None
The type of the data source connector. For example, S3.
class-attribute
instance-attribute
¶
updated_at: datetime | None = None
The Unix timestamp when the data source connector was last updated.
class-attribute
instance-attribute
¶
vpc_configuration: DataSourceVpcConfiguration | None = None
Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.