« blib/lib/Paws/Kinesis/PutRecordsResultEntry.pm
↑ Summary
blib/lib/Paws/Kinesis/RegisterStreamConsumer.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Kinesis::Record; | ||
| 3 | use Moose; | ||
| 4 | has ApproximateArrivalTimestamp => (is => 'ro', isa => 'Str'); | ||
| 5 | has Data => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has EncryptionType => (is => 'ro', isa => 'Str'); | ||
| 7 | has PartitionKey => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has SequenceNumber => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::Kinesis::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::Kinesis::Record object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { ApproximateArrivalTimestamp => $value, ..., SequenceNumber => $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::Kinesis::Record object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->ApproximateArrivalTimestamp | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | The unit of data of the Kinesis data stream, which is composed of a | ||
| 41 | sequence number, a partition key, and a data blob. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 ApproximateArrivalTimestamp => Str | ||
| 47 | |||
| 48 | The approximate time that the record was inserted into the stream. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> Data => Str | ||
| 52 | |||
| 53 | The data blob. The data in the blob is both opaque and immutable to | ||
| 54 | Kinesis Data Streams, which does not inspect, interpret, or change the | ||
| 55 | data in the blob in any way. When the data blob (the payload before | ||
| 56 | base64-encoding) is added to the partition key size, the total size | ||
| 57 | must not exceed the maximum record size (1 MiB). | ||
| 58 | |||
| 59 | |||
| 60 | =head2 EncryptionType => Str | ||
| 61 | |||
| 62 | The encryption type used on the record. This parameter can be one of | ||
| 63 | the following values: | ||
| 64 | |||
| 65 | =over | ||
| 66 | |||
| 67 | =item * | ||
| 68 | |||
| 69 | C<NONE>: Do not encrypt the records in the stream. | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | C<KMS>: Use server-side encryption on the records in the stream using a | ||
| 74 | customer-managed AWS KMS key. | ||
| 75 | |||
| 76 | =back | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 B<REQUIRED> PartitionKey => Str | ||
| 81 | |||
| 82 | Identifies which shard in the stream the data record is assigned to. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 B<REQUIRED> SequenceNumber => Str | ||
| 86 | |||
| 87 | The unique identifier of the record within its shard. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head1 SEE ALSO | ||
| 92 | |||
| 93 | This class forms part of L<Paws>, describing an object used in L<Paws::Kinesis> | ||
| 94 | |||
| 95 | =head1 BUGS and CONTRIBUTIONS | ||
| 96 | |||
| 97 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 98 | |||
| 99 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 100 | |||
| 101 | =cut | ||
| 102 |