File Coverage

blib/lib/Paws/DynamoDBStreams/StreamDescription.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::StreamDescription;
2 1     1   396 use Moose;
  1         2  
  1         6  
3             has CreationRequestDateTime => (is => 'ro', isa => 'Str');
4             has KeySchema => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDBStreams::KeySchemaElement]');
5             has LastEvaluatedShardId => (is => 'ro', isa => 'Str');
6             has Shards => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDBStreams::Shard]');
7             has StreamArn => (is => 'ro', isa => 'Str');
8             has StreamLabel => (is => 'ro', isa => 'Str');
9             has StreamStatus => (is => 'ro', isa => 'Str');
10             has StreamViewType => (is => 'ro', isa => 'Str');
11             has TableName => (is => 'ro', isa => 'Str');
12             1;
13              
14             ### main pod documentation begin ###
15              
16             =head1 NAME
17              
18             Paws::DynamoDBStreams::StreamDescription
19              
20             =head1 USAGE
21              
22             This class represents one of two things:
23              
24             =head3 Arguments in a call to a service
25              
26             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
27             Each attribute should be used as a named argument in the calls that expect this type of object.
28              
29             As an example, if Att1 is expected to be a Paws::DynamoDBStreams::StreamDescription object:
30              
31             $service_obj->Method(Att1 => { CreationRequestDateTime => $value, ..., TableName => $value });
32              
33             =head3 Results returned from an API call
34              
35             Use accessors for each attribute. If Att1 is expected to be an Paws::DynamoDBStreams::StreamDescription object:
36              
37             $result = $service_obj->Method(...);
38             $result->Att1->CreationRequestDateTime
39              
40             =head1 DESCRIPTION
41              
42             Represents all of the data describing a particular stream.
43              
44             =head1 ATTRIBUTES
45              
46              
47             =head2 CreationRequestDateTime => Str
48              
49             The date and time when the request to create this stream was issued.
50              
51              
52             =head2 KeySchema => ArrayRef[L<Paws::DynamoDBStreams::KeySchemaElement>]
53              
54             The key attribute(s) of the stream's DynamoDB table.
55              
56              
57             =head2 LastEvaluatedShardId => Str
58              
59             The shard ID of the item where the operation stopped, inclusive of the
60             previous result set. Use this value to start a new operation, excluding
61             this value in the new request.
62              
63             If C<LastEvaluatedShardId> is empty, then the "last page" of results
64             has been processed and there is currently no more data to be retrieved.
65              
66             If C<LastEvaluatedShardId> is not empty, it does not necessarily mean
67             that there is more data in the result set. The only way to know when
68             you have reached the end of the result set is when
69             C<LastEvaluatedShardId> is empty.
70              
71              
72             =head2 Shards => ArrayRef[L<Paws::DynamoDBStreams::Shard>]
73              
74             The shards that comprise the stream.
75              
76              
77             =head2 StreamArn => Str
78              
79             The Amazon Resource Name (ARN) for the stream.
80              
81              
82             =head2 StreamLabel => Str
83              
84             A timestamp, in ISO 8601 format, for this stream.
85              
86             Note that C<LatestStreamLabel> is not a unique identifier for the
87             stream, because it is possible that a stream from another table might
88             have the same timestamp. However, the combination of the following
89             three elements is guaranteed to be unique:
90              
91             =over
92              
93             =item *
94              
95             the AWS customer ID.
96              
97             =item *
98              
99             the table name
100              
101             =item *
102              
103             the C<StreamLabel>
104              
105             =back
106              
107              
108              
109             =head2 StreamStatus => Str
110              
111             Indicates the current status of the stream:
112              
113             =over
114              
115             =item *
116              
117             C<ENABLING> - Streams is currently being enabled on the DynamoDB table.
118              
119             =item *
120              
121             C<ENABLED> - the stream is enabled.
122              
123             =item *
124              
125             C<DISABLING> - Streams is currently being disabled on the DynamoDB
126             table.
127              
128             =item *
129              
130             C<DISABLED> - the stream is disabled.
131              
132             =back
133              
134              
135              
136             =head2 StreamViewType => Str
137              
138             Indicates the format of the records within this stream:
139              
140             =over
141              
142             =item *
143              
144             C<KEYS_ONLY> - only the key attributes of items that were modified in
145             the DynamoDB table.
146              
147             =item *
148              
149             C<NEW_IMAGE> - entire items from the table, as they appeared after they
150             were modified.
151              
152             =item *
153              
154             C<OLD_IMAGE> - entire items from the table, as they appeared before
155             they were modified.
156              
157             =item *
158              
159             C<NEW_AND_OLD_IMAGES> - both the new and the old images of the items
160             from the table.
161              
162             =back
163              
164              
165              
166             =head2 TableName => Str
167              
168             The DynamoDB table with which the stream is associated.
169              
170              
171              
172             =head1 SEE ALSO
173              
174             This class forms part of L<Paws>, describing an object used in L<Paws::DynamoDBStreams>
175              
176             =head1 BUGS and CONTRIBUTIONS
177              
178             The source code is located here: https://github.com/pplu/aws-sdk-perl
179              
180             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
181              
182             =cut
183