« blib/lib/Paws/Kendra/UpdateIndex.pm
↑ Summary
blib/lib/Paws/Kendra/UpdateQuerySuggestionsConfig.pm »
| 1 | |||
| 2 | package Paws::Kendra::UpdateQuerySuggestionsBlockList; | ||
| 3 | use Moose; | ||
| 4 | has Description => (is => 'ro', isa => 'Str'); | ||
| 5 | has Id => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has IndexId => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Name => (is => 'ro', isa => 'Str'); | ||
| 8 | has RoleArn => (is => 'ro', isa => 'Str'); | ||
| 9 | has SourceS3Path => (is => 'ro', isa => 'Paws::Kendra::S3Path'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateQuerySuggestionsBlockList'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::Kendra::UpdateQuerySuggestionsBlockList - Arguments for method UpdateQuerySuggestionsBlockList on L<Paws::Kendra> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method UpdateQuerySuggestionsBlockList on the | ||
| 27 | L<AWSKendraFrontendService|Paws::Kendra> service. Use the attributes of this class | ||
| 28 | as arguments to method UpdateQuerySuggestionsBlockList. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateQuerySuggestionsBlockList. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $kendra = Paws->service('Kendra'); | ||
| 35 | $kendra->UpdateQuerySuggestionsBlockList( | ||
| 36 | Id => 'MyQuerySuggestionsBlockListId', | ||
| 37 | IndexId => 'MyIndexId', | ||
| 38 | Description => 'MyDescription', # OPTIONAL | ||
| 39 | Name => 'MyQuerySuggestionsBlockListName', # OPTIONAL | ||
| 40 | RoleArn => 'MyRoleArn', # OPTIONAL | ||
| 41 | SourceS3Path => { | ||
| 42 | Bucket => 'MyS3BucketName', # min: 3, max: 63 | ||
| 43 | Key => 'MyS3ObjectKey', # min: 1, max: 1024 | ||
| 44 | |||
| 45 | }, # OPTIONAL | ||
| 46 | ); | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kendra/UpdateQuerySuggestionsBlockList> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 Description => Str | ||
| 55 | |||
| 56 | The description for a block list. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> Id => Str | ||
| 61 | |||
| 62 | The unique identifier of a block list. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> IndexId => Str | ||
| 67 | |||
| 68 | The identifier of the index for a block list. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 Name => Str | ||
| 73 | |||
| 74 | The name of a block list. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 RoleArn => Str | ||
| 79 | |||
| 80 | The IAM (Identity and Access Management) role used to access the block | ||
| 81 | list text file in S3. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 SourceS3Path => L<Paws::Kendra::S3Path> | ||
| 86 | |||
| 87 | The S3 path where your block list text file sits in S3. | ||
| 88 | |||
| 89 | If you update your block list and provide the same path to the block | ||
| 90 | list text file in S3, then Amazon Kendra reloads the file to refresh | ||
| 91 | the block list. Amazon Kendra does not automatically refresh your block | ||
| 92 | list. You need to call the C<UpdateQuerySuggestionsBlockList> API to | ||
| 93 | refresh you block list. | ||
| 94 | |||
| 95 | If you update your block list, then Amazon Kendra asynchronously | ||
| 96 | refreshes all query suggestions with the latest content in the S3 file. | ||
| 97 | This means changes might not take effect immediately. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head1 SEE ALSO | ||
| 103 | |||
| 104 | This class forms part of L<Paws>, documenting arguments for method UpdateQuerySuggestionsBlockList in L<Paws::Kendra> | ||
| 105 | |||
| 106 | =head1 BUGS and CONTRIBUTIONS | ||
| 107 | |||
| 108 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 109 | |||
| 110 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 111 | |||
| 112 | =cut | ||
| 113 |