@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class KendraConfiguration extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
KendraConfiguration() |
Modifier and Type | Method and Description |
---|---|
KendraConfiguration |
clone() |
boolean |
equals(Object obj) |
String |
getKendraIndex()
The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to
search.
|
String |
getQueryFilterString()
A query filter that Amazon Lex sends to Amazon Kendra to filter the response from the query.
|
String |
getRole()
The Amazon Resource Name (ARN) of an IAM role that has permission to search the Amazon Kendra index.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setKendraIndex(String kendraIndex)
The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to
search.
|
void |
setQueryFilterString(String queryFilterString)
A query filter that Amazon Lex sends to Amazon Kendra to filter the response from the query.
|
void |
setRole(String role)
The Amazon Resource Name (ARN) of an IAM role that has permission to search the Amazon Kendra index.
|
String |
toString()
Returns a string representation of this object.
|
KendraConfiguration |
withKendraIndex(String kendraIndex)
The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to
search.
|
KendraConfiguration |
withQueryFilterString(String queryFilterString)
A query filter that Amazon Lex sends to Amazon Kendra to filter the response from the query.
|
KendraConfiguration |
withRole(String role)
The Amazon Resource Name (ARN) of an IAM role that has permission to search the Amazon Kendra index.
|
public void setKendraIndex(String kendraIndex)
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.
kendraIndex
- 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.public String getKendraIndex()
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.
PutIntent
operation.public KendraConfiguration withKendraIndex(String kendraIndex)
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.
kendraIndex
- 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.public void setQueryFilterString(String queryFilterString)
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.
queryFilterString
- 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.
public String getQueryFilterString()
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.
You can override this filter string with a new filter string at runtime.
public KendraConfiguration withQueryFilterString(String queryFilterString)
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.
queryFilterString
- 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.
public void setRole(String role)
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.
role
- 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.public String getRole()
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.
PutIntent
operation.public KendraConfiguration withRole(String role)
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.
role
- 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.public String toString()
toString
in class Object
Object.toString()
public KendraConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.