@aws-sdk/client-data-pipeline 3.315.0 → 3.319.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist-cjs/DataPipeline.js +23 -266
  2. package/dist-es/DataPipeline.js +23 -266
  3. package/dist-types/DataPipeline.d.ts +42 -954
  4. package/dist-types/ts3.4/DataPipeline.d.ts +4 -1
  5. package/package.json +8 -8
package/dist-types/DataPipeline.d.ts CHANGED
@@ -19,1053 +19,141 @@ import { SetStatusCommandInput, SetStatusCommandOutput } from "./commands/SetSta
19
19
  import { SetTaskStatusCommandInput, SetTaskStatusCommandOutput } from "./commands/SetTaskStatusCommand";
20
20
  import { ValidatePipelineDefinitionCommandInput, ValidatePipelineDefinitionCommandOutput } from "./commands/ValidatePipelineDefinitionCommand";
21
21
  import { DataPipelineClient } from "./DataPipelineClient";
22
- /**
23
- * @public
24
- * <p>AWS Data Pipeline configures and manages a data-driven workflow called a pipeline. AWS Data Pipeline
25
- * handles the details of scheduling and ensuring that data dependencies are met so that your application
26
- * can focus on processing the data.</p>
27
- *
28
- * <p>AWS Data Pipeline provides a JAR implementation of a task runner called AWS Data Pipeline Task Runner.
29
- * AWS Data Pipeline Task Runner provides logic for common data management scenarios, such as performing
30
- * database queries and running data analysis using Amazon Elastic MapReduce (Amazon EMR). You can use
31
- * AWS Data Pipeline Task Runner as your task runner, or you can write your own task runner to provide
32
- * custom data management.</p>
33
- *
34
- * <p>AWS Data Pipeline implements two main sets of functionality. Use the first set to create a pipeline
35
- * and define data sources, schedules, dependencies, and the transforms to be performed on the data.
36
- * Use the second set in your task runner application to receive the next task ready for processing.
37
- * The logic for performing the task, such as querying the data, running data analysis, or converting
38
- * the data from one format to another, is contained within the task runner. The task runner performs
39
- * the task assigned to it by the web service, reporting progress to the web service as it does so.
40
- * When the task is done, the task runner reports the final success or failure of the task to the web service.</p>
41
- */
42
- export declare class DataPipeline extends DataPipelineClient {
22
+ export interface DataPipeline {
43
23
  /**
44
- * @public
45
- * <p>Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation,
46
- * activation fails.</p>
47
- * <p>If you need to pause the pipeline to investigate an issue with a component, such as a data source or script,
48
- * call <a>DeactivatePipeline</a>.</p>
49
- * <p>To activate a finished pipeline, modify the end date for the pipeline and then activate it.</p>
50
- * <examples>
51
- * <request>
52
- *
53
- * POST / HTTP/1.1
54
- * Content-Type: application/x-amz-json-1.1
55
- * X-Amz-Target: DataPipeline.ActivatePipeline
56
- * Content-Length: 39
57
- * Host: datapipeline.us-east-1.amazonaws.com
58
- * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
59
- * Authorization: AuthParams
60
- *
61
- * \{"pipelineId": "df-06372391ZG65EXAMPLE"\}
62
- *
63
- * </request>
64
- * <response>
65
- *
66
- * HTTP/1.1 200
67
- * x-amzn-RequestId: ee19d5bf-074e-11e2-af6f-6bc7a6be60d9
68
- * Content-Type: application/x-amz-json-1.1
69
- * Content-Length: 2
70
- * Date: Mon, 12 Nov 2012 17:50:53 GMT
71
- *
72
- * \{\}
73
- *
74
- * </response>
75
- * </examples>
24
+ * @see {@link ActivatePipelineCommand}
76
25
  */
77
26
  activatePipeline(args: ActivatePipelineCommandInput, options?: __HttpHandlerOptions): Promise<ActivatePipelineCommandOutput>;
78
27
  activatePipeline(args: ActivatePipelineCommandInput, cb: (err: any, data?: ActivatePipelineCommandOutput) => void): void;
79
28
  activatePipeline(args: ActivatePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ActivatePipelineCommandOutput) => void): void;
80
29
  /**
81
- * @public
82
- * <p>Adds or modifies tags for the specified pipeline.</p>
30
+ * @see {@link AddTagsCommand}
83
31
  */
84
32
  addTags(args: AddTagsCommandInput, options?: __HttpHandlerOptions): Promise<AddTagsCommandOutput>;
85
33
  addTags(args: AddTagsCommandInput, cb: (err: any, data?: AddTagsCommandOutput) => void): void;
86
34
  addTags(args: AddTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsCommandOutput) => void): void;
87
35
  /**
88
- * @public
89
- * <p>Creates a new, empty pipeline. Use <a>PutPipelineDefinition</a> to populate the pipeline.</p>
90
- *
91
- * <examples>
92
- * <request>
93
- *
94
- * POST / HTTP/1.1
95
- * Content-Type: application/x-amz-json-1.1
96
- * X-Amz-Target: DataPipeline.CreatePipeline
97
- * Content-Length: 91
98
- * Host: datapipeline.us-east-1.amazonaws.com
99
- * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
100
- * Authorization: AuthParams
101
- *
102
- * \{"name": "myPipeline",
103
- * "uniqueId": "123456789",
104
- * "description": "This is my first pipeline"\}
105
- *
106
- * </request>
107
- *
108
- * <response>
109
- *
110
- * HTTP/1.1 200
111
- * x-amzn-RequestId: b16911ce-0774-11e2-af6f-6bc7a6be60d9
112
- * Content-Type: application/x-amz-json-1.1
113
- * Content-Length: 40
114
- * Date: Mon, 12 Nov 2012 17:50:53 GMT
115
- *
116
- * \{"pipelineId": "df-06372391ZG65EXAMPLE"\}
117
- *
118
- * </response>
119
- * </examples>
36
+ * @see {@link CreatePipelineCommand}
120
37
  */
121
38
  createPipeline(args: CreatePipelineCommandInput, options?: __HttpHandlerOptions): Promise<CreatePipelineCommandOutput>;
122
39
  createPipeline(args: CreatePipelineCommandInput, cb: (err: any, data?: CreatePipelineCommandOutput) => void): void;
123
40
  createPipeline(args: CreatePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePipelineCommandOutput) => void): void;
124
41
  /**
125
- * @public
126
- * <p>Deactivates the specified running pipeline. The pipeline is set to the <code>DEACTIVATING</code>
127
- * state until the deactivation process completes.</p>
128
- * <p>To resume a deactivated pipeline, use <a>ActivatePipeline</a>. By default, the pipeline resumes from the last completed execution.
129
- * Optionally, you can specify the date and time to resume the pipeline.</p>
42
+ * @see {@link DeactivatePipelineCommand}
130
43
  */
131
44
  deactivatePipeline(args: DeactivatePipelineCommandInput, options?: __HttpHandlerOptions): Promise<DeactivatePipelineCommandOutput>;
132
45
  deactivatePipeline(args: DeactivatePipelineCommandInput, cb: (err: any, data?: DeactivatePipelineCommandOutput) => void): void;
133
46
  deactivatePipeline(args: DeactivatePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeactivatePipelineCommandOutput) => void): void;
134
47
  /**
135
- * @public
136
- * <p>Deletes a pipeline, its pipeline definition, and its run history.
137
- * AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners.</p>
138
- * <p>Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline.
139
- * To temporarily pause a pipeline instead of deleting it, call <a>SetStatus</a> with the status set to <code>PAUSE</code> on individual components.
140
- * Components that are paused by <a>SetStatus</a> can be resumed.</p>
141
- *
142
- * <examples>
143
- * <request>
144
- *
145
- * POST / HTTP/1.1
146
- * Content-Type: application/x-amz-json-1.1
147
- * X-Amz-Target: DataPipeline.DeletePipeline
148
- * Content-Length: 50
149
- * Host: datapipeline.us-east-1.amazonaws.com
150
- * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
151
- * Authorization: AuthParams
152
- *
153
- * \{"pipelineId": "df-06372391ZG65EXAMPLE"\}
154
- *
155
- * </request>
156
- *
157
- * <response>
158
- *
159
- * x-amzn-RequestId: b7a88c81-0754-11e2-af6f-6bc7a6be60d9
160
- * Content-Type: application/x-amz-json-1.1
161
- * Content-Length: 0
162
- * Date: Mon, 12 Nov 2012 17:50:53 GMT
163
- *
164
- * Unexpected response: 200, OK, undefined
165
- *
166
- * </response>
167
- * </examples>
48
+ * @see {@link DeletePipelineCommand}
168
49
  */
169
50
  deletePipeline(args: DeletePipelineCommandInput, options?: __HttpHandlerOptions): Promise<DeletePipelineCommandOutput>;
170
51
  deletePipeline(args: DeletePipelineCommandInput, cb: (err: any, data?: DeletePipelineCommandOutput) => void): void;
171
52
  deletePipeline(args: DeletePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePipelineCommandOutput) => void): void;
172
53
  /**
173
- * @public
174
- * <p>Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of
175
- * a set of fields that define the properties of the object.</p>
176
- *
177
- * <examples>
178
- * <request>
179
- *
180
- * POST / HTTP/1.1
181
- * Content-Type: application/x-amz-json-1.1
182
- * X-Amz-Target: DataPipeline.DescribeObjects
183
- * Content-Length: 98
184
- * Host: datapipeline.us-east-1.amazonaws.com
185
- * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
186
- * Authorization: AuthParams
187
- *
188
- * \{"pipelineId": "df-06372391ZG65EXAMPLE",
189
- * "objectIds":
190
- * ["Schedule"],
191
- * "evaluateExpressions": true\}
192
- *
193
- * </request>
194
- *
195
- * <response>
196
- *
197
- * x-amzn-RequestId: 4c18ea5d-0777-11e2-8a14-21bb8a1f50ef
198
- * Content-Type: application/x-amz-json-1.1
199
- * Content-Length: 1488
200
- * Date: Mon, 12 Nov 2012 17:50:53 GMT
201
- *
202
- * \{"hasMoreResults": false,
203
- * "pipelineObjects":
204
- * [
205
- * \{"fields":
206
- * [
207
- * \{"key": "startDateTime",
208
- * "stringValue": "2012-12-12T00:00:00"\},
209
- * \{"key": "parent",
210
- * "refValue": "Default"\},
211
- * \{"key": "@sphere",
212
- * "stringValue": "COMPONENT"\},
213
- * \{"key": "type",
214
- * "stringValue": "Schedule"\},
215
- * \{"key": "period",
216
- * "stringValue": "1 hour"\},
217
- * \{"key": "endDateTime",
218
- * "stringValue": "2012-12-21T18:00:00"\},
219
- * \{"key": "@version",
220
- * "stringValue": "1"\},
221
- * \{"key": "@status",
222
- * "stringValue": "PENDING"\},
223
- * \{"key": "@pipelineId",
224
- * "stringValue": "df-06372391ZG65EXAMPLE"\}
225
- * ],
226
- * "id": "Schedule",
227
- * "name": "Schedule"\}
228
- * ]
229
- * \}
230
- *
231
- * </response>
232
- * </examples>
54
+ * @see {@link DescribeObjectsCommand}
233
55
  */
234
56
  describeObjects(args: DescribeObjectsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeObjectsCommandOutput>;
235
57
  describeObjects(args: DescribeObjectsCommandInput, cb: (err: any, data?: DescribeObjectsCommandOutput) => void): void;
236
58
  describeObjects(args: DescribeObjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeObjectsCommandOutput) => void): void;
237
59
  /**
238
- * @public
239
- * <p>Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier,
240
- * its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines
241
- * that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines
242
- * for which you have read permissions.</p>
243
- * <p>To retrieve the full pipeline definition instead of metadata about the pipeline, call <a>GetPipelineDefinition</a>.</p>
244
- *
245
- * <examples>
246
- * <request>
247
- *
248
- * POST / HTTP/1.1
249
- * Content-Type: application/x-amz-json-1.1
250
- * X-Amz-Target: DataPipeline.DescribePipelines
251
- * Content-Length: 70
252
- * Host: datapipeline.us-east-1.amazonaws.com
253
- * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
254
- * Authorization: AuthParams
255
- *
256
- * \{"pipelineIds":
257
- * ["df-08785951KAKJEXAMPLE"]
258
- * \}
259
- *
260
- * </request>
261
- *
262
- * <response>
263
- *
264
- * x-amzn-RequestId: 02870eb7-0736-11e2-af6f-6bc7a6be60d9
265
- * Content-Type: application/x-amz-json-1.1
266
- * Content-Length: 767
267
- * Date: Mon, 12 Nov 2012 17:50:53 GMT
268
- *
269
- * \{"pipelineDescriptionList":
270
- * [
271
- * \{"description": "This is my first pipeline",
272
- * "fields":
273
- * [
274
- * \{"key": "@pipelineState",
275
- * "stringValue": "SCHEDULED"\},
276
- * \{"key": "description",
277
- * "stringValue": "This is my first pipeline"\},
278
- * \{"key": "name",
279
- * "stringValue": "myPipeline"\},
280
- * \{"key": "@creationTime",
281
- * "stringValue": "2012-12-13T01:24:06"\},
282
- * \{"key": "@id",
283
- * "stringValue": "df-0937003356ZJEXAMPLE"\},
284
- * \{"key": "@sphere",
285
- * "stringValue": "PIPELINE"\},
286
- * \{"key": "@version",
287
- * "stringValue": "1"\},
288
- * \{"key": "@userId",
289
- * "stringValue": "924374875933"\},
290
- * \{"key": "@accountId",
291
- * "stringValue": "924374875933"\},
292
- * \{"key": "uniqueId",
293
- * "stringValue": "1234567890"\}
294
- * ],
295
- * "name": "myPipeline",
296
- * "pipelineId": "df-0937003356ZJEXAMPLE"\}
297
- * ]
298
- * \}
299
- * </response>
300
- * </examples>
60
+ * @see {@link DescribePipelinesCommand}
301
61
  */
302
62
  describePipelines(args: DescribePipelinesCommandInput, options?: __HttpHandlerOptions): Promise<DescribePipelinesCommandOutput>;
303
63
  describePipelines(args: DescribePipelinesCommandInput, cb: (err: any, data?: DescribePipelinesCommandOutput) => void): void;
304
64
  describePipelines(args: DescribePipelinesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePipelinesCommandOutput) => void): void;
305
65
  /**
306
- * @public
307
- * <p>Task runners call <code>EvaluateExpression</code> to evaluate a string in the context of the specified object.
308
- * For example, a task runner can evaluate SQL queries stored in Amazon S3.</p>
309
- *
310
- * <examples>
311
- * <request>
312
- *
313
- * POST / HTTP/1.1
314
- * Content-Type: application/x-amz-json-1.1
315
- * X-Amz-Target: DataPipeline.DescribePipelines
316
- * Content-Length: 164
317
- * Host: datapipeline.us-east-1.amazonaws.com
318
- * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
319
- * Authorization: AuthParams
320
- *
321
- * \{"pipelineId": "df-08785951KAKJEXAMPLE",
322
- * "objectId": "Schedule",
323
- * "expression": "Transform started at #\{startDateTime\} and finished at #\{endDateTime\}"\}
324
- *
325
- * </request>
326
- *
327
- *
328
- * <response>
329
- *
330
- * x-amzn-RequestId: 02870eb7-0736-11e2-af6f-6bc7a6be60d9
331
- * Content-Type: application/x-amz-json-1.1
332
- * Content-Length: 103
333
- * Date: Mon, 12 Nov 2012 17:50:53 GMT
334
- *
335
- * \{"evaluatedExpression": "Transform started at 2012-12-12T00:00:00 and finished at 2012-12-21T18:00:00"\}
336
- * </response>
337
- * </examples>
66
+ * @see {@link EvaluateExpressionCommand}
338
67
  */
339
68
  evaluateExpression(args: EvaluateExpressionCommandInput, options?: __HttpHandlerOptions): Promise<EvaluateExpressionCommandOutput>;
340
69
  evaluateExpression(args: EvaluateExpressionCommandInput, cb: (err: any, data?: EvaluateExpressionCommandOutput) => void): void;
341
70
  evaluateExpression(args: EvaluateExpressionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EvaluateExpressionCommandOutput) => void): void;
342
71
  /**
343
- * @public
344
- * <p>Gets the definition of the specified pipeline. You can call <code>GetPipelineDefinition</code> to retrieve
345
- * the pipeline definition that you provided using <a>PutPipelineDefinition</a>.</p>
346
- *
347
- * <examples>
348
- * <request>
349
- *
350
- * POST / HTTP/1.1
351
- * Content-Type: application/x-amz-json-1.1
352
- * X-Amz-Target: DataPipeline.GetPipelineDefinition
353
- * Content-Length: 40
354
- * Host: datapipeline.us-east-1.amazonaws.com
355
- * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
356
- * Authorization: AuthParams
357
- *
358
- *
359
- * \{"pipelineId": "df-06372391ZG65EXAMPLE"\}
360
- *
361
- * </request>
362
- * <response>
363
- *
364
- * x-amzn-RequestId: e28309e5-0776-11e2-8a14-21bb8a1f50ef
365
- * Content-Type: application/x-amz-json-1.1
366
- * Content-Length: 890
367
- * Date: Mon, 12 Nov 2012 17:50:53 GMT
368
- *
369
- * \{"pipelineObjects":
370
- * [
371
- * \{"fields":
372
- * [
373
- * \{"key": "workerGroup",
374
- * "stringValue": "workerGroup"\}
375
- * ],
376
- * "id": "Default",
377
- * "name": "Default"\},
378
- * \{"fields":
379
- * [
380
- * \{"key": "startDateTime",
381
- * "stringValue": "2012-09-25T17:00:00"\},
382
- * \{"key": "type",
383
- * "stringValue": "Schedule"\},
384
- * \{"key": "period",
385
- * "stringValue": "1 hour"\},
386
- * \{"key": "endDateTime",
387
- * "stringValue": "2012-09-25T18:00:00"\}
388
- * ],
389
- * "id": "Schedule",
390
- * "name": "Schedule"\},
391
- * \{"fields":
392
- * [
393
- * \{"key": "schedule",
394
- * "refValue": "Schedule"\},
395
- * \{"key": "command",
396
- * "stringValue": "echo hello"\},
397
- * \{"key": "parent",
398
- * "refValue": "Default"\},
399
- * \{"key": "type",
400
- * "stringValue": "ShellCommandActivity"\}
401
- * ],
402
- * "id": "SayHello",
403
- * "name": "SayHello"\}
404
- * ]
405
- * \}
406
- *
407
- * </response>
408
- * </examples>
72
+ * @see {@link GetPipelineDefinitionCommand}
409
73
  */
410
74
  getPipelineDefinition(args: GetPipelineDefinitionCommandInput, options?: __HttpHandlerOptions): Promise<GetPipelineDefinitionCommandOutput>;
411
75
  getPipelineDefinition(args: GetPipelineDefinitionCommandInput, cb: (err: any, data?: GetPipelineDefinitionCommandOutput) => void): void;
412
76
  getPipelineDefinition(args: GetPipelineDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPipelineDefinitionCommandOutput) => void): void;
413
77
  /**
414
- * @public
415
- * <p>Lists the pipeline identifiers for all active pipelines that you have permission to access.</p>
416
- *
417
- * <examples>
418
- * <request>
419
- *
420
- * POST / HTTP/1.1
421
- * Content-Type: application/x-amz-json-1.1
422
- * X-Amz-Target: DataPipeline.ListPipelines
423
- * Content-Length: 14
424
- * Host: datapipeline.us-east-1.amazonaws.com
425
- * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
426
- * Authorization: AuthParams
427
- *
428
- * \{\}</request>
429
- *
430
- * <response>
431
- *
432
- * Status:
433
- * x-amzn-RequestId: b3104dc5-0734-11e2-af6f-6bc7a6be60d9
434
- * Content-Type: application/x-amz-json-1.1
435
- * Content-Length: 39
436
- * Date: Mon, 12 Nov 2012 17:50:53 GMT
437
- *
438
- * \{"PipelineIdList":
439
- * [
440
- * \{"id": "df-08785951KAKJEXAMPLE",
441
- * "name": "MyPipeline"\},
442
- * \{"id": "df-08662578ISYEXAMPLE",
443
- * "name": "MySecondPipeline"\}
444
- * ]
445
- * \}</response>
446
- * </examples>
78
+ * @see {@link ListPipelinesCommand}
447
79
  */
448
80
  listPipelines(args: ListPipelinesCommandInput, options?: __HttpHandlerOptions): Promise<ListPipelinesCommandOutput>;
449
81
  listPipelines(args: ListPipelinesCommandInput, cb: (err: any, data?: ListPipelinesCommandOutput) => void): void;
450
82
  listPipelines(args: ListPipelinesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPipelinesCommandOutput) => void): void;
451
83
  /**
452
- * @public
453
- * <p>Task runners call <code>PollForTask</code> to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform
454
- * by setting a value for the <code>workerGroup</code> parameter. The task returned can come from any of the pipelines that
455
- * match the <code>workerGroup</code> value passed in by the task runner and that was launched using the IAM user credentials
456
- * specified by the task runner.</p>
457
- * <p>If tasks are ready in the work queue, <code>PollForTask</code> returns a response immediately. If no tasks are available in the queue,
458
- * <code>PollForTask</code> uses long-polling and holds on to a poll connection for up to a 90 seconds, during which time the first newly
459
- * scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task
460
- * runner should not call <code>PollForTask</code> again on the same <code>workerGroup</code> until it receives a response, and this can take up to 90 seconds.
461
- * </p>
462
- *
463
- * <examples>
464
- * <request>
465
- *
466
- * POST / HTTP/1.1
467
- * Content-Type: application/x-amz-json-1.1
468
- * X-Amz-Target: DataPipeline.PollForTask
469
- * Content-Length: 59
470
- * Host: datapipeline.us-east-1.amazonaws.com
471
- * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
472
- * Authorization: AuthParams
473
- *
474
- * \{"workerGroup": "MyworkerGroup",
475
- * "hostname": "example.com"\}
476
- *
477
- * </request>
478
- *
479
- * <response>
480
- *
481
- * x-amzn-RequestId: 41c713d2-0775-11e2-af6f-6bc7a6be60d9
482
- * Content-Type: application/x-amz-json-1.1
483
- * Content-Length: 39
484
- * Date: Mon, 12 Nov 2012 17:50:53 GMT
485
- *
486
- * \{"taskObject":
487
- * \{"attemptId": "@SayHello_2012-12-12T00:00:00_Attempt=1",
488
- * "objects":
489
- * \{"@SayHello_2012-12-12T00:00:00_Attempt=1":
490
- * \{"fields":
491
- * [
492
- * \{"key": "@componentParent",
493
- * "refValue": "SayHello"\},
494
- * \{"key": "@scheduledStartTime",
495
- * "stringValue": "2012-12-12T00:00:00"\},
496
- * \{"key": "parent",
497
- * "refValue": "SayHello"\},
498
- * \{"key": "@sphere",
499
- * "stringValue": "ATTEMPT"\},
500
- * \{"key": "workerGroup",
501
- * "stringValue": "workerGroup"\},
502
- * \{"key": "@instanceParent",
503
- * "refValue": "@SayHello_2012-12-12T00:00:00"\},
504
- * \{"key": "type",
505
- * "stringValue": "ShellCommandActivity"\},
506
- * \{"key": "@status",
507
- * "stringValue": "WAITING_FOR_RUNNER"\},
508
- * \{"key": "@version",
509
- * "stringValue": "1"\},
510
- * \{"key": "schedule",
511
- * "refValue": "Schedule"\},
512
- * \{"key": "@actualStartTime",
513
- * "stringValue": "2012-12-13T01:40:50"\},
514
- * \{"key": "command",
515
- * "stringValue": "echo hello"\},
516
- * \{"key": "@scheduledEndTime",
517
- * "stringValue": "2012-12-12T01:00:00"\},
518
- * \{"key": "@activeInstances",
519
- * "refValue": "@SayHello_2012-12-12T00:00:00"\},
520
- * \{"key": "@pipelineId",
521
- * "stringValue": "df-0937003356ZJEXAMPLE"\}
522
- * ],
523
- * "id": "@SayHello_2012-12-12T00:00:00_Attempt=1",
524
- * "name": "@SayHello_2012-12-12T00:00:00_Attempt=1"\}
525
- * \},
526
- * "pipelineId": "df-0937003356ZJEXAMPLE",
527
- * "taskId": "2xaM4wRs5zOsIH+g9U3oVHfAgAlbSqU6XduncB0HhZ3xMnmvfePZPn4dIbYXHyWyRK+cU15MqDHwdrvftx/4wv+sNS4w34vJfv7QA9aOoOazW28l1GYSb2ZRR0N0paiQp+d1MhSKo10hOTWOsVK5S5Lnx9Qm6omFgXHyIvZRIvTlrQMpr1xuUrflyGOfbFOGpOLpvPE172MYdqpZKnbSS4TcuqgQKSWV2833fEubI57DPOP7ghWa2TcYeSIv4pdLYG53fTuwfbnbdc98g2LNUQzSVhSnt7BoqyNwht2aQ6b/UHg9A80+KVpuXuqmz3m1MXwHFgxjdmuesXNOrrlGpeLCcRWD+aGo0RN1NqhQRzNAig8V4GlaPTQzMsRCljKqvrIyAoP3Tt2XEGsHkkQo12rEX8Z90957XX2qKRwhruwYzqGkSLWjINoLdAxUJdpRXRc5DJTrBd3D5mdzn7kY1l7NEh4kFHJDt3Cx4Z3Mk8MYCACyCk/CEyy9DwuPi66cLz0NBcgbCM5LKjTBOwo1m+am+pvM1kSposE9FPP1+RFGb8k6jQBTJx3TRz1yKilnGXQTZ5xvdOFpJrklIT0OXP1MG3+auM9FlJA+1dX90QoNJE5z7axmK//MOGXUdkqFe2kiDkorqjxwDvc0Js9pVKfKvAmW8YqUbmI9l0ERpWCXXnLVHNmPWz3jaPY+OBAmuJWDmxB/Z8p94aEDg4BVXQ7LvsKQ3DLYhaB7yJ390CJT+i0mm+EBqY60V6YikPSWDFrYQ/NPi2b1DgE19mX8zHqw8qprIl4yh1Ckx2Iige4En/N5ktOoIxnASxAw/TzcE2skxdw5KlHDF+UTj71m16CR/dIaKlXijlfNlNzUBo/bNSadCQn3G5NoO501wPKI:XO50TgDNyo8EXAMPLE/g==:1"\}
528
- * \}
529
- *
530
- * </response>
531
- * </examples>
84
+ * @see {@link PollForTaskCommand}
532
85
  */
533
86
  pollForTask(args: PollForTaskCommandInput, options?: __HttpHandlerOptions): Promise<PollForTaskCommandOutput>;
534
87
  pollForTask(args: PollForTaskCommandInput, cb: (err: any, data?: PollForTaskCommandOutput) => void): void;
535
88
  pollForTask(args: PollForTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PollForTaskCommandOutput) => void): void;
536
89
  /**
537
- * @public
538
- * <p>Adds tasks, schedules, and preconditions to the specified pipeline. You can use <code>PutPipelineDefinition</code> to populate a new pipeline.</p>
539
- * <p>
540
- * <code>PutPipelineDefinition</code> also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one
541
- * of the following three validation errors exists in the pipeline.
542
- * </p>
543
- * <ol>
544
- * <li>An object is missing a name or identifier field.</li>
545
- * <li>A string or reference field is empty.</li>
546
- * <li>The number of objects in the pipeline exceeds the maximum allowed objects.</li>
547
- * <li>The pipeline is in a FINISHED state.</li>
548
- * </ol>
549
- * <p>
550
- * Pipeline object definitions are passed to the <code>PutPipelineDefinition</code> action and returned by the <a>GetPipelineDefinition</a> action.
551
- * </p>
552
- * <examples>
553
- * <example>
554
- * <name>Example 1</name>
555
- * <description>
556
- * This example sets an valid pipeline configuration and returns success.
557
- * </description>
558
- * <request>
559
- *
560
- * POST / HTTP/1.1
561
- * Content-Type: application/x-amz-json-1.1
562
- * X-Amz-Target: DataPipeline.PutPipelineDefinition
563
- * Content-Length: 914
564
- * Host: datapipeline.us-east-1.amazonaws.com
565
- * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
566
- * Authorization: AuthParams
567
- *
568
- * \{"pipelineId": "df-0937003356ZJEXAMPLE",
569
- * "pipelineObjects":
570
- * [
571
- * \{"id": "Default",
572
- * "name": "Default",
573
- * "fields":
574
- * [
575
- * \{"key": "workerGroup",
576
- * "stringValue": "workerGroup"\}
577
- * ]
578
- * \},
579
- * \{"id": "Schedule",
580
- * "name": "Schedule",
581
- * "fields":
582
- * [
583
- * \{"key": "startDateTime",
584
- * "stringValue": "2012-12-12T00:00:00"\},
585
- * \{"key": "type",
586
- * "stringValue": "Schedule"\},
587
- * \{"key": "period",
588
- * "stringValue": "1 hour"\},
589
- * \{"key": "endDateTime",
590
- * "stringValue": "2012-12-21T18:00:00"\}
591
- * ]
592
- * \},
593
- * \{"id": "SayHello",
594
- * "name": "SayHello",
595
- * "fields":
596
- * [
597
- * \{"key": "type",
598
- * "stringValue": "ShellCommandActivity"\},
599
- * \{"key": "command",
600
- * "stringValue": "echo hello"\},
601
- * \{"key": "parent",
602
- * "refValue": "Default"\},
603
- * \{"key": "schedule",
604
- * "refValue": "Schedule"\}
605
- * ]
606
- * \}
607
- * ]
608
- * \}
609
- *
610
- * </request>
611
- * <response>
612
- *
613
- * HTTP/1.1 200
614
- * x-amzn-RequestId: f74afc14-0754-11e2-af6f-6bc7a6be60d9
615
- * Content-Type: application/x-amz-json-1.1
616
- * Content-Length: 18
617
- * Date: Mon, 12 Nov 2012 17:50:53 GMT
618
- *
619
- * \{"errored": false\}
620
- *
621
- *
622
- * </response>
623
- * </example>
624
- * <example>
625
- * <name>Example 2</name>
626
- * <description>
627
- * This example sets an invalid pipeline configuration (the value for <code>workerGroup</code> is an empty string) and returns an error message.
628
- * </description>
629
- * <request>
630
- *
631
- * POST / HTTP/1.1
632
- * Content-Type: application/x-amz-json-1.1
633
- * X-Amz-Target: DataPipeline.PutPipelineDefinition
634
- * Content-Length: 903
635
- * Host: datapipeline.us-east-1.amazonaws.com
636
- * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
637
- * Authorization: AuthParams
638
- *
639
- * \{"pipelineId": "df-06372391ZG65EXAMPLE",
640
- * "pipelineObjects":
641
- * [
642
- * \{"id": "Default",
643
- * "name": "Default",
644
- * "fields":
645
- * [
646
- * \{"key": "workerGroup",
647
- * "stringValue": ""\}
648
- * ]
649
- * \},
650
- * \{"id": "Schedule",
651
- * "name": "Schedule",
652
- * "fields":
653
- * [
654
- * \{"key": "startDateTime",
655
- * "stringValue": "2012-09-25T17:00:00"\},
656
- * \{"key": "type",
657
- * "stringValue": "Schedule"\},
658
- * \{"key": "period",
659
- * "stringValue": "1 hour"\},
660
- * \{"key": "endDateTime",
661
- * "stringValue": "2012-09-25T18:00:00"\}
662
- * ]
663
- * \},
664
- * \{"id": "SayHello",
665
- * "name": "SayHello",
666
- * "fields":
667
- * [
668
- * \{"key": "type",
669
- * "stringValue": "ShellCommandActivity"\},
670
- * \{"key": "command",
671
- * "stringValue": "echo hello"\},
672
- * \{"key": "parent",
673
- * "refValue": "Default"\},
674
- * \{"key": "schedule",
675
- * "refValue": "Schedule"\}
676
- *
677
- * ]
678
- * \}
679
- * ]
680
- * \}
681
- *
682
- * </request>
683
- * <response>
684
- *
685
- * HTTP/1.1 200
686
- * x-amzn-RequestId: f74afc14-0754-11e2-af6f-6bc7a6be60d9
687
- * Content-Type: application/x-amz-json-1.1
688
- * Content-Length: 18
689
- * Date: Mon, 12 Nov 2012 17:50:53 GMT
690
- *
691
- * \{"__type": "com.amazon.setl.webservice#InvalidRequestException",
692
- * "message": "Pipeline definition has errors: Could not save the pipeline definition due to FATAL errors: [com.amazon.setl.webservice.ValidationError@108d7ea9] Please call Validate to validate your pipeline"\}
693
- *
694
- *
695
- * </response>
696
- * </example>
697
- * </examples>
90
+ * @see {@link PutPipelineDefinitionCommand}
698
91
  */
699
92
  putPipelineDefinition(args: PutPipelineDefinitionCommandInput, options?: __HttpHandlerOptions): Promise<PutPipelineDefinitionCommandOutput>;
700
93
  putPipelineDefinition(args: PutPipelineDefinitionCommandInput, cb: (err: any, data?: PutPipelineDefinitionCommandOutput) => void): void;
701
94
  putPipelineDefinition(args: PutPipelineDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPipelineDefinitionCommandOutput) => void): void;
702
95
  /**
703
- * @public
704
- * <p>Queries the specified pipeline for the names of objects that match the specified set of conditions.</p>
705
- *
706
- * <examples>
707
- * <request>
708
- *
709
- * POST / HTTP/1.1
710
- * Content-Type: application/x-amz-json-1.1
711
- * X-Amz-Target: DataPipeline.QueryObjects
712
- * Content-Length: 123
713
- * Host: datapipeline.us-east-1.amazonaws.com
714
- * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
715
- * Authorization: AuthParams
716
- *
717
- * \{"pipelineId": "df-06372391ZG65EXAMPLE",
718
- * "query":
719
- * \{"selectors":
720
- * [
721
- * ]
722
- * \},
723
- * "sphere": "INSTANCE",
724
- * "marker": "",
725
- * "limit": 10\}
726
- *
727
- * </request>
728
- *
729
- *
730
- * <response>
731
- *
732
- * x-amzn-RequestId: 14d704c1-0775-11e2-af6f-6bc7a6be60d9
733
- * Content-Type: application/x-amz-json-1.1
734
- * Content-Length: 72
735
- * Date: Mon, 12 Nov 2012 17:50:53 GMT
736
- *
737
- * \{"hasMoreResults": false,
738
- * "ids":
739
- * ["@SayHello_1_2012-09-25T17:00:00"]
740
- * \}
741
- * </response>
742
- * </examples>
96
+ * @see {@link QueryObjectsCommand}
743
97
  */
744
98
  queryObjects(args: QueryObjectsCommandInput, options?: __HttpHandlerOptions): Promise<QueryObjectsCommandOutput>;
745
99
  queryObjects(args: QueryObjectsCommandInput, cb: (err: any, data?: QueryObjectsCommandOutput) => void): void;
746
100
  queryObjects(args: QueryObjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryObjectsCommandOutput) => void): void;
747
101
  /**
748
- * @public
749
- * <p>Removes existing tags from the specified pipeline.</p>
102
+ * @see {@link RemoveTagsCommand}
750
103
  */
751
104
  removeTags(args: RemoveTagsCommandInput, options?: __HttpHandlerOptions): Promise<RemoveTagsCommandOutput>;
752
105
  removeTags(args: RemoveTagsCommandInput, cb: (err: any, data?: RemoveTagsCommandOutput) => void): void;
753
106
  removeTags(args: RemoveTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsCommandOutput) => void): void;
754
107
  /**
755
- * @public
756
- * <p>Task runners call <code>ReportTaskProgress</code> when assigned a task to acknowledge that it has the task. If the web service does not
757
- * receive this acknowledgement within 2 minutes, it assigns the task in a subsequent <a>PollForTask</a> call. After this initial acknowledgement,
758
- * the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time
759
- * from 15 minutes by specifying a <code>reportProgressTimeout</code> field in your pipeline.</p>
760
- * <p>If a task runner does not report its status after 5 minutes, AWS Data Pipeline assumes that the task runner is unable to process the task
761
- * and reassigns the task in a subsequent response to <a>PollForTask</a>. Task runners should call <code>ReportTaskProgress</code> every 60 seconds.</p>
762
- * <examples>
763
- * <request>
764
- *
765
- * POST / HTTP/1.1
766
- * Content-Type: application/x-amz-json-1.1
767
- * X-Amz-Target: DataPipeline.ReportTaskProgress
768
- * Content-Length: 832
769
- * Host: datapipeline.us-east-1.amazonaws.com
770
- * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
771
- * Authorization: AuthParams
772
- *
773
- * \{"taskId": "aaGgHT4LuH0T0Y0oLrJRjas5qH0d8cDPADxqq3tn+zCWGELkCdV2JprLreXm1oxeP5EFZHFLJ69kjSsLYE0iYHYBYVGBrB+E/pYq7ANEEeGJFnSBMRiXZVA+8UJ3OzcInvXeinqBmBaKwii7hnnKb/AXjXiNTXyxgydX1KAyg1AxkwBYG4cfPYMZbuEbQJFJvv5C/2+GVXz1w94nKYTeUeepwUOFOuRLS6JVtZoYwpF56E+Yfk1IcGpFOvCZ01B4Bkuu7x3J+MD/j6kJgZLAgbCJQtI3eiW3kdGmX0p0I2BdY1ZsX6b4UiSvM3OMj6NEHJCJL4E0ZfitnhCoe24Kvjo6C2hFbZq+ei/HPgSXBQMSagkr4vS9c0ChzxH2+LNYvec6bY4kymkaZI1dvOzmpa0FcnGf5AjSK4GpsViZ/ujz6zxFv81qBXzjF0/4M1775rjV1VUdyKaixiA/sJiACNezqZqETidp8d24BDPRhGsj6pBCrnelqGFrk/gXEXUsJ+xwMifRC8UVwiKekpAvHUywVk7Ku4jH/n3i2VoLRP6FXwpUbelu34iiZ9czpXyLtyPKwxa87dlrnRVURwkcVjOt2Mcrcaqe+cbWHvNRhyrPkkdfSF3ac8/wfgVbXvLEB2k9mKc67aD9rvdc1PKX09Tk8BKklsMTpZ3TRCd4NzQlJKigMe8Jat9+1tKj4Ole5ZzW6uyTu2s2iFjEV8KXu4MaiRJyNKCdKeGhhZWY37Qk4NBK4Ppgu+C6Y41dpfOh288SLDEVx0/UySlqOEdhba7c6BiPp5r3hKj3mk9lFy5OYp1aoGLeeFmjXveTnPdf2gkWqXXg7AUbJ7jEs1F0lKZQg4szep2gcKyAJXgvXLfJJHcha8Lfb/Ee7wYmyOcAaRpDBoFNSbtoVXar46teIrpho+ZDvynUXvU0grHWGOk=:wn3SgymHZM99bEXAMPLE",
774
- * "fields":
775
- * [
776
- * \{"key": "percentComplete",
777
- * "stringValue": "50"\}
778
- * ]
779
- * \}
780
- *
781
- * </request>
782
- *
783
- * <response>
784
- *
785
- * x-amzn-RequestId: 640bd023-0775-11e2-af6f-6bc7a6be60d9
786
- * Content-Type: application/x-amz-json-1.1
787
- * Content-Length: 18
788
- * Date: Mon, 12 Nov 2012 17:50:53 GMT
789
- *
790
- * \{"canceled": false\}
791
- *
792
- * </response>
793
- * </examples>
108
+ * @see {@link ReportTaskProgressCommand}
794
109
  */
795
110
  reportTaskProgress(args: ReportTaskProgressCommandInput, options?: __HttpHandlerOptions): Promise<ReportTaskProgressCommandOutput>;
796
111
  reportTaskProgress(args: ReportTaskProgressCommandInput, cb: (err: any, data?: ReportTaskProgressCommandOutput) => void): void;
797
112
  reportTaskProgress(args: ReportTaskProgressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReportTaskProgressCommandOutput) => void): void;
798
113
  /**
799
- * @public
800
- * <p>Task runners call <code>ReportTaskRunnerHeartbeat</code> every 15 minutes to indicate that they are operational.
801
- * If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can use
802
- * this call to detect when the task runner application has failed and restart a new instance.</p>
803
- *
804
- * <examples>
805
- * <request>
806
- *
807
- * POST / HTTP/1.1
808
- * Content-Type: application/x-amz-json-1.1
809
- * X-Amz-Target: DataPipeline.ReportTaskRunnerHeartbeat
810
- * Content-Length: 84
811
- * Host: datapipeline.us-east-1.amazonaws.com
812
- * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
813
- * Authorization: AuthParams
814
- *
815
- * \{"taskrunnerId": "1234567890",
816
- * "workerGroup": "wg-12345",
817
- * "hostname": "example.com"\}
818
- *
819
- * </request>
820
- *
821
- * <response>
822
- *
823
- * Status:
824
- * x-amzn-RequestId: b3104dc5-0734-11e2-af6f-6bc7a6be60d9
825
- * Content-Type: application/x-amz-json-1.1
826
- * Content-Length: 20
827
- * Date: Mon, 12 Nov 2012 17:50:53 GMT
828
- *
829
- * \{"terminate": false\}
830
- *
831
- * </response>
832
- * </examples>
114
+ * @see {@link ReportTaskRunnerHeartbeatCommand}
833
115
  */
834
116
  reportTaskRunnerHeartbeat(args: ReportTaskRunnerHeartbeatCommandInput, options?: __HttpHandlerOptions): Promise<ReportTaskRunnerHeartbeatCommandOutput>;
835
117
  reportTaskRunnerHeartbeat(args: ReportTaskRunnerHeartbeatCommandInput, cb: (err: any, data?: ReportTaskRunnerHeartbeatCommandOutput) => void): void;
836
118
  reportTaskRunnerHeartbeat(args: ReportTaskRunnerHeartbeatCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReportTaskRunnerHeartbeatCommandOutput) => void): void;
837
119
  /**
838
- * @public
839
- * <p>Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline.
840
- * This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity).
841
- * You cannot perform this operation on <code>FINISHED</code> pipelines and attempting to do so returns <code>InvalidRequestException</code>.</p>
842
- *
843
- * <examples>
844
- * <request>
845
- *
846
- * POST / HTTP/1.1
847
- * Content-Type: application/x-amz-json-1.1
848
- * X-Amz-Target: DataPipeline.SetStatus
849
- * Content-Length: 100
850
- * Host: datapipeline.us-east-1.amazonaws.com
851
- * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
852
- * Authorization: AuthParams
853
- *
854
- * \{"pipelineId": "df-0634701J7KEXAMPLE",
855
- * "objectIds":
856
- * ["o-08600941GHJWMBR9E2"],
857
- * "status": "pause"\}
858
- *
859
- * </request>
860
- *
861
- * <response>
862
- *
863
- * x-amzn-RequestId: e83b8ab7-076a-11e2-af6f-6bc7a6be60d9
864
- * Content-Type: application/x-amz-json-1.1
865
- * Content-Length: 0
866
- * Date: Mon, 12 Nov 2012 17:50:53 GMT
867
- *
868
- * Unexpected response: 200, OK, undefined
869
- *
870
- * </response>
871
- * </examples>
120
+ * @see {@link SetStatusCommand}
872
121
  */
873
122
  setStatus(args: SetStatusCommandInput, options?: __HttpHandlerOptions): Promise<SetStatusCommandOutput>;
874
123
  setStatus(args: SetStatusCommandInput, cb: (err: any, data?: SetStatusCommandOutput) => void): void;
875
124
  setStatus(args: SetStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetStatusCommandOutput) => void): void;
876
125
  /**
877
- * @public
878
- * <p>Task runners call <code>SetTaskStatus</code> to notify AWS Data Pipeline that a task is completed and provide information about the final status.
879
- * A task runner makes this call regardless of whether the task was sucessful. A task runner does not need to call <code>SetTaskStatus</code> for
880
- * tasks that are canceled by the web service during a call to <a>ReportTaskProgress</a>.</p>
881
- *
882
- * <examples>
883
- * <request>
884
- *
885
- * POST / HTTP/1.1
886
- * Content-Type: application/x-amz-json-1.1
887
- * X-Amz-Target: DataPipeline.SetTaskStatus
888
- * Content-Length: 847
889
- * Host: datapipeline.us-east-1.amazonaws.com
890
- * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
891
- * Authorization: AuthParams
892
- *
893
- * \{"taskId": "aaGgHT4LuH0T0Y0oLrJRjas5qH0d8cDPADxqq3tn+zCWGELkCdV2JprLreXm1oxeP5EFZHFLJ69kjSsLYE0iYHYBYVGBrB+E/pYq7ANEEeGJFnSBMRiXZVA+8UJ3OzcInvXeinqBmBaKwii7hnnKb/AXjXiNTXyxgydX1KAyg1AxkwBYG4cfPYMZbuEbQJFJvv5C/2+GVXz1w94nKYTeUeepwUOFOuRLS6JVtZoYwpF56E+Yfk1IcGpFOvCZ01B4Bkuu7x3J+MD/j6kJgZLAgbCJQtI3eiW3kdGmX0p0I2BdY1ZsX6b4UiSvM3OMj6NEHJCJL4E0ZfitnhCoe24Kvjo6C2hFbZq+ei/HPgSXBQMSagkr4vS9c0ChzxH2+LNYvec6bY4kymkaZI1dvOzmpa0FcnGf5AjSK4GpsViZ/ujz6zxFv81qBXzjF0/4M1775rjV1VUdyKaixiA/sJiACNezqZqETidp8d24BDPRhGsj6pBCrnelqGFrk/gXEXUsJ+xwMifRC8UVwiKekpAvHUywVk7Ku4jH/n3i2VoLRP6FXwpUbelu34iiZ9czpXyLtyPKwxa87dlrnRVURwkcVjOt2Mcrcaqe+cbWHvNRhyrPkkdfSF3ac8/wfgVbXvLEB2k9mKc67aD9rvdc1PKX09Tk8BKklsMTpZ3TRCd4NzQlJKigMe8Jat9+1tKj4Ole5ZzW6uyTu2s2iFjEV8KXu4MaiRJyNKCdKeGhhZWY37Qk4NBK4Ppgu+C6Y41dpfOh288SLDEVx0/UySlqOEdhba7c6BiPp5r3hKj3mk9lFy5OYp1aoGLeeFmjXveTnPdf2gkWqXXg7AUbJ7jEs1F0lKZQg4szep2gcKyAJXgvXLfJJHcha8Lfb/Ee7wYmyOcAaRpDBoFNSbtoVXar46teIrpho+ZDvynUXvU0grHWGOk=:wn3SgymHZM99bEXAMPLE",
894
- * "taskStatus": "FINISHED"\}
895
- *
896
- * </request>
897
- *
898
- * <response>
899
- *
900
- * x-amzn-RequestId: 8c8deb53-0788-11e2-af9c-6bc7a6be6qr8
901
- * Content-Type: application/x-amz-json-1.1
902
- * Content-Length: 0
903
- * Date: Mon, 12 Nov 2012 17:50:53 GMT
904
- *
905
- * \{\}
906
- *
907
- * </response>
908
- * </examples>
126
+ * @see {@link SetTaskStatusCommand}
909
127
  */
910
128
  setTaskStatus(args: SetTaskStatusCommandInput, options?: __HttpHandlerOptions): Promise<SetTaskStatusCommandOutput>;
911
129
  setTaskStatus(args: SetTaskStatusCommandInput, cb: (err: any, data?: SetTaskStatusCommandOutput) => void): void;
912
130
  setTaskStatus(args: SetTaskStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetTaskStatusCommandOutput) => void): void;
913
131
  /**
914
- * @public
915
- * <p>Validates the specified pipeline definition to ensure that it is well formed and can be run without error.</p>
916
- *
917
- * <examples>
918
- * <example>
919
- * <name>Example 1</name>
920
- * <description>
921
- * This example sets an valid pipeline configuration and returns success.
922
- * </description>
923
- * <request>
924
- *
925
- * POST / HTTP/1.1
926
- * Content-Type: application/x-amz-json-1.1
927
- * X-Amz-Target: DataPipeline.ValidatePipelineDefinition
928
- * Content-Length: 936
929
- * Host: datapipeline.us-east-1.amazonaws.com
930
- * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
931
- * Authorization: AuthParams
932
- *
933
- * \{"pipelineId": "df-06372391ZG65EXAMPLE",
934
- * "pipelineObjects":
935
- * [
936
- * \{"id": "Default",
937
- * "name": "Default",
938
- * "fields":
939
- * [
940
- * \{"key": "workerGroup",
941
- * "stringValue": "MyworkerGroup"\}
942
- * ]
943
- * \},
944
- * \{"id": "Schedule",
945
- * "name": "Schedule",
946
- * "fields":
947
- * [
948
- * \{"key": "startDateTime",
949
- * "stringValue": "2012-09-25T17:00:00"\},
950
- * \{"key": "type",
951
- * "stringValue": "Schedule"\},
952
- * \{"key": "period",
953
- * "stringValue": "1 hour"\},
954
- * \{"key": "endDateTime",
955
- * "stringValue": "2012-09-25T18:00:00"\}
956
- * ]
957
- * \},
958
- * \{"id": "SayHello",
959
- * "name": "SayHello",
960
- * "fields":
961
- * [
962
- * \{"key": "type",
963
- * "stringValue": "ShellCommandActivity"\},
964
- * \{"key": "command",
965
- * "stringValue": "echo hello"\},
966
- * \{"key": "parent",
967
- * "refValue": "Default"\},
968
- * \{"key": "schedule",
969
- * "refValue": "Schedule"\}
970
- *
971
- * ]
972
- * \}
973
- * ]
974
- * \}
975
- *
976
- * </request>
977
- * <response>
978
- *
979
- * x-amzn-RequestId: 92c9f347-0776-11e2-8a14-21bb8a1f50ef
980
- * Content-Type: application/x-amz-json-1.1
981
- * Content-Length: 18
982
- * Date: Mon, 12 Nov 2012 17:50:53 GMT
983
- *
984
- * \{"errored": false\}
985
- *
986
- * </response>
987
- * </example>
988
- * <example>
989
- * <name>Example 2</name>
990
- * <description>
991
- * This example sets an invalid pipeline configuration and returns the associated set of validation errors.
992
- * </description>
993
- *
994
- * <request>
995
- *
996
- * POST / HTTP/1.1
997
- * Content-Type: application/x-amz-json-1.1
998
- * X-Amz-Target: DataPipeline.ValidatePipelineDefinition
999
- * Content-Length: 903
1000
- * Host: datapipeline.us-east-1.amazonaws.com
1001
- * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
1002
- * Authorization: AuthParams
1003
- *
1004
- * \{"pipelineId": "df-06372391ZG65EXAMPLE",
1005
- * "pipelineObjects":
1006
- * [
1007
- * \{"id": "Default",
1008
- * "name": "Default",
1009
- * "fields":
1010
- * [
1011
- * \{"key": "workerGroup",
1012
- * "stringValue": "MyworkerGroup"\}
1013
- * ]
1014
- * \},
1015
- * \{"id": "Schedule",
1016
- * "name": "Schedule",
1017
- * "fields":
1018
- * [
1019
- * \{"key": "startDateTime",
1020
- * "stringValue": "bad-time"\},
1021
- * \{"key": "type",
1022
- * "stringValue": "Schedule"\},
1023
- * \{"key": "period",
1024
- * "stringValue": "1 hour"\},
1025
- * \{"key": "endDateTime",
1026
- * "stringValue": "2012-09-25T18:00:00"\}
1027
- * ]
1028
- * \},
1029
- * \{"id": "SayHello",
1030
- * "name": "SayHello",
1031
- * "fields":
1032
- * [
1033
- * \{"key": "type",
1034
- * "stringValue": "ShellCommandActivity"\},
1035
- * \{"key": "command",
1036
- * "stringValue": "echo hello"\},
1037
- * \{"key": "parent",
1038
- * "refValue": "Default"\},
1039
- * \{"key": "schedule",
1040
- * "refValue": "Schedule"\}
1041
- *
1042
- * ]
1043
- * \}
1044
- * ]
1045
- * \}
1046
- *
1047
- * </request>
1048
- * <response>
1049
- *
1050
- * x-amzn-RequestId: 496a1f5a-0e6a-11e2-a61c-bd6312c92ddd
1051
- * Content-Type: application/x-amz-json-1.1
1052
- * Content-Length: 278
1053
- * Date: Mon, 12 Nov 2012 17:50:53 GMT
1054
- *
1055
- * \{"errored": true,
1056
- * "validationErrors":
1057
- * [
1058
- * \{"errors":
1059
- * ["INVALID_FIELD_VALUE: 'startDateTime' value must be a literal datetime value."],
1060
- * "id": "Schedule"\}
1061
- * ]
1062
- * \}
1063
- *
1064
- * </response>
1065
- * </example>
1066
- * </examples>
132
+ * @see {@link ValidatePipelineDefinitionCommand}
1067
133
  */
1068
134
  validatePipelineDefinition(args: ValidatePipelineDefinitionCommandInput, options?: __HttpHandlerOptions): Promise<ValidatePipelineDefinitionCommandOutput>;
1069
135
  validatePipelineDefinition(args: ValidatePipelineDefinitionCommandInput, cb: (err: any, data?: ValidatePipelineDefinitionCommandOutput) => void): void;
1070
136
  validatePipelineDefinition(args: ValidatePipelineDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ValidatePipelineDefinitionCommandOutput) => void): void;
1071
137
  }
138
+ /**
139
+ * @public
140
+ * <p>AWS Data Pipeline configures and manages a data-driven workflow called a pipeline. AWS Data Pipeline
141
+ * handles the details of scheduling and ensuring that data dependencies are met so that your application
142
+ * can focus on processing the data.</p>
143
+ *
144
+ * <p>AWS Data Pipeline provides a JAR implementation of a task runner called AWS Data Pipeline Task Runner.
145
+ * AWS Data Pipeline Task Runner provides logic for common data management scenarios, such as performing
146
+ * database queries and running data analysis using Amazon Elastic MapReduce (Amazon EMR). You can use
147
+ * AWS Data Pipeline Task Runner as your task runner, or you can write your own task runner to provide
148
+ * custom data management.</p>
149
+ *
150
+ * <p>AWS Data Pipeline implements two main sets of functionality. Use the first set to create a pipeline
151
+ * and define data sources, schedules, dependencies, and the transforms to be performed on the data.
152
+ * Use the second set in your task runner application to receive the next task ready for processing.
153
+ * The logic for performing the task, such as querying the data, running data analysis, or converting
154
+ * the data from one format to another, is contained within the task runner. The task runner performs
155
+ * the task assigned to it by the web service, reporting progress to the web service as it does so.
156
+ * When the task is done, the task runner reports the final success or failure of the task to the web service.</p>
157
+ */
158
+ export declare class DataPipeline extends DataPipelineClient implements DataPipeline {
159
+ }