Class: Aws::QBusiness::Types::GetIndexResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_idString

The identifier of the Amazon Q Business application associated with the index.

Returns:

  • (String)


5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5016

class GetIndexResponse < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :index_arn,
  :status,
  :type,
  :description,
  :created_at,
  :updated_at,
  :capacity_configuration,
  :document_attribute_configurations,
  :error,
  :index_statistics)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_configurationTypes::IndexCapacityConfiguration

The storage capacity units chosen for your Amazon Q Business index.



5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5016

class GetIndexResponse < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :index_arn,
  :status,
  :type,
  :description,
  :created_at,
  :updated_at,
  :capacity_configuration,
  :document_attribute_configurations,
  :error,
  :index_statistics)
  SENSITIVE = []
  include Aws::Structure
end

#created_atTime

The Unix timestamp when the Amazon Q Business index was created.

Returns:

  • (Time)


5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5016

class GetIndexResponse < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :index_arn,
  :status,
  :type,
  :description,
  :created_at,
  :updated_at,
  :capacity_configuration,
  :document_attribute_configurations,
  :error,
  :index_statistics)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description for the Amazon Q Business index.

Returns:

  • (String)


5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5016

class GetIndexResponse < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :index_arn,
  :status,
  :type,
  :description,
  :created_at,
  :updated_at,
  :capacity_configuration,
  :document_attribute_configurations,
  :error,
  :index_statistics)
  SENSITIVE = []
  include Aws::Structure
end

#display_nameString

The name of the Amazon Q Business index.

Returns:

  • (String)


5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5016

class GetIndexResponse < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :index_arn,
  :status,
  :type,
  :description,
  :created_at,
  :updated_at,
  :capacity_configuration,
  :document_attribute_configurations,
  :error,
  :index_statistics)
  SENSITIVE = []
  include Aws::Structure
end

#document_attribute_configurationsArray<Types::DocumentAttributeConfiguration>

Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.



5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5016

class GetIndexResponse < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :index_arn,
  :status,
  :type,
  :description,
  :created_at,
  :updated_at,
  :capacity_configuration,
  :document_attribute_configurations,
  :error,
  :index_statistics)
  SENSITIVE = []
  include Aws::Structure
end

#errorTypes::ErrorDetail

When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

Returns:



5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5016

class GetIndexResponse < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :index_arn,
  :status,
  :type,
  :description,
  :created_at,
  :updated_at,
  :capacity_configuration,
  :document_attribute_configurations,
  :error,
  :index_statistics)
  SENSITIVE = []
  include Aws::Structure
end

#index_arnString

The Amazon Resource Name (ARN) of the Amazon Q Business index.

Returns:

  • (String)


5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5016

class GetIndexResponse < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :index_arn,
  :status,
  :type,
  :description,
  :created_at,
  :updated_at,
  :capacity_configuration,
  :document_attribute_configurations,
  :error,
  :index_statistics)
  SENSITIVE = []
  include Aws::Structure
end

#index_idString

The identifier of the Amazon Q Business index.

Returns:

  • (String)


5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5016

class GetIndexResponse < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :index_arn,
  :status,
  :type,
  :description,
  :created_at,
  :updated_at,
  :capacity_configuration,
  :document_attribute_configurations,
  :error,
  :index_statistics)
  SENSITIVE = []
  include Aws::Structure
end

#index_statisticsTypes::IndexStatistics

Provides information about the number of documents indexed.



5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5016

class GetIndexResponse < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :index_arn,
  :status,
  :type,
  :description,
  :created_at,
  :updated_at,
  :capacity_configuration,
  :document_attribute_configurations,
  :error,
  :index_statistics)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

Returns:

  • (String)


5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5016

class GetIndexResponse < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :index_arn,
  :status,
  :type,
  :description,
  :created_at,
  :updated_at,
  :capacity_configuration,
  :document_attribute_configurations,
  :error,
  :index_statistics)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The type of index attached to your Amazon Q Business application.

Returns:

  • (String)


5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5016

class GetIndexResponse < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :index_arn,
  :status,
  :type,
  :description,
  :created_at,
  :updated_at,
  :capacity_configuration,
  :document_attribute_configurations,
  :error,
  :index_statistics)
  SENSITIVE = []
  include Aws::Structure
end

#updated_atTime

The Unix timestamp when the Amazon Q Business index was last updated.

Returns:

  • (Time)


5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5016

class GetIndexResponse < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :index_arn,
  :status,
  :type,
  :description,
  :created_at,
  :updated_at,
  :capacity_configuration,
  :document_attribute_configurations,
  :error,
  :index_statistics)
  SENSITIVE = []
  include Aws::Structure
end