| 1 | |||
| 2 | package Paws::DynamoDB::QueryOutput; | ||
| 3 | use Moose; | ||
| 4 | has ConsumedCapacity => (is => 'ro', isa => 'Paws::DynamoDB::ConsumedCapacity'); | ||
| 5 | has Count => (is => 'ro', isa => 'Int'); | ||
| 6 | has Items => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::AttributeMap]'); | ||
| 7 | has LastEvaluatedKey => (is => 'ro', isa => 'Paws::DynamoDB::Key'); | ||
| 8 | has ScannedCount => (is => 'ro', isa => 'Int'); | ||
| 9 | |||
| 10 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::DynamoDB::QueryOutput | ||
| 17 | |||
| 18 | =head1 ATTRIBUTES | ||
| 19 | |||
| 20 | |||
| 21 | =head2 ConsumedCapacity => L<Paws::DynamoDB::ConsumedCapacity> | ||
| 22 | |||
| 23 | The capacity units consumed by the C<Query> operation. The data | ||
| 24 | returned includes the total provisioned throughput consumed, along with | ||
| 25 | statistics for the table and any indexes involved in the operation. | ||
| 26 | C<ConsumedCapacity> is only returned if the C<ReturnConsumedCapacity> | ||
| 27 | parameter was specified. For more information, see Provisioned | ||
| 28 | Throughput | ||
| 29 | (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) | ||
| 30 | in the I<Amazon DynamoDB Developer Guide>. | ||
| 31 | |||
| 32 | |||
| 33 | =head2 Count => Int | ||
| 34 | |||
| 35 | The number of items in the response. | ||
| 36 | |||
| 37 | If you used a C<QueryFilter> in the request, then C<Count> is the | ||
| 38 | number of items returned after the filter was applied, and | ||
| 39 | C<ScannedCount> is the number of matching items before the filter was | ||
| 40 | applied. | ||
| 41 | |||
| 42 | If you did not use a filter in the request, then C<Count> and | ||
| 43 | C<ScannedCount> are the same. | ||
| 44 | |||
| 45 | |||
| 46 | =head2 Items => ArrayRef[L<Paws::DynamoDB::AttributeMap>] | ||
| 47 | |||
| 48 | An array of item attributes that match the query criteria. Each element | ||
| 49 | in this array consists of an attribute name and the value for that | ||
| 50 | attribute. | ||
| 51 | |||
| 52 | |||
| 53 | =head2 LastEvaluatedKey => L<Paws::DynamoDB::Key> | ||
| 54 | |||
| 55 | The primary key of the item where the operation stopped, inclusive of | ||
| 56 | the previous result set. Use this value to start a new operation, | ||
| 57 | excluding this value in the new request. | ||
| 58 | |||
| 59 | If C<LastEvaluatedKey> is empty, then the "last page" of results has | ||
| 60 | been processed and there is no more data to be retrieved. | ||
| 61 | |||
| 62 | If C<LastEvaluatedKey> is not empty, it does not necessarily mean that | ||
| 63 | there is more data in the result set. The only way to know when you | ||
| 64 | have reached the end of the result set is when C<LastEvaluatedKey> is | ||
| 65 | empty. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 ScannedCount => Int | ||
| 69 | |||
| 70 | The number of items evaluated, before any C<QueryFilter> is applied. A | ||
| 71 | high C<ScannedCount> value with few, or no, C<Count> results indicates | ||
| 72 | an inefficient C<Query> operation. For more information, see Count and | ||
| 73 | ScannedCount | ||
| 74 | (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count) | ||
| 75 | in the I<Amazon DynamoDB Developer Guide>. | ||
| 76 | |||
| 77 | If you did not use a filter in the request, then C<ScannedCount> is the | ||
| 78 | same as C<Count>. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 _request_id => Str | ||
| 82 | |||
| 83 | |||
| 84 | =cut | ||
| 85 | |||
| 86 | 1; |