Class: Aws::QBusiness::Types::CreateDataSourceRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-qbusiness/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_id ⇒ String

The identifier of the Amazon Q Business application the data source will be attached to.

Returns:

  • (String) 


1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1858

class CreateDataSourceRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :configuration,
  :vpc_configuration,
  :description,
  :tags,
  :sync_schedule,
  :role_arn,
  :client_token,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

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.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String) 


1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1858

class CreateDataSourceRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :configuration,
  :vpc_configuration,
  :description,
  :tags,
  :sync_schedule,
  :role_arn,
  :client_token,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#configuration ⇒ Hash, ...

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:

  • Amazon S3 JSON schema][1
  • Web Crawler JSON schema][2

You can find configuration templates for your specific data source using the following steps:

  1. Navigate to the [Supported connectors] page in the Amazon Q Business User Guide, and select the data source of your choice.

  2. 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.

[1]: docs.aws.amazon.com/amazonq/latest/qbusiness-ug/s3-api.html [2]: docs.aws.amazon.com/amazonq/latest/qbusiness-ug/web-crawler-api.html [3]: docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html

Returns:

  • (Hash, Array, String, Numeric, Boolean) 


1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1858

class CreateDataSourceRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :configuration,
  :vpc_configuration,
  :description,
  :tags,
  :sync_schedule,
  :role_arn,
  :client_token,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description for the data source connector.

Returns:

  • (String) 


1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1858

class CreateDataSourceRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :configuration,
  :vpc_configuration,
  :description,
  :tags,
  :sync_schedule,
  :role_arn,
  :client_token,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

A name for the data source connector.

Returns:

  • (String) 


1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1858

class CreateDataSourceRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :configuration,
  :vpc_configuration,
  :description,
  :tags,
  :sync_schedule,
  :role_arn,
  :client_token,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#document_enrichment_configuration ⇒ Types::DocumentEnrichmentConfiguration

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

For more information, see [Custom document enrichment].

[1]: docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html

Returns:



1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1858

class CreateDataSourceRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :configuration,
  :vpc_configuration,
  :description,
  :tags,
  :sync_schedule,
  :role_arn,
  :client_token,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#index_id ⇒ String

The identifier of the index that you want to use with the data source connector.

Returns:

  • (String) 


1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1858

class CreateDataSourceRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :configuration,
  :vpc_configuration,
  :description,
  :tags,
  :sync_schedule,
  :role_arn,
  :client_token,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#media_extraction_configuration ⇒ Types::MediaExtractionConfiguration

The configuration for extracting information from media in documents during ingestion.

Returns:



1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1858

class CreateDataSourceRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :configuration,
  :vpc_configuration,
  :description,
  :tags,
  :sync_schedule,
  :role_arn,
  :client_token,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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

Returns:

  • (String) 


1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1858

class CreateDataSourceRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :configuration,
  :vpc_configuration,
  :description,
  :tags,
  :sync_schedule,
  :role_arn,
  :client_token,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#sync_schedule ⇒ String

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.

Returns:

  • (String) 


1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1858

class CreateDataSourceRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :configuration,
  :vpc_configuration,
  :description,
  :tags,
  :sync_schedule,
  :role_arn,
  :client_token,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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: _ . : / = + - @.

Returns:



1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1858

class CreateDataSourceRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :configuration,
  :vpc_configuration,
  :description,
  :tags,
  :sync_schedule,
  :role_arn,
  :client_token,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_configuration ⇒ Types::DataSourceVpcConfiguration

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].

[1]: docs.aws.amazon.com/amazonq/latest/business-use-dg/connector-vpc.html

Returns:



1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1858

class CreateDataSourceRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :configuration,
  :vpc_configuration,
  :description,
  :tags,
  :sync_schedule,
  :role_arn,
  :client_token,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end