blib/lib/Paws/ElasticBeanstalk/DescribeEnvironments.pm

filter: Statementstmt 100% 18 / 18 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 20 / 20 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/ElasticBeanstalk/DescribeConfigurationOptions.pm ↑ Summary blib/lib/Paws/ElasticBeanstalk/DescribeEvents.pm »
1  
2 package Paws::ElasticBeanstalk::DescribeEnvironments;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has ApplicationName => (is => 'ro', isa => 'Str');
5 1 has EnvironmentIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
6 1 has EnvironmentNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
7 1 has IncludedDeletedBackTo => (is => 'ro', isa => 'Str');
8 1 has IncludeDeleted => (is => 'ro', isa => 'Bool');
9 1 has MaxRecords => (is => 'ro', isa => 'Int');
10 1 has NextToken => (is => 'ro', isa => 'Str');
11 1 has VersionLabel => (is => 'ro', isa => 'Str');
12  
13 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
14  
15 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeEnvironments');
16 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ElasticBeanstalk::EnvironmentDescriptionsMessage');
17 1 class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeEnvironmentsResult');
18 1 1;
19  
20 ### main pod documentation begin ###
21  
22 =head1 NAME
23  
24 Paws::ElasticBeanstalk::DescribeEnvironments - Arguments for method DescribeEnvironments on L<Paws::ElasticBeanstalk>
25  
26 =head1 DESCRIPTION
27  
28 This class represents the parameters used for calling the method DescribeEnvironments on the
29 L<AWS Elastic Beanstalk|Paws::ElasticBeanstalk> 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 =head1 SYNOPSIS
35  
36 my $elasticbeanstalk = Paws->service('ElasticBeanstalk');
37 # To view information about an environment
38 # The following operation retrieves information about an environment named
39 # my-env:
40 my $EnvironmentDescriptionsMessage =
41 $elasticbeanstalk->DescribeEnvironments(
42 'EnvironmentNames' => ['my-env'] );
43  
44 # Results:
45 my $Environments = $EnvironmentDescriptionsMessage->Environments;
46  
47 # Returns a L<Paws::ElasticBeanstalk::EnvironmentDescriptionsMessage> object.
48  
49 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.
50 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk/DescribeEnvironments>
51  
52 =head1 ATTRIBUTES
53  
54  
55 =head2 ApplicationName => Str
56  
57 If specified, AWS Elastic Beanstalk restricts the returned descriptions
58 to include only those that are associated with this application.
59  
60  
61  
62 =head2 EnvironmentIds => ArrayRef[Str|Undef]
63  
64 If specified, AWS Elastic Beanstalk restricts the returned descriptions
65 to include only those that have the specified IDs.
66  
67  
68  
69 =head2 EnvironmentNames => ArrayRef[Str|Undef]
70  
71 If specified, AWS Elastic Beanstalk restricts the returned descriptions
72 to include only those that have the specified names.
73  
74  
75  
76 =head2 IncludedDeletedBackTo => Str
77  
78 If specified when C<IncludeDeleted> is set to C<true>, then
79 environments deleted after this date are displayed.
80  
81  
82  
83 =head2 IncludeDeleted => Bool
84  
85 Indicates whether to include deleted environments:
86  
87 C<true>: Environments that have been deleted after
88 C<IncludedDeletedBackTo> are displayed.
89  
90 C<false>: Do not include deleted environments.
91  
92  
93  
94 =head2 MaxRecords => Int
95  
96 For a paginated request. Specify a maximum number of environments to
97 include in each response.
98  
99 If no C<MaxRecords> is specified, all available environments are
100 retrieved in a single response.
101  
102  
103  
104 =head2 NextToken => Str
105  
106 For a paginated request. Specify a token from a previous response page
107 to retrieve the next response page. All other parameter values must be
108 identical to the ones specified in the initial request.
109  
110 If no C<NextToken> is specified, the first page is retrieved.
111  
112  
113  
114 =head2 VersionLabel => Str
115  
116 If specified, AWS Elastic Beanstalk restricts the returned descriptions
117 to include only those that are associated with this application
118 version.
119  
120  
121  
122  
123 =head1 SEE ALSO
124  
125 This class forms part of L<Paws>, documenting arguments for method DescribeEnvironments in L<Paws::ElasticBeanstalk>
126  
127 =head1 BUGS and CONTRIBUTIONS
128  
129 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
130  
131 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
132  
133 =cut
134  
« blib/lib/Paws/ElasticBeanstalk/DescribeConfigurationOptions.pm ↑ Summary blib/lib/Paws/ElasticBeanstalk/DescribeEvents.pm »