« blib/lib/Paws/Kendra/CreateIndexResponse.pm
↑ Summary
blib/lib/Paws/Kendra/CreateQuerySuggestionsBlockListResponse.pm »
| 1 | |||
| 2 | package Paws::Kendra::CreateQuerySuggestionsBlockList; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has Description => (is => 'ro', isa => 'Str'); | ||
| 6 | has IndexId => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has RoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has SourceS3Path => (is => 'ro', isa => 'Paws::Kendra::S3Path', required => 1); | ||
| 10 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Kendra::Tag]'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateQuerySuggestionsBlockList'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Kendra::CreateQuerySuggestionsBlockListResponse'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::Kendra::CreateQuerySuggestionsBlockList - Arguments for method CreateQuerySuggestionsBlockList on L<Paws::Kendra> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method CreateQuerySuggestionsBlockList on the | ||
| 28 | L<AWSKendraFrontendService|Paws::Kendra> service. Use the attributes of this class | ||
| 29 | as arguments to method CreateQuerySuggestionsBlockList. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateQuerySuggestionsBlockList. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $kendra = Paws->service('Kendra'); | ||
| 36 | my $CreateQuerySuggestionsBlockListResponse = | ||
| 37 | $kendra->CreateQuerySuggestionsBlockList( | ||
| 38 | IndexId => 'MyIndexId', | ||
| 39 | Name => 'MyQuerySuggestionsBlockListName', | ||
| 40 | RoleArn => 'MyRoleArn', | ||
| 41 | SourceS3Path => { | ||
| 42 | Bucket => 'MyS3BucketName', # min: 3, max: 63 | ||
| 43 | Key => 'MyS3ObjectKey', # min: 1, max: 1024 | ||
| 44 | |||
| 45 | }, | ||
| 46 | ClientToken => 'MyClientTokenName', # OPTIONAL | ||
| 47 | Description => 'MyDescription', # OPTIONAL | ||
| 48 | Tags => [ | ||
| 49 | { | ||
| 50 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 51 | Value => 'MyTagValue', # max: 256 | ||
| 52 | |||
| 53 | }, | ||
| 54 | ... | ||
| 55 | ], # OPTIONAL | ||
| 56 | ); | ||
| 57 | |||
| 58 | # Results: | ||
| 59 | my $Id = $CreateQuerySuggestionsBlockListResponse->Id; | ||
| 60 | |||
| 61 | # Returns a L<Paws::Kendra::CreateQuerySuggestionsBlockListResponse> object. | ||
| 62 | |||
| 63 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 64 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kendra/CreateQuerySuggestionsBlockList> | ||
| 65 | |||
| 66 | =head1 ATTRIBUTES | ||
| 67 | |||
| 68 | |||
| 69 | =head2 ClientToken => Str | ||
| 70 | |||
| 71 | A token that you provide to identify the request to create a query | ||
| 72 | suggestions block list. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 Description => Str | ||
| 77 | |||
| 78 | A user-friendly description for the block list. | ||
| 79 | |||
| 80 | For example, the description "List of all offensive words that can | ||
| 81 | appear in user queries and need to be blocked from suggestions." | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 B<REQUIRED> IndexId => Str | ||
| 86 | |||
| 87 | The identifier of the index you want to create a query suggestions | ||
| 88 | block list for. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 B<REQUIRED> Name => Str | ||
| 93 | |||
| 94 | A user friendly name for the block list. | ||
| 95 | |||
| 96 | For example, the block list named 'offensive-words' includes all | ||
| 97 | offensive words that could appear in user queries and need to be | ||
| 98 | blocked from suggestions. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 B<REQUIRED> RoleArn => Str | ||
| 103 | |||
| 104 | The IAM (Identity and Access Management) role used by Amazon Kendra to | ||
| 105 | access the block list text file in your S3 bucket. | ||
| 106 | |||
| 107 | You need permissions to the role ARN (Amazon Resource Name). The role | ||
| 108 | needs S3 read permissions to your file in S3 and needs to give STS | ||
| 109 | (Security Token Service) assume role permissions to Amazon Kendra. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 B<REQUIRED> SourceS3Path => L<Paws::Kendra::S3Path> | ||
| 114 | |||
| 115 | The S3 path to your block list text file in your S3 bucket. | ||
| 116 | |||
| 117 | Each block word or phrase should be on a separate line in a text file. | ||
| 118 | |||
| 119 | For information on the current quota limits for block lists, see Quotas | ||
| 120 | for Amazon Kendra | ||
| 121 | (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html). | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head2 Tags => ArrayRef[L<Paws::Kendra::Tag>] | ||
| 126 | |||
| 127 | A tag that you can assign to a block list that categorizes the block | ||
| 128 | list. | ||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head1 SEE ALSO | ||
| 134 | |||
| 135 | This class forms part of L<Paws>, documenting arguments for method CreateQuerySuggestionsBlockList in L<Paws::Kendra> | ||
| 136 | |||
| 137 | =head1 BUGS and CONTRIBUTIONS | ||
| 138 | |||
| 139 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 140 | |||
| 141 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 142 | |||
| 143 | =cut | ||
| 144 |