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

filter: Statementstmt 0.0% 0 / 12 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 14 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Kinesis::DescribeStream;
3 use Moose;
4 has ExclusiveStartShardId => (is => 'ro', isa => 'Str');
5 has Limit => (is => 'ro', isa => 'Int');
6 has StreamName => (is => 'ro', isa => 'Str', required => 1);
7  
8 use MooseX::ClassAttribute;
9  
10 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeStream');
11 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Kinesis::DescribeStreamOutput');
12 class_has _result_key => (isa => 'Str', is => 'ro');
13 1;
14  
15 ### main pod documentation begin ###
16  
17 =head1 NAME
18  
19 Paws::Kinesis::DescribeStream - Arguments for method DescribeStream on L<Paws::Kinesis>
20  
21 =head1 DESCRIPTION
22  
23 This class represents the parameters used for calling the method DescribeStream on the
24 L<Amazon Kinesis|Paws::Kinesis> service. Use the attributes of this class
25 as arguments to method DescribeStream.
26  
27 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeStream.
28  
29 =head1 SYNOPSIS
30  
31 my $kinesis = Paws->service('Kinesis');
32 my $DescribeStreamOutput = $kinesis->DescribeStream(
33 StreamName => 'MyStreamName',
34 ExclusiveStartShardId => 'MyShardId', # OPTIONAL
35 Limit => 1, # OPTIONAL
36 );
37  
38 # Results:
39 my $StreamDescription = $DescribeStreamOutput->StreamDescription;
40  
41 # Returns a L<Paws::Kinesis::DescribeStreamOutput> object.
42  
43 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.
44 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kinesis/DescribeStream>
45  
46 =head1 ATTRIBUTES
47  
48  
49 =head2 ExclusiveStartShardId => Str
50  
51 The shard ID of the shard to start with.
52  
53  
54  
55 =head2 Limit => Int
56  
57 The maximum number of shards to return in a single call. The default
58 value is 100. If you specify a value greater than 100, at most 100
59 shards are returned.
60  
61  
62  
63 =head2 B<REQUIRED> StreamName => Str
64  
65 The name of the stream to describe.
66  
67  
68  
69  
70 =head1 SEE ALSO
71  
72 This class forms part of L<Paws>, documenting arguments for method DescribeStream in L<Paws::Kinesis>
73  
74 =head1 BUGS and CONTRIBUTIONS
75  
76 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
77  
78 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
79  
80 =cut
81