« blib/lib/Paws/DynamoDBStreams/Shard.pm
↑ Summary
blib/lib/Paws/DynamoDBStreams/StreamDescription.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::DynamoDBStreams::Stream; | ||
| 3 | use Moose; | ||
| 4 | has StreamArn => (is => 'ro', isa => 'Str'); | ||
| 5 | has StreamLabel => (is => 'ro', isa => 'Str'); | ||
| 6 | has TableName => (is => 'ro', isa => 'Str'); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::DynamoDBStreams::Stream | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::DynamoDBStreams::Stream object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { StreamArn => $value, ..., TableName => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::DynamoDBStreams::Stream object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->StreamArn | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Represents all of the data describing a particular stream. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 StreamArn => Str | ||
| 44 | |||
| 45 | The Amazon Resource Name (ARN) for the stream. | ||
| 46 | |||
| 47 | |||
| 48 | =head2 StreamLabel => Str | ||
| 49 | |||
| 50 | A timestamp, in ISO 8601 format, for this stream. | ||
| 51 | |||
| 52 | Note that C<LatestStreamLabel> is not a unique identifier for the | ||
| 53 | stream, because it is possible that a stream from another table might | ||
| 54 | have the same timestamp. However, the combination of the following | ||
| 55 | three elements is guaranteed to be unique: | ||
| 56 | |||
| 57 | =over | ||
| 58 | |||
| 59 | =item * | ||
| 60 | |||
| 61 | the AWS customer ID. | ||
| 62 | |||
| 63 | =item * | ||
| 64 | |||
| 65 | the table name | ||
| 66 | |||
| 67 | =item * | ||
| 68 | |||
| 69 | the C<StreamLabel> | ||
| 70 | |||
| 71 | =back | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 TableName => Str | ||
| 76 | |||
| 77 | The DynamoDB table with which the stream is associated. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head1 SEE ALSO | ||
| 82 | |||
| 83 | This class forms part of L<Paws>, describing an object used in L<Paws::DynamoDBStreams> | ||
| 84 | |||
| 85 | =head1 BUGS and CONTRIBUTIONS | ||
| 86 | |||
| 87 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 88 | |||
| 89 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 90 | |||
| 91 | =cut | ||
| 92 |