File Coverage

blib/lib/Paws/ElasticBeanstalk/DescribeEnvironments.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::ElasticBeanstalk::DescribeEnvironments;
3 1     1   417 use Moose;
  1     1   2  
  1         9  
  1         492  
  1         3  
  1         7  
4             has ApplicationName => (is => 'ro', isa => 'Str');
5             has EnvironmentIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
6             has EnvironmentNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
7             has IncludedDeletedBackTo => (is => 'ro', isa => 'Str');
8             has IncludeDeleted => (is => 'ro', isa => 'Bool');
9             has MaxRecords => (is => 'ro', isa => 'Int');
10             has NextToken => (is => 'ro', isa => 'Str');
11             has VersionLabel => (is => 'ro', isa => 'Str');
12              
13 1     1   6395 use MooseX::ClassAttribute;
  1     1   2  
  1         10  
  1         6094  
  1         3  
  1         8  
14              
15             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeEnvironments');
16             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ElasticBeanstalk::EnvironmentDescriptionsMessage');
17             class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeEnvironmentsResult');
18             1;
19              
20             ### main pod documentation begin ###
21              
22             =head1 NAME
23              
24             Paws::ElasticBeanstalk::DescribeEnvironments - Arguments for method DescribeEnvironments on Paws::ElasticBeanstalk
25              
26             =head1 DESCRIPTION
27              
28             This class represents the parameters used for calling the method DescribeEnvironments on the
29             AWS Elastic Beanstalk service. Use the attributes of this class
30             as arguments to method DescribeEnvironments.
31              
32             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeEnvironments.
33              
34             As an example:
35              
36             $service_obj->DescribeEnvironments(Att1 => $value1, Att2 => $value2, ...);
37              
38             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.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 ApplicationName => Str
44              
45             If specified, AWS Elastic Beanstalk restricts the returned descriptions
46             to include only those that are associated with this application.
47              
48              
49              
50             =head2 EnvironmentIds => ArrayRef[Str|Undef]
51              
52             If specified, AWS Elastic Beanstalk restricts the returned descriptions
53             to include only those that have the specified IDs.
54              
55              
56              
57             =head2 EnvironmentNames => ArrayRef[Str|Undef]
58              
59             If specified, AWS Elastic Beanstalk restricts the returned descriptions
60             to include only those that have the specified names.
61              
62              
63              
64             =head2 IncludedDeletedBackTo => Str
65              
66             If specified when C<IncludeDeleted> is set to C<true>, then
67             environments deleted after this date are displayed.
68              
69              
70              
71             =head2 IncludeDeleted => Bool
72              
73             Indicates whether to include deleted environments:
74              
75             C<true>: Environments that have been deleted after
76             C<IncludedDeletedBackTo> are displayed.
77              
78             C<false>: Do not include deleted environments.
79              
80              
81              
82             =head2 MaxRecords => Int
83              
84             For a paginated request. Specify a maximum number of environments to
85             include in each response.
86              
87             If no C<MaxRecords> is specified, all available environments are
88             retrieved in a single response.
89              
90              
91              
92             =head2 NextToken => Str
93              
94             For a paginated request. Specify a token from a previous response page
95             to retrieve the next response page. All other parameter values must be
96             identical to the ones specified in the initial request.
97              
98             If no C<NextToken> is specified, the first page is retrieved.
99              
100              
101              
102             =head2 VersionLabel => Str
103              
104             If specified, AWS Elastic Beanstalk restricts the returned descriptions
105             to include only those that are associated with this application
106             version.
107              
108              
109              
110              
111             =head1 SEE ALSO
112              
113             This class forms part of L<Paws>, documenting arguments for method DescribeEnvironments in L<Paws::ElasticBeanstalk>
114              
115             =head1 BUGS and CONTRIBUTIONS
116              
117             The source code is located here: https://github.com/pplu/aws-sdk-perl
118              
119             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
120              
121             =cut
122