Class: Aws::QBusiness::Types::GetIndexResponse
- Inherits:
-
Struct
- Object
- Struct
- Aws::QBusiness::Types::GetIndexResponse
- Defined in:
- gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#application_id ⇒ String
The identifier of the Amazon Q Business application associated with the index.
-
#capacity_configuration ⇒ Types::IndexCapacityConfiguration
The storage capacity units chosen for your Amazon Q Business index.
-
#created_at ⇒ Time
The Unix timestamp when the Amazon Q Business index was created.
-
#description ⇒ String
The description for the Amazon Q Business index.
-
#display_name ⇒ String
The name of the Amazon Q Business index.
-
#document_attribute_configurations ⇒ Array<Types::DocumentAttributeConfiguration>
Configuration information for document attributes or metadata.
-
#error ⇒ Types::ErrorDetail
When the
Status
field value isFAILED
, theErrorMessage
field contains a message that explains why. -
#index_arn ⇒ String
The Amazon Resource Name (ARN) of the Amazon Q Business index.
-
#index_id ⇒ String
The identifier of the Amazon Q Business index.
-
#index_statistics ⇒ Types::IndexStatistics
Provides information about the number of documents indexed.
-
#status ⇒ String
The current status of the index.
-
#type ⇒ String
The type of index attached to your Amazon Q Business application.
-
#updated_at ⇒ Time
The Unix timestamp when the Amazon Q Business index was last updated.
Instance Attribute Details
#application_id ⇒ String
The identifier of the Amazon Q Business application associated with the index.
4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4025 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_configuration ⇒ Types::IndexCapacityConfiguration
The storage capacity units chosen for your Amazon Q Business index.
4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4025 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_at ⇒ Time
The Unix timestamp when the Amazon Q Business index was created.
4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4025 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 |
#description ⇒ String
The description for the Amazon Q Business index.
4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4025 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_name ⇒ String
The name of the Amazon Q Business index.
4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4025 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_configurations ⇒ Array<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.
4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4025 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 |
#error ⇒ Types::ErrorDetail
When the Status
field value is FAILED
, the ErrorMessage
field
contains a message that explains why.
4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4025 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_arn ⇒ String
The Amazon Resource Name (ARN) of the Amazon Q Business index.
4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4025 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_id ⇒ String
The identifier of the Amazon Q Business index.
4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4025 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_statistics ⇒ Types::IndexStatistics
Provides information about the number of documents indexed.
4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4025 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 |
#status ⇒ String
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.
4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4025 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 |
#type ⇒ String
The type of index attached to your Amazon Q Business application.
4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4025 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_at ⇒ Time
The Unix timestamp when the Amazon Q Business index was last updated.
4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4025 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 |