Class: Aws::Kendra::Types::DescribeDataSourceResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#configurationTypes::DataSourceConfiguration

Describes how the data source is configured. The specific information in the description depends on the data source provider.



4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4735

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :schedule,
  :role_arn,
  :error_message,
  :language_code,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#created_atTime

The Unix timestamp of when the data source was created.

Returns:

  • (Time)


4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4735

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :schedule,
  :role_arn,
  :error_message,
  :language_code,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#custom_document_enrichment_configurationTypes::CustomDocumentEnrichmentConfiguration

Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.



4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4735

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :schedule,
  :role_arn,
  :error_message,
  :language_code,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the data source.

Returns:

  • (String)


4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4735

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :schedule,
  :role_arn,
  :error_message,
  :language_code,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#error_messageString

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

Returns:

  • (String)


4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4735

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :schedule,
  :role_arn,
  :error_message,
  :language_code,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#idString

The identifier of the data source.

Returns:

  • (String)


4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4735

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :schedule,
  :role_arn,
  :error_message,
  :language_code,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#index_idString

The identifier of the index that contains the data source.

Returns:

  • (String)


4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4735

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :schedule,
  :role_arn,
  :error_message,
  :language_code,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#language_codeString

The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

Returns:

  • (String)


4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4735

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :schedule,
  :role_arn,
  :error_message,
  :language_code,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name that you gave the data source when it was created.

Returns:

  • (String)


4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4735

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :schedule,
  :role_arn,
  :error_message,
  :language_code,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.

Returns:

  • (String)


4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4735

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :schedule,
  :role_arn,
  :error_message,
  :language_code,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#scheduleString

The schedule for Amazon Kendra to update the index.

Returns:

  • (String)


4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4735

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :schedule,
  :role_arn,
  :error_message,
  :language_code,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The current status of the data source. When the status is ACTIVE the data source is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that the data source failed.

Returns:

  • (String)


4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4735

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :schedule,
  :role_arn,
  :error_message,
  :language_code,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The type of the data source.

Returns:

  • (String)


4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4735

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :schedule,
  :role_arn,
  :error_message,
  :language_code,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#updated_atTime

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

Returns:

  • (Time)


4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4735

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :schedule,
  :role_arn,
  :error_message,
  :language_code,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end