File Coverage

blib/lib/Paws/CodeDeploy/ListDeployments.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::CodeDeploy::ListDeployments;
3 1     1   629 use Moose;
  1         3  
  1         8  
4             has ApplicationName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'applicationName' );
5             has CreateTimeRange => (is => 'ro', isa => 'Paws::CodeDeploy::TimeRange', traits => ['NameInRequest'], request_name => 'createTimeRange' );
6             has DeploymentGroupName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'deploymentGroupName' );
7             has IncludeOnlyStatuses => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'includeOnlyStatuses' );
8             has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' );
9              
10 1     1   6919 use MooseX::ClassAttribute;
  1         2  
  1         10  
11              
12             class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListDeployments');
13             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeDeploy::ListDeploymentsOutput');
14             class_has _result_key => (isa => 'Str', is => 'ro');
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::CodeDeploy::ListDeployments - Arguments for method ListDeployments on Paws::CodeDeploy
22              
23             =head1 DESCRIPTION
24              
25             This class represents the parameters used for calling the method ListDeployments on the
26             AWS CodeDeploy service. Use the attributes of this class
27             as arguments to method ListDeployments.
28              
29             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListDeployments.
30              
31             As an example:
32              
33             $service_obj->ListDeployments(Att1 => $value1, Att2 => $value2, ...);
34              
35             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.
36              
37             =head1 ATTRIBUTES
38              
39              
40             =head2 ApplicationName => Str
41              
42             The name of an AWS CodeDeploy application associated with the
43             applicable IAM user or AWS account.
44              
45              
46              
47             =head2 CreateTimeRange => L<Paws::CodeDeploy::TimeRange>
48              
49             A time range (start and end) for returning a subset of the list of
50             deployments.
51              
52              
53              
54             =head2 DeploymentGroupName => Str
55              
56             The name of an existing deployment group for the specified application.
57              
58              
59              
60             =head2 IncludeOnlyStatuses => ArrayRef[Str|Undef]
61              
62             A subset of deployments to list by status:
63              
64             =over
65              
66             =item *
67              
68             Created: Include created deployments in the resulting list.
69              
70             =item *
71              
72             Queued: Include queued deployments in the resulting list.
73              
74             =item *
75              
76             In Progress: Include in-progress deployments in the resulting list.
77              
78             =item *
79              
80             Succeeded: Include successful deployments in the resulting list.
81              
82             =item *
83              
84             Failed: Include failed deployments in the resulting list.
85              
86             =item *
87              
88             Stopped: Include stopped deployments in the resulting list.
89              
90             =back
91              
92              
93              
94              
95             =head2 NextToken => Str
96              
97             An identifier returned from the previous list deployments call. It can
98             be used to return the next set of deployments in the list.
99              
100              
101              
102              
103             =head1 SEE ALSO
104              
105             This class forms part of L<Paws>, documenting arguments for method ListDeployments in L<Paws::CodeDeploy>
106              
107             =head1 BUGS and CONTRIBUTIONS
108              
109             The source code is located here: https://github.com/pplu/aws-sdk-perl
110              
111             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
112              
113             =cut
114