Struct DescribeIndexOutput 

#[non_exhaustive]
pub struct DescribeIndexOutput {

    pub name: Option<String>,
    pub id: Option<String>,
    pub edition: Option<IndexEdition>,
    pub role_arn: Option<String>,
    pub server_side_encryption_configuration: Option<ServerSideEncryptionConfiguration>,
    pub status: Option<IndexStatus>,
    pub description: Option<String>,
    pub created_at: Option<DateTime>,
    pub updated_at: Option<DateTime>,
    pub document_metadata_configurations: Option<Vec<DocumentMetadataConfiguration>>,
    pub index_statistics: Option<IndexStatistics>,
    pub error_message: Option<String>,
    pub capacity_units: Option<CapacityUnitsConfiguration>,
    pub user_token_configurations: Option<Vec<UserTokenConfiguration>>,
    pub user_context_policy: Option<UserContextPolicy>,
    pub user_group_resolution_configuration: Option<UserGroupResolutionConfiguration>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the index.

id: Option<String>

The identifier of the index.

edition: Option<IndexEdition>

The Amazon Kendra edition used for the index. You decide the edition when you create 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 KMS customer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.

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

description: Option<String>

The description for the index.

created_at: Option<DateTime>

The Unix timestamp when the index was created.

updated_at: Option<DateTime>

The Unix timestamp when the index was last updated.

document_metadata_configurations: Option<Vec<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.

index_statistics: Option<IndexStatistics>

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

error_message: Option<String>

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

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

user_token_configurations: Option<Vec<UserTokenConfiguration>>

The user token configuration for the Amazon Kendra index.

user_context_policy: Option<UserContextPolicy>

The user context policy for the Amazon Kendra index.

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

Implementations

impl DescribeIndexOutput

pub fn name(&self) -> Option<&str>

The name of the index.

pub fn id(&self) -> Option<&str>

The identifier of the index.

pub fn edition(&self) -> Option<&IndexEdition>

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

pub fn role_arn(&self) -> Option<&str>

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

pub fn server_side_encryption_configuration( &self, ) -> Option<&ServerSideEncryptionConfiguration>

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

pub fn status(&self) -> Option<&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.

pub fn description(&self) -> Option<&str>

The description for the index.

pub fn created_at(&self) -> Option<&DateTime>

The Unix timestamp when the index was created.

pub fn updated_at(&self) -> Option<&DateTime>

The Unix timestamp when the index was last updated.

pub fn document_metadata_configurations( &self, ) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .document_metadata_configurations.is_none().

pub fn index_statistics(&self) -> Option<&IndexStatistics>

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

pub fn error_message(&self) -> Option<&str>

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

pub fn capacity_units(&self) -> 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 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.

pub fn user_token_configurations(&self) -> &[UserTokenConfiguration]

The user token configuration for the Amazon Kendra index.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .user_token_configurations.is_none().

pub fn user_context_policy(&self) -> Option<&UserContextPolicy>

The user context policy for the Amazon Kendra index.

pub fn user_group_resolution_configuration( &self, ) -> Option<&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.

impl DescribeIndexOutput

pub fn builder() -> DescribeIndexOutputBuilder

Creates a new builder-style object to manufacture DescribeIndexOutput.

Trait Implementations

impl Clone for DescribeIndexOutput

fn clone(&self) -> DescribeIndexOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeIndexOutput

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

Formats the value using the given formatter.

impl PartialEq for DescribeIndexOutput

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for DescribeIndexOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for DescribeIndexOutput