blib/lib/Paws/DynamoDBStreams/GetShardIterator.pm untested

filter: Statementstmt 0.0% 0 / 13 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 15 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::DynamoDBStreams::GetShardIterator;
3 use Moose;
4 has SequenceNumber => (is => 'ro', isa => 'Str');
5 has ShardId => (is => 'ro', isa => 'Str', required => 1);
6 has ShardIteratorType => (is => 'ro', isa => 'Str', required => 1);
7 has StreamArn => (is => 'ro', isa => 'Str', required => 1);
8  
9 use MooseX::ClassAttribute;
10  
11 class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetShardIterator');
12 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DynamoDBStreams::GetShardIteratorOutput');
13 class_has _result_key => (isa => 'Str', is => 'ro');
14 1;
15  
16 ### main pod documentation begin ###
17  
18 =head1 NAME
19  
20 Paws::DynamoDBStreams::GetShardIterator - Arguments for method GetShardIterator on L<Paws::DynamoDBStreams>
21  
22 =head1 DESCRIPTION
23  
24 This class represents the parameters used for calling the method GetShardIterator on the
25 L<Amazon DynamoDB Streams|Paws::DynamoDBStreams> service. Use the attributes of this class
26 as arguments to method GetShardIterator.
27  
28 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetShardIterator.
29  
30 =head1 SYNOPSIS
31  
32 my $streams.dynamodb = Paws->service('DynamoDBStreams');
33 # To obtain a shard iterator for the provided stream ARN and shard ID
34 # The following example returns a shard iterator for the provided stream ARN and
35 # shard ID.
36 my $GetShardIteratorOutput = $streams
37 . dynamodb->GetShardIterator(
38 'ShardId' => '00000001414576573621-f55eea83',
39 'ShardIteratorType' => 'TRIM_HORIZON',
40 'StreamArn' =>
41 'arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252'
42 );
43  
44 # Results:
45 my $ShardIterator = $GetShardIteratorOutput->ShardIterator;
46  
47 # Returns a L<Paws::DynamoDBStreams::GetShardIteratorOutput> object.
48  
49 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.
50 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/streams.dynamodb/GetShardIterator>
51  
52 =head1 ATTRIBUTES
53  
54  
55 =head2 SequenceNumber => Str
56  
57 The sequence number of a stream record in the shard from which to start
58 reading.
59  
60  
61  
62 =head2 B<REQUIRED> ShardId => Str
63  
64 The identifier of the shard. The iterator will be returned for this
65 shard ID.
66  
67  
68  
69 =head2 B<REQUIRED> ShardIteratorType => Str
70  
71 Determines how the shard iterator is used to start reading stream
72 records from the shard:
73  
74 =over
75  
76 =item *
77  
78 C<AT_SEQUENCE_NUMBER> - Start reading exactly from the position denoted
79 by a specific sequence number.
80  
81 =item *
82  
83 C<AFTER_SEQUENCE_NUMBER> - Start reading right after the position
84 denoted by a specific sequence number.
85  
86 =item *
87  
88 C<TRIM_HORIZON> - Start reading at the last (untrimmed) stream record,
89 which is the oldest record in the shard. In DynamoDB Streams, there is
90 a 24 hour limit on data retention. Stream records whose age exceeds
91 this limit are subject to removal (trimming) from the stream.
92  
93 =item *
94  
95 C<LATEST> - Start reading just after the most recent stream record in
96 the shard, so that you always read the most recent data in the shard.
97  
98 =back
99  
100  
101 Valid values are: C<"TRIM_HORIZON">, C<"LATEST">, C<"AT_SEQUENCE_NUMBER">, C<"AFTER_SEQUENCE_NUMBER">
102  
103 =head2 B<REQUIRED> StreamArn => Str
104  
105 The Amazon Resource Name (ARN) for the stream.
106  
107  
108  
109  
110 =head1 SEE ALSO
111  
112 This class forms part of L<Paws>, documenting arguments for method GetShardIterator in L<Paws::DynamoDBStreams>
113  
114 =head1 BUGS and CONTRIBUTIONS
115  
116 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
117  
118 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
119  
120 =cut
121