File Coverage

blib/lib/Paws/DynamoDBStreams/Record.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::DynamoDBStreams::Record;
2 1     1   474 use Moose;
  1         3  
  1         9  
3             has AwsRegion => (is => 'ro', isa => 'Str', request_name => 'awsRegion', traits => ['NameInRequest']);
4             has Dynamodb => (is => 'ro', isa => 'Paws::DynamoDBStreams::StreamRecord', request_name => 'dynamodb', traits => ['NameInRequest']);
5             has EventID => (is => 'ro', isa => 'Str', request_name => 'eventID', traits => ['NameInRequest']);
6             has EventName => (is => 'ro', isa => 'Str', request_name => 'eventName', traits => ['NameInRequest']);
7             has EventSource => (is => 'ro', isa => 'Str', request_name => 'eventSource', traits => ['NameInRequest']);
8             has EventVersion => (is => 'ro', isa => 'Str', request_name => 'eventVersion', traits => ['NameInRequest']);
9             has UserIdentity => (is => 'ro', isa => 'Paws::DynamoDBStreams::Identity', request_name => 'userIdentity', traits => ['NameInRequest']);
10             1;
11              
12             ### main pod documentation begin ###
13              
14             =head1 NAME
15              
16             Paws::DynamoDBStreams::Record
17              
18             =head1 USAGE
19              
20             This class represents one of two things:
21              
22             =head3 Arguments in a call to a service
23              
24             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
25             Each attribute should be used as a named argument in the calls that expect this type of object.
26              
27             As an example, if Att1 is expected to be a Paws::DynamoDBStreams::Record object:
28              
29             $service_obj->Method(Att1 => { AwsRegion => $value, ..., UserIdentity => $value });
30              
31             =head3 Results returned from an API call
32              
33             Use accessors for each attribute. If Att1 is expected to be an Paws::DynamoDBStreams::Record object:
34              
35             $result = $service_obj->Method(...);
36             $result->Att1->AwsRegion
37              
38             =head1 DESCRIPTION
39              
40             A description of a unique event within a stream.
41              
42             =head1 ATTRIBUTES
43              
44              
45             =head2 AwsRegion => Str
46              
47             The region in which the C<GetRecords> request was received.
48              
49              
50             =head2 Dynamodb => L<Paws::DynamoDBStreams::StreamRecord>
51              
52             The main body of the stream record, containing all of the
53             DynamoDB-specific fields.
54              
55              
56             =head2 EventID => Str
57              
58             A globally unique identifier for the event that was recorded in this
59             stream record.
60              
61              
62             =head2 EventName => Str
63              
64             The type of data modification that was performed on the DynamoDB table:
65              
66             =over
67              
68             =item *
69              
70             C<INSERT> - a new item was added to the table.
71              
72             =item *
73              
74             C<MODIFY> - one or more of an existing item's attributes were modified.
75              
76             =item *
77              
78             C<REMOVE> - the item was deleted from the table
79              
80             =back
81              
82              
83              
84             =head2 EventSource => Str
85              
86             The AWS service from which the stream record originated. For DynamoDB
87             Streams, this is C<aws:dynamodb>.
88              
89              
90             =head2 EventVersion => Str
91              
92             The version number of the stream record format. This number is updated
93             whenever the structure of C<Record> is modified.
94              
95             Client applications must not assume that C<eventVersion> will remain at
96             a particular value, as this number is subject to change at any time. In
97             general, C<eventVersion> will only increase as the low-level DynamoDB
98             Streams API evolves.
99              
100              
101             =head2 UserIdentity => L<Paws::DynamoDBStreams::Identity>
102              
103             Items that are deleted by the Time to Live process after expiration
104             have the following fields:
105              
106             =over
107              
108             =item *
109              
110             Records[].userIdentity.type
111              
112             "Service"
113              
114             =item *
115              
116             Records[].userIdentity.principalId
117              
118             "dynamodb.amazonaws.com"
119              
120             =back
121              
122              
123              
124              
125             =head1 SEE ALSO
126              
127             This class forms part of L<Paws>, describing an object used in L<Paws::DynamoDBStreams>
128              
129             =head1 BUGS and CONTRIBUTIONS
130              
131             The source code is located here: https://github.com/pplu/aws-sdk-perl
132              
133             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
134              
135             =cut
136