« blib/lib/Paws/Kinesis/ExpiredNextTokenException.pm
↑ Summary
blib/lib/Paws/Kinesis/GetRecordsOutput.pm »
| 1 | |||
| 2 | package Paws::Kinesis::GetRecords; | ||
| 3 | use Moose; | ||
| 4 | has Limit => (is => 'ro', isa => 'Int'); | ||
| 5 | has ShardIterator => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetRecords'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Kinesis::GetRecordsOutput'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::Kinesis::GetRecords - Arguments for method GetRecords on L<Paws::Kinesis> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method GetRecords on the | ||
| 23 | L<Amazon Kinesis|Paws::Kinesis> service. Use the attributes of this class | ||
| 24 | as arguments to method GetRecords. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetRecords. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $kinesis = Paws->service('Kinesis'); | ||
| 31 | my $GetRecordsOutput = $kinesis->GetRecords( | ||
| 32 | ShardIterator => 'MyShardIterator', | ||
| 33 | Limit => 1, # OPTIONAL | ||
| 34 | ); | ||
| 35 | |||
| 36 | # Results: | ||
| 37 | my $ChildShards = $GetRecordsOutput->ChildShards; | ||
| 38 | my $MillisBehindLatest = $GetRecordsOutput->MillisBehindLatest; | ||
| 39 | my $NextShardIterator = $GetRecordsOutput->NextShardIterator; | ||
| 40 | my $Records = $GetRecordsOutput->Records; | ||
| 41 | |||
| 42 | # Returns a L<Paws::Kinesis::GetRecordsOutput> object. | ||
| 43 | |||
| 44 | 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. | ||
| 45 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kinesis/GetRecords> | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 Limit => Int | ||
| 51 | |||
| 52 | The maximum number of records to return. Specify a value of up to | ||
| 53 | 10,000. If you specify a value that is greater than 10,000, GetRecords | ||
| 54 | throws C<InvalidArgumentException>. The default value is 10,000. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> ShardIterator => Str | ||
| 59 | |||
| 60 | The position in the shard from which you want to start sequentially | ||
| 61 | reading data records. A shard iterator specifies this position using | ||
| 62 | the sequence number of a data record in the shard. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head1 SEE ALSO | ||
| 68 | |||
| 69 | This class forms part of L<Paws>, documenting arguments for method GetRecords in L<Paws::Kinesis> | ||
| 70 | |||
| 71 | =head1 BUGS and CONTRIBUTIONS | ||
| 72 | |||
| 73 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 74 | |||
| 75 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 76 | |||
| 77 | =cut | ||
| 78 |