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

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::DescribeIndexResponse

Defined in:

gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #capacity_units ⇒ Types::CapacityUnitsConfiguration

  For Enterprise Edition indexes, you can choose to use additional capacity to meet the needs of your application.

• #created_at ⇒ Time

  The Unix timestamp when the index was created.

• #description ⇒ String

  The description for the index.

• #document_metadata_configurations ⇒ Array<Types::DocumentMetadataConfiguration>

  Configuration information for document metadata or fields.

• #edition ⇒ String

  The Amazon Kendra edition used for the index.

• #error_message ⇒ String

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

• #id ⇒ String

  The identifier of the index.

• #index_statistics ⇒ Types::IndexStatistics

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

• #name ⇒ String

  The name of the index.

• #role_arn ⇒ String

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

• #server_side_encryption_configuration ⇒ Types::ServerSideEncryptionConfiguration

  The identifier of the KMS customer master key (CMK) that is used to encrypt your data.

• #status ⇒ String

  The current status of the index.

• #updated_at ⇒ Time

  The Unix timestamp when the index was last updated.

• #user_context_policy ⇒ String

  The user context policy for the Amazon Kendra index.

• #user_group_resolution_configuration ⇒ Types::UserGroupResolutionConfiguration

  Whether you have enabled IAM Identity Center identity source for your users and groups.

• #user_token_configurations ⇒ Array<Types::UserTokenConfiguration>

  The user token configuration for the Amazon Kendra index.

Instance Attribute Details

#capacity_units ⇒ Types::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 query or document storage capacity of zero indicates that the index is using the default capacity. For more information on the default capacity for an index and adjusting this, see Adjusting capacity.

Returns:

• (Types::CapacityUnitsConfiguration)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3974

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_at ⇒ Time

The Unix timestamp when the index was created.

Returns:

• (Time)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3974

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

#description ⇒ String

The description for the index.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3974

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_configurations ⇒ Array<Types::DocumentMetadataConfiguration>

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

Returns:

• (Array<Types::DocumentMetadataConfiguration>)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3974

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

#edition ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3974

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_message ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3974

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

#id ⇒ String

The identifier of the index.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3974

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_statistics ⇒ Types::IndexStatistics

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

Returns:

• (Types::IndexStatistics)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3974

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

#name ⇒ String

The name of the index.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3974

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_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3974

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_configuration ⇒ Types::ServerSideEncryptionConfiguration

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

Returns:

• (Types::ServerSideEncryptionConfiguration)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3974

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

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

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3974

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_at ⇒ Time

The Unix timestamp when the index was last updated.

Returns:

• (Time)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3974

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_policy ⇒ String

The user context policy for the Amazon Kendra index.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3974

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_configuration ⇒ Types::UserGroupResolutionConfiguration

Whether you have enabled IAM Identity Center identity source for your users and groups. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Returns:

• (Types::UserGroupResolutionConfiguration)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3974

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_configurations ⇒ Array<Types::UserTokenConfiguration>

The user token configuration for the Amazon Kendra index.

Returns:

• (Array<Types::UserTokenConfiguration>)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3974

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