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

Inherits:

Struct

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

Defined in:

(unknown)

Overview

Returned by:

• Client#describe_data_source

See Also:

• AWS API Documentation

Instance Attribute Summary

• #configuration ⇒ Types::DataSourceConfiguration

  Information that describes where the data source is located and how the data source is configured.

• #created_at ⇒ Time

  The Unix timestamp of when the data source was created.

• #description ⇒ String

  The description of the data source.

• #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.

• #index_id ⇒ String

  The identifier of the index that contains the data source.

• #name ⇒ String

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

• #role_arn ⇒ String

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

• #schedule ⇒ String

  The schedule that Amazon Kendra will update the data source.

• #status ⇒ String

  The current status of the data source.

• #type ⇒ String

  The type of the data source.

• #updated_at ⇒ Time

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

Instance Attribute Details

#configuration ⇒ Types::DataSourceConfiguration

Information that describes where the data source is located and how the data source is configured. The specific information in the description depends on the data source provider.

Returns:

• (Types::DataSourceConfiguration) —

  Information that describes where the data source is located and how the data source is configured.

#created_at ⇒ Time

The Unix timestamp of when the data source was created.

Returns:

• (Time) —

  The Unix timestamp of when the data source was created.

#description ⇒ String

The description of the data source.

Returns:

• (String) —

  The description of the data source.

#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) —

  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.

Returns:

• (String) —

  The identifier of the data source.

#index_id ⇒ String

The identifier of the index that contains the data source.

Returns:

• (String) —

  The identifier of the index that contains the data source.

#name ⇒ String

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

Returns:

• (String) —

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

#role_arn ⇒ String

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

Returns:

• (String) —

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

#schedule ⇒ String

The schedule that Amazon Kendra will update the data source.

Returns:

• (String) —

  The schedule that Amazon Kendra will update the data source.

#status ⇒ String

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.

Possible values:

• CREATING
• DELETING
• FAILED
• UPDATING
• ACTIVE

Returns:

• (String) —

  The current status of the data source.

#type ⇒ String

The type of the data source.

Possible values:

• S3
• SHAREPOINT
• DATABASE
• SALESFORCE
• ONEDRIVE
• SERVICENOW
• CUSTOM
• CONFLUENCE

Returns:

• (String) —

  The type of the data source.

#updated_at ⇒ Time

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

Returns:

• (Time) —

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