@aws-sdk/client-data-pipeline 3.533.0 → 3.540.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 (49) hide show
  1. package/dist-cjs/endpoint/endpointResolver.js +4 -2
  2. package/dist-cjs/index.js +0 -3
  3. package/dist-es/endpoint/endpointResolver.js +3 -1
  4. package/dist-es/index.js +0 -1
  5. package/dist-types/DataPipeline.d.ts +2 -1
  6. package/dist-types/DataPipelineClient.d.ts +1 -1
  7. package/dist-types/commands/ActivatePipelineCommand.d.ts +2 -1
  8. package/dist-types/commands/AddTagsCommand.d.ts +2 -1
  9. package/dist-types/commands/CreatePipelineCommand.d.ts +2 -1
  10. package/dist-types/commands/DeactivatePipelineCommand.d.ts +2 -1
  11. package/dist-types/commands/DeletePipelineCommand.d.ts +2 -1
  12. package/dist-types/commands/DescribeObjectsCommand.d.ts +2 -1
  13. package/dist-types/commands/DescribePipelinesCommand.d.ts +2 -1
  14. package/dist-types/commands/EvaluateExpressionCommand.d.ts +2 -1
  15. package/dist-types/commands/GetPipelineDefinitionCommand.d.ts +2 -1
  16. package/dist-types/commands/ListPipelinesCommand.d.ts +2 -1
  17. package/dist-types/commands/PollForTaskCommand.d.ts +2 -1
  18. package/dist-types/commands/PutPipelineDefinitionCommand.d.ts +2 -1
  19. package/dist-types/commands/QueryObjectsCommand.d.ts +2 -1
  20. package/dist-types/commands/RemoveTagsCommand.d.ts +2 -1
  21. package/dist-types/commands/ReportTaskProgressCommand.d.ts +2 -1
  22. package/dist-types/commands/ReportTaskRunnerHeartbeatCommand.d.ts +2 -1
  23. package/dist-types/commands/SetStatusCommand.d.ts +2 -1
  24. package/dist-types/commands/SetTaskStatusCommand.d.ts +2 -1
  25. package/dist-types/commands/ValidatePipelineDefinitionCommand.d.ts +2 -1
  26. package/dist-types/index.d.ts +0 -1
  27. package/dist-types/models/models_0.d.ts +170 -170
  28. package/dist-types/ts3.4/DataPipeline.d.ts +1 -0
  29. package/dist-types/ts3.4/commands/ActivatePipelineCommand.d.ts +9 -0
  30. package/dist-types/ts3.4/commands/AddTagsCommand.d.ts +7 -0
  31. package/dist-types/ts3.4/commands/CreatePipelineCommand.d.ts +9 -0
  32. package/dist-types/ts3.4/commands/DeactivatePipelineCommand.d.ts +9 -0
  33. package/dist-types/ts3.4/commands/DeletePipelineCommand.d.ts +9 -0
  34. package/dist-types/ts3.4/commands/DescribeObjectsCommand.d.ts +9 -0
  35. package/dist-types/ts3.4/commands/DescribePipelinesCommand.d.ts +9 -0
  36. package/dist-types/ts3.4/commands/EvaluateExpressionCommand.d.ts +9 -0
  37. package/dist-types/ts3.4/commands/GetPipelineDefinitionCommand.d.ts +9 -0
  38. package/dist-types/ts3.4/commands/ListPipelinesCommand.d.ts +9 -0
  39. package/dist-types/ts3.4/commands/PollForTaskCommand.d.ts +9 -0
  40. package/dist-types/ts3.4/commands/PutPipelineDefinitionCommand.d.ts +9 -0
  41. package/dist-types/ts3.4/commands/QueryObjectsCommand.d.ts +9 -0
  42. package/dist-types/ts3.4/commands/RemoveTagsCommand.d.ts +9 -0
  43. package/dist-types/ts3.4/commands/ReportTaskProgressCommand.d.ts +9 -0
  44. package/dist-types/ts3.4/commands/ReportTaskRunnerHeartbeatCommand.d.ts +9 -0
  45. package/dist-types/ts3.4/commands/SetStatusCommand.d.ts +9 -0
  46. package/dist-types/ts3.4/commands/SetTaskStatusCommand.d.ts +9 -0
  47. package/dist-types/ts3.4/commands/ValidatePipelineDefinitionCommand.d.ts +9 -0
  48. package/dist-types/ts3.4/index.d.ts +0 -1
  49. package/package.json +40 -40
@@ -1,51 +1,51 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { DataPipelineServiceException as __BaseException } from "./DataPipelineServiceException";
3
3
  /**
4
- * @public
5
4
  * <p>A value or list of parameter values. </p>
5
+ * @public
6
6
  */
7
7
  export interface ParameterValue {
8
8
  /**
9
- * @public
10
9
  * <p>The ID of the parameter value.</p>
10
+ * @public
11
11
  */
12
12
  id: string | undefined;
13
13
  /**
14
- * @public
15
14
  * <p>The field value, expressed as a String.</p>
15
+ * @public
16
16
  */
17
17
  stringValue: string | undefined;
18
18
  }
19
19
  /**
20
- * @public
21
20
  * <p>Contains the parameters for ActivatePipeline.</p>
21
+ * @public
22
22
  */
23
23
  export interface ActivatePipelineInput {
24
24
  /**
25
- * @public
26
25
  * <p>The ID of the pipeline.</p>
26
+ * @public
27
27
  */
28
28
  pipelineId: string | undefined;
29
29
  /**
30
- * @public
31
30
  * <p>A list of parameter values to pass to the pipeline at activation.</p>
31
+ * @public
32
32
  */
33
33
  parameterValues?: ParameterValue[];
34
34
  /**
35
- * @public
36
35
  * <p>The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.</p>
36
+ * @public
37
37
  */
38
38
  startTimestamp?: Date;
39
39
  }
40
40
  /**
41
- * @public
42
41
  * <p>Contains the output of ActivatePipeline.</p>
42
+ * @public
43
43
  */
44
44
  export interface ActivatePipelineOutput {
45
45
  }
46
46
  /**
47
- * @public
48
47
  * <p>An internal service error occurred.</p>
48
+ * @public
49
49
  */
50
50
  export declare class InternalServiceError extends __BaseException {
51
51
  readonly name: "InternalServiceError";
@@ -56,8 +56,8 @@ export declare class InternalServiceError extends __BaseException {
56
56
  constructor(opts: __ExceptionOptionType<InternalServiceError, __BaseException>);
57
57
  }
58
58
  /**
59
- * @public
60
59
  * <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>
60
+ * @public
61
61
  */
62
62
  export declare class InvalidRequestException extends __BaseException {
63
63
  readonly name: "InvalidRequestException";
@@ -68,8 +68,8 @@ export declare class InvalidRequestException extends __BaseException {
68
68
  constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
69
69
  }
70
70
  /**
71
- * @public
72
71
  * <p>The specified pipeline has been deleted.</p>
72
+ * @public
73
73
  */
74
74
  export declare class PipelineDeletedException extends __BaseException {
75
75
  readonly name: "PipelineDeletedException";
@@ -80,8 +80,8 @@ export declare class PipelineDeletedException extends __BaseException {
80
80
  constructor(opts: __ExceptionOptionType<PipelineDeletedException, __BaseException>);
81
81
  }
82
82
  /**
83
- * @public
84
83
  * <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>
84
+ * @public
85
85
  */
86
86
  export declare class PipelineNotFoundException extends __BaseException {
87
87
  readonly name: "PipelineNotFoundException";
@@ -92,59 +92,58 @@ export declare class PipelineNotFoundException extends __BaseException {
92
92
  constructor(opts: __ExceptionOptionType<PipelineNotFoundException, __BaseException>);
93
93
  }
94
94
  /**
95
- * @public
96
95
  * <p>Tags are key/value pairs defined by a user and associated with a pipeline to control access. AWS Data Pipeline allows you to associate ten tags per pipeline.
97
96
  * For more information, see <a href="http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html">Controlling User Access to Pipelines</a> in the <i>AWS Data Pipeline Developer Guide</i>.</p>
97
+ * @public
98
98
  */
99
99
  export interface Tag {
100
100
  /**
101
- * @public
102
101
  * <p>The key name of a tag defined by a user.
103
102
  * For more information, see <a href="http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html">Controlling User Access to Pipelines</a> in the <i>AWS Data Pipeline Developer Guide</i>.</p>
103
+ * @public
104
104
  */
105
105
  key: string | undefined;
106
106
  /**
107
- * @public
108
107
  * <p>The optional value portion of a tag defined by a user.
109
108
  * For more information, see <a href="http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html">Controlling User Access to Pipelines</a> in the <i>AWS Data Pipeline Developer Guide</i>.</p>
109
+ * @public
110
110
  */
111
111
  value: string | undefined;
112
112
  }
113
113
  /**
114
- * @public
115
114
  * <p>Contains the parameters for AddTags.</p>
115
+ * @public
116
116
  */
117
117
  export interface AddTagsInput {
118
118
  /**
119
- * @public
120
119
  * <p>The ID of the pipeline.</p>
120
+ * @public
121
121
  */
122
122
  pipelineId: string | undefined;
123
123
  /**
124
- * @public
125
124
  * <p>The tags to add, as key/value pairs.</p>
125
+ * @public
126
126
  */
127
127
  tags: Tag[] | undefined;
128
128
  }
129
129
  /**
130
- * @public
131
130
  * <p>Contains the output of AddTags.</p>
131
+ * @public
132
132
  */
133
133
  export interface AddTagsOutput {
134
134
  }
135
135
  /**
136
- * @public
137
136
  * <p>Contains the parameters for CreatePipeline.</p>
137
+ * @public
138
138
  */
139
139
  export interface CreatePipelineInput {
140
140
  /**
141
- * @public
142
141
  * <p>The name for the pipeline. You can use the same name for multiple pipelines associated with your AWS account,
143
142
  * because AWS Data Pipeline assigns each pipeline a unique pipeline identifier.</p>
143
+ * @public
144
144
  */
145
145
  name: string | undefined;
146
146
  /**
147
- * @public
148
147
  * <p>A unique identifier. This identifier is not the same as the pipeline identifier assigned by AWS Data Pipeline.
149
148
  * You are responsible for defining the format and ensuring the uniqueness of this identifier. You use this
150
149
  * parameter to ensure idempotency during repeated calls to <code>CreatePipeline</code>. For example, if the
@@ -153,250 +152,251 @@ export interface CreatePipelineInput {
153
152
  * ensures that if a pipeline already exists with the same name and unique identifier, a new pipeline is not
154
153
  * created. Instead, you'll receive the pipeline identifier from the previous attempt. The uniqueness of the
155
154
  * name and unique identifier combination is scoped to the AWS account or IAM user credentials.</p>
155
+ * @public
156
156
  */
157
157
  uniqueId: string | undefined;
158
158
  /**
159
- * @public
160
159
  * <p>The description for the pipeline.</p>
160
+ * @public
161
161
  */
162
162
  description?: string;
163
163
  /**
164
- * @public
165
164
  * <p>A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines.
166
165
  * For more information, see <a href="http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html">Controlling User Access to Pipelines</a>
167
166
  * in the <i>AWS Data Pipeline Developer Guide</i>.</p>
167
+ * @public
168
168
  */
169
169
  tags?: Tag[];
170
170
  }
171
171
  /**
172
- * @public
173
172
  * <p>Contains the output of CreatePipeline.</p>
173
+ * @public
174
174
  */
175
175
  export interface CreatePipelineOutput {
176
176
  /**
177
- * @public
178
177
  * <p>The ID that AWS Data Pipeline assigns the newly created pipeline. For example, <code>df-06372391ZG65EXAMPLE</code>.</p>
178
+ * @public
179
179
  */
180
180
  pipelineId: string | undefined;
181
181
  }
182
182
  /**
183
- * @public
184
183
  * <p>Contains the parameters for DeactivatePipeline.</p>
184
+ * @public
185
185
  */
186
186
  export interface DeactivatePipelineInput {
187
187
  /**
188
- * @public
189
188
  * <p>The ID of the pipeline.</p>
189
+ * @public
190
190
  */
191
191
  pipelineId: string | undefined;
192
192
  /**
193
- * @public
194
193
  * <p>Indicates whether to cancel any running objects. The default is true,
195
194
  * which sets the state of any running objects to <code>CANCELED</code>.
196
195
  * If this value is false, the pipeline is deactivated after all
197
196
  * running objects finish.</p>
197
+ * @public
198
198
  */
199
199
  cancelActive?: boolean;
200
200
  }
201
201
  /**
202
- * @public
203
202
  * <p>Contains the output of DeactivatePipeline.</p>
203
+ * @public
204
204
  */
205
205
  export interface DeactivatePipelineOutput {
206
206
  }
207
207
  /**
208
- * @public
209
208
  * <p>Contains the parameters for DeletePipeline.</p>
209
+ * @public
210
210
  */
211
211
  export interface DeletePipelineInput {
212
212
  /**
213
- * @public
214
213
  * <p>The ID of the pipeline.</p>
214
+ * @public
215
215
  */
216
216
  pipelineId: string | undefined;
217
217
  }
218
218
  /**
219
- * @public
220
219
  * <p>Contains the parameters for DescribeObjects.</p>
220
+ * @public
221
221
  */
222
222
  export interface DescribeObjectsInput {
223
223
  /**
224
- * @public
225
224
  * <p>The ID of the pipeline that contains the object definitions.</p>
225
+ * @public
226
226
  */
227
227
  pipelineId: string | undefined;
228
228
  /**
229
- * @public
230
229
  * <p>The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to <code>DescribeObjects</code>.</p>
230
+ * @public
231
231
  */
232
232
  objectIds: string[] | undefined;
233
233
  /**
234
- * @public
235
234
  * <p>Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.</p>
235
+ * @public
236
236
  */
237
237
  evaluateExpressions?: boolean;
238
238
  /**
239
- * @public
240
239
  * <p>The starting point for the results to be returned. For the first call, this value should be empty.
241
240
  * As long as there are more results, continue to call <code>DescribeObjects</code> with
242
241
  * the marker value from the previous call to retrieve the next set of results.</p>
242
+ * @public
243
243
  */
244
244
  marker?: string;
245
245
  }
246
246
  /**
247
- * @public
248
247
  * <p>A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (<code>StringValue</code>) or a reference to another object (<code>RefValue</code>) but not as both.</p>
248
+ * @public
249
249
  */
250
250
  export interface Field {
251
251
  /**
252
- * @public
253
252
  * <p>The field identifier.</p>
253
+ * @public
254
254
  */
255
255
  key: string | undefined;
256
256
  /**
257
- * @public
258
257
  * <p>The field value, expressed as a String.</p>
258
+ * @public
259
259
  */
260
260
  stringValue?: string;
261
261
  /**
262
- * @public
263
262
  * <p>The field value, expressed as the identifier of another object.</p>
263
+ * @public
264
264
  */
265
265
  refValue?: string;
266
266
  }
267
267
  /**
268
- * @public
269
268
  * <p>Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.</p>
269
+ * @public
270
270
  */
271
271
  export interface PipelineObject {
272
272
  /**
273
- * @public
274
273
  * <p>The ID of the object.</p>
274
+ * @public
275
275
  */
276
276
  id: string | undefined;
277
277
  /**
278
- * @public
279
278
  * <p>The name of the object.</p>
279
+ * @public
280
280
  */
281
281
  name: string | undefined;
282
282
  /**
283
- * @public
284
283
  * <p>Key-value pairs that define the properties of the object.</p>
284
+ * @public
285
285
  */
286
286
  fields: Field[] | undefined;
287
287
  }
288
288
  /**
289
- * @public
290
289
  * <p>Contains the output of DescribeObjects.</p>
290
+ * @public
291
291
  */
292
292
  export interface DescribeObjectsOutput {
293
293
  /**
294
- * @public
295
294
  * <p>An array of object definitions.</p>
295
+ * @public
296
296
  */
297
297
  pipelineObjects: PipelineObject[] | undefined;
298
298
  /**
299
- * @public
300
299
  * <p>The starting point for the next page of results. To view the next page of results, call <code>DescribeObjects</code>
301
300
  * again with this marker value. If the value is null, there are no more results.</p>
301
+ * @public
302
302
  */
303
303
  marker?: string;
304
304
  /**
305
- * @public
306
305
  * <p>Indicates whether there are more results to return.</p>
306
+ * @public
307
307
  */
308
308
  hasMoreResults?: boolean;
309
309
  }
310
310
  /**
311
- * @public
312
311
  * <p>Contains the parameters for DescribePipelines.</p>
312
+ * @public
313
313
  */
314
314
  export interface DescribePipelinesInput {
315
315
  /**
316
- * @public
317
316
  * <p>The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call.
318
317
  * To obtain pipeline IDs, call <a>ListPipelines</a>.</p>
318
+ * @public
319
319
  */
320
320
  pipelineIds: string[] | undefined;
321
321
  }
322
322
  /**
323
- * @public
324
323
  * <p>Contains pipeline metadata.</p>
324
+ * @public
325
325
  */
326
326
  export interface PipelineDescription {
327
327
  /**
328
- * @public
329
328
  * <p>The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form <code>df-297EG78HU43EEXAMPLE</code>.</p>
329
+ * @public
330
330
  */
331
331
  pipelineId: string | undefined;
332
332
  /**
333
- * @public
334
333
  * <p>The name of the pipeline.</p>
334
+ * @public
335
335
  */
336
336
  name: string | undefined;
337
337
  /**
338
- * @public
339
338
  * <p>A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.</p>
339
+ * @public
340
340
  */
341
341
  fields: Field[] | undefined;
342
342
  /**
343
- * @public
344
343
  * <p>Description of the pipeline.</p>
344
+ * @public
345
345
  */
346
346
  description?: string;
347
347
  /**
348
- * @public
349
348
  * <p>A list of tags to associated with a pipeline. Tags let you control access to pipelines.
350
349
  * For more information, see <a href="http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html">Controlling User Access to Pipelines</a> in the <i>AWS Data Pipeline Developer Guide</i>.</p>
350
+ * @public
351
351
  */
352
352
  tags?: Tag[];
353
353
  }
354
354
  /**
355
- * @public
356
355
  * <p>Contains the output of DescribePipelines.</p>
356
+ * @public
357
357
  */
358
358
  export interface DescribePipelinesOutput {
359
359
  /**
360
- * @public
361
360
  * <p>An array of descriptions for the specified pipelines.</p>
361
+ * @public
362
362
  */
363
363
  pipelineDescriptionList: PipelineDescription[] | undefined;
364
364
  }
365
365
  /**
366
- * @public
367
366
  * <p>Contains the parameters for EvaluateExpression.</p>
367
+ * @public
368
368
  */
369
369
  export interface EvaluateExpressionInput {
370
370
  /**
371
- * @public
372
371
  * <p>The ID of the pipeline.</p>
372
+ * @public
373
373
  */
374
374
  pipelineId: string | undefined;
375
375
  /**
376
- * @public
377
376
  * <p>The ID of the object.</p>
377
+ * @public
378
378
  */
379
379
  objectId: string | undefined;
380
380
  /**
381
- * @public
382
381
  * <p>The expression to evaluate.</p>
382
+ * @public
383
383
  */
384
384
  expression: string | undefined;
385
385
  }
386
386
  /**
387
- * @public
388
387
  * <p>Contains the output of EvaluateExpression.</p>
388
+ * @public
389
389
  */
390
390
  export interface EvaluateExpressionOutput {
391
391
  /**
392
- * @public
393
392
  * <p>The evaluated expression.</p>
393
+ * @public
394
394
  */
395
395
  evaluatedExpression: string | undefined;
396
396
  }
397
397
  /**
398
- * @public
399
398
  * <p>The specified task was not found. </p>
399
+ * @public
400
400
  */
401
401
  export declare class TaskNotFoundException extends __BaseException {
402
402
  readonly name: "TaskNotFoundException";
@@ -407,285 +407,285 @@ export declare class TaskNotFoundException extends __BaseException {
407
407
  constructor(opts: __ExceptionOptionType<TaskNotFoundException, __BaseException>);
408
408
  }
409
409
  /**
410
- * @public
411
410
  * <p>Contains the parameters for GetPipelineDefinition.</p>
411
+ * @public
412
412
  */
413
413
  export interface GetPipelineDefinitionInput {
414
414
  /**
415
- * @public
416
415
  * <p>The ID of the pipeline.</p>
416
+ * @public
417
417
  */
418
418
  pipelineId: string | undefined;
419
419
  /**
420
- * @public
421
420
  * <p>The version of the pipeline definition to retrieve. Set this parameter to <code>latest</code> (default)
422
421
  * to use the last definition saved to the pipeline or <code>active</code> to use the last definition
423
422
  * that was activated.</p>
423
+ * @public
424
424
  */
425
425
  version?: string;
426
426
  }
427
427
  /**
428
- * @public
429
428
  * <p>The attributes allowed or specified with a parameter object.</p>
429
+ * @public
430
430
  */
431
431
  export interface ParameterAttribute {
432
432
  /**
433
- * @public
434
433
  * <p>The field identifier.</p>
434
+ * @public
435
435
  */
436
436
  key: string | undefined;
437
437
  /**
438
- * @public
439
438
  * <p>The field value, expressed as a String.</p>
439
+ * @public
440
440
  */
441
441
  stringValue: string | undefined;
442
442
  }
443
443
  /**
444
- * @public
445
444
  * <p>Contains information about a parameter object.</p>
445
+ * @public
446
446
  */
447
447
  export interface ParameterObject {
448
448
  /**
449
- * @public
450
449
  * <p>The ID of the parameter object. </p>
450
+ * @public
451
451
  */
452
452
  id: string | undefined;
453
453
  /**
454
- * @public
455
454
  * <p>The attributes of the parameter object.</p>
455
+ * @public
456
456
  */
457
457
  attributes: ParameterAttribute[] | undefined;
458
458
  }
459
459
  /**
460
- * @public
461
460
  * <p>Contains the output of GetPipelineDefinition.</p>
461
+ * @public
462
462
  */
463
463
  export interface GetPipelineDefinitionOutput {
464
464
  /**
465
- * @public
466
465
  * <p>The objects defined in the pipeline.</p>
466
+ * @public
467
467
  */
468
468
  pipelineObjects?: PipelineObject[];
469
469
  /**
470
- * @public
471
470
  * <p>The parameter objects used in the pipeline definition.</p>
471
+ * @public
472
472
  */
473
473
  parameterObjects?: ParameterObject[];
474
474
  /**
475
- * @public
476
475
  * <p>The parameter values used in the pipeline definition.</p>
476
+ * @public
477
477
  */
478
478
  parameterValues?: ParameterValue[];
479
479
  }
480
480
  /**
481
- * @public
482
481
  * <p>Contains the parameters for ListPipelines.</p>
482
+ * @public
483
483
  */
484
484
  export interface ListPipelinesInput {
485
485
  /**
486
- * @public
487
486
  * <p>The starting point for the results to be returned. For the first call, this value should be empty.
488
487
  * As long as there are more results, continue to call <code>ListPipelines</code> with
489
488
  * the marker value from the previous call to retrieve the next set of results.</p>
489
+ * @public
490
490
  */
491
491
  marker?: string;
492
492
  }
493
493
  /**
494
- * @public
495
494
  * <p>Contains the name and identifier of a pipeline.</p>
495
+ * @public
496
496
  */
497
497
  export interface PipelineIdName {
498
498
  /**
499
- * @public
500
499
  * <p>The ID of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form <code>df-297EG78HU43EEXAMPLE</code>.</p>
500
+ * @public
501
501
  */
502
502
  id?: string;
503
503
  /**
504
- * @public
505
504
  * <p>The name of the pipeline.</p>
505
+ * @public
506
506
  */
507
507
  name?: string;
508
508
  }
509
509
  /**
510
- * @public
511
510
  * <p>Contains the output of ListPipelines.</p>
511
+ * @public
512
512
  */
513
513
  export interface ListPipelinesOutput {
514
514
  /**
515
- * @public
516
515
  * <p>The pipeline identifiers. If you require additional information about the pipelines, you can use these identifiers to call
517
516
  * <a>DescribePipelines</a> and <a>GetPipelineDefinition</a>.</p>
517
+ * @public
518
518
  */
519
519
  pipelineIdList: PipelineIdName[] | undefined;
520
520
  /**
521
- * @public
522
521
  * <p>The starting point for the next page of results. To view the next page of results, call <code>ListPipelinesOutput</code>
523
522
  * again with this marker value. If the value is null, there are no more results.</p>
523
+ * @public
524
524
  */
525
525
  marker?: string;
526
526
  /**
527
- * @public
528
527
  * <p>Indicates whether there are more results that can be obtained by a subsequent call.</p>
528
+ * @public
529
529
  */
530
530
  hasMoreResults?: boolean;
531
531
  }
532
532
  /**
533
- * @public
534
533
  * <p><p>Identity information for the EC2 instance that is hosting the task runner. You can get this value by calling a metadata URI from the EC2 instance.
535
534
  * For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html">Instance Metadata</a> in the <i>Amazon Elastic Compute Cloud User Guide.</i>
536
535
  * Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.</p></p>
536
+ * @public
537
537
  */
538
538
  export interface InstanceIdentity {
539
539
  /**
540
- * @public
541
540
  * <p>A description of an EC2 instance that is generated when the instance is launched and exposed to the instance via the instance metadata service in the form of a JSON representation of an object.</p>
541
+ * @public
542
542
  */
543
543
  document?: string;
544
544
  /**
545
- * @public
546
545
  * <p>A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document.</p>
546
+ * @public
547
547
  */
548
548
  signature?: string;
549
549
  }
550
550
  /**
551
- * @public
552
551
  * <p>Contains the parameters for PollForTask.</p>
552
+ * @public
553
553
  */
554
554
  export interface PollForTaskInput {
555
555
  /**
556
- * @public
557
556
  * <p>The type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created.
558
557
  * You can only specify a single value for <code>workerGroup</code> in the call to <code>PollForTask</code>. There are no wildcard values permitted in
559
558
  * <code>workerGroup</code>; the string must be an exact, case-sensitive, match.</p>
559
+ * @public
560
560
  */
561
561
  workerGroup: string | undefined;
562
562
  /**
563
- * @public
564
563
  * <p>The public DNS name of the calling task runner.</p>
564
+ * @public
565
565
  */
566
566
  hostname?: string;
567
567
  /**
568
- * @public
569
568
  * <p>Identity information for the EC2 instance that is hosting the task runner. You can get this value from the instance using <code>http://169.254.169.254/latest/meta-data/instance-id</code>. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html">Instance Metadata</a> in the <i>Amazon Elastic Compute Cloud User Guide.</i> Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.</p>
569
+ * @public
570
570
  */
571
571
  instanceIdentity?: InstanceIdentity;
572
572
  }
573
573
  /**
574
- * @public
575
574
  * <p>Contains information about a pipeline task that is assigned to a task runner.</p>
575
+ * @public
576
576
  */
577
577
  export interface TaskObject {
578
578
  /**
579
- * @public
580
579
  * <p>An internal identifier for the task. This ID is passed to the <a>SetTaskStatus</a> and <a>ReportTaskProgress</a> actions.</p>
580
+ * @public
581
581
  */
582
582
  taskId?: string;
583
583
  /**
584
- * @public
585
584
  * <p>The ID of the pipeline that provided the task.</p>
585
+ * @public
586
586
  */
587
587
  pipelineId?: string;
588
588
  /**
589
- * @public
590
589
  * <p>The ID of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted.</p>
590
+ * @public
591
591
  */
592
592
  attemptId?: string;
593
593
  /**
594
- * @public
595
594
  * <p>Connection information for the location where the task runner will publish the output of the task.</p>
595
+ * @public
596
596
  */
597
597
  objects?: Record<string, PipelineObject>;
598
598
  }
599
599
  /**
600
- * @public
601
600
  * <p>Contains the output of PollForTask.</p>
601
+ * @public
602
602
  */
603
603
  export interface PollForTaskOutput {
604
604
  /**
605
- * @public
606
605
  * <p>The information needed to complete the task that is being assigned to the task runner. One of the fields returned in this object is <code>taskId</code>,
607
606
  * which contains an identifier for the task being assigned. The calling task runner uses <code>taskId</code> in subsequent calls to <a>ReportTaskProgress</a>
608
607
  * and <a>SetTaskStatus</a>.</p>
608
+ * @public
609
609
  */
610
610
  taskObject?: TaskObject;
611
611
  }
612
612
  /**
613
- * @public
614
613
  * <p>Contains the parameters for PutPipelineDefinition.</p>
614
+ * @public
615
615
  */
616
616
  export interface PutPipelineDefinitionInput {
617
617
  /**
618
- * @public
619
618
  * <p>The ID of the pipeline.</p>
619
+ * @public
620
620
  */
621
621
  pipelineId: string | undefined;
622
622
  /**
623
- * @public
624
623
  * <p>The objects that define the pipeline. These objects overwrite the existing pipeline definition.</p>
624
+ * @public
625
625
  */
626
626
  pipelineObjects: PipelineObject[] | undefined;
627
627
  /**
628
- * @public
629
628
  * <p>The parameter objects used with the pipeline.</p>
629
+ * @public
630
630
  */
631
631
  parameterObjects?: ParameterObject[];
632
632
  /**
633
- * @public
634
633
  * <p>The parameter values used with the pipeline.</p>
634
+ * @public
635
635
  */
636
636
  parameterValues?: ParameterValue[];
637
637
  }
638
638
  /**
639
- * @public
640
639
  * <p>Defines a validation error. Validation errors prevent pipeline activation. The set of validation errors that can be returned are defined by AWS Data Pipeline.</p>
640
+ * @public
641
641
  */
642
642
  export interface ValidationError {
643
643
  /**
644
- * @public
645
644
  * <p>The identifier of the object that contains the validation error.</p>
645
+ * @public
646
646
  */
647
647
  id?: string;
648
648
  /**
649
- * @public
650
649
  * <p>A description of the validation error.</p>
650
+ * @public
651
651
  */
652
652
  errors?: string[];
653
653
  }
654
654
  /**
655
- * @public
656
655
  * <p>Defines a validation warning. Validation warnings do not prevent pipeline activation. The set of validation warnings that can be returned are defined by AWS Data Pipeline.</p>
656
+ * @public
657
657
  */
658
658
  export interface ValidationWarning {
659
659
  /**
660
- * @public
661
660
  * <p>The identifier of the object that contains the validation warning.</p>
661
+ * @public
662
662
  */
663
663
  id?: string;
664
664
  /**
665
- * @public
666
665
  * <p>A description of the validation warning.</p>
666
+ * @public
667
667
  */
668
668
  warnings?: string[];
669
669
  }
670
670
  /**
671
- * @public
672
671
  * <p>Contains the output of PutPipelineDefinition.</p>
672
+ * @public
673
673
  */
674
674
  export interface PutPipelineDefinitionOutput {
675
675
  /**
676
- * @public
677
676
  * <p>The validation errors that are associated with the objects defined in <code>pipelineObjects</code>.</p>
677
+ * @public
678
678
  */
679
679
  validationErrors?: ValidationError[];
680
680
  /**
681
- * @public
682
681
  * <p>The validation warnings that are associated with the objects defined in <code>pipelineObjects</code>.</p>
682
+ * @public
683
683
  */
684
684
  validationWarnings?: ValidationWarning[];
685
685
  /**
686
- * @public
687
686
  * <p>Indicates whether there were validation errors, and the pipeline definition is stored but cannot be
688
687
  * activated until you correct the pipeline and call <code>PutPipelineDefinition</code> to commit the corrected pipeline.</p>
688
+ * @public
689
689
  */
690
690
  errored: boolean | undefined;
691
691
  }
@@ -705,12 +705,11 @@ export declare const OperatorType: {
705
705
  */
706
706
  export type OperatorType = (typeof OperatorType)[keyof typeof OperatorType];
707
707
  /**
708
- * @public
709
708
  * <p>Contains a logical operation for comparing the value of a field with a specified value.</p>
709
+ * @public
710
710
  */
711
711
  export interface Operator {
712
712
  /**
713
- * @public
714
713
  * <p>
715
714
  * The logical operation to be performed: equal (<code>EQ</code>), equal reference (<code>REF_EQ</code>), less than or equal (<code>LE</code>), greater than or equal (<code>GE</code>), or between (<code>BETWEEN</code>). Equal reference (<code>REF_EQ</code>) can be used only with reference fields. The other comparison types can be used only with String fields. The comparison types you can use apply only to certain object fields, as detailed below.
716
715
  * </p>
@@ -740,203 +739,204 @@ export interface Operator {
740
739
  * <li>@actualEndTime</li>
741
740
  * </ul>
742
741
  * <p>Note that fields beginning with the at sign (@) are read-only and set by the web service. When you name fields, you should choose names containing only alpha-numeric values, as symbols may be reserved by AWS Data Pipeline. User-defined fields that you add to a pipeline should prefix their name with the string "my".</p>
742
+ * @public
743
743
  */
744
744
  type?: OperatorType;
745
745
  /**
746
- * @public
747
746
  * <p>The value that the actual field value will be compared with.</p>
747
+ * @public
748
748
  */
749
749
  values?: string[];
750
750
  }
751
751
  /**
752
- * @public
753
752
  * <p>A comparision that is used to determine whether a query should return this object.</p>
753
+ * @public
754
754
  */
755
755
  export interface Selector {
756
756
  /**
757
- * @public
758
757
  * <p>The name of the field that the operator will be applied to. The field name is the "key" portion of the field definition in the pipeline definition syntax that is used by the AWS Data Pipeline API. If the field is not set on the object, the condition fails.</p>
758
+ * @public
759
759
  */
760
760
  fieldName?: string;
761
761
  /**
762
- * @public
763
762
  * <p>Contains a logical operation for comparing the value of a field with a specified value.</p>
763
+ * @public
764
764
  */
765
765
  operator?: Operator;
766
766
  }
767
767
  /**
768
- * @public
769
768
  * <p>Defines the query to run against an object.</p>
769
+ * @public
770
770
  */
771
771
  export interface Query {
772
772
  /**
773
- * @public
774
773
  * <p>List of selectors that define the query. An object must satisfy all of the selectors to match the query.</p>
774
+ * @public
775
775
  */
776
776
  selectors?: Selector[];
777
777
  }
778
778
  /**
779
- * @public
780
779
  * <p>Contains the parameters for QueryObjects.</p>
780
+ * @public
781
781
  */
782
782
  export interface QueryObjectsInput {
783
783
  /**
784
- * @public
785
784
  * <p>The ID of the pipeline.</p>
785
+ * @public
786
786
  */
787
787
  pipelineId: string | undefined;
788
788
  /**
789
- * @public
790
789
  * <p>The query that defines the objects to be returned. The <code>Query</code> object can contain a maximum of ten selectors.
791
790
  * The conditions in the query are limited to top-level String fields in the object.
792
791
  * These filters can be applied to components, instances, and attempts.</p>
792
+ * @public
793
793
  */
794
794
  query?: Query;
795
795
  /**
796
- * @public
797
796
  * <p>Indicates whether the query applies to components or instances. The possible values are:
798
797
  * <code>COMPONENT</code>, <code>INSTANCE</code>, and <code>ATTEMPT</code>.</p>
798
+ * @public
799
799
  */
800
800
  sphere: string | undefined;
801
801
  /**
802
- * @public
803
802
  * <p>The starting point for the results to be returned. For the first call, this value should be empty.
804
803
  * As long as there are more results, continue to call <code>QueryObjects</code> with
805
804
  * the marker value from the previous call to retrieve the next set of results.</p>
805
+ * @public
806
806
  */
807
807
  marker?: string;
808
808
  /**
809
- * @public
810
809
  * <p>The maximum number of object names that <code>QueryObjects</code> will return in a single call. The default value is 100. </p>
810
+ * @public
811
811
  */
812
812
  limit?: number;
813
813
  }
814
814
  /**
815
- * @public
816
815
  * <p>Contains the output of QueryObjects.</p>
816
+ * @public
817
817
  */
818
818
  export interface QueryObjectsOutput {
819
819
  /**
820
- * @public
821
820
  * <p>The identifiers that match the query selectors.</p>
821
+ * @public
822
822
  */
823
823
  ids?: string[];
824
824
  /**
825
- * @public
826
825
  * <p>The starting point for the next page of results. To view the next page of results, call <code>QueryObjects</code>
827
826
  * again with this marker value. If the value is null, there are no more results.</p>
827
+ * @public
828
828
  */
829
829
  marker?: string;
830
830
  /**
831
- * @public
832
831
  * <p>Indicates whether there are more results that can be obtained by a subsequent call.</p>
832
+ * @public
833
833
  */
834
834
  hasMoreResults?: boolean;
835
835
  }
836
836
  /**
837
- * @public
838
837
  * <p>Contains the parameters for RemoveTags.</p>
838
+ * @public
839
839
  */
840
840
  export interface RemoveTagsInput {
841
841
  /**
842
- * @public
843
842
  * <p>The ID of the pipeline.</p>
843
+ * @public
844
844
  */
845
845
  pipelineId: string | undefined;
846
846
  /**
847
- * @public
848
847
  * <p>The keys of the tags to remove.</p>
848
+ * @public
849
849
  */
850
850
  tagKeys: string[] | undefined;
851
851
  }
852
852
  /**
853
- * @public
854
853
  * <p>Contains the output of RemoveTags.</p>
854
+ * @public
855
855
  */
856
856
  export interface RemoveTagsOutput {
857
857
  }
858
858
  /**
859
- * @public
860
859
  * <p>Contains the parameters for ReportTaskProgress.</p>
860
+ * @public
861
861
  */
862
862
  export interface ReportTaskProgressInput {
863
863
  /**
864
- * @public
865
864
  * <p>The ID of the task assigned to the task runner. This value is provided in the response for <a>PollForTask</a>.</p>
865
+ * @public
866
866
  */
867
867
  taskId: string | undefined;
868
868
  /**
869
- * @public
870
869
  * <p>Key-value pairs that define the properties of the ReportTaskProgressInput object.</p>
870
+ * @public
871
871
  */
872
872
  fields?: Field[];
873
873
  }
874
874
  /**
875
- * @public
876
875
  * <p>Contains the output of ReportTaskProgress.</p>
876
+ * @public
877
877
  */
878
878
  export interface ReportTaskProgressOutput {
879
879
  /**
880
- * @public
881
880
  * <p>If true, the calling task runner should cancel processing of the task. The task runner does not need to call <a>SetTaskStatus</a> for canceled tasks.</p>
881
+ * @public
882
882
  */
883
883
  canceled: boolean | undefined;
884
884
  }
885
885
  /**
886
- * @public
887
886
  * <p>Contains the parameters for ReportTaskRunnerHeartbeat.</p>
887
+ * @public
888
888
  */
889
889
  export interface ReportTaskRunnerHeartbeatInput {
890
890
  /**
891
- * @public
892
891
  * <p>The ID of the task runner. This value should be unique across your AWS account. In the case of AWS Data Pipeline Task Runner
893
892
  * launched on a resource managed by AWS Data Pipeline, the web service provides a unique identifier when it launches the application.
894
893
  * If you have written a custom task runner, you should assign a unique identifier for the task runner.</p>
894
+ * @public
895
895
  */
896
896
  taskrunnerId: string | undefined;
897
897
  /**
898
- * @public
899
898
  * <p>The type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created.
900
899
  * You can only specify a single value for <code>workerGroup</code>. There are no wildcard values permitted in <code>workerGroup</code>; the string
901
900
  * must be an exact, case-sensitive, match.</p>
901
+ * @public
902
902
  */
903
903
  workerGroup?: string;
904
904
  /**
905
- * @public
906
905
  * <p>The public DNS name of the task runner.</p>
906
+ * @public
907
907
  */
908
908
  hostname?: string;
909
909
  }
910
910
  /**
911
- * @public
912
911
  * <p>Contains the output of ReportTaskRunnerHeartbeat.</p>
912
+ * @public
913
913
  */
914
914
  export interface ReportTaskRunnerHeartbeatOutput {
915
915
  /**
916
- * @public
917
916
  * <p>Indicates whether the calling task runner should terminate.</p>
917
+ * @public
918
918
  */
919
919
  terminate: boolean | undefined;
920
920
  }
921
921
  /**
922
- * @public
923
922
  * <p>Contains the parameters for SetStatus.</p>
923
+ * @public
924
924
  */
925
925
  export interface SetStatusInput {
926
926
  /**
927
- * @public
928
927
  * <p>The ID of the pipeline that contains the objects.</p>
928
+ * @public
929
929
  */
930
930
  pipelineId: string | undefined;
931
931
  /**
932
- * @public
933
932
  * <p>The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.</p>
933
+ * @public
934
934
  */
935
935
  objectIds: string[] | undefined;
936
936
  /**
937
- * @public
938
937
  * <p>The status to be set on all the objects specified in <code>objectIds</code>. For components, use <code>PAUSE</code> or <code>RESUME</code>.
939
938
  * For instances, use <code>TRY_CANCEL</code>, <code>RERUN</code>, or <code>MARK_FINISHED</code>.</p>
939
+ * @public
940
940
  */
941
941
  status: string | undefined;
942
942
  }
@@ -954,89 +954,89 @@ export declare const TaskStatus: {
954
954
  */
955
955
  export type TaskStatus = (typeof TaskStatus)[keyof typeof TaskStatus];
956
956
  /**
957
- * @public
958
957
  * <p>Contains the parameters for SetTaskStatus.</p>
958
+ * @public
959
959
  */
960
960
  export interface SetTaskStatusInput {
961
961
  /**
962
- * @public
963
962
  * <p>The ID of the task assigned to the task runner. This value is provided in the response for <a>PollForTask</a>.</p>
963
+ * @public
964
964
  */
965
965
  taskId: string | undefined;
966
966
  /**
967
- * @public
968
967
  * <p>If <code>FINISHED</code>, the task successfully completed. If <code>FAILED</code>, the task ended unsuccessfully. Preconditions use false.</p>
968
+ * @public
969
969
  */
970
970
  taskStatus: TaskStatus | undefined;
971
971
  /**
972
- * @public
973
972
  * <p>If an error occurred during the task, this value specifies the error code. This value is set on the physical attempt object.
974
973
  * It is used to display error information to the user. It should not start with string "Service_" which is reserved by the system.</p>
974
+ * @public
975
975
  */
976
976
  errorId?: string;
977
977
  /**
978
- * @public
979
978
  * <p>If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object.
980
979
  * It is used to display error information to the user. The web service does not parse this value.</p>
980
+ * @public
981
981
  */
982
982
  errorMessage?: string;
983
983
  /**
984
- * @public
985
984
  * <p>If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object.
986
985
  * It is used to display error information to the user. The web service does not parse this value.</p>
986
+ * @public
987
987
  */
988
988
  errorStackTrace?: string;
989
989
  }
990
990
  /**
991
- * @public
992
991
  * <p>Contains the output of SetTaskStatus.</p>
992
+ * @public
993
993
  */
994
994
  export interface SetTaskStatusOutput {
995
995
  }
996
996
  /**
997
- * @public
998
997
  * <p>Contains the parameters for ValidatePipelineDefinition.</p>
998
+ * @public
999
999
  */
1000
1000
  export interface ValidatePipelineDefinitionInput {
1001
1001
  /**
1002
- * @public
1003
1002
  * <p>The ID of the pipeline.</p>
1003
+ * @public
1004
1004
  */
1005
1005
  pipelineId: string | undefined;
1006
1006
  /**
1007
- * @public
1008
1007
  * <p>The objects that define the pipeline changes to validate against the pipeline.</p>
1008
+ * @public
1009
1009
  */
1010
1010
  pipelineObjects: PipelineObject[] | undefined;
1011
1011
  /**
1012
- * @public
1013
1012
  * <p>The parameter objects used with the pipeline.</p>
1013
+ * @public
1014
1014
  */
1015
1015
  parameterObjects?: ParameterObject[];
1016
1016
  /**
1017
- * @public
1018
1017
  * <p>The parameter values used with the pipeline.</p>
1018
+ * @public
1019
1019
  */
1020
1020
  parameterValues?: ParameterValue[];
1021
1021
  }
1022
1022
  /**
1023
- * @public
1024
1023
  * <p>Contains the output of ValidatePipelineDefinition.</p>
1024
+ * @public
1025
1025
  */
1026
1026
  export interface ValidatePipelineDefinitionOutput {
1027
1027
  /**
1028
- * @public
1029
1028
  * <p>Any validation errors that were found.</p>
1029
+ * @public
1030
1030
  */
1031
1031
  validationErrors?: ValidationError[];
1032
1032
  /**
1033
- * @public
1034
1033
  * <p>Any validation warnings that were found.</p>
1034
+ * @public
1035
1035
  */
1036
1036
  validationWarnings?: ValidationWarning[];
1037
1037
  /**
1038
- * @public
1039
1038
  * <p>Indicates whether there were validation errors.</p>
1039
+ * @public
1040
1040
  */
1041
1041
  errored: boolean | undefined;
1042
1042
  }