« blib/lib/Paws/LexModels/IntentMetadata.pm
↑ Summary
blib/lib/Paws/LexModels/ListTagsForResource.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::LexModels::KendraConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has KendraIndex => (is => 'ro', isa => 'Str', request_name => 'kendraIndex', traits => ['NameInRequest'], required => 1); | ||
| 5 | has QueryFilterString => (is => 'ro', isa => 'Str', request_name => 'queryFilterString', traits => ['NameInRequest']); | ||
| 6 | has Role => (is => 'ro', isa => 'Str', request_name => 'role', traits => ['NameInRequest'], required => 1); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::LexModels::KendraConfiguration | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::LexModels::KendraConfiguration object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { KendraIndex => $value, ..., Role => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::LexModels::KendraConfiguration object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->KendraIndex | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Provides configuration information for the AMAZON.KendraSearchIntent | ||
| 39 | intent. When you use this intent, Amazon Lex searches the specified | ||
| 40 | Amazon Kendra index and returns documents from the index that match the | ||
| 41 | user's utterance. For more information, see AMAZON.KendraSearchIntent | ||
| 42 | (http://docs.aws.amazon.com/lex/latest/dg/built-in-intent-kendra-search.html). | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 B<REQUIRED> KendraIndex => Str | ||
| 48 | |||
| 49 | The Amazon Resource Name (ARN) of the Amazon Kendra index that you want | ||
| 50 | the AMAZON.KendraSearchIntent intent to search. The index must be in | ||
| 51 | the same account and Region as the Amazon Lex bot. If the Amazon Kendra | ||
| 52 | index does not exist, you get an exception when you call the | ||
| 53 | C<PutIntent> operation. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 QueryFilterString => Str | ||
| 57 | |||
| 58 | A query filter that Amazon Lex sends to Amazon Kendra to filter the | ||
| 59 | response from the query. The filter is in the format defined by Amazon | ||
| 60 | Kendra. For more information, see Filtering queries | ||
| 61 | (http://docs.aws.amazon.com/kendra/latest/dg/filtering.html). | ||
| 62 | |||
| 63 | You can override this filter string with a new filter string at | ||
| 64 | runtime. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> Role => Str | ||
| 68 | |||
| 69 | The Amazon Resource Name (ARN) of an IAM role that has permission to | ||
| 70 | search the Amazon Kendra index. The role must be in the same account | ||
| 71 | and Region as the Amazon Lex bot. If the role does not exist, you get | ||
| 72 | an exception when you call the C<PutIntent> operation. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head1 SEE ALSO | ||
| 77 | |||
| 78 | This class forms part of L<Paws>, describing an object used in L<Paws::LexModels> | ||
| 79 | |||
| 80 | =head1 BUGS and CONTRIBUTIONS | ||
| 81 | |||
| 82 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 83 | |||
| 84 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 85 | |||
| 86 | =cut | ||
| 87 |