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