blib/lib/Paws/Kinesis/ListShards.pm untested

filter: Statementstmt 0.0% 0 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 17 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Kinesis::ListShards;
3 use Moose;
4 has ExclusiveStartShardId => (is => 'ro', isa => 'Str');
5 has MaxResults => (is => 'ro', isa => 'Int');
6 has NextToken => (is => 'ro', isa => 'Str');
7 has ShardFilter => (is => 'ro', isa => 'Paws::Kinesis::ShardFilter');
8 has StreamCreationTimestamp => (is => 'ro', isa => 'Str');
9 has StreamName => (is => 'ro', isa => 'Str');
10  
11 use MooseX::ClassAttribute;
12  
13 class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListShards');
14 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Kinesis::ListShardsOutput');
15 class_has _result_key => (isa => 'Str', is => 'ro');
16 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::Kinesis::ListShards - Arguments for method ListShards on L<Paws::Kinesis>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method ListShards on the
27 L<Amazon Kinesis|Paws::Kinesis> service. Use the attributes of this class
28 as arguments to method ListShards.
29  
30 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListShards.
31  
32 =head1 SYNOPSIS
33  
34 my $kinesis = Paws->service('Kinesis');
35 my $ListShardsOutput = $kinesis->ListShards(
36 ExclusiveStartShardId => 'MyShardId', # OPTIONAL
37 MaxResults => 1, # OPTIONAL
38 NextToken => 'MyNextToken', # OPTIONAL
39 ShardFilter => {
40 Type => 'AFTER_SHARD_ID'
41 , # values: AFTER_SHARD_ID, AT_TRIM_HORIZON, FROM_TRIM_HORIZON, AT_LATEST, AT_TIMESTAMP, FROM_TIMESTAMP
42 ShardId => 'MyShardId', # min: 1, max: 128
43 Timestamp => '1970-01-01T01:00:00', # OPTIONAL
44 }, # OPTIONAL
45 StreamCreationTimestamp => '1970-01-01T01:00:00', # OPTIONAL
46 StreamName => 'MyStreamName', # OPTIONAL
47 );
48  
49 # Results:
50 my $NextToken = $ListShardsOutput->NextToken;
51 my $Shards = $ListShardsOutput->Shards;
52  
53 # Returns a L<Paws::Kinesis::ListShardsOutput> object.
54  
55 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.
56 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kinesis/ListShards>
57  
58 =head1 ATTRIBUTES
59  
60  
61 =head2 ExclusiveStartShardId => Str
62  
63 Specify this parameter to indicate that you want to list the shards
64 starting with the shard whose ID immediately follows
65 C<ExclusiveStartShardId>.
66  
67 If you don't specify this parameter, the default behavior is for
68 C<ListShards> to list the shards starting with the first one in the
69 stream.
70  
71 You cannot specify this parameter if you specify C<NextToken>.
72  
73  
74  
75 =head2 MaxResults => Int
76  
77 The maximum number of shards to return in a single call to
78 C<ListShards>. The minimum value you can specify for this parameter is
79 1, and the maximum is 10,000, which is also the default.
80  
81 When the number of shards to be listed is greater than the value of
82 C<MaxResults>, the response contains a C<NextToken> value that you can
83 use in a subsequent call to C<ListShards> to list the next set of
84 shards.
85  
86  
87  
88 =head2 NextToken => Str
89  
90 When the number of shards in the data stream is greater than the
91 default value for the C<MaxResults> parameter, or if you explicitly
92 specify a value for C<MaxResults> that is less than the number of
93 shards in the data stream, the response includes a pagination token
94 named C<NextToken>. You can specify this C<NextToken> value in a
95 subsequent call to C<ListShards> to list the next set of shards.
96  
97 Don't specify C<StreamName> or C<StreamCreationTimestamp> if you
98 specify C<NextToken> because the latter unambiguously identifies the
99 stream.
100  
101 You can optionally specify a value for the C<MaxResults> parameter when
102 you specify C<NextToken>. If you specify a C<MaxResults> value that is
103 less than the number of shards that the operation returns if you don't
104 specify C<MaxResults>, the response will contain a new C<NextToken>
105 value. You can use the new C<NextToken> value in a subsequent call to
106 the C<ListShards> operation.
107  
108 Tokens expire after 300 seconds. When you obtain a value for
109 C<NextToken> in the response to a call to C<ListShards>, you have 300
110 seconds to use that value. If you specify an expired token in a call to
111 C<ListShards>, you get C<ExpiredNextTokenException>.
112  
113  
114  
115 =head2 ShardFilter => L<Paws::Kinesis::ShardFilter>
116  
117  
118  
119  
120  
121 =head2 StreamCreationTimestamp => Str
122  
123 Specify this input parameter to distinguish data streams that have the
124 same name. For example, if you create a data stream and then delete it,
125 and you later create another data stream with the same name, you can
126 use this input parameter to specify which of the two streams you want
127 to list the shards for.
128  
129 You cannot specify this parameter if you specify the C<NextToken>
130 parameter.
131  
132  
133  
134 =head2 StreamName => Str
135  
136 The name of the data stream whose shards you want to list.
137  
138 You cannot specify this parameter if you specify the C<NextToken>
139 parameter.
140  
141  
142  
143  
144 =head1 SEE ALSO
145  
146 This class forms part of L<Paws>, documenting arguments for method ListShards in L<Paws::Kinesis>
147  
148 =head1 BUGS and CONTRIBUTIONS
149  
150 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
151  
152 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
153  
154 =cut
155