« blib/lib/Paws/Kendra/UpdateDataSource.pm
↑ Summary
blib/lib/Paws/Kendra/UpdateQuerySuggestionsBlockList.pm »
| 1 | |||
| 2 | package Paws::Kendra::UpdateIndex; | ||
| 3 | use Moose; | ||
| 4 | has CapacityUnits => (is => 'ro', isa => 'Paws::Kendra::CapacityUnitsConfiguration'); | ||
| 5 | has Description => (is => 'ro', isa => 'Str'); | ||
| 6 | has DocumentMetadataConfigurationUpdates => (is => 'ro', isa => 'ArrayRef[Paws::Kendra::DocumentMetadataConfiguration]'); | ||
| 7 | has Id => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has Name => (is => 'ro', isa => 'Str'); | ||
| 9 | has RoleArn => (is => 'ro', isa => 'Str'); | ||
| 10 | has UserContextPolicy => (is => 'ro', isa => 'Str'); | ||
| 11 | has UserTokenConfigurations => (is => 'ro', isa => 'ArrayRef[Paws::Kendra::UserTokenConfiguration]'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateIndex'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::Kendra::UpdateIndex - Arguments for method UpdateIndex on L<Paws::Kendra> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method UpdateIndex on the | ||
| 29 | L<AWSKendraFrontendService|Paws::Kendra> service. Use the attributes of this class | ||
| 30 | as arguments to method UpdateIndex. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateIndex. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $kendra = Paws->service('Kendra'); | ||
| 37 | $kendra->UpdateIndex( | ||
| 38 | Id => 'MyIndexId', | ||
| 39 | CapacityUnits => { | ||
| 40 | QueryCapacityUnits => 1, | ||
| 41 | StorageCapacityUnits => 1, | ||
| 42 | |||
| 43 | }, # OPTIONAL | ||
| 44 | Description => 'MyDescription', # OPTIONAL | ||
| 45 | DocumentMetadataConfigurationUpdates => [ | ||
| 46 | { | ||
| 47 | Name => 'MyDocumentMetadataConfigurationName', # min: 1, max: 30 | ||
| 48 | Type => 'STRING_VALUE' | ||
| 49 | , # values: STRING_VALUE, STRING_LIST_VALUE, LONG_VALUE, DATE_VALUE | ||
| 50 | Relevance => { | ||
| 51 | Duration => 'MyDuration', # min: 1, max: 10; OPTIONAL | ||
| 52 | Freshness => 1, # OPTIONAL | ||
| 53 | Importance => 1, # min: 1, max: 10; OPTIONAL | ||
| 54 | RankOrder => 'ASCENDING', # values: ASCENDING, DESCENDING; OPTIONAL | ||
| 55 | ValueImportanceMap => { | ||
| 56 | 'MyValueImportanceMapKey' => | ||
| 57 | 1, # key: min: 1, max: 50, value: min: 1, max: 10; OPTIONAL | ||
| 58 | }, # OPTIONAL | ||
| 59 | }, # OPTIONAL | ||
| 60 | Search => { | ||
| 61 | Displayable => 1, # OPTIONAL | ||
| 62 | Facetable => 1, # OPTIONAL | ||
| 63 | Searchable => 1, # OPTIONAL | ||
| 64 | Sortable => 1, # OPTIONAL | ||
| 65 | }, # OPTIONAL | ||
| 66 | }, | ||
| 67 | ... | ||
| 68 | ], # OPTIONAL | ||
| 69 | Name => 'MyIndexName', # OPTIONAL | ||
| 70 | RoleArn => 'MyRoleArn', # OPTIONAL | ||
| 71 | UserContextPolicy => 'ATTRIBUTE_FILTER', # OPTIONAL | ||
| 72 | UserTokenConfigurations => [ | ||
| 73 | { | ||
| 74 | JsonTokenTypeConfiguration => { | ||
| 75 | GroupAttributeField => 'MyString', # min: 1, max: 2048 | ||
| 76 | UserNameAttributeField => 'MyString', # min: 1, max: 2048 | ||
| 77 | |||
| 78 | }, # OPTIONAL | ||
| 79 | JwtTokenTypeConfiguration => { | ||
| 80 | KeyLocation => 'URL', # values: URL, SECRET_MANAGER | ||
| 81 | ClaimRegex => 'MyClaimRegex', # min: 1, max: 100; OPTIONAL | ||
| 82 | GroupAttributeField => | ||
| 83 | 'MyGroupAttributeField', # min: 1, max: 100; OPTIONAL | ||
| 84 | Issuer => 'MyIssuer', # min: 1, max: 65; OPTIONAL | ||
| 85 | SecretManagerArn => 'MyRoleArn', # min: 1, max: 1284 | ||
| 86 | URL => 'MyUrl', # min: 1, max: 2048; OPTIONAL | ||
| 87 | UserNameAttributeField => | ||
| 88 | 'MyUserNameAttributeField', # min: 1, max: 100; OPTIONAL | ||
| 89 | }, # OPTIONAL | ||
| 90 | }, | ||
| 91 | ... | ||
| 92 | ], # OPTIONAL | ||
| 93 | ); | ||
| 94 | |||
| 95 | 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. | ||
| 96 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kendra/UpdateIndex> | ||
| 97 | |||
| 98 | =head1 ATTRIBUTES | ||
| 99 | |||
| 100 | |||
| 101 | =head2 CapacityUnits => L<Paws::Kendra::CapacityUnitsConfiguration> | ||
| 102 | |||
| 103 | Sets the number of additional storage and query capacity units that | ||
| 104 | should be used by the index. You can change the capacity of the index | ||
| 105 | up to 5 times per day. | ||
| 106 | |||
| 107 | If you are using extra storage units, you can't reduce the storage | ||
| 108 | capacity below that required to meet the storage needs for your index. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 Description => Str | ||
| 113 | |||
| 114 | A new description for the index. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head2 DocumentMetadataConfigurationUpdates => ArrayRef[L<Paws::Kendra::DocumentMetadataConfiguration>] | ||
| 119 | |||
| 120 | The document metadata to update. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head2 B<REQUIRED> Id => Str | ||
| 125 | |||
| 126 | The identifier of the index to update. | ||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head2 Name => Str | ||
| 131 | |||
| 132 | The name of the index to update. | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | =head2 RoleArn => Str | ||
| 137 | |||
| 138 | A new IAM role that gives Amazon Kendra permission to access your | ||
| 139 | Amazon CloudWatch logs. | ||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head2 UserContextPolicy => Str | ||
| 144 | |||
| 145 | The user user token context policy. | ||
| 146 | |||
| 147 | Valid values are: C<"ATTRIBUTE_FILTER">, C<"USER_TOKEN"> | ||
| 148 | |||
| 149 | =head2 UserTokenConfigurations => ArrayRef[L<Paws::Kendra::UserTokenConfiguration>] | ||
| 150 | |||
| 151 | The user token configuration. | ||
| 152 | |||
| 153 | |||
| 154 | |||
| 155 | |||
| 156 | =head1 SEE ALSO | ||
| 157 | |||
| 158 | This class forms part of L<Paws>, documenting arguments for method UpdateIndex in L<Paws::Kendra> | ||
| 159 | |||
| 160 | =head1 BUGS and CONTRIBUTIONS | ||
| 161 | |||
| 162 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 163 | |||
| 164 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 165 | |||
| 166 | =cut | ||
| 167 |