GetIndexResult class
Result data returned by getIndex.
Constructors
-
GetIndexResult({String? arn, List<
GetIndexCapacityUnit> ? capacityUnits, String? createdAt, String? description, List<GetIndexDocumentMetadataConfigurationUpdate> ? documentMetadataConfigurationUpdates, String? edition, String? errorMessage, String? id, List<GetIndexIndexStatistic> ? indexStatistics, String? name, String? region, String? roleArn, List<GetIndexServerSideEncryptionConfiguration> ? serverSideEncryptionConfigurations, String? status, Map<String, String> ? tags, String? updatedAt, String? userContextPolicy, List<GetIndexUserGroupResolutionConfiguration> ? userGroupResolutionConfigurations, List<GetIndexUserTokenConfiguration> ? userTokenConfigurations}) -
Creates a new GetIndexResult.
arnARN of the Index.capacityUnitsBlock that sets the number of additional document storage and query capacity units that should be used by the index. Documented below.createdAtUnix datetime that the index was created.descriptionDescription of the Index.documentMetadataConfigurationUpdatesOne or more blocks that specify the configuration settings for any metadata applied to the documents in the index. Documented below.editionAmazon Kendra edition for the index.errorMessageWhen the Status field value isFAILED, this contains a message that explains why.idIdentifier of the Index.indexStatisticsBlock that provides information about the number of FAQ questions and answers and the number of text documents indexed. Documented below.nameName of the index field. Minimum length of 1. Maximum length of 30.regionOptional.roleArnAn AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role you use when you call theBatchPutDocumentAPI to index documents from an Amazon S3 bucket.serverSideEncryptionConfigurationsA block that specifies the identifier of the AWS KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs. Documented below.statusCurrent status of the index. When the value isACTIVE, the index is ready for use. If the Status field value isFAILED, theerrorMessagefield contains a message that explains why.tagsMetadata that helps organize the Indices you create.updatedAtUnix datetime that the index was last updated.userContextPolicyUser context policy. Valid values areATTRIBUTE_FILTERorUSER_TOKEN. For more information, refer to UserContextPolicy.userGroupResolutionConfigurationsA block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. Documented below.userTokenConfigurationsA block that specifies the user token configuration. Documented below.const -
GetIndexResult.fromMap(Map<
String, dynamic> map) -
factory
Properties
- arn → String?
-
ARN of the Index.
final
-
capacityUnits
→ List<
GetIndexCapacityUnit> ? -
Block that sets the number of additional document storage and query capacity units that should be used by the index. Documented below.
final
- createdAt → String?
-
Unix datetime that the index was created.
final
- description → String?
-
Description of the Index.
final
-
documentMetadataConfigurationUpdates
→ List<
GetIndexDocumentMetadataConfigurationUpdate> ? -
One or more blocks that specify the configuration settings for any metadata applied to the documents in the index. Documented below.
final
- edition → String?
-
Amazon Kendra edition for the index.
final
- errorMessage → String?
-
When the Status field value is
FAILED, this contains a message that explains why.final - hashCode → int
-
The hash code for this object.
no setterinherited
- id → String?
-
Identifier of the Index.
final
-
indexStatistics
→ List<
GetIndexIndexStatistic> ? -
Block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Documented below.
final
- name → String?
-
Name of the index field. Minimum length of 1. Maximum length of 30.
final
- region → String?
-
final
- roleArn → String?
-
An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role you use when you call the
BatchPutDocumentAPI to index documents from an Amazon S3 bucket.final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
serverSideEncryptionConfigurations
→ List<
GetIndexServerSideEncryptionConfiguration> ? -
A block that specifies the identifier of the AWS KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs. Documented below.
final
- status → String?
-
Current status of the index. When the value is
ACTIVE, the index is ready for use. If the Status field value isFAILED, theerrorMessagefield contains a message that explains why.final -
Metadata that helps organize the Indices you create.
final
- updatedAt → String?
-
Unix datetime that the index was last updated.
final
- userContextPolicy → String?
-
User context policy. Valid values are
ATTRIBUTE_FILTERorUSER_TOKEN. For more information, refer to UserContextPolicy.final -
userGroupResolutionConfigurations
→ List<
GetIndexUserGroupResolutionConfiguration> ? -
A block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. Documented below.
final
-
userTokenConfigurations
→ List<
GetIndexUserTokenConfiguration> ? -
A block that specifies the user token configuration. Documented below.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited