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

Inherits:

Struct

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

Defined in:

gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

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)

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

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

#created_at ⇒ Time

The Unix timestamp of when the data source was created.

Returns:

• (Time)

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

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

#description ⇒ String

The description of the data source.

Returns:

• (String)

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

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :schedule,
  :role_arn,
  :error_message)
  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 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2015

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

#id ⇒ String

The identifier of the data source.

Returns:

• (String)

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

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

#index_id ⇒ String

The identifier of the index that contains the data source.

Returns:

• (String)

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

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

#name ⇒ String

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

Returns:

• (String)

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

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

#role_arn ⇒ String

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

Returns:

• (String)

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

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

#schedule ⇒ String

The schedule that Amazon Kendra will update the data source.

Returns:

• (String)

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

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

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

Returns:

• (String)

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

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

#type ⇒ String

The type of the data source.

Returns:

• (String)

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

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

#updated_at ⇒ Time

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

Returns:

• (Time)

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

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