create_data_source¶
Operation¶
async
¶
create_data_source(input: CreateDataSourceInput, plugins: list[Plugin] | None = None) -> CreateDataSourceOutput
Creates a data source connector for an Amazon Q Business application.
CreateDataSource is a synchronous operation. The operation returns 200
if the data source was successfully created. Otherwise, an exception is
raised.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateDataSourceInput
|
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 |
|---|---|
CreateDataSourceOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for CreateDataSourceInput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_id: str | None = None
The identifier of the Amazon Q Business application the data source will be attached to.
class-attribute
instance-attribute
¶
client_token: str | None = None
A token you provide to identify a request to create a data source
connector. Multiple calls to the CreateDataSource API with the same
client token will create only one data source connector.
class-attribute
instance-attribute
¶
configuration: Document | None = None
Configuration information to connect your data source repository to Amazon Q Business. Use this parameter to provide a JSON schema with configuration information specific to your data source connector.
Each data source has a JSON schema provided by Amazon Q Business that you must use. For example, the Amazon S3 and Web Crawler connectors require the following JSON schemas:
You can find configuration templates for your specific data source using the following steps:
-
Navigate to the Supported connectors page in the Amazon Q Business User Guide, and select the data source of your choice.
-
Then, from your specific data source connector page, select Using the API. You will find the JSON schema for your data source, including parameter descriptions, in this section.
class-attribute
instance-attribute
¶
description: str | None = None
A description for the data source connector.
class-attribute
instance-attribute
¶
display_name: str | None = None
A 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
¶
index_id: str | None = None
The identifier of the index that you want to use with the data source connector.
class-attribute
instance-attribute
¶
media_extraction_configuration: MediaExtractionConfiguration | None = None
The configuration for extracting information from media in documents during ingestion.
class-attribute
instance-attribute
¶
role_arn: str | None = None
The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. This field is required for all connector types except custom connectors, where it is optional.
class-attribute
instance-attribute
¶
sync_schedule: str | None = None
Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q Business won't periodically update the index.
Specify a cron- format schedule string or an empty string to indicate
that the index is updated on demand. You can't specify the Schedule
parameter when the Type parameter is set to CUSTOM. If you do, you
receive a ValidationException exception.
class-attribute
instance-attribute
¶
tags: list[Tag] | None = None
A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
class-attribute
instance-attribute
¶
vpc_configuration: DataSourceVpcConfiguration | None = None
Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors.
Output¶
dataclass
¶
Dataclass for CreateDataSourceOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
data_source_arn: str | None = None
The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
class-attribute
instance-attribute
¶
data_source_id: str | None = None
The identifier of the data source connector.