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

NAME

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

DESCRIPTION

This class represents the parameters used for calling the method GetShardIterator on the Amazon DynamoDB Streams 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 $streams.dynamodb = Paws->service('DynamoDBStreams');
# To obtain a shard iterator for the provided stream ARN and shard ID
# The following example returns a shard iterator for the provided stream ARN and
# shard ID.
my $GetShardIteratorOutput = $streams
  . dynamodb->GetShardIterator(
  'ShardId'           => '00000001414576573621-f55eea83',
  'ShardIteratorType' => 'TRIM_HORIZON',
  'StreamArn'         =>
'arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252'
  );

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

# Returns a L<Paws::DynamoDBStreams::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/streams.dynamodb/GetShardIterator

ATTRIBUTES

SequenceNumber => Str

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

REQUIRED ShardId => Str

The identifier of the shard. The iterator will be returned for this shard ID.

REQUIRED ShardIteratorType => Str

Determines how the shard iterator is used to start reading stream records from the shard:

  • 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) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.

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

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

REQUIRED StreamArn => Str

The Amazon Resource Name (ARN) for the stream.

SEE ALSO

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

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