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

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::DescribeDataSourceResponse

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #configuration ⇒ Types::DataSourceConfiguration

  Configuration details for the data source connector.

• #created_at ⇒ Time

  The Unix timestamp when the data source connector was created.

• #custom_document_enrichment_configuration ⇒ Types::CustomDocumentEnrichmentConfiguration

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

• #description ⇒ String

  The description for the data source connector.

• #error_message ⇒ String

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

• #id ⇒ String

  The identifier of the data source connector.

• #index_id ⇒ String

  The identifier of the index used with the data source connector.

• #language_code ⇒ String

  The code for a language.

• #name ⇒ String

  The name for the data source connector.

• #role_arn ⇒ String

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

• #schedule ⇒ String

  The schedule for Amazon Kendra to update the index.

• #status ⇒ String

  The current status of the data source connector.

• #type ⇒ String

  The type of the data source.

• #updated_at ⇒ Time

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

• #vpc_configuration ⇒ Types::DataSourceVpcConfiguration

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

Instance Attribute Details

#configuration ⇒ Types::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.

Returns:

• (Types::DataSourceConfiguration)

# File 'lib/aws-sdk-kendra/types.rb', line 3569

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_at ⇒ Time

The Unix timestamp when the data source connector was created.

Returns:

• (Time)

# File 'lib/aws-sdk-kendra/types.rb', line 3569

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_configuration ⇒ Types::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].

[1]: docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html

Returns:

• (Types::CustomDocumentEnrichmentConfiguration)

# File 'lib/aws-sdk-kendra/types.rb', line 3569

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

#description ⇒ String

The description for the data source connector.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 3569

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

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)

# File 'lib/aws-sdk-kendra/types.rb', line 3569

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

#id ⇒ String

The identifier of the data source connector.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 3569

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

The identifier of the index used with the data source connector.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 3569

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

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].

[1]: docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 3569

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

#name ⇒ String

The name for the data source connector.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 3569

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

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

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 3569

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

#schedule ⇒ String

The schedule for Amazon Kendra to update the index.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 3569

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

#status ⇒ String

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)

# File 'lib/aws-sdk-kendra/types.rb', line 3569

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

#type ⇒ String

The type of the data source. For example, ‘SHAREPOINT`.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 3569

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_at ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-kendra/types.rb', line 3569

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_configuration ⇒ Types::DataSourceVpcConfiguration

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

[1]: docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html

Returns:

• (Types::DataSourceVpcConfiguration)

# File 'lib/aws-sdk-kendra/types.rb', line 3569

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