File Coverage

blib/lib/Paws/RDS/DescribeOptionGroups.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::RDS::DescribeOptionGroups;
3 1     1   272 use Moose;
  1     1   3  
  1         6  
  1         484  
  1         2  
  1         6  
4             has EngineName => (is => 'ro', isa => 'Str');
5             has Filters => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Filter]');
6             has MajorEngineVersion => (is => 'ro', isa => 'Str');
7             has Marker => (is => 'ro', isa => 'Str');
8             has MaxRecords => (is => 'ro', isa => 'Int');
9             has OptionGroupName => (is => 'ro', isa => 'Str');
10              
11 1     1   5326 use MooseX::ClassAttribute;
  1     1   3  
  1         7  
  1         6236  
  1         2  
  1         11  
12              
13             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeOptionGroups');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::OptionGroups');
15             class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeOptionGroupsResult');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::RDS::DescribeOptionGroups - Arguments for method DescribeOptionGroups on Paws::RDS
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method DescribeOptionGroups on the
27             Amazon Relational Database Service service. Use the attributes of this class
28             as arguments to method DescribeOptionGroups.
29              
30             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeOptionGroups.
31              
32             As an example:
33              
34             $service_obj->DescribeOptionGroups(Att1 => $value1, Att2 => $value2, ...);
35              
36             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.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 EngineName => Str
42              
43             Filters the list of option groups to only include groups associated
44             with a specific database engine.
45              
46              
47              
48             =head2 Filters => ArrayRef[L<Paws::RDS::Filter>]
49              
50             This parameter is not currently supported.
51              
52              
53              
54             =head2 MajorEngineVersion => Str
55              
56             Filters the list of option groups to only include groups associated
57             with a specific database engine version. If specified, then EngineName
58             must also be specified.
59              
60              
61              
62             =head2 Marker => Str
63              
64             An optional pagination token provided by a previous
65             DescribeOptionGroups request. If this parameter is specified, the
66             response includes only records beyond the marker, up to the value
67             specified by C<MaxRecords>.
68              
69              
70              
71             =head2 MaxRecords => Int
72              
73             The maximum number of records to include in the response. If more
74             records exist than the specified C<MaxRecords> value, a pagination
75             token called a marker is included in the response so that the remaining
76             results can be retrieved.
77              
78             Default: 100
79              
80             Constraints: Minimum 20, maximum 100.
81              
82              
83              
84             =head2 OptionGroupName => Str
85              
86             The name of the option group to describe. Cannot be supplied together
87             with EngineName or MajorEngineVersion.
88              
89              
90              
91              
92             =head1 SEE ALSO
93              
94             This class forms part of L<Paws>, documenting arguments for method DescribeOptionGroups in L<Paws::RDS>
95              
96             =head1 BUGS and CONTRIBUTIONS
97              
98             The source code is located here: https://github.com/pplu/aws-sdk-perl
99              
100             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
101              
102             =cut
103