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