Class: Aws::Kendra::Types::DescribeIndexResponse

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

#capacity_unitsTypes::CapacityUnitsConfiguration

For Enterprise edition indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A 0 for the query capacity or the storage capacity indicates that the index is using the default capacity for the index.



3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3765

class DescribeIndexResponse < Struct.new(
  :name,
  :id,
  :edition,
  :role_arn,
  :server_side_encryption_configuration,
  :status,
  :description,
  :created_at,
  :updated_at,
  :document_metadata_configurations,
  :index_statistics,
  :error_message,
  :capacity_units,
  :user_token_configurations,
  :user_context_policy,
  :user_group_resolution_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#created_atTime

The Unix datetime that the index was created.

Returns:

  • (Time)


3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3765

class DescribeIndexResponse < Struct.new(
  :name,
  :id,
  :edition,
  :role_arn,
  :server_side_encryption_configuration,
  :status,
  :description,
  :created_at,
  :updated_at,
  :document_metadata_configurations,
  :index_statistics,
  :error_message,
  :capacity_units,
  :user_token_configurations,
  :user_context_policy,
  :user_group_resolution_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the index.

Returns:

  • (String)


3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3765

class DescribeIndexResponse < Struct.new(
  :name,
  :id,
  :edition,
  :role_arn,
  :server_side_encryption_configuration,
  :status,
  :description,
  :created_at,
  :updated_at,
  :document_metadata_configurations,
  :index_statistics,
  :error_message,
  :capacity_units,
  :user_token_configurations,
  :user_context_policy,
  :user_group_resolution_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#document_metadata_configurationsArray<Types::DocumentMetadataConfiguration>

Configuration settings for any metadata applied to the documents in the index.



3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3765

class DescribeIndexResponse < Struct.new(
  :name,
  :id,
  :edition,
  :role_arn,
  :server_side_encryption_configuration,
  :status,
  :description,
  :created_at,
  :updated_at,
  :document_metadata_configurations,
  :index_statistics,
  :error_message,
  :capacity_units,
  :user_token_configurations,
  :user_context_policy,
  :user_group_resolution_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#editionString

The Amazon Kendra edition used for the index. You decide the edition when you create the index.

Returns:

  • (String)


3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3765

class DescribeIndexResponse < Struct.new(
  :name,
  :id,
  :edition,
  :role_arn,
  :server_side_encryption_configuration,
  :status,
  :description,
  :created_at,
  :updated_at,
  :document_metadata_configurations,
  :index_statistics,
  :error_message,
  :capacity_units,
  :user_token_configurations,
  :user_context_policy,
  :user_group_resolution_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#error_messageString

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

Returns:

  • (String)


3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3765

class DescribeIndexResponse < Struct.new(
  :name,
  :id,
  :edition,
  :role_arn,
  :server_side_encryption_configuration,
  :status,
  :description,
  :created_at,
  :updated_at,
  :document_metadata_configurations,
  :index_statistics,
  :error_message,
  :capacity_units,
  :user_token_configurations,
  :user_context_policy,
  :user_group_resolution_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#idString

The name of the index.

Returns:

  • (String)


3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3765

class DescribeIndexResponse < Struct.new(
  :name,
  :id,
  :edition,
  :role_arn,
  :server_side_encryption_configuration,
  :status,
  :description,
  :created_at,
  :updated_at,
  :document_metadata_configurations,
  :index_statistics,
  :error_message,
  :capacity_units,
  :user_token_configurations,
  :user_context_policy,
  :user_group_resolution_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#index_statisticsTypes::IndexStatistics

Provides information about the number of FAQ questions and answers and the number of text documents indexed.



3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3765

class DescribeIndexResponse < Struct.new(
  :name,
  :id,
  :edition,
  :role_arn,
  :server_side_encryption_configuration,
  :status,
  :description,
  :created_at,
  :updated_at,
  :document_metadata_configurations,
  :index_statistics,
  :error_message,
  :capacity_units,
  :user_token_configurations,
  :user_context_policy,
  :user_group_resolution_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the index.

Returns:

  • (String)


3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3765

class DescribeIndexResponse < Struct.new(
  :name,
  :id,
  :edition,
  :role_arn,
  :server_side_encryption_configuration,
  :status,
  :description,
  :created_at,
  :updated_at,
  :document_metadata_configurations,
  :index_statistics,
  :error_message,
  :capacity_units,
  :user_token_configurations,
  :user_context_policy,
  :user_group_resolution_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon Cloudwatch logs.

Returns:

  • (String)


3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3765

class DescribeIndexResponse < Struct.new(
  :name,
  :id,
  :edition,
  :role_arn,
  :server_side_encryption_configuration,
  :status,
  :description,
  :created_at,
  :updated_at,
  :document_metadata_configurations,
  :index_statistics,
  :error_message,
  :capacity_units,
  :user_token_configurations,
  :user_context_policy,
  :user_group_resolution_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#server_side_encryption_configurationTypes::ServerSideEncryptionConfiguration

The identifier of the KMScustomer master key (CMK) used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.



3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3765

class DescribeIndexResponse < Struct.new(
  :name,
  :id,
  :edition,
  :role_arn,
  :server_side_encryption_configuration,
  :status,
  :description,
  :created_at,
  :updated_at,
  :document_metadata_configurations,
  :index_statistics,
  :error_message,
  :capacity_units,
  :user_token_configurations,
  :user_context_policy,
  :user_group_resolution_configuration)
  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)


3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3765

class DescribeIndexResponse < Struct.new(
  :name,
  :id,
  :edition,
  :role_arn,
  :server_side_encryption_configuration,
  :status,
  :description,
  :created_at,
  :updated_at,
  :document_metadata_configurations,
  :index_statistics,
  :error_message,
  :capacity_units,
  :user_token_configurations,
  :user_context_policy,
  :user_group_resolution_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#updated_atTime

The Unix datetime that the index was last updated.

Returns:

  • (Time)


3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3765

class DescribeIndexResponse < Struct.new(
  :name,
  :id,
  :edition,
  :role_arn,
  :server_side_encryption_configuration,
  :status,
  :description,
  :created_at,
  :updated_at,
  :document_metadata_configurations,
  :index_statistics,
  :error_message,
  :capacity_units,
  :user_token_configurations,
  :user_context_policy,
  :user_group_resolution_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#user_context_policyString

The user context policy for the Amazon Kendra index.

Returns:

  • (String)


3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3765

class DescribeIndexResponse < Struct.new(
  :name,
  :id,
  :edition,
  :role_arn,
  :server_side_encryption_configuration,
  :status,
  :description,
  :created_at,
  :updated_at,
  :document_metadata_configurations,
  :index_statistics,
  :error_message,
  :capacity_units,
  :user_token_configurations,
  :user_context_policy,
  :user_group_resolution_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#user_group_resolution_configurationTypes::UserGroupResolutionConfiguration

Shows whether you have enabled the configuration for fetching access levels of groups and users from an AWS Single Sign-On identity source.



3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3765

class DescribeIndexResponse < Struct.new(
  :name,
  :id,
  :edition,
  :role_arn,
  :server_side_encryption_configuration,
  :status,
  :description,
  :created_at,
  :updated_at,
  :document_metadata_configurations,
  :index_statistics,
  :error_message,
  :capacity_units,
  :user_token_configurations,
  :user_context_policy,
  :user_group_resolution_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#user_token_configurationsArray<Types::UserTokenConfiguration>

The user token configuration for the Amazon Kendra index.

Returns:



3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3765

class DescribeIndexResponse < Struct.new(
  :name,
  :id,
  :edition,
  :role_arn,
  :server_side_encryption_configuration,
  :status,
  :description,
  :created_at,
  :updated_at,
  :document_metadata_configurations,
  :index_statistics,
  :error_message,
  :capacity_units,
  :user_token_configurations,
  :user_context_policy,
  :user_group_resolution_configuration)
  SENSITIVE = []
  include Aws::Structure
end