Class: Aws::QBusiness::Types::GetDataSourceResponse

Inherits:

Struct

• Object
• Struct
• Aws::QBusiness::Types::GetDataSourceResponse

Defined in:

gems/aws-sdk-qbusiness/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.

• #configuration ⇒ Hash, ...

  The details of how the data source connector is configured.

• #created_at ⇒ Time

  The Unix timestamp when the data source connector was created.

• #data_source_arn ⇒ String

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

• #data_source_id ⇒ String

  The identifier of the data source connector.

• #description ⇒ String

  The description for the data source connector.

• #display_name ⇒ String

  The name for the data source connector.

• #document_enrichment_configuration ⇒ Types::DocumentEnrichmentConfiguration

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

• #error ⇒ Types::ErrorDetail

  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 ⇒ String

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

• #media_extraction_configuration ⇒ Types::MediaExtractionConfiguration

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

• #role_arn ⇒ String

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

• #status ⇒ String

  The current status of the data source connector.

• #sync_schedule ⇒ String

  The schedule for Amazon Q Business to update the index.

• #type ⇒ String

  The type of the data source connector.

• #updated_at ⇒ Time

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

• #vpc_configuration ⇒ Types::DataSourceVpcConfiguration

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

Instance Attribute Details

#application_id ⇒ String

The identifier of the Amazon Q Business application.

Returns:

• (String)

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

class GetDataSourceResponse < Struct.new(
  :application_id,
  :index_id,
  :data_source_id,
  :data_source_arn,
  :display_name,
  :type,
  :configuration,
  :vpc_configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :sync_schedule,
  :role_arn,
  :error,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#configuration ⇒ Hash, ...

The details of how the data source connector is configured.

Returns:

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

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

class GetDataSourceResponse < Struct.new(
  :application_id,
  :index_id,
  :data_source_id,
  :data_source_arn,
  :display_name,
  :type,
  :configuration,
  :vpc_configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :sync_schedule,
  :role_arn,
  :error,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The Unix timestamp when the data source connector was created.

Returns:

• (Time)

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

class GetDataSourceResponse < Struct.new(
  :application_id,
  :index_id,
  :data_source_id,
  :data_source_arn,
  :display_name,
  :type,
  :configuration,
  :vpc_configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :sync_schedule,
  :role_arn,
  :error,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#data_source_arn ⇒ String

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

Returns:

• (String)

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

class GetDataSourceResponse < Struct.new(
  :application_id,
  :index_id,
  :data_source_id,
  :data_source_arn,
  :display_name,
  :type,
  :configuration,
  :vpc_configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :sync_schedule,
  :role_arn,
  :error,
  :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 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4101

class GetDataSourceResponse < Struct.new(
  :application_id,
  :index_id,
  :data_source_id,
  :data_source_arn,
  :display_name,
  :type,
  :configuration,
  :vpc_configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :sync_schedule,
  :role_arn,
  :error,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description for the data source connector.

Returns:

• (String)

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

class GetDataSourceResponse < Struct.new(
  :application_id,
  :index_id,
  :data_source_id,
  :data_source_arn,
  :display_name,
  :type,
  :configuration,
  :vpc_configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :sync_schedule,
  :role_arn,
  :error,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

The name for the data source connector.

Returns:

• (String)

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

class GetDataSourceResponse < Struct.new(
  :application_id,
  :index_id,
  :data_source_id,
  :data_source_arn,
  :display_name,
  :type,
  :configuration,
  :vpc_configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :sync_schedule,
  :role_arn,
  :error,
  :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.

Returns:

• (Types::DocumentEnrichmentConfiguration)

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

class GetDataSourceResponse < Struct.new(
  :application_id,
  :index_id,
  :data_source_id,
  :data_source_arn,
  :display_name,
  :type,
  :configuration,
  :vpc_configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :sync_schedule,
  :role_arn,
  :error,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#error ⇒ Types::ErrorDetail

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

Returns:

• (Types::ErrorDetail)

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

class GetDataSourceResponse < Struct.new(
  :application_id,
  :index_id,
  :data_source_id,
  :data_source_arn,
  :display_name,
  :type,
  :configuration,
  :vpc_configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :sync_schedule,
  :role_arn,
  :error,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#index_id ⇒ String

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

Returns:

• (String)

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

class GetDataSourceResponse < Struct.new(
  :application_id,
  :index_id,
  :data_source_id,
  :data_source_arn,
  :display_name,
  :type,
  :configuration,
  :vpc_configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :sync_schedule,
  :role_arn,
  :error,
  :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 the data source.

Returns:

• (Types::MediaExtractionConfiguration)

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

class GetDataSourceResponse < Struct.new(
  :application_id,
  :index_id,
  :data_source_id,
  :data_source_arn,
  :display_name,
  :type,
  :configuration,
  :vpc_configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :sync_schedule,
  :role_arn,
  :error,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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

Returns:

• (String)

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

class GetDataSourceResponse < Struct.new(
  :application_id,
  :index_id,
  :data_source_id,
  :data_source_arn,
  :display_name,
  :type,
  :configuration,
  :vpc_configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :sync_schedule,
  :role_arn,
  :error,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

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.

Returns:

• (String)

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

class GetDataSourceResponse < Struct.new(
  :application_id,
  :index_id,
  :data_source_id,
  :data_source_arn,
  :display_name,
  :type,
  :configuration,
  :vpc_configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :sync_schedule,
  :role_arn,
  :error,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#sync_schedule ⇒ String

The schedule for Amazon Q Business to update the index.

Returns:

• (String)

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

class GetDataSourceResponse < Struct.new(
  :application_id,
  :index_id,
  :data_source_id,
  :data_source_arn,
  :display_name,
  :type,
  :configuration,
  :vpc_configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :sync_schedule,
  :role_arn,
  :error,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

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

Returns:

• (String)

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

class GetDataSourceResponse < Struct.new(
  :application_id,
  :index_id,
  :data_source_id,
  :data_source_arn,
  :display_name,
  :type,
  :configuration,
  :vpc_configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :sync_schedule,
  :role_arn,
  :error,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

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

Returns:

• (Time)

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

class GetDataSourceResponse < Struct.new(
  :application_id,
  :index_id,
  :data_source_id,
  :data_source_arn,
  :display_name,
  :type,
  :configuration,
  :vpc_configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :sync_schedule,
  :role_arn,
  :error,
  :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.

Returns:

• (Types::DataSourceVpcConfiguration)

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

class GetDataSourceResponse < Struct.new(
  :application_id,
  :index_id,
  :data_source_id,
  :data_source_arn,
  :display_name,
  :type,
  :configuration,
  :vpc_configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :sync_schedule,
  :role_arn,
  :error,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end