Struct GetIndexOutput 

#[non_exhaustive]
pub struct GetIndexOutput {

    pub application_id: Option<String>,
    pub index_id: Option<String>,
    pub display_name: Option<String>,
    pub index_arn: Option<String>,
    pub status: Option<IndexStatus>,
    pub type: Option<IndexType>,
    pub description: Option<String>,
    pub created_at: Option<DateTime>,
    pub updated_at: Option<DateTime>,
    pub capacity_configuration: Option<IndexCapacityConfiguration>,
    pub document_attribute_configurations: Option<Vec<DocumentAttributeConfiguration>>,
    pub error: Option<ErrorDetail>,
    pub index_statistics: Option<IndexStatistics>,
    /* 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.

application_id: Option<String>

The identifier of the Amazon Q Business application associated with the index.

index_id: Option<String>

The identifier of the Amazon Q Business index.

display_name: Option<String>

The name of the Amazon Q Business index.

index_arn: Option<String>

The Amazon Resource Name (ARN) of the Amazon Q Business index.

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.

type: Option<IndexType>

The type of index attached to your Amazon Q Business application.

description: Option<String>

The description for the Amazon Q Business index.

created_at: Option<DateTime>

The Unix timestamp when the Amazon Q Business index was created.

updated_at: Option<DateTime>

The Unix timestamp when the Amazon Q Business index was last updated.

capacity_configuration: Option<IndexCapacityConfiguration>

The storage capacity units chosen for your Amazon Q Business index.

document_attribute_configurations: Option<Vec<DocumentAttributeConfiguration>>

Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

error: Option<ErrorDetail>

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

index_statistics: Option<IndexStatistics>

Provides information about the number of documents indexed.

Implementations

impl GetIndexOutput

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

The identifier of the Amazon Q Business application associated with the index.

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

The identifier of the Amazon Q Business index.

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

The name of the Amazon Q Business index.

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

The Amazon Resource Name (ARN) of the Amazon Q Business index.

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 type(&self) -> Option<&IndexType>

The type of index attached to your Amazon Q Business application.

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

The description for the Amazon Q Business index.

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

The Unix timestamp when the Amazon Q Business index was created.

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

The Unix timestamp when the Amazon Q Business index was last updated.

pub fn capacity_configuration(&self) -> Option<&IndexCapacityConfiguration>

The storage capacity units chosen for your Amazon Q Business index.

pub fn document_attribute_configurations( &self, ) -> &[DocumentAttributeConfiguration]

Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

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_attribute_configurations.is_none().

pub fn error(&self) -> Option<&ErrorDetail>

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

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

Provides information about the number of documents indexed.

impl GetIndexOutput

pub fn builder() -> GetIndexOutputBuilder

Creates a new builder-style object to manufacture GetIndexOutput.

Trait Implementations

impl Clone for GetIndexOutput

fn clone(&self) -> GetIndexOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetIndexOutput

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

Formats the value using the given formatter.

impl PartialEq for GetIndexOutput

fn eq(&self, other: &GetIndexOutput) -> 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 GetIndexOutput

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

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

impl StructuralPartialEq for GetIndexOutput