File Coverage

blib/lib/Paws/DynamoDB/BatchWriteItem.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::DynamoDB::BatchWriteItem;
3 1     1   385 use Moose;
  1     1   3  
  1         7  
  1         640  
  1         5  
  1         12  
4             has RequestItems => (is => 'ro', isa => 'Paws::DynamoDB::BatchWriteItemRequestMap', required => 1);
5             has ReturnConsumedCapacity => (is => 'ro', isa => 'Str');
6             has ReturnItemCollectionMetrics => (is => 'ro', isa => 'Str');
7              
8 1     1   6158 use MooseX::ClassAttribute;
  1     1   3  
  1         10  
  1         6883  
  1         4  
  1         8  
9              
10             class_has _api_call => (isa => 'Str', is => 'ro', default => 'BatchWriteItem');
11             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DynamoDB::BatchWriteItemOutput');
12             class_has _result_key => (isa => 'Str', is => 'ro');
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::DynamoDB::BatchWriteItem - Arguments for method BatchWriteItem on Paws::DynamoDB
20              
21             =head1 DESCRIPTION
22              
23             This class represents the parameters used for calling the method BatchWriteItem on the
24             Amazon DynamoDB service. Use the attributes of this class
25             as arguments to method BatchWriteItem.
26              
27             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to BatchWriteItem.
28              
29             As an example:
30              
31             $service_obj->BatchWriteItem(Att1 => $value1, Att2 => $value2, ...);
32              
33             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.
34              
35             =head1 ATTRIBUTES
36              
37              
38             =head2 B<REQUIRED> RequestItems => L<Paws::DynamoDB::BatchWriteItemRequestMap>
39              
40             A map of one or more table names and, for each table, a list of
41             operations to be performed (C<DeleteRequest> or C<PutRequest>). Each
42             element in the map consists of the following:
43              
44             =over
45              
46             =item *
47              
48             C<DeleteRequest> - Perform a C<DeleteItem> operation on the specified
49             item. The item to be deleted is identified by a C<Key> subelement:
50              
51             =over
52              
53             =item *
54              
55             C<Key> - A map of primary key attribute values that uniquely identify
56             the item. Each entry in this map consists of an attribute name and an
57             attribute value. For each primary key, you must provide I<all> of the
58             key attributes. For example, with a simple primary key, you only need
59             to provide a value for the partition key. For a composite primary key,
60             you must provide values for I<both> the partition key and the sort key.
61              
62             =back
63              
64             =item *
65              
66             C<PutRequest> - Perform a C<PutItem> operation on the specified item.
67             The item to be put is identified by an C<Item> subelement:
68              
69             =over
70              
71             =item *
72              
73             C<Item> - A map of attributes and their values. Each entry in this map
74             consists of an attribute name and an attribute value. Attribute values
75             must not be null; string and binary type attributes must have lengths
76             greater than zero; and set type attributes must not be empty. Requests
77             that contain empty values will be rejected with a
78             C<ValidationException> exception.
79              
80             If you specify any attributes that are part of an index key, then the
81             data types for those attributes must match those of the schema in the
82             table's attribute definition.
83              
84             =back
85              
86             =back
87              
88              
89              
90              
91             =head2 ReturnConsumedCapacity => Str
92              
93              
94              
95             Valid values are: C<"INDEXES">, C<"TOTAL">, C<"NONE">
96              
97             =head2 ReturnItemCollectionMetrics => Str
98              
99             Determines whether item collection metrics are returned. If set to
100             C<SIZE>, the response includes statistics about item collections, if
101             any, that were modified during the operation are returned in the
102             response. If set to C<NONE> (the default), no statistics are returned.
103              
104             Valid values are: C<"SIZE">, C<"NONE">
105              
106              
107             =head1 SEE ALSO
108              
109             This class forms part of L<Paws>, documenting arguments for method BatchWriteItem in L<Paws::DynamoDB>
110              
111             =head1 BUGS and CONTRIBUTIONS
112              
113             The source code is located here: https://github.com/pplu/aws-sdk-perl
114              
115             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
116              
117             =cut
118