blib/lib/Paws/Neptune/DescribeDBInstances.pm untested

filter: Statementstmt 0.0% 0 / 13 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 15 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Neptune::DescribeDBInstances;
3 use Moose;
4 has DBInstanceIdentifier => (is => 'ro', isa => 'Str');
5 has Filters => (is => 'ro', isa => 'ArrayRef[Paws::Neptune::Filter]');
6 has Marker => (is => 'ro', isa => 'Str');
7 has MaxRecords => (is => 'ro', isa => 'Int');
8  
9 use MooseX::ClassAttribute;
10  
11 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeDBInstances');
12 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Neptune::DBInstanceMessage');
13 class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeDBInstancesResult');
14 1;
15  
16 ### main pod documentation begin ###
17  
18 =head1 NAME
19  
20 Paws::Neptune::DescribeDBInstances - Arguments for method DescribeDBInstances on L<Paws::Neptune>
21  
22 =head1 DESCRIPTION
23  
24 This class represents the parameters used for calling the method DescribeDBInstances on the
25 L<Amazon Neptune|Paws::Neptune> service. Use the attributes of this class
26 as arguments to method DescribeDBInstances.
27  
28 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDBInstances.
29  
30 =head1 SYNOPSIS
31  
32 my $rds = Paws->service('Neptune');
33 my $DBInstanceMessage = $rds->DescribeDBInstances(
34 DBInstanceIdentifier => 'MyString', # OPTIONAL
35 Filters => [
36 {
37 Name => 'MyString',
38 Values => [ 'MyString', ... ],
39  
40 },
41 ...
42 ], # OPTIONAL
43 Marker => 'MyString', # OPTIONAL
44 MaxRecords => 1, # OPTIONAL
45 );
46  
47 # Results:
48 my $DBInstances = $DBInstanceMessage->DBInstances;
49 my $Marker = $DBInstanceMessage->Marker;
50  
51 # Returns a L<Paws::Neptune::DBInstanceMessage> object.
52  
53 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.
54 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/DescribeDBInstances>
55  
56 =head1 ATTRIBUTES
57  
58  
59 =head2 DBInstanceIdentifier => Str
60  
61 The user-supplied instance identifier. If this parameter is specified,
62 information from only the specific DB instance is returned. This
63 parameter isn't case-sensitive.
64  
65 Constraints:
66  
67 =over
68  
69 =item *
70  
71 If supplied, must match the identifier of an existing DBInstance.
72  
73 =back
74  
75  
76  
77  
78 =head2 Filters => ArrayRef[L<Paws::Neptune::Filter>]
79  
80 A filter that specifies one or more DB instances to describe.
81  
82 Supported filters:
83  
84 =over
85  
86 =item *
87  
88 C<db-cluster-id> - Accepts DB cluster identifiers and DB cluster Amazon
89 Resource Names (ARNs). The results list will only include information
90 about the DB instances associated with the DB clusters identified by
91 these ARNs.
92  
93 =item *
94  
95 C<engine> - Accepts an engine name (such as C<neptune>), and restricts
96 the results list to DB instances created by that engine.
97  
98 =back
99  
100 For example, to invoke this API from the Amazon CLI and filter so that
101 only Neptune DB instances are returned, you could use the following
102 command:
103  
104  
105  
106 =head2 Marker => Str
107  
108 An optional pagination token provided by a previous
109 C<DescribeDBInstances> request. If this parameter is specified, the
110 response includes only records beyond the marker, up to the value
111 specified by C<MaxRecords>.
112  
113  
114  
115 =head2 MaxRecords => Int
116  
117 The maximum number of records to include in the response. If more
118 records exist than the specified C<MaxRecords> value, a pagination
119 token called a marker is included in the response so that the remaining
120 results can be retrieved.
121  
122 Default: 100
123  
124 Constraints: Minimum 20, maximum 100.
125  
126  
127  
128  
129 =head1 SEE ALSO
130  
131 This class forms part of L<Paws>, documenting arguments for method DescribeDBInstances in L<Paws::Neptune>
132  
133 =head1 BUGS and CONTRIBUTIONS
134  
135 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
136  
137 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
138  
139 =cut
140