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
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#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 isFAILED
, theErrorMessage
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.
-
#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.
3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3079 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) SENSITIVE = [] include Aws::Structure end |
#configuration ⇒ Hash, ...
The details of how the data source connector is configured.
3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3079 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) SENSITIVE = [] include Aws::Structure end |
#created_at ⇒ Time
The Unix timestamp when the data source connector was created.
3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3079 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) SENSITIVE = [] include Aws::Structure end |
#data_source_arn ⇒ String
The Amazon Resource Name (ARN) of the data source.
3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3079 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) SENSITIVE = [] include Aws::Structure end |
#data_source_id ⇒ String
The identifier of the data source connector.
3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3079 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) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
The description for the data source connector.
3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3079 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) SENSITIVE = [] include Aws::Structure end |
#display_name ⇒ String
The name for the data source connector.
3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3079 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) 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.
3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3079 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) 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.
3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3079 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) SENSITIVE = [] include Aws::Structure end |
#index_id ⇒ String
The identifier of the index linked to the data source connector.
3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3079 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) 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.
3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3079 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) 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.
3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3079 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) SENSITIVE = [] include Aws::Structure end |
#sync_schedule ⇒ String
The schedule for Amazon Q Business to update the index.
3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3079 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) SENSITIVE = [] include Aws::Structure end |
#type ⇒ String
The type of the data source connector. For example, S3
.
3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3079 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) SENSITIVE = [] include Aws::Structure end |
#updated_at ⇒ Time
The Unix timestamp when the data source connector was last updated.
3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3079 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) SENSITIVE = [] include Aws::Structure end |
#vpc_configuration ⇒ Types::DataSourceVpcConfiguration
Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.
3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3079 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) SENSITIVE = [] include Aws::Structure end |