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   468 use Moose;
  1     1   3  
  1         6  
  1         503  
  1         2  
  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 VersionLabel => (is => 'ro', isa => 'Str');
10              
11 1     1   6507 use MooseX::ClassAttribute;
  1     1   2  
  1         6  
  1         6553  
  1         3  
  1         7  
12              
13             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeEnvironments');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ElasticBeanstalk::EnvironmentDescriptionsMessage');
15             class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeEnvironmentsResult');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::ElasticBeanstalk::DescribeEnvironments - Arguments for method DescribeEnvironments on Paws::ElasticBeanstalk
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method DescribeEnvironments on the
27             AWS Elastic Beanstalk service. Use the attributes of this class
28             as arguments to method DescribeEnvironments.
29              
30             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeEnvironments.
31              
32             As an example:
33              
34             $service_obj->DescribeEnvironments(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 ApplicationName => Str
42              
43             If specified, AWS Elastic Beanstalk restricts the returned descriptions
44             to include only those that are associated with this application.
45              
46              
47              
48             =head2 EnvironmentIds => ArrayRef[Str|Undef]
49              
50             If specified, AWS Elastic Beanstalk restricts the returned descriptions
51             to include only those that have the specified IDs.
52              
53              
54              
55             =head2 EnvironmentNames => ArrayRef[Str|Undef]
56              
57             If specified, AWS Elastic Beanstalk restricts the returned descriptions
58             to include only those that have the specified names.
59              
60              
61              
62             =head2 IncludedDeletedBackTo => Str
63              
64             If specified when C<IncludeDeleted> is set to C<true>, then
65             environments deleted after this date are displayed.
66              
67              
68              
69             =head2 IncludeDeleted => Bool
70              
71             Indicates whether to include deleted environments:
72              
73             C<true>: Environments that have been deleted after
74             C<IncludedDeletedBackTo> are displayed.
75              
76             C<false>: Do not include deleted environments.
77              
78              
79              
80             =head2 VersionLabel => Str
81              
82             If specified, AWS Elastic Beanstalk restricts the returned descriptions
83             to include only those that are associated with this application
84             version.
85              
86              
87              
88              
89             =head1 SEE ALSO
90              
91             This class forms part of L<Paws>, documenting arguments for method DescribeEnvironments in L<Paws::ElasticBeanstalk>
92              
93             =head1 BUGS and CONTRIBUTIONS
94              
95             The source code is located here: https://github.com/pplu/aws-sdk-perl
96              
97             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
98              
99             =cut
100