File Coverage

blib/lib/Paws/Kinesis/DescribeStream.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::Kinesis::DescribeStream;
3 1     1   344 use Moose;
  1         4  
  1         6  
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 1     1   5578 use MooseX::ClassAttribute;
  1         3  
  1         9  
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 Paws::Kinesis
20              
21             =head1 DESCRIPTION
22              
23             This class represents the parameters used for calling the method DescribeStream on the
24             Amazon 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             As an example:
30              
31             $service_obj->DescribeStream(Att1 => $value1, Att2 => $value2, ...);
32              
33             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.
34              
35             =head1 ATTRIBUTES
36              
37              
38             =head2 ExclusiveStartShardId => Str
39              
40             The shard ID of the shard to start with.
41              
42              
43              
44             =head2 Limit => Int
45              
46             The maximum number of shards to return in a single call. The default
47             value is 100. If you specify a value greater than 100, at most 100
48             shards are returned.
49              
50              
51              
52             =head2 B<REQUIRED> StreamName => Str
53              
54             The name of the stream to describe.
55              
56              
57              
58              
59             =head1 SEE ALSO
60              
61             This class forms part of L<Paws>, documenting arguments for method DescribeStream in L<Paws::Kinesis>
62              
63             =head1 BUGS and CONTRIBUTIONS
64              
65             The source code is located here: https://github.com/pplu/aws-sdk-perl
66              
67             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
68              
69             =cut
70