AWS SDK for C++  1.9.4
AWS SDK for C++
Public Member Functions | List of all members
Aws::kendra::Model::DescribeIndexResult Class Reference

#include <DescribeIndexResult.h>

Public Member Functions

 DescribeIndexResult ()
 
 DescribeIndexResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
DescribeIndexResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetName () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
DescribeIndexResultWithName (const Aws::String &value)
 
DescribeIndexResultWithName (Aws::String &&value)
 
DescribeIndexResultWithName (const char *value)
 
const Aws::StringGetId () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
DescribeIndexResultWithId (const Aws::String &value)
 
DescribeIndexResultWithId (Aws::String &&value)
 
DescribeIndexResultWithId (const char *value)
 
const IndexEditionGetEdition () const
 
void SetEdition (const IndexEdition &value)
 
void SetEdition (IndexEdition &&value)
 
DescribeIndexResultWithEdition (const IndexEdition &value)
 
DescribeIndexResultWithEdition (IndexEdition &&value)
 
const Aws::StringGetRoleArn () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
DescribeIndexResultWithRoleArn (const Aws::String &value)
 
DescribeIndexResultWithRoleArn (Aws::String &&value)
 
DescribeIndexResultWithRoleArn (const char *value)
 
const ServerSideEncryptionConfigurationGetServerSideEncryptionConfiguration () const
 
void SetServerSideEncryptionConfiguration (const ServerSideEncryptionConfiguration &value)
 
void SetServerSideEncryptionConfiguration (ServerSideEncryptionConfiguration &&value)
 
DescribeIndexResultWithServerSideEncryptionConfiguration (const ServerSideEncryptionConfiguration &value)
 
DescribeIndexResultWithServerSideEncryptionConfiguration (ServerSideEncryptionConfiguration &&value)
 
const IndexStatusGetStatus () const
 
void SetStatus (const IndexStatus &value)
 
void SetStatus (IndexStatus &&value)
 
DescribeIndexResultWithStatus (const IndexStatus &value)
 
DescribeIndexResultWithStatus (IndexStatus &&value)
 
const Aws::StringGetDescription () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
DescribeIndexResultWithDescription (const Aws::String &value)
 
DescribeIndexResultWithDescription (Aws::String &&value)
 
DescribeIndexResultWithDescription (const char *value)
 
const Aws::Utils::DateTimeGetCreatedAt () const
 
void SetCreatedAt (const Aws::Utils::DateTime &value)
 
void SetCreatedAt (Aws::Utils::DateTime &&value)
 
DescribeIndexResultWithCreatedAt (const Aws::Utils::DateTime &value)
 
DescribeIndexResultWithCreatedAt (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetUpdatedAt () const
 
void SetUpdatedAt (const Aws::Utils::DateTime &value)
 
void SetUpdatedAt (Aws::Utils::DateTime &&value)
 
DescribeIndexResultWithUpdatedAt (const Aws::Utils::DateTime &value)
 
DescribeIndexResultWithUpdatedAt (Aws::Utils::DateTime &&value)
 
const Aws::Vector< DocumentMetadataConfiguration > & GetDocumentMetadataConfigurations () const
 
void SetDocumentMetadataConfigurations (const Aws::Vector< DocumentMetadataConfiguration > &value)
 
void SetDocumentMetadataConfigurations (Aws::Vector< DocumentMetadataConfiguration > &&value)
 
DescribeIndexResultWithDocumentMetadataConfigurations (const Aws::Vector< DocumentMetadataConfiguration > &value)
 
DescribeIndexResultWithDocumentMetadataConfigurations (Aws::Vector< DocumentMetadataConfiguration > &&value)
 
DescribeIndexResultAddDocumentMetadataConfigurations (const DocumentMetadataConfiguration &value)
 
DescribeIndexResultAddDocumentMetadataConfigurations (DocumentMetadataConfiguration &&value)
 
const IndexStatisticsGetIndexStatistics () const
 
void SetIndexStatistics (const IndexStatistics &value)
 
void SetIndexStatistics (IndexStatistics &&value)
 
DescribeIndexResultWithIndexStatistics (const IndexStatistics &value)
 
DescribeIndexResultWithIndexStatistics (IndexStatistics &&value)
 
const Aws::StringGetErrorMessage () const
 
void SetErrorMessage (const Aws::String &value)
 
void SetErrorMessage (Aws::String &&value)
 
void SetErrorMessage (const char *value)
 
DescribeIndexResultWithErrorMessage (const Aws::String &value)
 
DescribeIndexResultWithErrorMessage (Aws::String &&value)
 
DescribeIndexResultWithErrorMessage (const char *value)
 
const CapacityUnitsConfigurationGetCapacityUnits () const
 
void SetCapacityUnits (const CapacityUnitsConfiguration &value)
 
void SetCapacityUnits (CapacityUnitsConfiguration &&value)
 
DescribeIndexResultWithCapacityUnits (const CapacityUnitsConfiguration &value)
 
DescribeIndexResultWithCapacityUnits (CapacityUnitsConfiguration &&value)
 
const Aws::Vector< UserTokenConfiguration > & GetUserTokenConfigurations () const
 
void SetUserTokenConfigurations (const Aws::Vector< UserTokenConfiguration > &value)
 
void SetUserTokenConfigurations (Aws::Vector< UserTokenConfiguration > &&value)
 
DescribeIndexResultWithUserTokenConfigurations (const Aws::Vector< UserTokenConfiguration > &value)
 
DescribeIndexResultWithUserTokenConfigurations (Aws::Vector< UserTokenConfiguration > &&value)
 
DescribeIndexResultAddUserTokenConfigurations (const UserTokenConfiguration &value)
 
DescribeIndexResultAddUserTokenConfigurations (UserTokenConfiguration &&value)
 
const UserContextPolicyGetUserContextPolicy () const
 
void SetUserContextPolicy (const UserContextPolicy &value)
 
void SetUserContextPolicy (UserContextPolicy &&value)
 
DescribeIndexResultWithUserContextPolicy (const UserContextPolicy &value)
 
DescribeIndexResultWithUserContextPolicy (UserContextPolicy &&value)
 

Detailed Description

Definition at line 37 of file DescribeIndexResult.h.

Constructor & Destructor Documentation

◆ DescribeIndexResult() [1/2]

Aws::kendra::Model::DescribeIndexResult::DescribeIndexResult ( )

◆ DescribeIndexResult() [2/2]

Aws::kendra::Model::DescribeIndexResult::DescribeIndexResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ AddDocumentMetadataConfigurations() [1/2]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::AddDocumentMetadataConfigurations ( const DocumentMetadataConfiguration value)
inline

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

Definition at line 385 of file DescribeIndexResult.h.

◆ AddDocumentMetadataConfigurations() [2/2]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::AddDocumentMetadataConfigurations ( DocumentMetadataConfiguration &&  value)
inline

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

Definition at line 391 of file DescribeIndexResult.h.

◆ AddUserTokenConfigurations() [1/2]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::AddUserTokenConfigurations ( const UserTokenConfiguration value)
inline

The user token configuration for the Amazon Kendra index.

Definition at line 537 of file DescribeIndexResult.h.

◆ AddUserTokenConfigurations() [2/2]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::AddUserTokenConfigurations ( UserTokenConfiguration &&  value)
inline

The user token configuration for the Amazon Kendra index.

Definition at line 542 of file DescribeIndexResult.h.

◆ GetCapacityUnits()

const CapacityUnitsConfiguration& Aws::kendra::Model::DescribeIndexResult::GetCapacityUnits ( ) const
inline

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.

Definition at line 474 of file DescribeIndexResult.h.

◆ GetCreatedAt()

const Aws::Utils::DateTime& Aws::kendra::Model::DescribeIndexResult::GetCreatedAt ( ) const
inline

The Unix datetime that the index was created.

Definition at line 302 of file DescribeIndexResult.h.

◆ GetDescription()

const Aws::String& Aws::kendra::Model::DescribeIndexResult::GetDescription ( ) const
inline

The description of the index.

Definition at line 266 of file DescribeIndexResult.h.

◆ GetDocumentMetadataConfigurations()

const Aws::Vector<DocumentMetadataConfiguration>& Aws::kendra::Model::DescribeIndexResult::GetDocumentMetadataConfigurations ( ) const
inline

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

Definition at line 355 of file DescribeIndexResult.h.

◆ GetEdition()

const IndexEdition& Aws::kendra::Model::DescribeIndexResult::GetEdition ( ) const
inline

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

Definition at line 121 of file DescribeIndexResult.h.

◆ GetErrorMessage()

const Aws::String& Aws::kendra::Model::DescribeIndexResult::GetErrorMessage ( ) const
inline

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

Definition at line 429 of file DescribeIndexResult.h.

◆ GetId()

const Aws::String& Aws::kendra::Model::DescribeIndexResult::GetId ( ) const
inline

The name of the index.

Definition at line 84 of file DescribeIndexResult.h.

◆ GetIndexStatistics()

const IndexStatistics& Aws::kendra::Model::DescribeIndexResult::GetIndexStatistics ( ) const
inline

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

Definition at line 398 of file DescribeIndexResult.h.

◆ GetName()

const Aws::String& Aws::kendra::Model::DescribeIndexResult::GetName ( ) const
inline

The name of the index.

Definition at line 48 of file DescribeIndexResult.h.

◆ GetRoleArn()

const Aws::String& Aws::kendra::Model::DescribeIndexResult::GetRoleArn ( ) const
inline

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

Definition at line 152 of file DescribeIndexResult.h.

◆ GetServerSideEncryptionConfiguration()

const ServerSideEncryptionConfiguration& Aws::kendra::Model::DescribeIndexResult::GetServerSideEncryptionConfiguration ( ) const
inline

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

Definition at line 195 of file DescribeIndexResult.h.

◆ GetStatus()

const IndexStatus& Aws::kendra::Model::DescribeIndexResult::GetStatus ( ) const
inline

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.

Definition at line 228 of file DescribeIndexResult.h.

◆ GetUpdatedAt()

const Aws::Utils::DateTime& Aws::kendra::Model::DescribeIndexResult::GetUpdatedAt ( ) const
inline

The Unix datetime that the index was last updated.

Definition at line 328 of file DescribeIndexResult.h.

◆ GetUserContextPolicy()

const UserContextPolicy& Aws::kendra::Model::DescribeIndexResult::GetUserContextPolicy ( ) const
inline

The user context policy for the Amazon Kendra index.

Definition at line 548 of file DescribeIndexResult.h.

◆ GetUserTokenConfigurations()

const Aws::Vector<UserTokenConfiguration>& Aws::kendra::Model::DescribeIndexResult::GetUserTokenConfigurations ( ) const
inline

The user token configuration for the Amazon Kendra index.

Definition at line 512 of file DescribeIndexResult.h.

◆ operator=()

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetCapacityUnits() [1/2]

void Aws::kendra::Model::DescribeIndexResult::SetCapacityUnits ( CapacityUnitsConfiguration &&  value)
inline

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.

Definition at line 490 of file DescribeIndexResult.h.

◆ SetCapacityUnits() [2/2]

void Aws::kendra::Model::DescribeIndexResult::SetCapacityUnits ( const CapacityUnitsConfiguration value)
inline

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.

Definition at line 482 of file DescribeIndexResult.h.

◆ SetCreatedAt() [1/2]

void Aws::kendra::Model::DescribeIndexResult::SetCreatedAt ( Aws::Utils::DateTime &&  value)
inline

The Unix datetime that the index was created.

Definition at line 312 of file DescribeIndexResult.h.

◆ SetCreatedAt() [2/2]

void Aws::kendra::Model::DescribeIndexResult::SetCreatedAt ( const Aws::Utils::DateTime value)
inline

The Unix datetime that the index was created.

Definition at line 307 of file DescribeIndexResult.h.

◆ SetDescription() [1/3]

void Aws::kendra::Model::DescribeIndexResult::SetDescription ( Aws::String &&  value)
inline

The description of the index.

Definition at line 276 of file DescribeIndexResult.h.

◆ SetDescription() [2/3]

void Aws::kendra::Model::DescribeIndexResult::SetDescription ( const Aws::String value)
inline

The description of the index.

Definition at line 271 of file DescribeIndexResult.h.

◆ SetDescription() [3/3]

void Aws::kendra::Model::DescribeIndexResult::SetDescription ( const char *  value)
inline

The description of the index.

Definition at line 281 of file DescribeIndexResult.h.

◆ SetDocumentMetadataConfigurations() [1/2]

void Aws::kendra::Model::DescribeIndexResult::SetDocumentMetadataConfigurations ( Aws::Vector< DocumentMetadataConfiguration > &&  value)
inline

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

Definition at line 367 of file DescribeIndexResult.h.

◆ SetDocumentMetadataConfigurations() [2/2]

void Aws::kendra::Model::DescribeIndexResult::SetDocumentMetadataConfigurations ( const Aws::Vector< DocumentMetadataConfiguration > &  value)
inline

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

Definition at line 361 of file DescribeIndexResult.h.

◆ SetEdition() [1/2]

void Aws::kendra::Model::DescribeIndexResult::SetEdition ( const IndexEdition value)
inline

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

Definition at line 127 of file DescribeIndexResult.h.

◆ SetEdition() [2/2]

void Aws::kendra::Model::DescribeIndexResult::SetEdition ( IndexEdition &&  value)
inline

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

Definition at line 133 of file DescribeIndexResult.h.

◆ SetErrorMessage() [1/3]

void Aws::kendra::Model::DescribeIndexResult::SetErrorMessage ( Aws::String &&  value)
inline

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

Definition at line 441 of file DescribeIndexResult.h.

◆ SetErrorMessage() [2/3]

void Aws::kendra::Model::DescribeIndexResult::SetErrorMessage ( const Aws::String value)
inline

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

Definition at line 435 of file DescribeIndexResult.h.

◆ SetErrorMessage() [3/3]

void Aws::kendra::Model::DescribeIndexResult::SetErrorMessage ( const char *  value)
inline

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

Definition at line 447 of file DescribeIndexResult.h.

◆ SetId() [1/3]

void Aws::kendra::Model::DescribeIndexResult::SetId ( Aws::String &&  value)
inline

The name of the index.

Definition at line 94 of file DescribeIndexResult.h.

◆ SetId() [2/3]

void Aws::kendra::Model::DescribeIndexResult::SetId ( const Aws::String value)
inline

The name of the index.

Definition at line 89 of file DescribeIndexResult.h.

◆ SetId() [3/3]

void Aws::kendra::Model::DescribeIndexResult::SetId ( const char *  value)
inline

The name of the index.

Definition at line 99 of file DescribeIndexResult.h.

◆ SetIndexStatistics() [1/2]

void Aws::kendra::Model::DescribeIndexResult::SetIndexStatistics ( const IndexStatistics value)
inline

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

Definition at line 404 of file DescribeIndexResult.h.

◆ SetIndexStatistics() [2/2]

void Aws::kendra::Model::DescribeIndexResult::SetIndexStatistics ( IndexStatistics &&  value)
inline

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

Definition at line 410 of file DescribeIndexResult.h.

◆ SetName() [1/3]

void Aws::kendra::Model::DescribeIndexResult::SetName ( Aws::String &&  value)
inline

The name of the index.

Definition at line 58 of file DescribeIndexResult.h.

◆ SetName() [2/3]

void Aws::kendra::Model::DescribeIndexResult::SetName ( const Aws::String value)
inline

The name of the index.

Definition at line 53 of file DescribeIndexResult.h.

◆ SetName() [3/3]

void Aws::kendra::Model::DescribeIndexResult::SetName ( const char *  value)
inline

The name of the index.

Definition at line 63 of file DescribeIndexResult.h.

◆ SetRoleArn() [1/3]

void Aws::kendra::Model::DescribeIndexResult::SetRoleArn ( Aws::String &&  value)
inline

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

Definition at line 164 of file DescribeIndexResult.h.

◆ SetRoleArn() [2/3]

void Aws::kendra::Model::DescribeIndexResult::SetRoleArn ( const Aws::String value)
inline

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

Definition at line 158 of file DescribeIndexResult.h.

◆ SetRoleArn() [3/3]

void Aws::kendra::Model::DescribeIndexResult::SetRoleArn ( const char *  value)
inline

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

Definition at line 170 of file DescribeIndexResult.h.

◆ SetServerSideEncryptionConfiguration() [1/2]

void Aws::kendra::Model::DescribeIndexResult::SetServerSideEncryptionConfiguration ( const ServerSideEncryptionConfiguration value)
inline

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

Definition at line 201 of file DescribeIndexResult.h.

◆ SetServerSideEncryptionConfiguration() [2/2]

void Aws::kendra::Model::DescribeIndexResult::SetServerSideEncryptionConfiguration ( ServerSideEncryptionConfiguration &&  value)
inline

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

Definition at line 207 of file DescribeIndexResult.h.

◆ SetStatus() [1/2]

void Aws::kendra::Model::DescribeIndexResult::SetStatus ( const IndexStatus value)
inline

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.

Definition at line 236 of file DescribeIndexResult.h.

◆ SetStatus() [2/2]

void Aws::kendra::Model::DescribeIndexResult::SetStatus ( IndexStatus &&  value)
inline

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.

Definition at line 244 of file DescribeIndexResult.h.

◆ SetUpdatedAt() [1/2]

void Aws::kendra::Model::DescribeIndexResult::SetUpdatedAt ( Aws::Utils::DateTime &&  value)
inline

The Unix datetime that the index was last updated.

Definition at line 338 of file DescribeIndexResult.h.

◆ SetUpdatedAt() [2/2]

void Aws::kendra::Model::DescribeIndexResult::SetUpdatedAt ( const Aws::Utils::DateTime value)
inline

The Unix datetime that the index was last updated.

Definition at line 333 of file DescribeIndexResult.h.

◆ SetUserContextPolicy() [1/2]

void Aws::kendra::Model::DescribeIndexResult::SetUserContextPolicy ( const UserContextPolicy value)
inline

The user context policy for the Amazon Kendra index.

Definition at line 553 of file DescribeIndexResult.h.

◆ SetUserContextPolicy() [2/2]

void Aws::kendra::Model::DescribeIndexResult::SetUserContextPolicy ( UserContextPolicy &&  value)
inline

The user context policy for the Amazon Kendra index.

Definition at line 558 of file DescribeIndexResult.h.

◆ SetUserTokenConfigurations() [1/2]

void Aws::kendra::Model::DescribeIndexResult::SetUserTokenConfigurations ( Aws::Vector< UserTokenConfiguration > &&  value)
inline

The user token configuration for the Amazon Kendra index.

Definition at line 522 of file DescribeIndexResult.h.

◆ SetUserTokenConfigurations() [2/2]

void Aws::kendra::Model::DescribeIndexResult::SetUserTokenConfigurations ( const Aws::Vector< UserTokenConfiguration > &  value)
inline

The user token configuration for the Amazon Kendra index.

Definition at line 517 of file DescribeIndexResult.h.

◆ WithCapacityUnits() [1/2]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithCapacityUnits ( CapacityUnitsConfiguration &&  value)
inline

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.

Definition at line 506 of file DescribeIndexResult.h.

◆ WithCapacityUnits() [2/2]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithCapacityUnits ( const CapacityUnitsConfiguration value)
inline

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.

Definition at line 498 of file DescribeIndexResult.h.

◆ WithCreatedAt() [1/2]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithCreatedAt ( Aws::Utils::DateTime &&  value)
inline

The Unix datetime that the index was created.

Definition at line 322 of file DescribeIndexResult.h.

◆ WithCreatedAt() [2/2]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithCreatedAt ( const Aws::Utils::DateTime value)
inline

The Unix datetime that the index was created.

Definition at line 317 of file DescribeIndexResult.h.

◆ WithDescription() [1/3]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithDescription ( Aws::String &&  value)
inline

The description of the index.

Definition at line 291 of file DescribeIndexResult.h.

◆ WithDescription() [2/3]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithDescription ( const Aws::String value)
inline

The description of the index.

Definition at line 286 of file DescribeIndexResult.h.

◆ WithDescription() [3/3]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithDescription ( const char *  value)
inline

The description of the index.

Definition at line 296 of file DescribeIndexResult.h.

◆ WithDocumentMetadataConfigurations() [1/2]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithDocumentMetadataConfigurations ( Aws::Vector< DocumentMetadataConfiguration > &&  value)
inline

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

Definition at line 379 of file DescribeIndexResult.h.

◆ WithDocumentMetadataConfigurations() [2/2]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithDocumentMetadataConfigurations ( const Aws::Vector< DocumentMetadataConfiguration > &  value)
inline

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

Definition at line 373 of file DescribeIndexResult.h.

◆ WithEdition() [1/2]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithEdition ( const IndexEdition value)
inline

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

Definition at line 139 of file DescribeIndexResult.h.

◆ WithEdition() [2/2]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithEdition ( IndexEdition &&  value)
inline

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

Definition at line 145 of file DescribeIndexResult.h.

◆ WithErrorMessage() [1/3]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithErrorMessage ( Aws::String &&  value)
inline

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

Definition at line 459 of file DescribeIndexResult.h.

◆ WithErrorMessage() [2/3]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithErrorMessage ( const Aws::String value)
inline

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

Definition at line 453 of file DescribeIndexResult.h.

◆ WithErrorMessage() [3/3]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithErrorMessage ( const char *  value)
inline

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

Definition at line 465 of file DescribeIndexResult.h.

◆ WithId() [1/3]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithId ( Aws::String &&  value)
inline

The name of the index.

Definition at line 109 of file DescribeIndexResult.h.

◆ WithId() [2/3]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithId ( const Aws::String value)
inline

The name of the index.

Definition at line 104 of file DescribeIndexResult.h.

◆ WithId() [3/3]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithId ( const char *  value)
inline

The name of the index.

Definition at line 114 of file DescribeIndexResult.h.

◆ WithIndexStatistics() [1/2]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithIndexStatistics ( const IndexStatistics value)
inline

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

Definition at line 416 of file DescribeIndexResult.h.

◆ WithIndexStatistics() [2/2]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithIndexStatistics ( IndexStatistics &&  value)
inline

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

Definition at line 422 of file DescribeIndexResult.h.

◆ WithName() [1/3]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithName ( Aws::String &&  value)
inline

The name of the index.

Definition at line 73 of file DescribeIndexResult.h.

◆ WithName() [2/3]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithName ( const Aws::String value)
inline

The name of the index.

Definition at line 68 of file DescribeIndexResult.h.

◆ WithName() [3/3]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithName ( const char *  value)
inline

The name of the index.

Definition at line 78 of file DescribeIndexResult.h.

◆ WithRoleArn() [1/3]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithRoleArn ( Aws::String &&  value)
inline

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

Definition at line 182 of file DescribeIndexResult.h.

◆ WithRoleArn() [2/3]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithRoleArn ( const Aws::String value)
inline

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

Definition at line 176 of file DescribeIndexResult.h.

◆ WithRoleArn() [3/3]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithRoleArn ( const char *  value)
inline

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

Definition at line 188 of file DescribeIndexResult.h.

◆ WithServerSideEncryptionConfiguration() [1/2]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithServerSideEncryptionConfiguration ( const ServerSideEncryptionConfiguration value)
inline

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

Definition at line 213 of file DescribeIndexResult.h.

◆ WithServerSideEncryptionConfiguration() [2/2]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithServerSideEncryptionConfiguration ( ServerSideEncryptionConfiguration &&  value)
inline

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

Definition at line 219 of file DescribeIndexResult.h.

◆ WithStatus() [1/2]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithStatus ( const IndexStatus value)
inline

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.

Definition at line 252 of file DescribeIndexResult.h.

◆ WithStatus() [2/2]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithStatus ( IndexStatus &&  value)
inline

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.

Definition at line 260 of file DescribeIndexResult.h.

◆ WithUpdatedAt() [1/2]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithUpdatedAt ( Aws::Utils::DateTime &&  value)
inline

The Unix datetime that the index was last updated.

Definition at line 348 of file DescribeIndexResult.h.

◆ WithUpdatedAt() [2/2]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithUpdatedAt ( const Aws::Utils::DateTime value)
inline

The Unix datetime that the index was last updated.

Definition at line 343 of file DescribeIndexResult.h.

◆ WithUserContextPolicy() [1/2]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithUserContextPolicy ( const UserContextPolicy value)
inline

The user context policy for the Amazon Kendra index.

Definition at line 563 of file DescribeIndexResult.h.

◆ WithUserContextPolicy() [2/2]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithUserContextPolicy ( UserContextPolicy &&  value)
inline

The user context policy for the Amazon Kendra index.

Definition at line 568 of file DescribeIndexResult.h.

◆ WithUserTokenConfigurations() [1/2]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithUserTokenConfigurations ( Aws::Vector< UserTokenConfiguration > &&  value)
inline

The user token configuration for the Amazon Kendra index.

Definition at line 532 of file DescribeIndexResult.h.

◆ WithUserTokenConfigurations() [2/2]

DescribeIndexResult& Aws::kendra::Model::DescribeIndexResult::WithUserTokenConfigurations ( const Aws::Vector< UserTokenConfiguration > &  value)
inline

The user token configuration for the Amazon Kendra index.

Definition at line 527 of file DescribeIndexResult.h.


The documentation for this class was generated from the following file: