Sponsoring The Perl Toolchain Summit 2025: Help make this important event another success Learn more

JROBINSON / Paws-0.46 / lib / Paws / Neptune / DescribeDBEngineVersions.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
—
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162

              
package Paws::Neptune::DescribeDBEngineVersions;
  use Moose;
  has DBParameterGroupFamily => (is => 'ro', isa => 'Str');
  has DefaultOnly => (is => 'ro', isa => 'Bool');
  has Engine => (is => 'ro', isa => 'Str');
  has EngineVersion => (is => 'ro', isa => 'Str');
  has Filters => (is => 'ro', isa => 'ArrayRef[Paws::Neptune::Filter]');
  has ListSupportedCharacterSets => (is => 'ro', isa => 'Bool');
  has ListSupportedTimezones => (is => 'ro', isa => 'Bool');
  has Marker => (is => 'ro', isa => 'Str');
  has MaxRecords => (is => 'ro', isa => 'Int');
  use MooseX::ClassAttribute;
  class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeDBEngineVersions');
  class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Neptune::DBEngineVersionMessage');
  class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeDBEngineVersionsResult');
1;
### main pod documentation begin ###
=head1 NAME
Paws::Neptune::DescribeDBEngineVersions - Arguments for method DescribeDBEngineVersions on L<Paws::Neptune>
=head1 DESCRIPTION
This class represents the parameters used for calling the method DescribeDBEngineVersions on the
L<Amazon Neptune|Paws::Neptune> service. Use the attributes of this class
as arguments to method DescribeDBEngineVersions.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDBEngineVersions.
=head1 SYNOPSIS
    my $rds = Paws->service('Neptune');
    my $DBEngineVersionMessage = $rds->DescribeDBEngineVersions(
      DBParameterGroupFamily => 'MyString',    # OPTIONAL
      DefaultOnly            => 1,             # OPTIONAL
      Engine                 => 'MyString',    # OPTIONAL
      EngineVersion          => 'MyString',    # OPTIONAL
      Filters                => [
        {
          Name   => 'MyString',
          Values => [ 'MyString', ... ],
        },
        ...
      ],                                       # OPTIONAL
      ListSupportedCharacterSets => 1,             # OPTIONAL
      ListSupportedTimezones     => 1,             # OPTIONAL
      Marker                     => 'MyString',    # OPTIONAL
      MaxRecords                 => 1,             # OPTIONAL
    );
    # Results:
    my $DBEngineVersions = $DBEngineVersionMessage->DBEngineVersions;
    my $Marker           = $DBEngineVersionMessage->Marker;
    # Returns a L<Paws::Neptune::DBEngineVersionMessage> object.
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.
For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/DescribeDBEngineVersions>
=head1 ATTRIBUTES
=head2 DBParameterGroupFamily => Str
The name of a specific DB parameter group family to return details for.
Constraints:
=over
=item *
If supplied, must match an existing DBParameterGroupFamily.
=back
=head2 DefaultOnly => Bool
Indicates that only the default version of the specified engine or
engine and major version combination is returned.
=head2 Engine => Str
The database engine to return.
=head2 EngineVersion => Str
The database engine version to return.
Example: C<5.1.49>
=head2 Filters => ArrayRef[L<Paws::Neptune::Filter>]
Not currently supported.
=head2 ListSupportedCharacterSets => Bool
If this parameter is specified and the requested engine supports the
C<CharacterSetName> parameter for C<CreateDBInstance>, the response
includes a list of supported character sets for each engine version.
=head2 ListSupportedTimezones => Bool
If this parameter is specified and the requested engine supports the
C<TimeZone> parameter for C<CreateDBInstance>, the response includes a
list of supported time zones for each engine version.
=head2 Marker => Str
An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by C<MaxRecords>.
=head2 MaxRecords => Int
The maximum number of records to include in the response. If more than
the C<MaxRecords> value is available, a pagination token called a
marker is included in the response so that the following results can be
retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
=head1 SEE ALSO
This class forms part of L<Paws>, documenting arguments for method DescribeDBEngineVersions in L<Paws::Neptune>
=head1 BUGS and CONTRIBUTIONS
The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
=cut