From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

JROBINSON / Paws-0.46 / lib / Paws / CodeDeploy / ListDeployments.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
—
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

              
package Paws::CodeDeploy::ListDeployments;
  use Moose;
  has ApplicationName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'applicationName' );
  has CreateTimeRange => (is => 'ro', isa => 'Paws::CodeDeploy::TimeRange', traits => ['NameInRequest'], request_name => 'createTimeRange' );
  has DeploymentGroupName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'deploymentGroupName' );
  has ExternalId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'externalId' );
  has IncludeOnlyStatuses => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'includeOnlyStatuses' );
  has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' );
  use MooseX::ClassAttribute;
  class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListDeployments');
  class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeDeploy::ListDeploymentsOutput');
  class_has _result_key => (isa => 'Str', is => 'ro');
1;
### main pod documentation begin ###
=head1 NAME
Paws::CodeDeploy::ListDeployments - Arguments for method ListDeployments on L<Paws::CodeDeploy>
=head1 DESCRIPTION
This class represents the parameters used for calling the method ListDeployments on the
L<AWS CodeDeploy|Paws::CodeDeploy> service. Use the attributes of this class
as arguments to method ListDeployments.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListDeployments.
=head1 SYNOPSIS
    my $codedeploy = Paws->service('CodeDeploy');
    my $ListDeploymentsOutput = $codedeploy->ListDeployments(
      ApplicationName => 'MyApplicationName',    # OPTIONAL
      CreateTimeRange => {
        End   => '1970-01-01T01:00:00',          # OPTIONAL
        Start => '1970-01-01T01:00:00',          # OPTIONAL
      },    # OPTIONAL
      DeploymentGroupName => 'MyDeploymentGroupName',    # OPTIONAL
      ExternalId          => 'MyExternalId',             # OPTIONAL
      IncludeOnlyStatuses => [
        'Created',
        ... # values: Created, Queued, InProgress, Baking, Succeeded, Failed, Stopped, Ready
      ],    # OPTIONAL
      NextToken => 'MyNextToken',    # OPTIONAL
    );
    # Results:
    my $Deployments = $ListDeploymentsOutput->Deployments;
    my $NextToken   = $ListDeploymentsOutput->NextToken;
    # Returns a L<Paws::CodeDeploy::ListDeploymentsOutput> object.
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.
For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/codedeploy/ListDeployments>
=head1 ATTRIBUTES
=head2 ApplicationName => Str
The name of an AWS CodeDeploy application associated with the IAM user
or AWS account.
If C<applicationName> is specified, then C<deploymentGroupName> must be
specified. If it is not specified, then C<deploymentGroupName> must not
be specified.
=head2 CreateTimeRange => L<Paws::CodeDeploy::TimeRange>
A time range (start and end) for returning a subset of the list of
deployments.
=head2 DeploymentGroupName => Str
The name of a deployment group for the specified application.
If C<deploymentGroupName> is specified, then C<applicationName> must be
specified. If it is not specified, then C<applicationName> must not be
specified.
=head2 ExternalId => Str
The unique ID of an external resource for returning deployments linked
to the external resource.
=head2 IncludeOnlyStatuses => ArrayRef[Str|Undef]
A subset of deployments to list by status:
=over
=item *
C<Created>: Include created deployments in the resulting list.
=item *
C<Queued>: Include queued deployments in the resulting list.
=item *
C<In Progress>: Include in-progress deployments in the resulting list.
=item *
C<Succeeded>: Include successful deployments in the resulting list.
=item *
C<Failed>: Include failed deployments in the resulting list.
=item *
C<Stopped>: Include stopped deployments in the resulting list.
=back
=head2 NextToken => Str
An identifier returned from the previous list deployments call. It can
be used to return the next set of deployments in the list.
=head1 SEE ALSO
This class forms part of L<Paws>, documenting arguments for method ListDeployments in L<Paws::CodeDeploy>
=head1 BUGS and CONTRIBUTIONS
The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
=cut