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

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