blib/lib/Paws/CodeStarConnections.pm untested

filter: Statementstmt 0.0% 0 / 51 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 19 Podpod 0.0% 0 / 18 totaltotal 0.0% 0 / 88 CC 1 SCAR 6.9
CC
1
Cov
0%
service
2.0
signing_name
2.0
version
2.0
CRAP 2.0
1 package Paws::CodeStarConnections;
2 use Moose;
3 sub service { 'codestar-connections' }
4 sub signing_name { 'codestar-connections' }
5 sub version { '2019-12-01' }
6 sub target_prefix { 'com.amazonaws.codestar.connections.CodeStar_connections_20191201' }
7 sub json_version { "1.0" }
8 has max_attempts => (is => 'ro', isa => 'Int', default => 5);
9 has retry => (is => 'ro', isa => 'HashRef', default => sub {
10 { base => 'rand', type => 'exponential', growth_factor => 2 }
11 });
12 has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
13 ] });
14  
15 with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::JsonCaller';
16  
17
18 sub CreateConnection {
19 my $self = shift;
20 my $call_object = $self->new_with_coercions('Paws::CodeStarConnections::CreateConnection', @_);
21 return $self->caller->do_call($self, $call_object);
22 }
23 sub CreateHost {
24 my $self = shift;
25 my $call_object = $self->new_with_coercions('Paws::CodeStarConnections::CreateHost', @_);
26 return $self->caller->do_call($self, $call_object);
27 }
28 sub DeleteConnection {
29 my $self = shift;
30 my $call_object = $self->new_with_coercions('Paws::CodeStarConnections::DeleteConnection', @_);
31 return $self->caller->do_call($self, $call_object);
32 }
33 sub DeleteHost {
34 my $self = shift;
35 my $call_object = $self->new_with_coercions('Paws::CodeStarConnections::DeleteHost', @_);
36 return $self->caller->do_call($self, $call_object);
37 }
38 sub GetConnection {
39 my $self = shift;
40 my $call_object = $self->new_with_coercions('Paws::CodeStarConnections::GetConnection', @_);
41 return $self->caller->do_call($self, $call_object);
42 }
43 sub GetHost {
44 my $self = shift;
45 my $call_object = $self->new_with_coercions('Paws::CodeStarConnections::GetHost', @_);
46 return $self->caller->do_call($self, $call_object);
47 }
48 sub ListConnections {
49 my $self = shift;
50 my $call_object = $self->new_with_coercions('Paws::CodeStarConnections::ListConnections', @_);
51 return $self->caller->do_call($self, $call_object);
52 }
53 sub ListHosts {
54 my $self = shift;
55 my $call_object = $self->new_with_coercions('Paws::CodeStarConnections::ListHosts', @_);
56 return $self->caller->do_call($self, $call_object);
57 }
58 sub ListTagsForResource {
59 my $self = shift;
60 my $call_object = $self->new_with_coercions('Paws::CodeStarConnections::ListTagsForResource', @_);
61 return $self->caller->do_call($self, $call_object);
62 }
63 sub TagResource {
64 my $self = shift;
65 my $call_object = $self->new_with_coercions('Paws::CodeStarConnections::TagResource', @_);
66 return $self->caller->do_call($self, $call_object);
67 }
68 sub UntagResource {
69 my $self = shift;
70 my $call_object = $self->new_with_coercions('Paws::CodeStarConnections::UntagResource', @_);
71 return $self->caller->do_call($self, $call_object);
72 }
73 sub UpdateHost {
74 my $self = shift;
75 my $call_object = $self->new_with_coercions('Paws::CodeStarConnections::UpdateHost', @_);
76 return $self->caller->do_call($self, $call_object);
77 }
78
79  
80  
81 sub operations { qw/CreateConnection CreateHost DeleteConnection DeleteHost GetConnection GetHost ListConnections ListHosts ListTagsForResource TagResource UntagResource UpdateHost / }
82  
83 1;
84  
85 ### main pod documentation begin ###
86  
87 =head1 NAME
88  
89 Paws::CodeStarConnections - Perl Interface to AWS AWS CodeStar connections
90  
91 =head1 SYNOPSIS
92  
93 use Paws;
94  
95 my $obj = Paws->service('CodeStarConnections');
96 my $res = $obj->Method(
97 Arg1 => $val1,
98 Arg2 => [ 'V1', 'V2' ],
99 # if Arg3 is an object, the HashRef will be used as arguments to the constructor
100 # of the arguments type
101 Arg3 => { Att1 => 'Val1' },
102 # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
103 # the constructor of the arguments type
104 Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
105 );
106  
107 =head1 DESCRIPTION
108  
109 AWS CodeStar Connections
110  
111 This AWS CodeStar Connections API Reference provides descriptions and
112 usage examples of the operations and data types for the AWS CodeStar
113 Connections API. You can use the connections API to work with
114 connections and installations.
115  
116 I<Connections> are configurations that you use to connect AWS resources
117 to external code repositories. Each connection is a resource that can
118 be given to services such as CodePipeline to connect to a third-party
119 repository such as Bitbucket. For example, you can add the connection
120 in CodePipeline so that it triggers your pipeline when a code change is
121 made to your third-party code repository. Each connection is named and
122 associated with a unique ARN that is used to reference the connection.
123  
124 When you create a connection, the console initiates a third-party
125 connection handshake. I<Installations> are the apps that are used to
126 conduct this handshake. For example, the installation for the Bitbucket
127 provider type is the Bitbucket app. When you create a connection, you
128 can choose an existing installation or create one.
129  
130 When you want to create a connection to an installed provider type such
131 as GitHub Enterprise Server, you create a I<host> for your connections.
132  
133 You can work with connections by calling:
134  
135 =over
136  
137 =item *
138  
139 CreateConnection, which creates a uniquely named connection that can be
140 referenced by services such as CodePipeline.
141  
142 =item *
143  
144 DeleteConnection, which deletes the specified connection.
145  
146 =item *
147  
148 GetConnection, which returns information about the connection,
149 including the connection status.
150  
151 =item *
152  
153 ListConnections, which lists the connections associated with your
154 account.
155  
156 =back
157  
158 You can work with hosts by calling:
159  
160 =over
161  
162 =item *
163  
164 CreateHost, which creates a host that represents the infrastructure
165 where your provider is installed.
166  
167 =item *
168  
169 DeleteHost, which deletes the specified host.
170  
171 =item *
172  
173 GetHost, which returns information about the host, including the setup
174 status.
175  
176 =item *
177  
178 ListHosts, which lists the hosts associated with your account.
179  
180 =back
181  
182 You can work with tags in AWS CodeStar Connections by calling the
183 following:
184  
185 =over
186  
187 =item *
188  
189 ListTagsForResource, which gets information about AWS tags for a
190 specified Amazon Resource Name (ARN) in AWS CodeStar Connections.
191  
192 =item *
193  
194 TagResource, which adds or updates tags for a resource in AWS CodeStar
195 Connections.
196  
197 =item *
198  
199 UntagResource, which removes tags for a resource in AWS CodeStar
200 Connections.
201  
202 =back
203  
204 For information about how to use AWS CodeStar Connections, see the
205 Developer Tools User Guide
206 (https://docs.aws.amazon.com/dtconsole/latest/userguide/welcome-connections.html).
207  
208 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/codestar-connections-2019-12-01>
209  
210  
211 =head1 METHODS
212  
213 =head2 CreateConnection
214  
215 =over
216  
217 =item ConnectionName => Str
218  
219 =item [HostArn => Str]
220  
221 =item [ProviderType => Str]
222  
223 =item [Tags => ArrayRef[L<Paws::CodeStarConnections::Tag>]]
224  
225  
226 =back
227  
228 Each argument is described in detail in: L<Paws::CodeStarConnections::CreateConnection>
229  
230 Returns: a L<Paws::CodeStarConnections::CreateConnectionOutput> instance
231  
232 Creates a connection that can then be given to other AWS services like
233 CodePipeline so that it can access third-party code repositories. The
234 connection is in pending status until the third-party connection
235 handshake is completed from the console.
236  
237  
238 =head2 CreateHost
239  
240 =over
241  
242 =item Name => Str
243  
244 =item ProviderEndpoint => Str
245  
246 =item ProviderType => Str
247  
248 =item [Tags => ArrayRef[L<Paws::CodeStarConnections::Tag>]]
249  
250 =item [VpcConfiguration => L<Paws::CodeStarConnections::VpcConfiguration>]
251  
252  
253 =back
254  
255 Each argument is described in detail in: L<Paws::CodeStarConnections::CreateHost>
256  
257 Returns: a L<Paws::CodeStarConnections::CreateHostOutput> instance
258  
259 Creates a resource that represents the infrastructure where a
260 third-party provider is installed. The host is used when you create
261 connections to an installed third-party provider type, such as GitHub
262 Enterprise Server. You create one host for all connections to that
263 provider.
264  
265 A host created through the CLI or the SDK is in `PENDING` status by
266 default. You can make its status `AVAILABLE` by setting up the host in
267 the console.
268  
269  
270 =head2 DeleteConnection
271  
272 =over
273  
274 =item ConnectionArn => Str
275  
276  
277 =back
278  
279 Each argument is described in detail in: L<Paws::CodeStarConnections::DeleteConnection>
280  
281 Returns: a L<Paws::CodeStarConnections::DeleteConnectionOutput> instance
282  
283 The connection to be deleted.
284  
285  
286 =head2 DeleteHost
287  
288 =over
289  
290 =item HostArn => Str
291  
292  
293 =back
294  
295 Each argument is described in detail in: L<Paws::CodeStarConnections::DeleteHost>
296  
297 Returns: a L<Paws::CodeStarConnections::DeleteHostOutput> instance
298  
299 The host to be deleted. Before you delete a host, all connections
300 associated to the host must be deleted.
301  
302 A host cannot be deleted if it is in the VPC_CONFIG_INITIALIZING or
303 VPC_CONFIG_DELETING state.
304  
305  
306 =head2 GetConnection
307  
308 =over
309  
310 =item ConnectionArn => Str
311  
312  
313 =back
314  
315 Each argument is described in detail in: L<Paws::CodeStarConnections::GetConnection>
316  
317 Returns: a L<Paws::CodeStarConnections::GetConnectionOutput> instance
318  
319 Returns the connection ARN and details such as status, owner, and
320 provider type.
321  
322  
323 =head2 GetHost
324  
325 =over
326  
327 =item HostArn => Str
328  
329  
330 =back
331  
332 Each argument is described in detail in: L<Paws::CodeStarConnections::GetHost>
333  
334 Returns: a L<Paws::CodeStarConnections::GetHostOutput> instance
335  
336 Returns the host ARN and details such as status, provider type,
337 endpoint, and, if applicable, the VPC configuration.
338  
339  
340 =head2 ListConnections
341  
342 =over
343  
344 =item [HostArnFilter => Str]
345  
346 =item [MaxResults => Int]
347  
348 =item [NextToken => Str]
349  
350 =item [ProviderTypeFilter => Str]
351  
352  
353 =back
354  
355 Each argument is described in detail in: L<Paws::CodeStarConnections::ListConnections>
356  
357 Returns: a L<Paws::CodeStarConnections::ListConnectionsOutput> instance
358  
359 Lists the connections associated with your account.
360  
361  
362 =head2 ListHosts
363  
364 =over
365  
366 =item [MaxResults => Int]
367  
368 =item [NextToken => Str]
369  
370  
371 =back
372  
373 Each argument is described in detail in: L<Paws::CodeStarConnections::ListHosts>
374  
375 Returns: a L<Paws::CodeStarConnections::ListHostsOutput> instance
376  
377 Lists the hosts associated with your account.
378  
379  
380 =head2 ListTagsForResource
381  
382 =over
383  
384 =item ResourceArn => Str
385  
386  
387 =back
388  
389 Each argument is described in detail in: L<Paws::CodeStarConnections::ListTagsForResource>
390  
391 Returns: a L<Paws::CodeStarConnections::ListTagsForResourceOutput> instance
392  
393 Gets the set of key-value pairs (metadata) that are used to manage the
394 resource.
395  
396  
397 =head2 TagResource
398  
399 =over
400  
401 =item ResourceArn => Str
402  
403 =item Tags => ArrayRef[L<Paws::CodeStarConnections::Tag>]
404  
405  
406 =back
407  
408 Each argument is described in detail in: L<Paws::CodeStarConnections::TagResource>
409  
410 Returns: a L<Paws::CodeStarConnections::TagResourceOutput> instance
411  
412 Adds to or modifies the tags of the given resource. Tags are metadata
413 that can be used to manage a resource.
414  
415  
416 =head2 UntagResource
417  
418 =over
419  
420 =item ResourceArn => Str
421  
422 =item TagKeys => ArrayRef[Str|Undef]
423  
424  
425 =back
426  
427 Each argument is described in detail in: L<Paws::CodeStarConnections::UntagResource>
428  
429 Returns: a L<Paws::CodeStarConnections::UntagResourceOutput> instance
430  
431 Removes tags from an AWS resource.
432  
433  
434 =head2 UpdateHost
435  
436 =over
437  
438 =item HostArn => Str
439  
440 =item [ProviderEndpoint => Str]
441  
442 =item [VpcConfiguration => L<Paws::CodeStarConnections::VpcConfiguration>]
443  
444  
445 =back
446  
447 Each argument is described in detail in: L<Paws::CodeStarConnections::UpdateHost>
448  
449 Returns: a L<Paws::CodeStarConnections::UpdateHostOutput> instance
450  
451 Updates a specified host with the provided configurations.
452  
453  
454  
455  
456 =head1 PAGINATORS
457  
458 Paginator methods are helpers that repetively call methods that return partial results
459  
460  
461  
462  
463 =head1 SEE ALSO
464  
465 This service class forms part of L<Paws>
466  
467 =head1 BUGS and CONTRIBUTIONS
468  
469 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
470  
471 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
472  
473 =cut
474