DescribeIndexResponse class

Constructors

DescribeIndexResponse({CapacityUnitsConfiguration? capacityUnits, DateTime? createdAt, String? description, List<DocumentMetadataConfiguration>? documentMetadataConfigurations, IndexEdition? edition, String? errorMessage, String? id, IndexStatistics? indexStatistics, String? name, String? roleArn, ServerSideEncryptionConfiguration? serverSideEncryptionConfiguration, IndexStatus? status, DateTime? updatedAt, UserContextPolicy? userContextPolicy, List<UserTokenConfiguration>? userTokenConfigurations})
DescribeIndexResponse.fromJson(Map<String, dynamic> json)
factory

Properties

capacityUnits → CapacityUnitsConfiguration?
For enterprise edtion 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.
final
createdAt → DateTime?
The Unix datetime that the index was created.
final
description → String?
The description of the index.
final
documentMetadataConfigurations → List<DocumentMetadataConfiguration>?
Configuration settings for any metadata applied to the documents in the index.
final
edition → IndexEdition?
The Amazon Kendra edition used for the index. You decide the edition when you create the index.
final
errorMessage → String?
When th eStatus field value is FAILED, the ErrorMessage field contains a message that explains why.
final
hashCode → int
The hash code for this object.
no setterinherited
id → String?
The name of the index.
final
indexStatistics → IndexStatistics?
Provides information about the number of FAQ questions and answers and the number of text documents indexed.
final
name → String?
The name of the index.
final
roleArn → String?
The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon Cloudwatch logs.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serverSideEncryptionConfiguration → ServerSideEncryptionConfiguration?
The identifier of the AWS KMS customer master key (CMK) used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.
final
status → IndexStatus?
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.
final
updatedAt → DateTime?
The Unix datetime that the index was last updated.
final
userContextPolicy → UserContextPolicy?
The user context policy for the Amazon Kendra index.
final
userTokenConfigurations → List<UserTokenConfiguration>?
The user token configuration for the Amazon Kendra index.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited