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

Configuration details for the data source connector. This shows how the data source is configured. The configuration options for a data source depend on the data source provider.



5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5511

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :vpc_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 connector was created.

Returns:

  • (Time)


5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5511

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :vpc_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.



5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5511

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :vpc_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 for the data source connector.

Returns:

  • (String)


5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5511

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :vpc_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)


5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5511

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :vpc_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 connector.

Returns:

  • (String)


5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5511

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :vpc_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 used with the data source connector.

Returns:

  • (String)


5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5511

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :vpc_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)


5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5511

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :vpc_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 for the data source connector.

Returns:

  • (String)


5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5511

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :vpc_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 with permission to access the data source and required resources.

Returns:

  • (String)


5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5511

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :vpc_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)


5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5511

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :vpc_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 connector. 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)


5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5511

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :vpc_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. For example, SHAREPOINT.

Returns:

  • (String)


5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5511

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :vpc_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 connector was last updated.

Returns:

  • (Time)


5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5511

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

#vpc_configurationTypes::DataSourceVpcConfiguration

Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.



5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5511

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