/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Kinesis::GetShardIterator

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.

SYNOPSIS

my $kinesis = Paws->service('Kinesis');
my $GetShardIteratorOutput = $kinesis->GetShardIterator(
  ShardId                => 'MyShardId',
  ShardIteratorType      => 'AT_SEQUENCE_NUMBER',
  StreamName             => 'MyStreamName',
  StartingSequenceNumber => 'MySequenceNumber',       # OPTIONAL
  Timestamp              => '1970-01-01T01:00:00',    # OPTIONAL
);

# Results:
my $ShardIterator = $GetShardIteratorOutput->ShardIterator;

# Returns a L<Paws::Kinesis::GetShardIteratorOutput> 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/GetShardIterator

ATTRIBUTES

REQUIRED ShardId => Str

The shard ID of the Kinesis Data Streams 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 Amazon Kinesis shard iterator types:

  • AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

  • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

  • AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value Timestamp.

  • 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.

Valid values are: "AT_SEQUENCE_NUMBER", "AFTER_SEQUENCE_NUMBER", "TRIM_HORIZON", "LATEST", "AT_TIMESTAMP"

StartingSequenceNumber => Str

The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.

REQUIRED StreamName => Str

The name of the Amazon Kinesis data stream.

Timestamp => Str

The time stamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. If a record with this exact time stamp does not exist, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).

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