AWS SDK for C++  1.9.68
AWS SDK for C++
Public Member Functions | List of all members
Aws::LexModelBuildingService::Model::KendraConfiguration Class Reference

#include <KendraConfiguration.h>

Public Member Functions

 KendraConfiguration ()
 
 KendraConfiguration (Aws::Utils::Json::JsonView jsonValue)
 
KendraConfigurationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetKendraIndex () const
 
bool KendraIndexHasBeenSet () const
 
void SetKendraIndex (const Aws::String &value)
 
void SetKendraIndex (Aws::String &&value)
 
void SetKendraIndex (const char *value)
 
KendraConfigurationWithKendraIndex (const Aws::String &value)
 
KendraConfigurationWithKendraIndex (Aws::String &&value)
 
KendraConfigurationWithKendraIndex (const char *value)
 
const Aws::StringGetQueryFilterString () const
 
bool QueryFilterStringHasBeenSet () const
 
void SetQueryFilterString (const Aws::String &value)
 
void SetQueryFilterString (Aws::String &&value)
 
void SetQueryFilterString (const char *value)
 
KendraConfigurationWithQueryFilterString (const Aws::String &value)
 
KendraConfigurationWithQueryFilterString (Aws::String &&value)
 
KendraConfigurationWithQueryFilterString (const char *value)
 
const Aws::StringGetRole () const
 
bool RoleHasBeenSet () const
 
void SetRole (const Aws::String &value)
 
void SetRole (Aws::String &&value)
 
void SetRole (const char *value)
 
KendraConfigurationWithRole (const Aws::String &value)
 
KendraConfigurationWithRole (Aws::String &&value)
 
KendraConfigurationWithRole (const char *value)
 

Detailed Description

Provides configuration information for the AMAZON.KendraSearchIntent intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user's utterance. For more information, see AMAZON.KendraSearchIntent.

See Also:

AWS API Reference

Definition at line 36 of file KendraConfiguration.h.

Constructor & Destructor Documentation

◆ KendraConfiguration() [1/2]

Aws::LexModelBuildingService::Model::KendraConfiguration::KendraConfiguration ( )

◆ KendraConfiguration() [2/2]

Aws::LexModelBuildingService::Model::KendraConfiguration::KendraConfiguration ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetKendraIndex()

const Aws::String& Aws::LexModelBuildingService::Model::KendraConfiguration::GetKendraIndex ( ) const
inline

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot. If the Amazon Kendra index does not exist, you get an exception when you call the PutIntent operation.

Definition at line 52 of file KendraConfiguration.h.

◆ GetQueryFilterString()

const Aws::String& Aws::LexModelBuildingService::Model::KendraConfiguration::GetQueryFilterString ( ) const
inline

A query filter that Amazon Lex sends to Amazon Kendra to filter the response from the query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.

You can override this filter string with a new filter string at runtime.

Definition at line 126 of file KendraConfiguration.h.

◆ GetRole()

const Aws::String& Aws::LexModelBuildingService::Model::KendraConfiguration::GetRole ( ) const
inline

The Amazon Resource Name (ARN) of an IAM role that has permission to search the Amazon Kendra index. The role must be in the same account and Region as the Amazon Lex bot. If the role does not exist, you get an exception when you call the PutIntent operation.

Definition at line 205 of file KendraConfiguration.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::LexModelBuildingService::Model::KendraConfiguration::Jsonize ( ) const

◆ KendraIndexHasBeenSet()

bool Aws::LexModelBuildingService::Model::KendraConfiguration::KendraIndexHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot. If the Amazon Kendra index does not exist, you get an exception when you call the PutIntent operation.

Definition at line 61 of file KendraConfiguration.h.

◆ operator=()

KendraConfiguration& Aws::LexModelBuildingService::Model::KendraConfiguration::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ QueryFilterStringHasBeenSet()

bool Aws::LexModelBuildingService::Model::KendraConfiguration::QueryFilterStringHasBeenSet ( ) const
inline

A query filter that Amazon Lex sends to Amazon Kendra to filter the response from the query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.

You can override this filter string with a new filter string at runtime.

Definition at line 136 of file KendraConfiguration.h.

◆ RoleHasBeenSet()

bool Aws::LexModelBuildingService::Model::KendraConfiguration::RoleHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of an IAM role that has permission to search the Amazon Kendra index. The role must be in the same account and Region as the Amazon Lex bot. If the role does not exist, you get an exception when you call the PutIntent operation.

Definition at line 213 of file KendraConfiguration.h.

◆ SetKendraIndex() [1/3]

void Aws::LexModelBuildingService::Model::KendraConfiguration::SetKendraIndex ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot. If the Amazon Kendra index does not exist, you get an exception when you call the PutIntent operation.

Definition at line 79 of file KendraConfiguration.h.

◆ SetKendraIndex() [2/3]

void Aws::LexModelBuildingService::Model::KendraConfiguration::SetKendraIndex ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot. If the Amazon Kendra index does not exist, you get an exception when you call the PutIntent operation.

Definition at line 70 of file KendraConfiguration.h.

◆ SetKendraIndex() [3/3]

void Aws::LexModelBuildingService::Model::KendraConfiguration::SetKendraIndex ( const char *  value)
inline

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot. If the Amazon Kendra index does not exist, you get an exception when you call the PutIntent operation.

Definition at line 88 of file KendraConfiguration.h.

◆ SetQueryFilterString() [1/3]

void Aws::LexModelBuildingService::Model::KendraConfiguration::SetQueryFilterString ( Aws::String &&  value)
inline

A query filter that Amazon Lex sends to Amazon Kendra to filter the response from the query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.

You can override this filter string with a new filter string at runtime.

Definition at line 156 of file KendraConfiguration.h.

◆ SetQueryFilterString() [2/3]

void Aws::LexModelBuildingService::Model::KendraConfiguration::SetQueryFilterString ( const Aws::String value)
inline

A query filter that Amazon Lex sends to Amazon Kendra to filter the response from the query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.

You can override this filter string with a new filter string at runtime.

Definition at line 146 of file KendraConfiguration.h.

◆ SetQueryFilterString() [3/3]

void Aws::LexModelBuildingService::Model::KendraConfiguration::SetQueryFilterString ( const char *  value)
inline

A query filter that Amazon Lex sends to Amazon Kendra to filter the response from the query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.

You can override this filter string with a new filter string at runtime.

Definition at line 166 of file KendraConfiguration.h.

◆ SetRole() [1/3]

void Aws::LexModelBuildingService::Model::KendraConfiguration::SetRole ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of an IAM role that has permission to search the Amazon Kendra index. The role must be in the same account and Region as the Amazon Lex bot. If the role does not exist, you get an exception when you call the PutIntent operation.

Definition at line 229 of file KendraConfiguration.h.

◆ SetRole() [2/3]

void Aws::LexModelBuildingService::Model::KendraConfiguration::SetRole ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of an IAM role that has permission to search the Amazon Kendra index. The role must be in the same account and Region as the Amazon Lex bot. If the role does not exist, you get an exception when you call the PutIntent operation.

Definition at line 221 of file KendraConfiguration.h.

◆ SetRole() [3/3]

void Aws::LexModelBuildingService::Model::KendraConfiguration::SetRole ( const char *  value)
inline

The Amazon Resource Name (ARN) of an IAM role that has permission to search the Amazon Kendra index. The role must be in the same account and Region as the Amazon Lex bot. If the role does not exist, you get an exception when you call the PutIntent operation.

Definition at line 237 of file KendraConfiguration.h.

◆ WithKendraIndex() [1/3]

KendraConfiguration& Aws::LexModelBuildingService::Model::KendraConfiguration::WithKendraIndex ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot. If the Amazon Kendra index does not exist, you get an exception when you call the PutIntent operation.

Definition at line 106 of file KendraConfiguration.h.

◆ WithKendraIndex() [2/3]

KendraConfiguration& Aws::LexModelBuildingService::Model::KendraConfiguration::WithKendraIndex ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot. If the Amazon Kendra index does not exist, you get an exception when you call the PutIntent operation.

Definition at line 97 of file KendraConfiguration.h.

◆ WithKendraIndex() [3/3]

KendraConfiguration& Aws::LexModelBuildingService::Model::KendraConfiguration::WithKendraIndex ( const char *  value)
inline

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot. If the Amazon Kendra index does not exist, you get an exception when you call the PutIntent operation.

Definition at line 115 of file KendraConfiguration.h.

◆ WithQueryFilterString() [1/3]

KendraConfiguration& Aws::LexModelBuildingService::Model::KendraConfiguration::WithQueryFilterString ( Aws::String &&  value)
inline

A query filter that Amazon Lex sends to Amazon Kendra to filter the response from the query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.

You can override this filter string with a new filter string at runtime.

Definition at line 186 of file KendraConfiguration.h.

◆ WithQueryFilterString() [2/3]

KendraConfiguration& Aws::LexModelBuildingService::Model::KendraConfiguration::WithQueryFilterString ( const Aws::String value)
inline

A query filter that Amazon Lex sends to Amazon Kendra to filter the response from the query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.

You can override this filter string with a new filter string at runtime.

Definition at line 176 of file KendraConfiguration.h.

◆ WithQueryFilterString() [3/3]

KendraConfiguration& Aws::LexModelBuildingService::Model::KendraConfiguration::WithQueryFilterString ( const char *  value)
inline

A query filter that Amazon Lex sends to Amazon Kendra to filter the response from the query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.

You can override this filter string with a new filter string at runtime.

Definition at line 196 of file KendraConfiguration.h.

◆ WithRole() [1/3]

KendraConfiguration& Aws::LexModelBuildingService::Model::KendraConfiguration::WithRole ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of an IAM role that has permission to search the Amazon Kendra index. The role must be in the same account and Region as the Amazon Lex bot. If the role does not exist, you get an exception when you call the PutIntent operation.

Definition at line 253 of file KendraConfiguration.h.

◆ WithRole() [2/3]

KendraConfiguration& Aws::LexModelBuildingService::Model::KendraConfiguration::WithRole ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of an IAM role that has permission to search the Amazon Kendra index. The role must be in the same account and Region as the Amazon Lex bot. If the role does not exist, you get an exception when you call the PutIntent operation.

Definition at line 245 of file KendraConfiguration.h.

◆ WithRole() [3/3]

KendraConfiguration& Aws::LexModelBuildingService::Model::KendraConfiguration::WithRole ( const char *  value)
inline

The Amazon Resource Name (ARN) of an IAM role that has permission to search the Amazon Kendra index. The role must be in the same account and Region as the Amazon Lex bot. If the role does not exist, you get an exception when you call the PutIntent operation.

Definition at line 261 of file KendraConfiguration.h.


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