DescribeIndexResponse Structure Reference


                    
                    
                    _members

Declaration

Swift

public static var _members: [AWSShapeMember]


                    
                    
                    capacityUnits

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.

Declaration

Swift

public let capacityUnits: CapacityUnitsConfiguration?


                    
                    
                    createdAt

The Unix datetime that the index was created.

Declaration

Swift

public let createdAt: TimeStamp?


                    
                    
                    description

The description of the index.

Declaration

Swift

public let description: String?


                    
                    
                    documentMetadataConfigurations

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

Declaration

Swift

public let documentMetadataConfigurations: [DocumentMetadataConfiguration]?


                    
                    
                    edition

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

Declaration

Swift

public let edition: IndexEdition?


                    
                    
                    errorMessage

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

Declaration

Swift

public let errorMessage: String?

id

the name of the index.

Declaration

Swift

public let id: String?


                    
                    
                    indexStatistics

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

Declaration

Swift

public let indexStatistics: IndexStatistics?


                    
                    
                    name

The name of the index.

Declaration

Swift

public let name: String?


                    
                    
                    roleArn

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

Declaration

Swift

public let roleArn: String?


                    
                    
                    serverSideEncryptionConfiguration

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

Declaration

Swift

public let serverSideEncryptionConfiguration: ServerSideEncryptionConfiguration?


                    
                    
                    status

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.

Declaration

Swift

public let status: IndexStatus?


                    
                    
                    updatedAt

The Unix datetime that the index was last updated.

Declaration

Swift

public let updatedAt: TimeStamp?


                    
                    
                    init(capacityUnits:createdAt:description:documentMetadataConfigurations:edition:errorMessage:id:indexStatistics:name:roleArn:serverSideEncryptionConfiguration:status:updatedAt:)

Undocumented

Declaration

Swift

public init(capacityUnits: CapacityUnitsConfiguration? = nil, createdAt: TimeStamp? = nil, description: String? = nil, documentMetadataConfigurations: [DocumentMetadataConfiguration]? = nil, edition: IndexEdition? = nil, errorMessage: String? = nil, id: String? = nil, indexStatistics: IndexStatistics? = nil, name: String? = nil, roleArn: String? = nil, serverSideEncryptionConfiguration: ServerSideEncryptionConfiguration? = nil, status: IndexStatus? = nil, updatedAt: TimeStamp? = nil)