Skip to content

get_data_source

Operation

get_data_source

get_data_source(request: GetDataSourceInput | GetDataSourceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDataSourceInputDict]) -> GetDataSourceOutput

Gets information about an existing Amazon Q Business data source connector.

Parameters:

Name Type Description Default
request GetDataSourceInput | GetDataSourceInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetDataSourceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetDataSourceOutput

An instance of GetDataSourceOutput.

get_data_source async

get_data_source(request: GetDataSourceInput | GetDataSourceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDataSourceInputDict]) -> GetDataSourceOutput

Gets information about an existing Amazon Q Business data source connector.

Parameters:

Name Type Description Default
request GetDataSourceInput | GetDataSourceInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetDataSourceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetDataSourceOutput

An instance of GetDataSourceOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetDataSourceInputDict

Bases: TypedDict

Dictionary form of GetDataSourceInput.

Attributes

application_id instance-attribute
application_id: Required[str]

The identifier of the Amazon Q Business application.

data_source_id instance-attribute
data_source_id: Required[str]

The identifier of the data source connector.

index_id instance-attribute
index_id: Required[str]

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

GetDataSourceInput dataclass

Bases: _SerdeShape

Dataclass for GetDataSourceInput structure.

Attributes

application_id class-attribute instance-attribute
application_id: str | None = ...

The identifier of the Amazon Q Business application.

data_source_id class-attribute instance-attribute
data_source_id: str | None = ...

The identifier of the data source connector.

index_id class-attribute instance-attribute
index_id: str | None = ...

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

Output

GetDataSourceOutput dataclass

Bases: _SerdeShape

Dataclass for GetDataSourceOutput structure.

Attributes

application_id class-attribute instance-attribute
application_id: str | None = ...

The identifier of the Amazon Q Business application.

configuration class-attribute instance-attribute
configuration: Document | None = ...

The details of how the data source connector is configured.

created_at class-attribute instance-attribute
created_at: datetime | None = ...

The Unix timestamp when the data source connector was created.

data_source_arn class-attribute instance-attribute
data_source_arn: str | None = ...

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

data_source_id class-attribute instance-attribute
data_source_id: str | None = ...

The identifier of the data source connector.

description class-attribute instance-attribute
description: str | None = ...

The description for the data source connector.

display_name class-attribute instance-attribute
display_name: str | None = ...

The name for the data source connector.

document_enrichment_configuration class-attribute instance-attribute
document_enrichment_configuration: DocumentEnrichmentConfiguration | None = ...

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

For more information, see Custom document enrichment.

error class-attribute instance-attribute
error: ErrorDetail | 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.

index_id class-attribute instance-attribute
index_id: str | None = ...

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

media_extraction_configuration class-attribute instance-attribute
media_extraction_configuration: MediaExtractionConfiguration | None = ...

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

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

role_arn class-attribute instance-attribute
role_arn: str | None = ...

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

status class-attribute instance-attribute
status: str | 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.

sync_schedule class-attribute instance-attribute
sync_schedule: str | None = ...

The schedule for Amazon Q Business to update the index.

type class-attribute instance-attribute
type: str | None = ...

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

updated_at class-attribute instance-attribute
updated_at: datetime | None = ...

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

vpc_configuration class-attribute instance-attribute
vpc_configuration: DataSourceVpcConfiguration | None = ...

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