File Coverage

blib/lib/Paws/OpsWorksCM/DescribeEvents.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::OpsWorksCM::DescribeEvents;
3 1     1   301 use Moose;
  1         4  
  1         7  
4             has MaxResults => (is => 'ro', isa => 'Int');
5             has NextToken => (is => 'ro', isa => 'Str');
6             has ServerName => (is => 'ro', isa => 'Str', required => 1);
7              
8 1     1   5333 use MooseX::ClassAttribute;
  1         2  
  1         7  
9              
10             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeEvents');
11             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::OpsWorksCM::DescribeEventsResponse');
12             class_has _result_key => (isa => 'Str', is => 'ro');
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::OpsWorksCM::DescribeEvents - Arguments for method DescribeEvents on Paws::OpsWorksCM
20              
21             =head1 DESCRIPTION
22              
23             This class represents the parameters used for calling the method DescribeEvents on the
24             AWS OpsWorks for Chef Automate service. Use the attributes of this class
25             as arguments to method DescribeEvents.
26              
27             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeEvents.
28              
29             As an example:
30              
31             $service_obj->DescribeEvents(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 MaxResults => Int
39              
40             To receive a paginated response, use this parameter to specify the
41             maximum number of results to be returned with a single call. If the
42             number of available results exceeds this maximum, the response includes
43             a C<NextToken> value that you can assign to the C<NextToken> request
44             parameter to get the next set of results.
45              
46              
47              
48             =head2 NextToken => Str
49              
50             NextToken is a string that is returned in some command responses. It
51             indicates that not all entries have been returned, and that you must
52             run at least one more request to get remaining items. To get remaining
53             results, call C<DescribeEvents> again, and assign the token from the
54             previous results as the value of the C<nextToken> parameter. If there
55             are no more results, the response object's C<nextToken> parameter value
56             is C<null>. Setting a C<nextToken> value that was not returned in your
57             previous results causes an C<InvalidNextTokenException> to occur.
58              
59              
60              
61             =head2 B<REQUIRED> ServerName => Str
62              
63             The name of the server for which you want to view events.
64              
65              
66              
67              
68             =head1 SEE ALSO
69              
70             This class forms part of L<Paws>, documenting arguments for method DescribeEvents in L<Paws::OpsWorksCM>
71              
72             =head1 BUGS and CONTRIBUTIONS
73              
74             The source code is located here: https://github.com/pplu/aws-sdk-perl
75              
76             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
77              
78             =cut
79