blib/lib/Paws/Appflow/CreateFlow.pm untested

filter: Statementstmt 0.0% 0 / 26 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 28 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Appflow::CreateFlow;
3 use Moose;
4 has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description');
5 has DestinationFlowConfigList => (is => 'ro', isa => 'ArrayRef[Paws::Appflow::DestinationFlowConfig]', traits => ['NameInRequest'], request_name => 'destinationFlowConfigList', required => 1);
6 has FlowName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'flowName', required => 1);
7 has KmsArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'kmsArn');
8 has SourceFlowConfig => (is => 'ro', isa => 'Paws::Appflow::SourceFlowConfig', traits => ['NameInRequest'], request_name => 'sourceFlowConfig', required => 1);
9 has Tags => (is => 'ro', isa => 'Paws::Appflow::TagMap', traits => ['NameInRequest'], request_name => 'tags');
10 has Tasks => (is => 'ro', isa => 'ArrayRef[Paws::Appflow::Task]', traits => ['NameInRequest'], request_name => 'tasks', required => 1);
11 has TriggerConfig => (is => 'ro', isa => 'Paws::Appflow::TriggerConfig', traits => ['NameInRequest'], request_name => 'triggerConfig', required => 1);
12  
13 use MooseX::ClassAttribute;
14  
15 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateFlow');
16 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/create-flow');
17 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
18 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Appflow::CreateFlowResponse');
19 1;
20  
21 ### main pod documentation begin ###
22  
23 =head1 NAME
24  
25 Paws::Appflow::CreateFlow - Arguments for method CreateFlow on L<Paws::Appflow>
26  
27 =head1 DESCRIPTION
28  
29 This class represents the parameters used for calling the method CreateFlow on the
30 L<Amazon Appflow|Paws::Appflow> service. Use the attributes of this class
31 as arguments to method CreateFlow.
32  
33 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateFlow.
34  
35 =head1 SYNOPSIS
36  
37 my $appflow = Paws->service('Appflow');
38 my $CreateFlowResponse = $appflow->CreateFlow(
39 DestinationFlowConfigList => [
40 {
41 ConnectorType => 'Salesforce'
42 , # values: Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles
43 DestinationConnectorProperties => {
44 CustomerProfiles => {
45 DomainName => 'MyDomainName', # max: 64
46 ObjectTypeName => 'MyObjectTypeName', # max: 255; OPTIONAL
47 }, # OPTIONAL
48 EventBridge => {
49 Object => 'MyObject', # max: 512
50 ErrorHandlingConfig => {
51 BucketName => 'MyBucketName', # min: 3, max: 63; OPTIONAL
52 BucketPrefix => 'MyBucketPrefix', # max: 512; OPTIONAL
53 FailOnFirstDestinationError => 1, # OPTIONAL
54 }, # OPTIONAL
55 }, # OPTIONAL
56 Honeycode => {
57 Object => 'MyObject', # max: 512
58 ErrorHandlingConfig => {
59 BucketName => 'MyBucketName', # min: 3, max: 63; OPTIONAL
60 BucketPrefix => 'MyBucketPrefix', # max: 512; OPTIONAL
61 FailOnFirstDestinationError => 1, # OPTIONAL
62 }, # OPTIONAL
63 }, # OPTIONAL
64 LookoutMetrics => {
65  
66 }, # OPTIONAL
67 Redshift => {
68 IntermediateBucketName =>
69 'MyBucketName', # min: 3, max: 63; OPTIONAL
70 Object => 'MyObject', # max: 512
71 BucketPrefix => 'MyBucketPrefix', # max: 512; OPTIONAL
72 ErrorHandlingConfig => {
73 BucketName => 'MyBucketName', # min: 3, max: 63; OPTIONAL
74 BucketPrefix => 'MyBucketPrefix', # max: 512; OPTIONAL
75 FailOnFirstDestinationError => 1, # OPTIONAL
76 }, # OPTIONAL
77 }, # OPTIONAL
78 S3 => {
79 BucketName => 'MyBucketName', # min: 3, max: 63; OPTIONAL
80 BucketPrefix => 'MyBucketPrefix', # max: 512; OPTIONAL
81 S3OutputFormatConfig => {
82 AggregationConfig => {
83 AggregationType =>
84 'None', # values: None, SingleFile; OPTIONAL
85 }, # OPTIONAL
86 FileType => 'CSV', # values: CSV, JSON, PARQUET; OPTIONAL
87 PrefixConfig => {
88 PrefixFormat =>
89 'YEAR', # values: YEAR, MONTH, DAY, HOUR, MINUTE; OPTIONAL
90 PrefixType => 'FILENAME'
91 , # values: FILENAME, PATH, PATH_AND_FILENAME; OPTIONAL
92 }, # OPTIONAL
93 }, # OPTIONAL
94 }, # OPTIONAL
95 Salesforce => {
96 Object => 'MyObject', # max: 512
97 ErrorHandlingConfig => {
98 BucketName => 'MyBucketName', # min: 3, max: 63; OPTIONAL
99 BucketPrefix => 'MyBucketPrefix', # max: 512; OPTIONAL
100 FailOnFirstDestinationError => 1, # OPTIONAL
101 }, # OPTIONAL
102 IdFieldNames => [
103 'MyName', ... # max: 128
104 ], # max: 1; OPTIONAL
105 WriteOperationType =>
106 'INSERT', # values: INSERT, UPSERT, UPDATE; OPTIONAL
107 }, # OPTIONAL
108 Snowflake => {
109 IntermediateBucketName =>
110 'MyBucketName', # min: 3, max: 63; OPTIONAL
111 Object => 'MyObject', # max: 512
112 BucketPrefix => 'MyBucketPrefix', # max: 512; OPTIONAL
113 ErrorHandlingConfig => {
114 BucketName => 'MyBucketName', # min: 3, max: 63; OPTIONAL
115 BucketPrefix => 'MyBucketPrefix', # max: 512; OPTIONAL
116 FailOnFirstDestinationError => 1, # OPTIONAL
117 }, # OPTIONAL
118 }, # OPTIONAL
119 Upsolver => {
120 BucketName => 'MyUpsolverBucketName', # min: 16, max: 63
121 S3OutputFormatConfig => {
122 PrefixConfig => {
123 PrefixFormat =>
124 'YEAR', # values: YEAR, MONTH, DAY, HOUR, MINUTE; OPTIONAL
125 PrefixType => 'FILENAME'
126 , # values: FILENAME, PATH, PATH_AND_FILENAME; OPTIONAL
127 }, # OPTIONAL
128 AggregationConfig => {
129 AggregationType =>
130 'None', # values: None, SingleFile; OPTIONAL
131 }, # OPTIONAL
132 FileType => 'CSV', # values: CSV, JSON, PARQUET; OPTIONAL
133 },
134 BucketPrefix => 'MyBucketPrefix', # max: 512; OPTIONAL
135 }, # OPTIONAL
136 Zendesk => {
137 Object => 'MyObject', # max: 512
138 ErrorHandlingConfig => {
139 BucketName => 'MyBucketName', # min: 3, max: 63; OPTIONAL
140 BucketPrefix => 'MyBucketPrefix', # max: 512; OPTIONAL
141 FailOnFirstDestinationError => 1, # OPTIONAL
142 }, # OPTIONAL
143 IdFieldNames => [
144 'MyName', ... # max: 128
145 ], # max: 1; OPTIONAL
146 WriteOperationType =>
147 'INSERT', # values: INSERT, UPSERT, UPDATE; OPTIONAL
148 }, # OPTIONAL
149 },
150 ConnectorProfileName => 'MyConnectorProfileName', # max: 256; OPTIONAL
151 },
152 ...
153 ],
154 FlowName => 'MyFlowName',
155 SourceFlowConfig => {
156 ConnectorType => 'Salesforce'
157 , # values: Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles
158 SourceConnectorProperties => {
159 Amplitude => {
160 Object => 'MyObject', # max: 512
161  
162 }, # OPTIONAL
163 Datadog => {
164 Object => 'MyObject', # max: 512
165  
166 }, # OPTIONAL
167 Dynatrace => {
168 Object => 'MyObject', # max: 512
169  
170 }, # OPTIONAL
171 GoogleAnalytics => {
172 Object => 'MyObject', # max: 512
173  
174 }, # OPTIONAL
175 InforNexus => {
176 Object => 'MyObject', # max: 512
177  
178 }, # OPTIONAL
179 Marketo => {
180 Object => 'MyObject', # max: 512
181  
182 }, # OPTIONAL
183 S3 => {
184 BucketName => 'MyBucketName', # min: 3, max: 63; OPTIONAL
185 BucketPrefix => 'MyBucketPrefix', # max: 512; OPTIONAL
186 }, # OPTIONAL
187 Salesforce => {
188 Object => 'MyObject', # max: 512
189 EnableDynamicFieldUpdate => 1, # OPTIONAL
190 IncludeDeletedRecords => 1, # OPTIONAL
191 }, # OPTIONAL
192 ServiceNow => {
193 Object => 'MyObject', # max: 512
194  
195 }, # OPTIONAL
196 Singular => {
197 Object => 'MyObject', # max: 512
198  
199 }, # OPTIONAL
200 Slack => {
201 Object => 'MyObject', # max: 512
202  
203 }, # OPTIONAL
204 Trendmicro => {
205 Object => 'MyObject', # max: 512
206  
207 }, # OPTIONAL
208 Veeva => {
209 Object => 'MyObject', # max: 512
210  
211 }, # OPTIONAL
212 Zendesk => {
213 Object => 'MyObject', # max: 512
214  
215 }, # OPTIONAL
216 },
217 ConnectorProfileName => 'MyConnectorProfileName', # max: 256; OPTIONAL
218 IncrementalPullConfig => {
219 DatetimeTypeFieldName =>
220 'MyDatetimeTypeFieldName', # max: 256; OPTIONAL
221 }, # OPTIONAL
222 },
223 Tasks => [
224 {
225 SourceFields => [
226 'MyString', ... # max: 2048
227 ],
228 TaskType => 'Arithmetic'
229 , # values: Arithmetic, Filter, Map, Map_all, Mask, Merge, Truncate, Validate
230 ConnectorOperator => {
231 Amplitude => 'BETWEEN', # values: BETWEEN; OPTIONAL
232 Datadog => 'PROJECTION'
233 , # values: PROJECTION, BETWEEN, EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP; OPTIONAL
234 Dynatrace => 'PROJECTION'
235 , # values: PROJECTION, BETWEEN, EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP; OPTIONAL
236 GoogleAnalytics =>
237 'PROJECTION', # values: PROJECTION, BETWEEN; OPTIONAL
238 InforNexus => 'PROJECTION'
239 , # values: PROJECTION, BETWEEN, EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP; OPTIONAL
240 Marketo => 'PROJECTION'
241 , # values: PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP; OPTIONAL
242 S3 => 'PROJECTION'
243 , # values: PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP; OPTIONAL
244 Salesforce => 'PROJECTION'
245 , # values: PROJECTION, LESS_THAN, CONTAINS, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP; OPTIONAL
246 ServiceNow => 'PROJECTION'
247 , # values: PROJECTION, CONTAINS, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP; OPTIONAL
248 Singular => 'PROJECTION'
249 , # values: PROJECTION, EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP; OPTIONAL
250 Slack => 'PROJECTION'
251 , # values: PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP; OPTIONAL
252 Trendmicro => 'PROJECTION'
253 , # values: PROJECTION, EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP; OPTIONAL
254 Veeva => 'PROJECTION'
255 , # values: PROJECTION, LESS_THAN, GREATER_THAN, CONTAINS, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP; OPTIONAL
256 Zendesk => 'PROJECTION'
257 , # values: PROJECTION, GREATER_THAN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP; OPTIONAL
258 }, # OPTIONAL
259 DestinationField => 'MyDestinationField', # max: 256; OPTIONAL
260 TaskProperties => {
261 'VALUE' => 'MyProperty'
262 , # key: values: VALUE, VALUES, DATA_TYPE, UPPER_BOUND, LOWER_BOUND, SOURCE_DATA_TYPE, DESTINATION_DATA_TYPE, VALIDATION_ACTION, MASK_VALUE, MASK_LENGTH, TRUNCATE_LENGTH, MATH_OPERATION_FIELDS_ORDER, CONCAT_FORMAT, SUBFIELD_CATEGORY_MAP, EXCLUDE_SOURCE_FIELDS_LIST, value: max: 2048
263 }, # OPTIONAL
264 },
265 ...
266 ],
267 TriggerConfig => {
268 TriggerType => 'Scheduled', # values: Scheduled, Event, OnDemand
269 TriggerProperties => {
270 Scheduled => {
271 ScheduleExpression => 'MyScheduleExpression', # max: 256
272 DataPullMode =>
273 'Incremental', # values: Incremental, Complete; OPTIONAL
274 FirstExecutionFrom => '1970-01-01T01:00:00', # OPTIONAL
275 ScheduleEndTime => '1970-01-01T01:00:00', # OPTIONAL
276 ScheduleOffset => 1, # max: 36000; OPTIONAL
277 ScheduleStartTime => '1970-01-01T01:00:00', # OPTIONAL
278 Timezone => 'MyTimezone', # max: 256; OPTIONAL
279 }, # OPTIONAL
280 }, # OPTIONAL
281 },
282 Description => 'MyFlowDescription', # OPTIONAL
283 KmsArn => 'MyKMSArn', # OPTIONAL
284 Tags => {
285 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256
286 }, # OPTIONAL
287 );
288  
289 # Results:
290 my $FlowArn = $CreateFlowResponse->FlowArn;
291 my $FlowStatus = $CreateFlowResponse->FlowStatus;
292  
293 # Returns a L<Paws::Appflow::CreateFlowResponse> object.
294  
295 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.
296 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/appflow/CreateFlow>
297  
298 =head1 ATTRIBUTES
299  
300  
301 =head2 Description => Str
302  
303 A description of the flow you want to create.
304  
305  
306  
307 =head2 B<REQUIRED> DestinationFlowConfigList => ArrayRef[L<Paws::Appflow::DestinationFlowConfig>]
308  
309 The configuration that controls how Amazon AppFlow places data in the
310 destination connector.
311  
312  
313  
314 =head2 B<REQUIRED> FlowName => Str
315  
316 The specified name of the flow. Spaces are not allowed. Use underscores
317 (_) or hyphens (-) only.
318  
319  
320  
321 =head2 KmsArn => Str
322  
323 The ARN (Amazon Resource Name) of the Key Management Service (KMS) key
324 you provide for encryption. This is required if you do not want to use
325 the Amazon AppFlow-managed KMS key. If you don't provide anything here,
326 Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
327  
328  
329  
330 =head2 B<REQUIRED> SourceFlowConfig => L<Paws::Appflow::SourceFlowConfig>
331  
332 The configuration that controls how Amazon AppFlow retrieves data from
333 the source connector.
334  
335  
336  
337 =head2 Tags => L<Paws::Appflow::TagMap>
338  
339 The tags used to organize, track, or control access for your flow.
340  
341  
342  
343 =head2 B<REQUIRED> Tasks => ArrayRef[L<Paws::Appflow::Task>]
344  
345 A list of tasks that Amazon AppFlow performs while transferring the
346 data in the flow run.
347  
348  
349  
350 =head2 B<REQUIRED> TriggerConfig => L<Paws::Appflow::TriggerConfig>
351  
352 The trigger settings that determine how and when the flow runs.
353  
354  
355  
356  
357 =head1 SEE ALSO
358  
359 This class forms part of L<Paws>, documenting arguments for method CreateFlow in L<Paws::Appflow>
360  
361 =head1 BUGS and CONTRIBUTIONS
362  
363 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
364  
365 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
366  
367 =cut
368