Amazonka.LexModels.Types.KendraConfiguration

Documentation

data KendraConfiguration

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: newKendraConfiguration smart constructor.

Constructors

KendraConfiguration'

Fields

• queryFilterString :: Maybe Text

  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.

• kendraIndex :: Text

  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.

• role' :: Text

  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.

Instances

FromJSON KendraConfiguration

Defined in Amazonka.LexModels.Types.KendraConfiguration

Methods

parseJSON :: Value -> Parser KendraConfiguration

parseJSONList :: Value -> Parser [KendraConfiguration]

ToJSON KendraConfiguration

Defined in Amazonka.LexModels.Types.KendraConfiguration

Methods

toJSON :: KendraConfiguration -> Value

toEncoding :: KendraConfiguration -> Encoding

toJSONList :: [KendraConfiguration] -> Value

toEncodingList :: [KendraConfiguration] -> Encoding

Generic KendraConfiguration

Defined in Amazonka.LexModels.Types.KendraConfiguration

Associated Types

type Rep KendraConfiguration :: Type -> Type

Methods

from :: KendraConfiguration -> Rep KendraConfiguration x

to :: Rep KendraConfiguration x -> KendraConfiguration

Read KendraConfiguration

Defined in Amazonka.LexModels.Types.KendraConfiguration

Methods

readsPrec :: Int -> ReadS KendraConfiguration

readList :: ReadS [KendraConfiguration]

readPrec :: ReadPrec KendraConfiguration

readListPrec :: ReadPrec [KendraConfiguration]

Show KendraConfiguration

Defined in Amazonka.LexModels.Types.KendraConfiguration

Methods

showsPrec :: Int -> KendraConfiguration -> ShowS

show :: KendraConfiguration -> String

showList :: [KendraConfiguration] -> ShowS

NFData KendraConfiguration

Defined in Amazonka.LexModels.Types.KendraConfiguration

Methods

rnf :: KendraConfiguration -> ()

Eq KendraConfiguration

Defined in Amazonka.LexModels.Types.KendraConfiguration

Methods

(==) :: KendraConfiguration -> KendraConfiguration -> Bool

(/=) :: KendraConfiguration -> KendraConfiguration -> Bool

Hashable KendraConfiguration

Defined in Amazonka.LexModels.Types.KendraConfiguration

Methods

hashWithSalt :: Int -> KendraConfiguration -> Int

hash :: KendraConfiguration -> Int

type Rep KendraConfiguration

Defined in Amazonka.LexModels.Types.KendraConfiguration

type Rep KendraConfiguration = D1 ('MetaData "KendraConfiguration" "Amazonka.LexModels.Types.KendraConfiguration" "amazonka-lex-models-2.0-8Q1WIjnrCCIAMPuyNOCiG7" 'False) (C1 ('MetaCons "KendraConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "queryFilterString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "kendraIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "role'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newKendraConfiguration

Arguments

:: Text

$sel:kendraIndex:KendraConfiguration'

-> Text

$sel:role':KendraConfiguration'

-> KendraConfiguration

Create a value of KendraConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:queryFilterString:KendraConfiguration', kendraConfiguration_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.

$sel:kendraIndex:KendraConfiguration', kendraConfiguration_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.

$sel:role':KendraConfiguration', kendraConfiguration_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.

kendraConfiguration_queryFilterString :: Lens' KendraConfiguration (Maybe Text)

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.

kendraConfiguration_kendraIndex :: Lens' KendraConfiguration Text

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.

kendraConfiguration_role :: Lens' KendraConfiguration Text

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.