File Coverage

blib/lib/Paws/Kinesis/PutRecordsResultEntry.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::Kinesis::PutRecordsResultEntry;
2 1     1   575 use Moose;
  1         4  
  1         9  
3             has ErrorCode => (is => 'ro', isa => 'Str');
4             has ErrorMessage => (is => 'ro', isa => 'Str');
5             has SequenceNumber => (is => 'ro', isa => 'Str');
6             has ShardId => (is => 'ro', isa => 'Str');
7             1;
8              
9             ### main pod documentation begin ###
10              
11             =head1 NAME
12              
13             Paws::Kinesis::PutRecordsResultEntry
14              
15             =head1 USAGE
16              
17             This class represents one of two things:
18              
19             =head3 Arguments in a call to a service
20              
21             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
22             Each attribute should be used as a named argument in the calls that expect this type of object.
23              
24             As an example, if Att1 is expected to be a Paws::Kinesis::PutRecordsResultEntry object:
25              
26             $service_obj->Method(Att1 => { ErrorCode => $value, ..., ShardId => $value });
27              
28             =head3 Results returned from an API call
29              
30             Use accessors for each attribute. If Att1 is expected to be an Paws::Kinesis::PutRecordsResultEntry object:
31              
32             $result = $service_obj->Method(...);
33             $result->Att1->ErrorCode
34              
35             =head1 DESCRIPTION
36              
37             Represents the result of an individual record from a C<PutRecords>
38             request. A record that is successfully added to a stream includes
39             C<SequenceNumber> and C<ShardId> in the result. A record that fails to
40             be added to the stream includes C<ErrorCode> and C<ErrorMessage> in the
41             result.
42              
43             =head1 ATTRIBUTES
44              
45              
46             =head2 ErrorCode => Str
47              
48             The error code for an individual record result. C<ErrorCodes> can be
49             either C<ProvisionedThroughputExceededException> or C<InternalFailure>.
50              
51              
52             =head2 ErrorMessage => Str
53              
54             The error message for an individual record result. An C<ErrorCode>
55             value of C<ProvisionedThroughputExceededException> has an error message
56             that includes the account ID, stream name, and shard ID. An
57             C<ErrorCode> value of C<InternalFailure> has the error message
58             C<"Internal Service Failure">.
59              
60              
61             =head2 SequenceNumber => Str
62              
63             The sequence number for an individual record result.
64              
65              
66             =head2 ShardId => Str
67              
68             The shard ID for an individual record result.
69              
70              
71              
72             =head1 SEE ALSO
73              
74             This class forms part of L<Paws>, describing an object used in L<Paws::Kinesis>
75              
76             =head1 BUGS and CONTRIBUTIONS
77              
78             The source code is located here: https://github.com/pplu/aws-sdk-perl
79              
80             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
81              
82             =cut
83