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

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.



3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3546

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

#created_atTime

The Unix timestamp of when the data source was created.

Returns:

  • (Time)


3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3546

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

#descriptionString

The description of the data source.

Returns:

  • (String)


3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3546

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :schedule,
  :role_arn,
  :error_message,
  :language_code)
  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)


3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3546

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

#idString

The identifier of the data source.

Returns:

  • (String)


3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3546

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

#index_idString

The identifier of the index that contains the data source.

Returns:

  • (String)


3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3546

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :schedule,
  :role_arn,
  :error_message,
  :language_code)
  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)


3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3546

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

#nameString

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

Returns:

  • (String)


3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3546

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :schedule,
  :role_arn,
  :error_message,
  :language_code)
  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)


3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3546

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

#scheduleString

The schedule that Amazon Kendra will update the data source.

Returns:

  • (String)


3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3546

class DescribeDataSourceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :type,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :schedule,
  :role_arn,
  :error_message,
  :language_code)
  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)


3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3546

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

#typeString

The type of the data source.

Returns:

  • (String)


3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3546

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

#updated_atTime

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

Returns:

  • (Time)


3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3546

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