File Coverage

blib/lib/Paws/CodeDeploy/ListDeploymentInstances.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::ListDeploymentInstances;
3 1     1   471 use Moose;
  1         4  
  1         10  
4             has DeploymentId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'deploymentId' , required => 1);
5             has InstanceStatusFilter => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'instanceStatusFilter' );
6             has InstanceTypeFilter => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'instanceTypeFilter' );
7             has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' );
8              
9 1     1   6482 use MooseX::ClassAttribute;
  1         3  
  1         8  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListDeploymentInstances');
12             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeDeploy::ListDeploymentInstancesOutput');
13             class_has _result_key => (isa => 'Str', is => 'ro');
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::CodeDeploy::ListDeploymentInstances - Arguments for method ListDeploymentInstances on Paws::CodeDeploy
21              
22             =head1 DESCRIPTION
23              
24             This class represents the parameters used for calling the method ListDeploymentInstances on the
25             AWS CodeDeploy service. Use the attributes of this class
26             as arguments to method ListDeploymentInstances.
27              
28             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListDeploymentInstances.
29              
30             As an example:
31              
32             $service_obj->ListDeploymentInstances(Att1 => $value1, Att2 => $value2, ...);
33              
34             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.
35              
36             =head1 ATTRIBUTES
37              
38              
39             =head2 B<REQUIRED> DeploymentId => Str
40              
41             The unique ID of a deployment.
42              
43              
44              
45             =head2 InstanceStatusFilter => ArrayRef[Str|Undef]
46              
47             A subset of instances to list by status:
48              
49             =over
50              
51             =item *
52              
53             Pending: Include those instance with pending deployments.
54              
55             =item *
56              
57             InProgress: Include those instance where deployments are still in
58             progress.
59              
60             =item *
61              
62             Succeeded: Include those instances with successful deployments.
63              
64             =item *
65              
66             Failed: Include those instance with failed deployments.
67              
68             =item *
69              
70             Skipped: Include those instance with skipped deployments.
71              
72             =item *
73              
74             Unknown: Include those instance with deployments in an unknown state.
75              
76             =back
77              
78              
79              
80              
81             =head2 InstanceTypeFilter => ArrayRef[Str|Undef]
82              
83             The set of instances in a blue/green deployment, either those in the
84             original environment ("BLUE") or those in the replacement environment
85             ("GREEN"), for which you want to view instance information.
86              
87              
88              
89             =head2 NextToken => Str
90              
91             An identifier returned from the previous list deployment instances
92             call. It can be used to return the next set of deployment instances in
93             the list.
94              
95              
96              
97              
98             =head1 SEE ALSO
99              
100             This class forms part of L<Paws>, documenting arguments for method ListDeploymentInstances in L<Paws::CodeDeploy>
101              
102             =head1 BUGS and CONTRIBUTIONS
103              
104             The source code is located here: https://github.com/pplu/aws-sdk-perl
105              
106             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
107              
108             =cut
109