« blib/lib/Paws/Kendra/BatchPutDocumentResponseFailedDocument.pm
↑ Summary
blib/lib/Paws/Kendra/ClearQuerySuggestions.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Kendra::CapacityUnitsConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has QueryCapacityUnits => (is => 'ro', isa => 'Int', required => 1); | ||
| 5 | has StorageCapacityUnits => (is => 'ro', isa => 'Int', required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::Kendra::CapacityUnitsConfiguration | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::Kendra::CapacityUnitsConfiguration object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { QueryCapacityUnits => $value, ..., StorageCapacityUnits => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::CapacityUnitsConfiguration object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->QueryCapacityUnits | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Specifies capacity units configured for your enterprise edition index. | ||
| 38 | You can add and remove capacity units to tune an index to your | ||
| 39 | requirements. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 B<REQUIRED> QueryCapacityUnits => Int | ||
| 45 | |||
| 46 | The amount of extra query capacity for an index and GetQuerySuggestions | ||
| 47 | (https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html) | ||
| 48 | capacity. | ||
| 49 | |||
| 50 | A single extra capacity unit for an index provides 0.1 queries per | ||
| 51 | second or approximately 8,000 queries per day. | ||
| 52 | |||
| 53 | C<GetQuerySuggestions> capacity is five times the provisioned query | ||
| 54 | capacity for an index, or the base capacity of 2.5 calls per second, | ||
| 55 | whichever is higher. For example, the base capacity for an index is 0.1 | ||
| 56 | queries per second, and C<GetQuerySuggestions> capacity has a base of | ||
| 57 | 2.5 calls per second. If you add another 0.1 queries per second to | ||
| 58 | total 0.2 queries per second for an index, the C<GetQuerySuggestions> | ||
| 59 | capacity is 2.5 calls per second (higher than five times 0.2 queries | ||
| 60 | per second). | ||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> StorageCapacityUnits => Int | ||
| 64 | |||
| 65 | The amount of extra storage capacity for an index. A single capacity | ||
| 66 | unit provides 30 GB of storage space or 100,000 documents, whichever is | ||
| 67 | reached first. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head1 SEE ALSO | ||
| 72 | |||
| 73 | This class forms part of L<Paws>, describing an object used in L<Paws::Kendra> | ||
| 74 | |||
| 75 | =head1 BUGS and CONTRIBUTIONS | ||
| 76 | |||
| 77 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 78 | |||
| 79 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 80 | |||
| 81 | =cut | ||
| 82 |