Struct rusoto_kendra::DescribeIndexResponse

pub struct DescribeIndexResponse {

    pub capacity_units: Option<CapacityUnitsConfiguration>,
    pub created_at: Option<f64>,
    pub description: Option<String>,
    pub document_metadata_configurations: Option<Vec<DocumentMetadataConfiguration>>,
    pub edition: Option<String>,
    pub error_message: Option<String>,
    pub id: Option<String>,
    pub index_statistics: Option<IndexStatistics>,
    pub name: Option<String>,
    pub role_arn: Option<String>,
    pub server_side_encryption_configuration: Option<ServerSideEncryptionConfiguration>,
    pub status: Option<String>,
    pub updated_at: Option<f64>,
    pub user_context_policy: Option<String>,
    pub user_token_configurations: Option<Vec<UserTokenConfiguration>>,
}

Fields

capacity_units: Option<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.

created_at: Option<f64>

The Unix datetime that the index was created.

description: Option<String>

The description of the index.

document_metadata_configurations: Option<Vec<DocumentMetadataConfiguration>>

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

edition: Option<String>

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

error_message: Option<String>

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

id: Option<String>

The name of the index.

index_statistics: Option<IndexStatistics>

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

name: Option<String>

The name of the index.

role_arn: Option<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: Option<ServerSideEncryptionConfiguration>

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

status: Option<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.

updated_at: Option<f64>

The Unix datetime that the index was last updated.

user_context_policy: Option<String>

The user context policy for the Amazon Kendra index.

user_token_configurations: Option<Vec<UserTokenConfiguration>>

The user token configuration for the Amazon Kendra index.

Trait Implementations

impl Clone for DescribeIndexResponse

fn clone(&self) -> DescribeIndexResponse

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeIndexResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DescribeIndexResponse

fn default() -> DescribeIndexResponse

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DescribeIndexResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<DescribeIndexResponse> for DescribeIndexResponse

fn eq(&self, other: &DescribeIndexResponse) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DescribeIndexResponse) -> bool

This method tests for !=.

impl StructuralPartialEq for DescribeIndexResponse