Class: Aws::QBusiness::Types::UpdateDataSourceRequest

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 is attached to.

Returns:

  • (String) 


8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 8952

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

#configuration ⇒ Hash, ...

Provides the configuration information for an Amazon Q Business data source.

Returns:

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


8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 8952

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

#data_source_id ⇒ String

The identifier of the data source connector.

Returns:

  • (String) 


8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 8952

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

#description ⇒ String

The description of the data source connector.

Returns:

  • (String) 


8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 8952

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

#display_name ⇒ String

A name of the data source connector.

Returns:

  • (String) 


8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 8952

class UpdateDataSourceRequest < Struct.new(
  :application_id,
  :index_id,
  :data_source_id,
  :display_name,
  :configuration,
  :vpc_configuration,
  :description,
  :sync_schedule,
  :role_arn,
  :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:



8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 8952

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

#index_id ⇒ String

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

Returns:

  • (String) 


8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 8952

class UpdateDataSourceRequest < Struct.new(
  :application_id,
  :index_id,
  :data_source_id,
  :display_name,
  :configuration,
  :vpc_configuration,
  :description,
  :sync_schedule,
  :role_arn,
  :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 for your data source.

Returns:



8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 8952

class UpdateDataSourceRequest < Struct.new(
  :application_id,
  :index_id,
  :data_source_id,
  :display_name,
  :configuration,
  :vpc_configuration,
  :description,
  :sync_schedule,
  :role_arn,
  :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) 


8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 8952

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

#sync_schedule ⇒ String

The chosen update frequency for your data source.

Returns:

  • (String) 


8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 8952

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

#vpc_configuration ⇒ Types::DataSourceVpcConfiguration

Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).

Returns:



8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 8952

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