NAME

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

DESCRIPTION

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

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

As an example:

$service_obj->GetShardIterator(Att1 => $value1, Att2 => $value2, ...);

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.

ATTRIBUTES

REQUIRED ShardId => Str

The shard ID of the shard to get the iterator for.

REQUIRED ShardIteratorType => Str

Determines how the shard iterator is used to start reading data records
from the shard.

The following are the valid shard iterator types:

• AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

• AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

• TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.

• LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard.

StartingSequenceNumber => Str

The sequence number of the data record in the shard from which to start
reading from.

REQUIRED StreamName => Str

The name of the stream.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetShardIterator in Paws::Kinesis

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