NAME

Paws::Kinesis::GetRecords - Arguments for method GetRecords on Paws::Kinesis

DESCRIPTION

This class represents the parameters used for calling the method GetRecords on the Amazon Kinesis service. Use the attributes of this class as arguments to method GetRecords.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetRecords.

SYNOPSIS

    my $kinesis = Paws->service('Kinesis');
    my $GetRecordsOutput = $kinesis->GetRecords(
      ShardIterator => 'MyShardIterator',
      Limit         => 1,                   # OPTIONAL
    );
    # Results:
    my $ChildShards        = $GetRecordsOutput->ChildShards;
    my $MillisBehindLatest = $GetRecordsOutput->MillisBehindLatest;
    my $NextShardIterator  = $GetRecordsOutput->NextShardIterator;
    my $Records            = $GetRecordsOutput->Records;
    # Returns a L<Paws::Kinesis::GetRecordsOutput> object.

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. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/kinesis/GetRecords>

ATTRIBUTES

Limit => Int

The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws "InvalidArgumentException". The default value is 10,000.

REQUIRED ShardIterator => Str

The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>