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.



2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
# 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_atTime

The Unix timestamp of when the data source was created.

Returns:

  • (Time)


2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
# 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

#descriptionString

The description of the data source.

Returns:

  • (String)


2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
# 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_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)


2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
# 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

#idString

The identifier of the data source.

Returns:

  • (String)


2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
# 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_idString

The identifier of the index that contains the data source.

Returns:

  • (String)


2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
# 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

#nameString

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

Returns:

  • (String)


2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
# 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_arnString

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

Returns:

  • (String)


2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
# 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

#scheduleString

The schedule that Amazon Kendra will update the data source.

Returns:

  • (String)


2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
# 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

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


2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
# 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

#typeString

The type of the data source.

Returns:

  • (String)


2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
# 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_atTime

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

Returns:

  • (Time)


2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
# 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