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

Inherits:

Struct

• Object
• Struct
• Aws::QBusiness::Types::UpdateDataSourceRequest

Includes:

Structure

Defined in:

lib/aws-sdk-qbusiness/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #application_id ⇒ String

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

• #configuration ⇒ Hash, ...

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

• #data_source_id ⇒ String

  The identifier of the data source connector.

• #description ⇒ String

  The description of the data source connector.

• #display_name ⇒ String

  A name of the data source connector.

• #document_enrichment_configuration ⇒ Types::DocumentEnrichmentConfiguration

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

• #index_id ⇒ String

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

• #media_extraction_configuration ⇒ Types::MediaExtractionConfiguration

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

• #role_arn ⇒ String

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

• #sync_schedule ⇒ String

  The chosen update frequency for your data source.

• #vpc_configuration ⇒ Types::DataSourceVpcConfiguration

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

Instance Attribute Details

#application_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-qbusiness/types.rb', line 7715

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)

# File 'lib/aws-sdk-qbusiness/types.rb', line 7715

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)

# File 'lib/aws-sdk-qbusiness/types.rb', line 7715

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)

# File 'lib/aws-sdk-qbusiness/types.rb', line 7715

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)

# File 'lib/aws-sdk-qbusiness/types.rb', line 7715

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:

• (Types::DocumentEnrichmentConfiguration)

# File 'lib/aws-sdk-qbusiness/types.rb', line 7715

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)

# File 'lib/aws-sdk-qbusiness/types.rb', line 7715

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:

• (Types::MediaExtractionConfiguration)

# File 'lib/aws-sdk-qbusiness/types.rb', line 7715

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)

# File 'lib/aws-sdk-qbusiness/types.rb', line 7715

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)

# File 'lib/aws-sdk-qbusiness/types.rb', line 7715

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:

• (Types::DataSourceVpcConfiguration)

# File 'lib/aws-sdk-qbusiness/types.rb', line 7715

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