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