File Coverage

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