blib/lib/Paws/Appflow.pm untested

filter: Statementstmt 0.0% 0 / 67 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 24 Podpod 0.0% 0 / 23 totaltotal 0.0% 0 / 114 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::Appflow;
2 use Moose;
3 sub service { 'appflow' }
4 sub signing_name { 'appflow' }
5 sub version { '2020-08-23' }
6 sub flattened_arrays { 0 }
7 has max_attempts => (is => 'ro', isa => 'Int', default => 5);
8 has retry => (is => 'ro', isa => 'HashRef', default => sub {
9 { base => 'rand', type => 'exponential', growth_factor => 2 }
10 });
11 has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
12 ] });
13  
14 with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::RestJsonCaller';
15  
16
17 sub CreateConnectorProfile {
18 my $self = shift;
19 my $call_object = $self->new_with_coercions('Paws::Appflow::CreateConnectorProfile', @_);
20 return $self->caller->do_call($self, $call_object);
21 }
22 sub CreateFlow {
23 my $self = shift;
24 my $call_object = $self->new_with_coercions('Paws::Appflow::CreateFlow', @_);
25 return $self->caller->do_call($self, $call_object);
26 }
27 sub DeleteConnectorProfile {
28 my $self = shift;
29 my $call_object = $self->new_with_coercions('Paws::Appflow::DeleteConnectorProfile', @_);
30 return $self->caller->do_call($self, $call_object);
31 }
32 sub DeleteFlow {
33 my $self = shift;
34 my $call_object = $self->new_with_coercions('Paws::Appflow::DeleteFlow', @_);
35 return $self->caller->do_call($self, $call_object);
36 }
37 sub DescribeConnectorEntity {
38 my $self = shift;
39 my $call_object = $self->new_with_coercions('Paws::Appflow::DescribeConnectorEntity', @_);
40 return $self->caller->do_call($self, $call_object);
41 }
42 sub DescribeConnectorProfiles {
43 my $self = shift;
44 my $call_object = $self->new_with_coercions('Paws::Appflow::DescribeConnectorProfiles', @_);
45 return $self->caller->do_call($self, $call_object);
46 }
47 sub DescribeConnectors {
48 my $self = shift;
49 my $call_object = $self->new_with_coercions('Paws::Appflow::DescribeConnectors', @_);
50 return $self->caller->do_call($self, $call_object);
51 }
52 sub DescribeFlow {
53 my $self = shift;
54 my $call_object = $self->new_with_coercions('Paws::Appflow::DescribeFlow', @_);
55 return $self->caller->do_call($self, $call_object);
56 }
57 sub DescribeFlowExecutionRecords {
58 my $self = shift;
59 my $call_object = $self->new_with_coercions('Paws::Appflow::DescribeFlowExecutionRecords', @_);
60 return $self->caller->do_call($self, $call_object);
61 }
62 sub ListConnectorEntities {
63 my $self = shift;
64 my $call_object = $self->new_with_coercions('Paws::Appflow::ListConnectorEntities', @_);
65 return $self->caller->do_call($self, $call_object);
66 }
67 sub ListFlows {
68 my $self = shift;
69 my $call_object = $self->new_with_coercions('Paws::Appflow::ListFlows', @_);
70 return $self->caller->do_call($self, $call_object);
71 }
72 sub ListTagsForResource {
73 my $self = shift;
74 my $call_object = $self->new_with_coercions('Paws::Appflow::ListTagsForResource', @_);
75 return $self->caller->do_call($self, $call_object);
76 }
77 sub StartFlow {
78 my $self = shift;
79 my $call_object = $self->new_with_coercions('Paws::Appflow::StartFlow', @_);
80 return $self->caller->do_call($self, $call_object);
81 }
82 sub StopFlow {
83 my $self = shift;
84 my $call_object = $self->new_with_coercions('Paws::Appflow::StopFlow', @_);
85 return $self->caller->do_call($self, $call_object);
86 }
87 sub TagResource {
88 my $self = shift;
89 my $call_object = $self->new_with_coercions('Paws::Appflow::TagResource', @_);
90 return $self->caller->do_call($self, $call_object);
91 }
92 sub UntagResource {
93 my $self = shift;
94 my $call_object = $self->new_with_coercions('Paws::Appflow::UntagResource', @_);
95 return $self->caller->do_call($self, $call_object);
96 }
97 sub UpdateConnectorProfile {
98 my $self = shift;
99 my $call_object = $self->new_with_coercions('Paws::Appflow::UpdateConnectorProfile', @_);
100 return $self->caller->do_call($self, $call_object);
101 }
102 sub UpdateFlow {
103 my $self = shift;
104 my $call_object = $self->new_with_coercions('Paws::Appflow::UpdateFlow', @_);
105 return $self->caller->do_call($self, $call_object);
106 }
107
108  
109  
110 sub operations { qw/CreateConnectorProfile CreateFlow DeleteConnectorProfile DeleteFlow DescribeConnectorEntity DescribeConnectorProfiles DescribeConnectors DescribeFlow DescribeFlowExecutionRecords ListConnectorEntities ListFlows ListTagsForResource StartFlow StopFlow TagResource UntagResource UpdateConnectorProfile UpdateFlow / }
111  
112 1;
113  
114 ### main pod documentation begin ###
115  
116 =head1 NAME
117  
118 Paws::Appflow - Perl Interface to AWS Amazon Appflow
119  
120 =head1 SYNOPSIS
121  
122 use Paws;
123  
124 my $obj = Paws->service('Appflow');
125 my $res = $obj->Method(
126 Arg1 => $val1,
127 Arg2 => [ 'V1', 'V2' ],
128 # if Arg3 is an object, the HashRef will be used as arguments to the constructor
129 # of the arguments type
130 Arg3 => { Att1 => 'Val1' },
131 # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
132 # the constructor of the arguments type
133 Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
134 );
135  
136 =head1 DESCRIPTION
137  
138 Welcome to the Amazon AppFlow API reference. This guide is for
139 developers who need detailed information about the Amazon AppFlow API
140 operations, data types, and errors.
141  
142 Amazon AppFlow is a fully managed integration service that enables you
143 to securely transfer data between software as a service (SaaS)
144 applications like Salesforce, Marketo, Slack, and ServiceNow, and AWS
145 services like Amazon S3 and Amazon Redshift.
146  
147 Use the following links to get started on the Amazon AppFlow API:
148  
149 =over
150  
151 =item *
152  
153 Actions
154 (https://docs.aws.amazon.com/appflow/1.0/APIReference/API_Operations.html):
155 An alphabetical list of all Amazon AppFlow API operations.
156  
157 =item *
158  
159 Data types
160 (https://docs.aws.amazon.com/appflow/1.0/APIReference/API_Types.html):
161 An alphabetical list of all Amazon AppFlow data types.
162  
163 =item *
164  
165 Common parameters
166 (https://docs.aws.amazon.com/appflow/1.0/APIReference/CommonParameters.html):
167 Parameters that all Query operations can use.
168  
169 =item *
170  
171 Common errors
172 (https://docs.aws.amazon.com/appflow/1.0/APIReference/CommonErrors.html):
173 Client and server errors that all operations can return.
174  
175 =back
176  
177 If you're new to Amazon AppFlow, we recommend that you review the
178 Amazon AppFlow User Guide
179 (https://docs.aws.amazon.com/appflow/latest/userguide/what-is-appflow.html).
180  
181 Amazon AppFlow API users can use vendor-specific mechanisms for OAuth,
182 and include applicable OAuth attributes (such as C<auth-code> and
183 C<redirecturi>) with the connector-specific
184 C<ConnectorProfileProperties> when creating a new connector profile
185 using Amazon AppFlow API operations. For example, Salesforce users can
186 refer to the I<Authorize Apps with OAuth>
187 (https://help.salesforce.com/articleView?id=remoteaccess_authenticate.htm)
188 documentation.
189  
190 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23>
191  
192  
193 =head1 METHODS
194  
195 =head2 CreateConnectorProfile
196  
197 =over
198  
199 =item ConnectionMode => Str
200  
201 =item ConnectorProfileConfig => L<Paws::Appflow::ConnectorProfileConfig>
202  
203 =item ConnectorProfileName => Str
204  
205 =item ConnectorType => Str
206  
207 =item [KmsArn => Str]
208  
209  
210 =back
211  
212 Each argument is described in detail in: L<Paws::Appflow::CreateConnectorProfile>
213  
214 Returns: a L<Paws::Appflow::CreateConnectorProfileResponse> instance
215  
216 Creates a new connector profile associated with your AWS account. There
217 is a soft quota of 100 connector profiles per AWS account. If you need
218 more connector profiles than this quota allows, you can submit a
219 request to the Amazon AppFlow team through the Amazon AppFlow support
220 channel.
221  
222  
223 =head2 CreateFlow
224  
225 =over
226  
227 =item DestinationFlowConfigList => ArrayRef[L<Paws::Appflow::DestinationFlowConfig>]
228  
229 =item FlowName => Str
230  
231 =item SourceFlowConfig => L<Paws::Appflow::SourceFlowConfig>
232  
233 =item Tasks => ArrayRef[L<Paws::Appflow::Task>]
234  
235 =item TriggerConfig => L<Paws::Appflow::TriggerConfig>
236  
237 =item [Description => Str]
238  
239 =item [KmsArn => Str]
240  
241 =item [Tags => L<Paws::Appflow::TagMap>]
242  
243  
244 =back
245  
246 Each argument is described in detail in: L<Paws::Appflow::CreateFlow>
247  
248 Returns: a L<Paws::Appflow::CreateFlowResponse> instance
249  
250 Enables your application to create a new flow using Amazon AppFlow. You
251 must create a connector profile before calling this API. Please note
252 that the Request Syntax below shows syntax for multiple destinations,
253 however, you can only transfer data to one item in this list at a time.
254 Amazon AppFlow does not currently support flows to multiple
255 destinations at once.
256  
257  
258 =head2 DeleteConnectorProfile
259  
260 =over
261  
262 =item ConnectorProfileName => Str
263  
264 =item [ForceDelete => Bool]
265  
266  
267 =back
268  
269 Each argument is described in detail in: L<Paws::Appflow::DeleteConnectorProfile>
270  
271 Returns: a L<Paws::Appflow::DeleteConnectorProfileResponse> instance
272  
273 Enables you to delete an existing connector profile.
274  
275  
276 =head2 DeleteFlow
277  
278 =over
279  
280 =item FlowName => Str
281  
282 =item [ForceDelete => Bool]
283  
284  
285 =back
286  
287 Each argument is described in detail in: L<Paws::Appflow::DeleteFlow>
288  
289 Returns: a L<Paws::Appflow::DeleteFlowResponse> instance
290  
291 Enables your application to delete an existing flow. Before deleting
292 the flow, Amazon AppFlow validates the request by checking the flow
293 configuration and status. You can delete flows one at a time.
294  
295  
296 =head2 DescribeConnectorEntity
297  
298 =over
299  
300 =item ConnectorEntityName => Str
301  
302 =item [ConnectorProfileName => Str]
303  
304 =item [ConnectorType => Str]
305  
306  
307 =back
308  
309 Each argument is described in detail in: L<Paws::Appflow::DescribeConnectorEntity>
310  
311 Returns: a L<Paws::Appflow::DescribeConnectorEntityResponse> instance
312  
313 Provides details regarding the entity used with the connector, with a
314 description of the data model for each entity.
315  
316  
317 =head2 DescribeConnectorProfiles
318  
319 =over
320  
321 =item [ConnectorProfileNames => ArrayRef[Str|Undef]]
322  
323 =item [ConnectorType => Str]
324  
325 =item [MaxResults => Int]
326  
327 =item [NextToken => Str]
328  
329  
330 =back
331  
332 Each argument is described in detail in: L<Paws::Appflow::DescribeConnectorProfiles>
333  
334 Returns: a L<Paws::Appflow::DescribeConnectorProfilesResponse> instance
335  
336 Returns a list of C<connector-profile> details matching the provided
337 C<connector-profile> names and C<connector-types>. Both input lists are
338 optional, and you can use them to filter the result.
339  
340 If no names or C<connector-types> are provided, returns all connector
341 profiles in a paginated form. If there is no match, this operation
342 returns an empty list.
343  
344  
345 =head2 DescribeConnectors
346  
347 =over
348  
349 =item [ConnectorTypes => ArrayRef[Str|Undef]]
350  
351 =item [NextToken => Str]
352  
353  
354 =back
355  
356 Each argument is described in detail in: L<Paws::Appflow::DescribeConnectors>
357  
358 Returns: a L<Paws::Appflow::DescribeConnectorsResponse> instance
359  
360 Describes the connectors vended by Amazon AppFlow for specified
361 connector types. If you don't specify a connector type, this operation
362 describes all connectors vended by Amazon AppFlow. If there are more
363 connectors than can be returned in one page, the response contains a
364 C<nextToken> object, which can be be passed in to the next call to the
365 C<DescribeConnectors> API operation to retrieve the next page.
366  
367  
368 =head2 DescribeFlow
369  
370 =over
371  
372 =item FlowName => Str
373  
374  
375 =back
376  
377 Each argument is described in detail in: L<Paws::Appflow::DescribeFlow>
378  
379 Returns: a L<Paws::Appflow::DescribeFlowResponse> instance
380  
381 Provides a description of the specified flow.
382  
383  
384 =head2 DescribeFlowExecutionRecords
385  
386 =over
387  
388 =item FlowName => Str
389  
390 =item [MaxResults => Int]
391  
392 =item [NextToken => Str]
393  
394  
395 =back
396  
397 Each argument is described in detail in: L<Paws::Appflow::DescribeFlowExecutionRecords>
398  
399 Returns: a L<Paws::Appflow::DescribeFlowExecutionRecordsResponse> instance
400  
401 Fetches the execution history of the flow.
402  
403  
404 =head2 ListConnectorEntities
405  
406 =over
407  
408 =item [ConnectorProfileName => Str]
409  
410 =item [ConnectorType => Str]
411  
412 =item [EntitiesPath => Str]
413  
414  
415 =back
416  
417 Each argument is described in detail in: L<Paws::Appflow::ListConnectorEntities>
418  
419 Returns: a L<Paws::Appflow::ListConnectorEntitiesResponse> instance
420  
421 Returns the list of available connector entities supported by Amazon
422 AppFlow. For example, you can query Salesforce for I<Account> and
423 I<Opportunity> entities, or query ServiceNow for the I<Incident>
424 entity.
425  
426  
427 =head2 ListFlows
428  
429 =over
430  
431 =item [MaxResults => Int]
432  
433 =item [NextToken => Str]
434  
435  
436 =back
437  
438 Each argument is described in detail in: L<Paws::Appflow::ListFlows>
439  
440 Returns: a L<Paws::Appflow::ListFlowsResponse> instance
441  
442 Lists all of the flows associated with your account.
443  
444  
445 =head2 ListTagsForResource
446  
447 =over
448  
449 =item ResourceArn => Str
450  
451  
452 =back
453  
454 Each argument is described in detail in: L<Paws::Appflow::ListTagsForResource>
455  
456 Returns: a L<Paws::Appflow::ListTagsForResourceResponse> instance
457  
458 Retrieves the tags that are associated with a specified flow.
459  
460  
461 =head2 StartFlow
462  
463 =over
464  
465 =item FlowName => Str
466  
467  
468 =back
469  
470 Each argument is described in detail in: L<Paws::Appflow::StartFlow>
471  
472 Returns: a L<Paws::Appflow::StartFlowResponse> instance
473  
474 Activates an existing flow. For on-demand flows, this operation runs
475 the flow immediately. For schedule and event-triggered flows, this
476 operation activates the flow.
477  
478  
479 =head2 StopFlow
480  
481 =over
482  
483 =item FlowName => Str
484  
485  
486 =back
487  
488 Each argument is described in detail in: L<Paws::Appflow::StopFlow>
489  
490 Returns: a L<Paws::Appflow::StopFlowResponse> instance
491  
492 Deactivates the existing flow. For on-demand flows, this operation
493 returns an C<unsupportedOperationException> error message. For schedule
494 and event-triggered flows, this operation deactivates the flow.
495  
496  
497 =head2 TagResource
498  
499 =over
500  
501 =item ResourceArn => Str
502  
503 =item Tags => L<Paws::Appflow::TagMap>
504  
505  
506 =back
507  
508 Each argument is described in detail in: L<Paws::Appflow::TagResource>
509  
510 Returns: a L<Paws::Appflow::TagResourceResponse> instance
511  
512 Applies a tag to the specified flow.
513  
514  
515 =head2 UntagResource
516  
517 =over
518  
519 =item ResourceArn => Str
520  
521 =item TagKeys => ArrayRef[Str|Undef]
522  
523  
524 =back
525  
526 Each argument is described in detail in: L<Paws::Appflow::UntagResource>
527  
528 Returns: a L<Paws::Appflow::UntagResourceResponse> instance
529  
530 Removes a tag from the specified flow.
531  
532  
533 =head2 UpdateConnectorProfile
534  
535 =over
536  
537 =item ConnectionMode => Str
538  
539 =item ConnectorProfileConfig => L<Paws::Appflow::ConnectorProfileConfig>
540  
541 =item ConnectorProfileName => Str
542  
543  
544 =back
545  
546 Each argument is described in detail in: L<Paws::Appflow::UpdateConnectorProfile>
547  
548 Returns: a L<Paws::Appflow::UpdateConnectorProfileResponse> instance
549  
550 Updates a given connector profile associated with your account.
551  
552  
553 =head2 UpdateFlow
554  
555 =over
556  
557 =item DestinationFlowConfigList => ArrayRef[L<Paws::Appflow::DestinationFlowConfig>]
558  
559 =item FlowName => Str
560  
561 =item Tasks => ArrayRef[L<Paws::Appflow::Task>]
562  
563 =item TriggerConfig => L<Paws::Appflow::TriggerConfig>
564  
565 =item [Description => Str]
566  
567 =item [SourceFlowConfig => L<Paws::Appflow::SourceFlowConfig>]
568  
569  
570 =back
571  
572 Each argument is described in detail in: L<Paws::Appflow::UpdateFlow>
573  
574 Returns: a L<Paws::Appflow::UpdateFlowResponse> instance
575  
576 Updates an existing flow.
577  
578  
579  
580  
581 =head1 PAGINATORS
582  
583 Paginator methods are helpers that repetively call methods that return partial results
584  
585  
586  
587  
588 =head1 SEE ALSO
589  
590 This service class forms part of L<Paws>
591  
592 =head1 BUGS and CONTRIBUTIONS
593  
594 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
595  
596 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
597  
598 =cut
599