« blib/lib/Paws/DynamoDB/BatchStatementResponse.pm
↑ Summary
blib/lib/Paws/DynamoDB/CancellationReason.pm »
| 1 | |||
| 2 | package Paws::DynamoDB::BatchWriteItemOutput; | ||
| 3 | use Moose; | ||
| 4 | has ConsumedCapacity => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::ConsumedCapacity]'); | ||
| 5 | has ItemCollectionMetrics => (is => 'ro', isa => 'Paws::DynamoDB::ItemCollectionMetricsPerTable'); | ||
| 6 | has UnprocessedItems => (is => 'ro', isa => 'Paws::DynamoDB::BatchWriteItemRequestMap'); | ||
| 7 | |||
| 8 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::DynamoDB::BatchWriteItemOutput | ||
| 15 | |||
| 16 | =head1 ATTRIBUTES | ||
| 17 | |||
| 18 | |||
| 19 | =head2 ConsumedCapacity => ArrayRef[L<Paws::DynamoDB::ConsumedCapacity>] | ||
| 20 | |||
| 21 | The capacity units consumed by the entire C<BatchWriteItem> operation. | ||
| 22 | |||
| 23 | Each element consists of: | ||
| 24 | |||
| 25 | =over | ||
| 26 | |||
| 27 | =item * | ||
| 28 | |||
| 29 | C<TableName> - The table that consumed the provisioned throughput. | ||
| 30 | |||
| 31 | =item * | ||
| 32 | |||
| 33 | C<CapacityUnits> - The total number of capacity units consumed. | ||
| 34 | |||
| 35 | =back | ||
| 36 | |||
| 37 | |||
| 38 | |||
| 39 | =head2 ItemCollectionMetrics => L<Paws::DynamoDB::ItemCollectionMetricsPerTable> | ||
| 40 | |||
| 41 | A list of tables that were processed by C<BatchWriteItem> and, for each | ||
| 42 | table, information about any item collections that were affected by | ||
| 43 | individual C<DeleteItem> or C<PutItem> operations. | ||
| 44 | |||
| 45 | Each entry consists of the following subelements: | ||
| 46 | |||
| 47 | =over | ||
| 48 | |||
| 49 | =item * | ||
| 50 | |||
| 51 | C<ItemCollectionKey> - The partition key value of the item collection. | ||
| 52 | This is the same as the partition key value of the item. | ||
| 53 | |||
| 54 | =item * | ||
| 55 | |||
| 56 | C<SizeEstimateRangeGB> - An estimate of item collection size, expressed | ||
| 57 | in GB. This is a two-element array containing a lower bound and an | ||
| 58 | upper bound for the estimate. The estimate includes the size of all the | ||
| 59 | items in the table, plus the size of all attributes projected into all | ||
| 60 | of the local secondary indexes on the table. Use this estimate to | ||
| 61 | measure whether a local secondary index is approaching its size limit. | ||
| 62 | |||
| 63 | The estimate is subject to change over time; therefore, do not rely on | ||
| 64 | the precision or accuracy of the estimate. | ||
| 65 | |||
| 66 | =back | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 UnprocessedItems => L<Paws::DynamoDB::BatchWriteItemRequestMap> | ||
| 71 | |||
| 72 | A map of tables and requests against those tables that were not | ||
| 73 | processed. The C<UnprocessedItems> value is in the same form as | ||
| 74 | C<RequestItems>, so you can provide this value directly to a subsequent | ||
| 75 | C<BatchGetItem> operation. For more information, see C<RequestItems> in | ||
| 76 | the Request Parameters section. | ||
| 77 | |||
| 78 | Each C<UnprocessedItems> entry consists of a table name and, for that | ||
| 79 | table, a list of operations to perform (C<DeleteRequest> or | ||
| 80 | C<PutRequest>). | ||
| 81 | |||
| 82 | =over | ||
| 83 | |||
| 84 | =item * | ||
| 85 | |||
| 86 | C<DeleteRequest> - Perform a C<DeleteItem> operation on the specified | ||
| 87 | item. The item to be deleted is identified by a C<Key> subelement: | ||
| 88 | |||
| 89 | =over | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | C<Key> - A map of primary key attribute values that uniquely identify | ||
| 94 | the item. Each entry in this map consists of an attribute name and an | ||
| 95 | attribute value. | ||
| 96 | |||
| 97 | =back | ||
| 98 | |||
| 99 | =item * | ||
| 100 | |||
| 101 | C<PutRequest> - Perform a C<PutItem> operation on the specified item. | ||
| 102 | The item to be put is identified by an C<Item> subelement: | ||
| 103 | |||
| 104 | =over | ||
| 105 | |||
| 106 | =item * | ||
| 107 | |||
| 108 | C<Item> - A map of attributes and their values. Each entry in this map | ||
| 109 | consists of an attribute name and an attribute value. Attribute values | ||
| 110 | must not be null; string and binary type attributes must have lengths | ||
| 111 | greater than zero; and set type attributes must not be empty. Requests | ||
| 112 | that contain empty values will be rejected with a | ||
| 113 | C<ValidationException> exception. | ||
| 114 | |||
| 115 | If you specify any attributes that are part of an index key, then the | ||
| 116 | data types for those attributes must match those of the schema in the | ||
| 117 | table's attribute definition. | ||
| 118 | |||
| 119 | =back | ||
| 120 | |||
| 121 | =back | ||
| 122 | |||
| 123 | If there are no unprocessed items remaining, the response contains an | ||
| 124 | empty C<UnprocessedItems> map. | ||
| 125 | |||
| 126 | |||
| 127 | =head2 _request_id => Str | ||
| 128 | |||
| 129 | |||
| 130 | =cut | ||
| 131 | |||
| 132 | 1; |