« blib/lib/Paws/Kinesis/GetRecordsOutput.pm
↑ Summary
blib/lib/Paws/Kinesis/GetShardIteratorOutput.pm »
| 1 | |||
| 2 | package Paws::Kinesis::GetShardIterator; | ||
| 3 | use Moose; | ||
| 4 | has ShardId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has ShardIteratorType => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has StartingSequenceNumber => (is => 'ro', isa => 'Str'); | ||
| 7 | has StreamName => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has Timestamp => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetShardIterator'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Kinesis::GetShardIteratorOutput'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Kinesis::GetShardIterator - Arguments for method GetShardIterator on L<Paws::Kinesis> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method GetShardIterator on the | ||
| 26 | L<Amazon Kinesis|Paws::Kinesis> service. Use the attributes of this class | ||
| 27 | as arguments to method GetShardIterator. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetShardIterator. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $kinesis = Paws->service('Kinesis'); | ||
| 34 | my $GetShardIteratorOutput = $kinesis->GetShardIterator( | ||
| 35 | ShardId => 'MyShardId', | ||
| 36 | ShardIteratorType => 'AT_SEQUENCE_NUMBER', | ||
| 37 | StreamName => 'MyStreamName', | ||
| 38 | StartingSequenceNumber => 'MySequenceNumber', # OPTIONAL | ||
| 39 | Timestamp => '1970-01-01T01:00:00', # OPTIONAL | ||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $ShardIterator = $GetShardIteratorOutput->ShardIterator; | ||
| 44 | |||
| 45 | # Returns a L<Paws::Kinesis::GetShardIteratorOutput> object. | ||
| 46 | |||
| 47 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 48 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kinesis/GetShardIterator> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 B<REQUIRED> ShardId => Str | ||
| 54 | |||
| 55 | The shard ID of the Kinesis Data Streams shard to get the iterator for. | ||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> ShardIteratorType => Str | ||
| 60 | |||
| 61 | Determines how the shard iterator is used to start reading data records | ||
| 62 | from the shard. | ||
| 63 | |||
| 64 | The following are the valid Amazon Kinesis shard iterator types: | ||
| 65 | |||
| 66 | =over | ||
| 67 | |||
| 68 | =item * | ||
| 69 | |||
| 70 | AT_SEQUENCE_NUMBER - Start reading from the position denoted by a | ||
| 71 | specific sequence number, provided in the value | ||
| 72 | C<StartingSequenceNumber>. | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted | ||
| 77 | by a specific sequence number, provided in the value | ||
| 78 | C<StartingSequenceNumber>. | ||
| 79 | |||
| 80 | =item * | ||
| 81 | |||
| 82 | AT_TIMESTAMP - Start reading from the position denoted by a specific | ||
| 83 | time stamp, provided in the value C<Timestamp>. | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | TRIM_HORIZON - Start reading at the last untrimmed record in the shard | ||
| 88 | in the system, which is the oldest data record in the shard. | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | LATEST - Start reading just after the most recent record in the shard, | ||
| 93 | so that you always read the most recent data in the shard. | ||
| 94 | |||
| 95 | =back | ||
| 96 | |||
| 97 | |||
| 98 | Valid values are: C<"AT_SEQUENCE_NUMBER">, C<"AFTER_SEQUENCE_NUMBER">, C<"TRIM_HORIZON">, C<"LATEST">, C<"AT_TIMESTAMP"> | ||
| 99 | |||
| 100 | =head2 StartingSequenceNumber => Str | ||
| 101 | |||
| 102 | The sequence number of the data record in the shard from which to start | ||
| 103 | reading. Used with shard iterator type AT_SEQUENCE_NUMBER and | ||
| 104 | AFTER_SEQUENCE_NUMBER. | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head2 B<REQUIRED> StreamName => Str | ||
| 109 | |||
| 110 | The name of the Amazon Kinesis data stream. | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head2 Timestamp => Str | ||
| 115 | |||
| 116 | The time stamp of the data record from which to start reading. Used | ||
| 117 | with shard iterator type AT_TIMESTAMP. A time stamp is the Unix epoch | ||
| 118 | date with precision in milliseconds. For example, | ||
| 119 | C<2016-04-04T19:58:46.480-00:00> or C<1459799926.480>. If a record with | ||
| 120 | this exact time stamp does not exist, the iterator returned is for the | ||
| 121 | next (later) record. If the time stamp is older than the current trim | ||
| 122 | horizon, the iterator returned is for the oldest untrimmed data record | ||
| 123 | (TRIM_HORIZON). | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head1 SEE ALSO | ||
| 129 | |||
| 130 | This class forms part of L<Paws>, documenting arguments for method GetShardIterator in L<Paws::Kinesis> | ||
| 131 | |||
| 132 | =head1 BUGS and CONTRIBUTIONS | ||
| 133 | |||
| 134 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 135 | |||
| 136 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 137 | |||
| 138 | =cut | ||
| 139 |