@aws-sdk/client-data-pipeline 3.379.1 → 3.382.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.
- package/dist-types/models/models_0.d.ts +114 -0
- package/package.json +5 -5
|
@@ -6,10 +6,12 @@ import { DataPipelineServiceException as __BaseException } from "./DataPipelineS
|
|
|
6
6
|
*/
|
|
7
7
|
export interface ParameterValue {
|
|
8
8
|
/**
|
|
9
|
+
* @public
|
|
9
10
|
* <p>The ID of the parameter value.</p>
|
|
10
11
|
*/
|
|
11
12
|
id: string | undefined;
|
|
12
13
|
/**
|
|
14
|
+
* @public
|
|
13
15
|
* <p>The field value, expressed as a String.</p>
|
|
14
16
|
*/
|
|
15
17
|
stringValue: string | undefined;
|
|
@@ -20,14 +22,17 @@ export interface ParameterValue {
|
|
|
20
22
|
*/
|
|
21
23
|
export interface ActivatePipelineInput {
|
|
22
24
|
/**
|
|
25
|
+
* @public
|
|
23
26
|
* <p>The ID of the pipeline.</p>
|
|
24
27
|
*/
|
|
25
28
|
pipelineId: string | undefined;
|
|
26
29
|
/**
|
|
30
|
+
* @public
|
|
27
31
|
* <p>A list of parameter values to pass to the pipeline at activation.</p>
|
|
28
32
|
*/
|
|
29
33
|
parameterValues?: ParameterValue[];
|
|
30
34
|
/**
|
|
35
|
+
* @public
|
|
31
36
|
* <p>The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.</p>
|
|
32
37
|
*/
|
|
33
38
|
startTimestamp?: Date;
|
|
@@ -93,11 +98,13 @@ export declare class PipelineNotFoundException extends __BaseException {
|
|
|
93
98
|
*/
|
|
94
99
|
export interface Tag {
|
|
95
100
|
/**
|
|
101
|
+
* @public
|
|
96
102
|
* <p>The key name of a tag defined by a user.
|
|
97
103
|
* 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>
|
|
98
104
|
*/
|
|
99
105
|
key: string | undefined;
|
|
100
106
|
/**
|
|
107
|
+
* @public
|
|
101
108
|
* <p>The optional value portion of a tag defined by a user.
|
|
102
109
|
* 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
110
|
*/
|
|
@@ -109,10 +116,12 @@ export interface Tag {
|
|
|
109
116
|
*/
|
|
110
117
|
export interface AddTagsInput {
|
|
111
118
|
/**
|
|
119
|
+
* @public
|
|
112
120
|
* <p>The ID of the pipeline.</p>
|
|
113
121
|
*/
|
|
114
122
|
pipelineId: string | undefined;
|
|
115
123
|
/**
|
|
124
|
+
* @public
|
|
116
125
|
* <p>The tags to add, as key/value pairs.</p>
|
|
117
126
|
*/
|
|
118
127
|
tags: Tag[] | undefined;
|
|
@@ -129,11 +138,13 @@ export interface AddTagsOutput {
|
|
|
129
138
|
*/
|
|
130
139
|
export interface CreatePipelineInput {
|
|
131
140
|
/**
|
|
141
|
+
* @public
|
|
132
142
|
* <p>The name for the pipeline. You can use the same name for multiple pipelines associated with your AWS account,
|
|
133
143
|
* because AWS Data Pipeline assigns each pipeline a unique pipeline identifier.</p>
|
|
134
144
|
*/
|
|
135
145
|
name: string | undefined;
|
|
136
146
|
/**
|
|
147
|
+
* @public
|
|
137
148
|
* <p>A unique identifier. This identifier is not the same as the pipeline identifier assigned by AWS Data Pipeline.
|
|
138
149
|
* You are responsible for defining the format and ensuring the uniqueness of this identifier. You use this
|
|
139
150
|
* parameter to ensure idempotency during repeated calls to <code>CreatePipeline</code>. For example, if the
|
|
@@ -145,10 +156,12 @@ export interface CreatePipelineInput {
|
|
|
145
156
|
*/
|
|
146
157
|
uniqueId: string | undefined;
|
|
147
158
|
/**
|
|
159
|
+
* @public
|
|
148
160
|
* <p>The description for the pipeline.</p>
|
|
149
161
|
*/
|
|
150
162
|
description?: string;
|
|
151
163
|
/**
|
|
164
|
+
* @public
|
|
152
165
|
* <p>A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines.
|
|
153
166
|
* For more information, see <a href="http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html">Controlling User Access to Pipelines</a>
|
|
154
167
|
* in the <i>AWS Data Pipeline Developer Guide</i>.</p>
|
|
@@ -161,6 +174,7 @@ export interface CreatePipelineInput {
|
|
|
161
174
|
*/
|
|
162
175
|
export interface CreatePipelineOutput {
|
|
163
176
|
/**
|
|
177
|
+
* @public
|
|
164
178
|
* <p>The ID that AWS Data Pipeline assigns the newly created pipeline. For example, <code>df-06372391ZG65EXAMPLE</code>.</p>
|
|
165
179
|
*/
|
|
166
180
|
pipelineId: string | undefined;
|
|
@@ -171,10 +185,12 @@ export interface CreatePipelineOutput {
|
|
|
171
185
|
*/
|
|
172
186
|
export interface DeactivatePipelineInput {
|
|
173
187
|
/**
|
|
188
|
+
* @public
|
|
174
189
|
* <p>The ID of the pipeline.</p>
|
|
175
190
|
*/
|
|
176
191
|
pipelineId: string | undefined;
|
|
177
192
|
/**
|
|
193
|
+
* @public
|
|
178
194
|
* <p>Indicates whether to cancel any running objects. The default is true,
|
|
179
195
|
* which sets the state of any running objects to <code>CANCELED</code>.
|
|
180
196
|
* If this value is false, the pipeline is deactivated after all
|
|
@@ -194,6 +210,7 @@ export interface DeactivatePipelineOutput {
|
|
|
194
210
|
*/
|
|
195
211
|
export interface DeletePipelineInput {
|
|
196
212
|
/**
|
|
213
|
+
* @public
|
|
197
214
|
* <p>The ID of the pipeline.</p>
|
|
198
215
|
*/
|
|
199
216
|
pipelineId: string | undefined;
|
|
@@ -204,18 +221,22 @@ export interface DeletePipelineInput {
|
|
|
204
221
|
*/
|
|
205
222
|
export interface DescribeObjectsInput {
|
|
206
223
|
/**
|
|
224
|
+
* @public
|
|
207
225
|
* <p>The ID of the pipeline that contains the object definitions.</p>
|
|
208
226
|
*/
|
|
209
227
|
pipelineId: string | undefined;
|
|
210
228
|
/**
|
|
229
|
+
* @public
|
|
211
230
|
* <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>
|
|
212
231
|
*/
|
|
213
232
|
objectIds: string[] | undefined;
|
|
214
233
|
/**
|
|
234
|
+
* @public
|
|
215
235
|
* <p>Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.</p>
|
|
216
236
|
*/
|
|
217
237
|
evaluateExpressions?: boolean;
|
|
218
238
|
/**
|
|
239
|
+
* @public
|
|
219
240
|
* <p>The starting point for the results to be returned. For the first call, this value should be empty.
|
|
220
241
|
* As long as there are more results, continue to call <code>DescribeObjects</code> with
|
|
221
242
|
* the marker value from the previous call to retrieve the next set of results.</p>
|
|
@@ -228,14 +249,17 @@ export interface DescribeObjectsInput {
|
|
|
228
249
|
*/
|
|
229
250
|
export interface Field {
|
|
230
251
|
/**
|
|
252
|
+
* @public
|
|
231
253
|
* <p>The field identifier.</p>
|
|
232
254
|
*/
|
|
233
255
|
key: string | undefined;
|
|
234
256
|
/**
|
|
257
|
+
* @public
|
|
235
258
|
* <p>The field value, expressed as a String.</p>
|
|
236
259
|
*/
|
|
237
260
|
stringValue?: string;
|
|
238
261
|
/**
|
|
262
|
+
* @public
|
|
239
263
|
* <p>The field value, expressed as the identifier of another object.</p>
|
|
240
264
|
*/
|
|
241
265
|
refValue?: string;
|
|
@@ -246,14 +270,17 @@ export interface Field {
|
|
|
246
270
|
*/
|
|
247
271
|
export interface PipelineObject {
|
|
248
272
|
/**
|
|
273
|
+
* @public
|
|
249
274
|
* <p>The ID of the object.</p>
|
|
250
275
|
*/
|
|
251
276
|
id: string | undefined;
|
|
252
277
|
/**
|
|
278
|
+
* @public
|
|
253
279
|
* <p>The name of the object.</p>
|
|
254
280
|
*/
|
|
255
281
|
name: string | undefined;
|
|
256
282
|
/**
|
|
283
|
+
* @public
|
|
257
284
|
* <p>Key-value pairs that define the properties of the object.</p>
|
|
258
285
|
*/
|
|
259
286
|
fields: Field[] | undefined;
|
|
@@ -264,15 +291,18 @@ export interface PipelineObject {
|
|
|
264
291
|
*/
|
|
265
292
|
export interface DescribeObjectsOutput {
|
|
266
293
|
/**
|
|
294
|
+
* @public
|
|
267
295
|
* <p>An array of object definitions.</p>
|
|
268
296
|
*/
|
|
269
297
|
pipelineObjects: PipelineObject[] | undefined;
|
|
270
298
|
/**
|
|
299
|
+
* @public
|
|
271
300
|
* <p>The starting point for the next page of results. To view the next page of results, call <code>DescribeObjects</code>
|
|
272
301
|
* again with this marker value. If the value is null, there are no more results.</p>
|
|
273
302
|
*/
|
|
274
303
|
marker?: string;
|
|
275
304
|
/**
|
|
305
|
+
* @public
|
|
276
306
|
* <p>Indicates whether there are more results to return.</p>
|
|
277
307
|
*/
|
|
278
308
|
hasMoreResults?: boolean;
|
|
@@ -283,6 +313,7 @@ export interface DescribeObjectsOutput {
|
|
|
283
313
|
*/
|
|
284
314
|
export interface DescribePipelinesInput {
|
|
285
315
|
/**
|
|
316
|
+
* @public
|
|
286
317
|
* <p>The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call.
|
|
287
318
|
* To obtain pipeline IDs, call <a>ListPipelines</a>.</p>
|
|
288
319
|
*/
|
|
@@ -294,22 +325,27 @@ export interface DescribePipelinesInput {
|
|
|
294
325
|
*/
|
|
295
326
|
export interface PipelineDescription {
|
|
296
327
|
/**
|
|
328
|
+
* @public
|
|
297
329
|
* <p>The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form <code>df-297EG78HU43EEXAMPLE</code>.</p>
|
|
298
330
|
*/
|
|
299
331
|
pipelineId: string | undefined;
|
|
300
332
|
/**
|
|
333
|
+
* @public
|
|
301
334
|
* <p>The name of the pipeline.</p>
|
|
302
335
|
*/
|
|
303
336
|
name: string | undefined;
|
|
304
337
|
/**
|
|
338
|
+
* @public
|
|
305
339
|
* <p>A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.</p>
|
|
306
340
|
*/
|
|
307
341
|
fields: Field[] | undefined;
|
|
308
342
|
/**
|
|
343
|
+
* @public
|
|
309
344
|
* <p>Description of the pipeline.</p>
|
|
310
345
|
*/
|
|
311
346
|
description?: string;
|
|
312
347
|
/**
|
|
348
|
+
* @public
|
|
313
349
|
* <p>A list of tags to associated with a pipeline. Tags let you control access to pipelines.
|
|
314
350
|
* 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>
|
|
315
351
|
*/
|
|
@@ -321,6 +357,7 @@ export interface PipelineDescription {
|
|
|
321
357
|
*/
|
|
322
358
|
export interface DescribePipelinesOutput {
|
|
323
359
|
/**
|
|
360
|
+
* @public
|
|
324
361
|
* <p>An array of descriptions for the specified pipelines.</p>
|
|
325
362
|
*/
|
|
326
363
|
pipelineDescriptionList: PipelineDescription[] | undefined;
|
|
@@ -331,14 +368,17 @@ export interface DescribePipelinesOutput {
|
|
|
331
368
|
*/
|
|
332
369
|
export interface EvaluateExpressionInput {
|
|
333
370
|
/**
|
|
371
|
+
* @public
|
|
334
372
|
* <p>The ID of the pipeline.</p>
|
|
335
373
|
*/
|
|
336
374
|
pipelineId: string | undefined;
|
|
337
375
|
/**
|
|
376
|
+
* @public
|
|
338
377
|
* <p>The ID of the object.</p>
|
|
339
378
|
*/
|
|
340
379
|
objectId: string | undefined;
|
|
341
380
|
/**
|
|
381
|
+
* @public
|
|
342
382
|
* <p>The expression to evaluate.</p>
|
|
343
383
|
*/
|
|
344
384
|
expression: string | undefined;
|
|
@@ -349,6 +389,7 @@ export interface EvaluateExpressionInput {
|
|
|
349
389
|
*/
|
|
350
390
|
export interface EvaluateExpressionOutput {
|
|
351
391
|
/**
|
|
392
|
+
* @public
|
|
352
393
|
* <p>The evaluated expression.</p>
|
|
353
394
|
*/
|
|
354
395
|
evaluatedExpression: string | undefined;
|
|
@@ -371,10 +412,12 @@ export declare class TaskNotFoundException extends __BaseException {
|
|
|
371
412
|
*/
|
|
372
413
|
export interface GetPipelineDefinitionInput {
|
|
373
414
|
/**
|
|
415
|
+
* @public
|
|
374
416
|
* <p>The ID of the pipeline.</p>
|
|
375
417
|
*/
|
|
376
418
|
pipelineId: string | undefined;
|
|
377
419
|
/**
|
|
420
|
+
* @public
|
|
378
421
|
* <p>The version of the pipeline definition to retrieve. Set this parameter to <code>latest</code> (default)
|
|
379
422
|
* to use the last definition saved to the pipeline or <code>active</code> to use the last definition
|
|
380
423
|
* that was activated.</p>
|
|
@@ -387,10 +430,12 @@ export interface GetPipelineDefinitionInput {
|
|
|
387
430
|
*/
|
|
388
431
|
export interface ParameterAttribute {
|
|
389
432
|
/**
|
|
433
|
+
* @public
|
|
390
434
|
* <p>The field identifier.</p>
|
|
391
435
|
*/
|
|
392
436
|
key: string | undefined;
|
|
393
437
|
/**
|
|
438
|
+
* @public
|
|
394
439
|
* <p>The field value, expressed as a String.</p>
|
|
395
440
|
*/
|
|
396
441
|
stringValue: string | undefined;
|
|
@@ -401,10 +446,12 @@ export interface ParameterAttribute {
|
|
|
401
446
|
*/
|
|
402
447
|
export interface ParameterObject {
|
|
403
448
|
/**
|
|
449
|
+
* @public
|
|
404
450
|
* <p>The ID of the parameter object. </p>
|
|
405
451
|
*/
|
|
406
452
|
id: string | undefined;
|
|
407
453
|
/**
|
|
454
|
+
* @public
|
|
408
455
|
* <p>The attributes of the parameter object.</p>
|
|
409
456
|
*/
|
|
410
457
|
attributes: ParameterAttribute[] | undefined;
|
|
@@ -415,14 +462,17 @@ export interface ParameterObject {
|
|
|
415
462
|
*/
|
|
416
463
|
export interface GetPipelineDefinitionOutput {
|
|
417
464
|
/**
|
|
465
|
+
* @public
|
|
418
466
|
* <p>The objects defined in the pipeline.</p>
|
|
419
467
|
*/
|
|
420
468
|
pipelineObjects?: PipelineObject[];
|
|
421
469
|
/**
|
|
470
|
+
* @public
|
|
422
471
|
* <p>The parameter objects used in the pipeline definition.</p>
|
|
423
472
|
*/
|
|
424
473
|
parameterObjects?: ParameterObject[];
|
|
425
474
|
/**
|
|
475
|
+
* @public
|
|
426
476
|
* <p>The parameter values used in the pipeline definition.</p>
|
|
427
477
|
*/
|
|
428
478
|
parameterValues?: ParameterValue[];
|
|
@@ -433,6 +483,7 @@ export interface GetPipelineDefinitionOutput {
|
|
|
433
483
|
*/
|
|
434
484
|
export interface ListPipelinesInput {
|
|
435
485
|
/**
|
|
486
|
+
* @public
|
|
436
487
|
* <p>The starting point for the results to be returned. For the first call, this value should be empty.
|
|
437
488
|
* As long as there are more results, continue to call <code>ListPipelines</code> with
|
|
438
489
|
* the marker value from the previous call to retrieve the next set of results.</p>
|
|
@@ -445,10 +496,12 @@ export interface ListPipelinesInput {
|
|
|
445
496
|
*/
|
|
446
497
|
export interface PipelineIdName {
|
|
447
498
|
/**
|
|
499
|
+
* @public
|
|
448
500
|
* <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>
|
|
449
501
|
*/
|
|
450
502
|
id?: string;
|
|
451
503
|
/**
|
|
504
|
+
* @public
|
|
452
505
|
* <p>The name of the pipeline.</p>
|
|
453
506
|
*/
|
|
454
507
|
name?: string;
|
|
@@ -459,16 +512,19 @@ export interface PipelineIdName {
|
|
|
459
512
|
*/
|
|
460
513
|
export interface ListPipelinesOutput {
|
|
461
514
|
/**
|
|
515
|
+
* @public
|
|
462
516
|
* <p>The pipeline identifiers. If you require additional information about the pipelines, you can use these identifiers to call
|
|
463
517
|
* <a>DescribePipelines</a> and <a>GetPipelineDefinition</a>.</p>
|
|
464
518
|
*/
|
|
465
519
|
pipelineIdList: PipelineIdName[] | undefined;
|
|
466
520
|
/**
|
|
521
|
+
* @public
|
|
467
522
|
* <p>The starting point for the next page of results. To view the next page of results, call <code>ListPipelinesOutput</code>
|
|
468
523
|
* again with this marker value. If the value is null, there are no more results.</p>
|
|
469
524
|
*/
|
|
470
525
|
marker?: string;
|
|
471
526
|
/**
|
|
527
|
+
* @public
|
|
472
528
|
* <p>Indicates whether there are more results that can be obtained by a subsequent call.</p>
|
|
473
529
|
*/
|
|
474
530
|
hasMoreResults?: boolean;
|
|
@@ -481,10 +537,12 @@ export interface ListPipelinesOutput {
|
|
|
481
537
|
*/
|
|
482
538
|
export interface InstanceIdentity {
|
|
483
539
|
/**
|
|
540
|
+
* @public
|
|
484
541
|
* <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>
|
|
485
542
|
*/
|
|
486
543
|
document?: string;
|
|
487
544
|
/**
|
|
545
|
+
* @public
|
|
488
546
|
* <p>A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document.</p>
|
|
489
547
|
*/
|
|
490
548
|
signature?: string;
|
|
@@ -495,16 +553,19 @@ export interface InstanceIdentity {
|
|
|
495
553
|
*/
|
|
496
554
|
export interface PollForTaskInput {
|
|
497
555
|
/**
|
|
556
|
+
* @public
|
|
498
557
|
* <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.
|
|
499
558
|
* 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
|
|
500
559
|
* <code>workerGroup</code>; the string must be an exact, case-sensitive, match.</p>
|
|
501
560
|
*/
|
|
502
561
|
workerGroup: string | undefined;
|
|
503
562
|
/**
|
|
563
|
+
* @public
|
|
504
564
|
* <p>The public DNS name of the calling task runner.</p>
|
|
505
565
|
*/
|
|
506
566
|
hostname?: string;
|
|
507
567
|
/**
|
|
568
|
+
* @public
|
|
508
569
|
* <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>
|
|
509
570
|
*/
|
|
510
571
|
instanceIdentity?: InstanceIdentity;
|
|
@@ -515,18 +576,22 @@ export interface PollForTaskInput {
|
|
|
515
576
|
*/
|
|
516
577
|
export interface TaskObject {
|
|
517
578
|
/**
|
|
579
|
+
* @public
|
|
518
580
|
* <p>An internal identifier for the task. This ID is passed to the <a>SetTaskStatus</a> and <a>ReportTaskProgress</a> actions.</p>
|
|
519
581
|
*/
|
|
520
582
|
taskId?: string;
|
|
521
583
|
/**
|
|
584
|
+
* @public
|
|
522
585
|
* <p>The ID of the pipeline that provided the task.</p>
|
|
523
586
|
*/
|
|
524
587
|
pipelineId?: string;
|
|
525
588
|
/**
|
|
589
|
+
* @public
|
|
526
590
|
* <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>
|
|
527
591
|
*/
|
|
528
592
|
attemptId?: string;
|
|
529
593
|
/**
|
|
594
|
+
* @public
|
|
530
595
|
* <p>Connection information for the location where the task runner will publish the output of the task.</p>
|
|
531
596
|
*/
|
|
532
597
|
objects?: Record<string, PipelineObject>;
|
|
@@ -537,6 +602,7 @@ export interface TaskObject {
|
|
|
537
602
|
*/
|
|
538
603
|
export interface PollForTaskOutput {
|
|
539
604
|
/**
|
|
605
|
+
* @public
|
|
540
606
|
* <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>,
|
|
541
607
|
* which contains an identifier for the task being assigned. The calling task runner uses <code>taskId</code> in subsequent calls to <a>ReportTaskProgress</a>
|
|
542
608
|
* and <a>SetTaskStatus</a>.</p>
|
|
@@ -549,18 +615,22 @@ export interface PollForTaskOutput {
|
|
|
549
615
|
*/
|
|
550
616
|
export interface PutPipelineDefinitionInput {
|
|
551
617
|
/**
|
|
618
|
+
* @public
|
|
552
619
|
* <p>The ID of the pipeline.</p>
|
|
553
620
|
*/
|
|
554
621
|
pipelineId: string | undefined;
|
|
555
622
|
/**
|
|
623
|
+
* @public
|
|
556
624
|
* <p>The objects that define the pipeline. These objects overwrite the existing pipeline definition.</p>
|
|
557
625
|
*/
|
|
558
626
|
pipelineObjects: PipelineObject[] | undefined;
|
|
559
627
|
/**
|
|
628
|
+
* @public
|
|
560
629
|
* <p>The parameter objects used with the pipeline.</p>
|
|
561
630
|
*/
|
|
562
631
|
parameterObjects?: ParameterObject[];
|
|
563
632
|
/**
|
|
633
|
+
* @public
|
|
564
634
|
* <p>The parameter values used with the pipeline.</p>
|
|
565
635
|
*/
|
|
566
636
|
parameterValues?: ParameterValue[];
|
|
@@ -571,10 +641,12 @@ export interface PutPipelineDefinitionInput {
|
|
|
571
641
|
*/
|
|
572
642
|
export interface ValidationError {
|
|
573
643
|
/**
|
|
644
|
+
* @public
|
|
574
645
|
* <p>The identifier of the object that contains the validation error.</p>
|
|
575
646
|
*/
|
|
576
647
|
id?: string;
|
|
577
648
|
/**
|
|
649
|
+
* @public
|
|
578
650
|
* <p>A description of the validation error.</p>
|
|
579
651
|
*/
|
|
580
652
|
errors?: string[];
|
|
@@ -585,10 +657,12 @@ export interface ValidationError {
|
|
|
585
657
|
*/
|
|
586
658
|
export interface ValidationWarning {
|
|
587
659
|
/**
|
|
660
|
+
* @public
|
|
588
661
|
* <p>The identifier of the object that contains the validation warning.</p>
|
|
589
662
|
*/
|
|
590
663
|
id?: string;
|
|
591
664
|
/**
|
|
665
|
+
* @public
|
|
592
666
|
* <p>A description of the validation warning.</p>
|
|
593
667
|
*/
|
|
594
668
|
warnings?: string[];
|
|
@@ -599,14 +673,17 @@ export interface ValidationWarning {
|
|
|
599
673
|
*/
|
|
600
674
|
export interface PutPipelineDefinitionOutput {
|
|
601
675
|
/**
|
|
676
|
+
* @public
|
|
602
677
|
* <p>The validation errors that are associated with the objects defined in <code>pipelineObjects</code>.</p>
|
|
603
678
|
*/
|
|
604
679
|
validationErrors?: ValidationError[];
|
|
605
680
|
/**
|
|
681
|
+
* @public
|
|
606
682
|
* <p>The validation warnings that are associated with the objects defined in <code>pipelineObjects</code>.</p>
|
|
607
683
|
*/
|
|
608
684
|
validationWarnings?: ValidationWarning[];
|
|
609
685
|
/**
|
|
686
|
+
* @public
|
|
610
687
|
* <p>Indicates whether there were validation errors, and the pipeline definition is stored but cannot be
|
|
611
688
|
* activated until you correct the pipeline and call <code>PutPipelineDefinition</code> to commit the corrected pipeline.</p>
|
|
612
689
|
*/
|
|
@@ -633,6 +710,7 @@ export type OperatorType = (typeof OperatorType)[keyof typeof OperatorType];
|
|
|
633
710
|
*/
|
|
634
711
|
export interface Operator {
|
|
635
712
|
/**
|
|
713
|
+
* @public
|
|
636
714
|
* <p>
|
|
637
715
|
* 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.
|
|
638
716
|
* </p>
|
|
@@ -665,6 +743,7 @@ export interface Operator {
|
|
|
665
743
|
*/
|
|
666
744
|
type?: OperatorType | string;
|
|
667
745
|
/**
|
|
746
|
+
* @public
|
|
668
747
|
* <p>The value that the actual field value will be compared with.</p>
|
|
669
748
|
*/
|
|
670
749
|
values?: string[];
|
|
@@ -675,10 +754,12 @@ export interface Operator {
|
|
|
675
754
|
*/
|
|
676
755
|
export interface Selector {
|
|
677
756
|
/**
|
|
757
|
+
* @public
|
|
678
758
|
* <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>
|
|
679
759
|
*/
|
|
680
760
|
fieldName?: string;
|
|
681
761
|
/**
|
|
762
|
+
* @public
|
|
682
763
|
* <p>Contains a logical operation for comparing the value of a field with a specified value.</p>
|
|
683
764
|
*/
|
|
684
765
|
operator?: Operator;
|
|
@@ -689,6 +770,7 @@ export interface Selector {
|
|
|
689
770
|
*/
|
|
690
771
|
export interface Query {
|
|
691
772
|
/**
|
|
773
|
+
* @public
|
|
692
774
|
* <p>List of selectors that define the query. An object must satisfy all of the selectors to match the query.</p>
|
|
693
775
|
*/
|
|
694
776
|
selectors?: Selector[];
|
|
@@ -699,27 +781,32 @@ export interface Query {
|
|
|
699
781
|
*/
|
|
700
782
|
export interface QueryObjectsInput {
|
|
701
783
|
/**
|
|
784
|
+
* @public
|
|
702
785
|
* <p>The ID of the pipeline.</p>
|
|
703
786
|
*/
|
|
704
787
|
pipelineId: string | undefined;
|
|
705
788
|
/**
|
|
789
|
+
* @public
|
|
706
790
|
* <p>The query that defines the objects to be returned. The <code>Query</code> object can contain a maximum of ten selectors.
|
|
707
791
|
* The conditions in the query are limited to top-level String fields in the object.
|
|
708
792
|
* These filters can be applied to components, instances, and attempts.</p>
|
|
709
793
|
*/
|
|
710
794
|
query?: Query;
|
|
711
795
|
/**
|
|
796
|
+
* @public
|
|
712
797
|
* <p>Indicates whether the query applies to components or instances. The possible values are:
|
|
713
798
|
* <code>COMPONENT</code>, <code>INSTANCE</code>, and <code>ATTEMPT</code>.</p>
|
|
714
799
|
*/
|
|
715
800
|
sphere: string | undefined;
|
|
716
801
|
/**
|
|
802
|
+
* @public
|
|
717
803
|
* <p>The starting point for the results to be returned. For the first call, this value should be empty.
|
|
718
804
|
* As long as there are more results, continue to call <code>QueryObjects</code> with
|
|
719
805
|
* the marker value from the previous call to retrieve the next set of results.</p>
|
|
720
806
|
*/
|
|
721
807
|
marker?: string;
|
|
722
808
|
/**
|
|
809
|
+
* @public
|
|
723
810
|
* <p>The maximum number of object names that <code>QueryObjects</code> will return in a single call. The default value is 100. </p>
|
|
724
811
|
*/
|
|
725
812
|
limit?: number;
|
|
@@ -730,15 +817,18 @@ export interface QueryObjectsInput {
|
|
|
730
817
|
*/
|
|
731
818
|
export interface QueryObjectsOutput {
|
|
732
819
|
/**
|
|
820
|
+
* @public
|
|
733
821
|
* <p>The identifiers that match the query selectors.</p>
|
|
734
822
|
*/
|
|
735
823
|
ids?: string[];
|
|
736
824
|
/**
|
|
825
|
+
* @public
|
|
737
826
|
* <p>The starting point for the next page of results. To view the next page of results, call <code>QueryObjects</code>
|
|
738
827
|
* again with this marker value. If the value is null, there are no more results.</p>
|
|
739
828
|
*/
|
|
740
829
|
marker?: string;
|
|
741
830
|
/**
|
|
831
|
+
* @public
|
|
742
832
|
* <p>Indicates whether there are more results that can be obtained by a subsequent call.</p>
|
|
743
833
|
*/
|
|
744
834
|
hasMoreResults?: boolean;
|
|
@@ -749,10 +839,12 @@ export interface QueryObjectsOutput {
|
|
|
749
839
|
*/
|
|
750
840
|
export interface RemoveTagsInput {
|
|
751
841
|
/**
|
|
842
|
+
* @public
|
|
752
843
|
* <p>The ID of the pipeline.</p>
|
|
753
844
|
*/
|
|
754
845
|
pipelineId: string | undefined;
|
|
755
846
|
/**
|
|
847
|
+
* @public
|
|
756
848
|
* <p>The keys of the tags to remove.</p>
|
|
757
849
|
*/
|
|
758
850
|
tagKeys: string[] | undefined;
|
|
@@ -769,10 +861,12 @@ export interface RemoveTagsOutput {
|
|
|
769
861
|
*/
|
|
770
862
|
export interface ReportTaskProgressInput {
|
|
771
863
|
/**
|
|
864
|
+
* @public
|
|
772
865
|
* <p>The ID of the task assigned to the task runner. This value is provided in the response for <a>PollForTask</a>.</p>
|
|
773
866
|
*/
|
|
774
867
|
taskId: string | undefined;
|
|
775
868
|
/**
|
|
869
|
+
* @public
|
|
776
870
|
* <p>Key-value pairs that define the properties of the ReportTaskProgressInput object.</p>
|
|
777
871
|
*/
|
|
778
872
|
fields?: Field[];
|
|
@@ -783,6 +877,7 @@ export interface ReportTaskProgressInput {
|
|
|
783
877
|
*/
|
|
784
878
|
export interface ReportTaskProgressOutput {
|
|
785
879
|
/**
|
|
880
|
+
* @public
|
|
786
881
|
* <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>
|
|
787
882
|
*/
|
|
788
883
|
canceled: boolean | undefined;
|
|
@@ -793,18 +888,21 @@ export interface ReportTaskProgressOutput {
|
|
|
793
888
|
*/
|
|
794
889
|
export interface ReportTaskRunnerHeartbeatInput {
|
|
795
890
|
/**
|
|
891
|
+
* @public
|
|
796
892
|
* <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
|
|
797
893
|
* launched on a resource managed by AWS Data Pipeline, the web service provides a unique identifier when it launches the application.
|
|
798
894
|
* If you have written a custom task runner, you should assign a unique identifier for the task runner.</p>
|
|
799
895
|
*/
|
|
800
896
|
taskrunnerId: string | undefined;
|
|
801
897
|
/**
|
|
898
|
+
* @public
|
|
802
899
|
* <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.
|
|
803
900
|
* You can only specify a single value for <code>workerGroup</code>. There are no wildcard values permitted in <code>workerGroup</code>; the string
|
|
804
901
|
* must be an exact, case-sensitive, match.</p>
|
|
805
902
|
*/
|
|
806
903
|
workerGroup?: string;
|
|
807
904
|
/**
|
|
905
|
+
* @public
|
|
808
906
|
* <p>The public DNS name of the task runner.</p>
|
|
809
907
|
*/
|
|
810
908
|
hostname?: string;
|
|
@@ -815,6 +913,7 @@ export interface ReportTaskRunnerHeartbeatInput {
|
|
|
815
913
|
*/
|
|
816
914
|
export interface ReportTaskRunnerHeartbeatOutput {
|
|
817
915
|
/**
|
|
916
|
+
* @public
|
|
818
917
|
* <p>Indicates whether the calling task runner should terminate.</p>
|
|
819
918
|
*/
|
|
820
919
|
terminate: boolean | undefined;
|
|
@@ -825,14 +924,17 @@ export interface ReportTaskRunnerHeartbeatOutput {
|
|
|
825
924
|
*/
|
|
826
925
|
export interface SetStatusInput {
|
|
827
926
|
/**
|
|
927
|
+
* @public
|
|
828
928
|
* <p>The ID of the pipeline that contains the objects.</p>
|
|
829
929
|
*/
|
|
830
930
|
pipelineId: string | undefined;
|
|
831
931
|
/**
|
|
932
|
+
* @public
|
|
832
933
|
* <p>The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.</p>
|
|
833
934
|
*/
|
|
834
935
|
objectIds: string[] | undefined;
|
|
835
936
|
/**
|
|
937
|
+
* @public
|
|
836
938
|
* <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>.
|
|
837
939
|
* For instances, use <code>TRY_CANCEL</code>, <code>RERUN</code>, or <code>MARK_FINISHED</code>.</p>
|
|
838
940
|
*/
|
|
@@ -857,24 +959,29 @@ export type TaskStatus = (typeof TaskStatus)[keyof typeof TaskStatus];
|
|
|
857
959
|
*/
|
|
858
960
|
export interface SetTaskStatusInput {
|
|
859
961
|
/**
|
|
962
|
+
* @public
|
|
860
963
|
* <p>The ID of the task assigned to the task runner. This value is provided in the response for <a>PollForTask</a>.</p>
|
|
861
964
|
*/
|
|
862
965
|
taskId: string | undefined;
|
|
863
966
|
/**
|
|
967
|
+
* @public
|
|
864
968
|
* <p>If <code>FINISHED</code>, the task successfully completed. If <code>FAILED</code>, the task ended unsuccessfully. Preconditions use false.</p>
|
|
865
969
|
*/
|
|
866
970
|
taskStatus: TaskStatus | string | undefined;
|
|
867
971
|
/**
|
|
972
|
+
* @public
|
|
868
973
|
* <p>If an error occurred during the task, this value specifies the error code. This value is set on the physical attempt object.
|
|
869
974
|
* It is used to display error information to the user. It should not start with string "Service_" which is reserved by the system.</p>
|
|
870
975
|
*/
|
|
871
976
|
errorId?: string;
|
|
872
977
|
/**
|
|
978
|
+
* @public
|
|
873
979
|
* <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.
|
|
874
980
|
* It is used to display error information to the user. The web service does not parse this value.</p>
|
|
875
981
|
*/
|
|
876
982
|
errorMessage?: string;
|
|
877
983
|
/**
|
|
984
|
+
* @public
|
|
878
985
|
* <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.
|
|
879
986
|
* It is used to display error information to the user. The web service does not parse this value.</p>
|
|
880
987
|
*/
|
|
@@ -892,18 +999,22 @@ export interface SetTaskStatusOutput {
|
|
|
892
999
|
*/
|
|
893
1000
|
export interface ValidatePipelineDefinitionInput {
|
|
894
1001
|
/**
|
|
1002
|
+
* @public
|
|
895
1003
|
* <p>The ID of the pipeline.</p>
|
|
896
1004
|
*/
|
|
897
1005
|
pipelineId: string | undefined;
|
|
898
1006
|
/**
|
|
1007
|
+
* @public
|
|
899
1008
|
* <p>The objects that define the pipeline changes to validate against the pipeline.</p>
|
|
900
1009
|
*/
|
|
901
1010
|
pipelineObjects: PipelineObject[] | undefined;
|
|
902
1011
|
/**
|
|
1012
|
+
* @public
|
|
903
1013
|
* <p>The parameter objects used with the pipeline.</p>
|
|
904
1014
|
*/
|
|
905
1015
|
parameterObjects?: ParameterObject[];
|
|
906
1016
|
/**
|
|
1017
|
+
* @public
|
|
907
1018
|
* <p>The parameter values used with the pipeline.</p>
|
|
908
1019
|
*/
|
|
909
1020
|
parameterValues?: ParameterValue[];
|
|
@@ -914,14 +1025,17 @@ export interface ValidatePipelineDefinitionInput {
|
|
|
914
1025
|
*/
|
|
915
1026
|
export interface ValidatePipelineDefinitionOutput {
|
|
916
1027
|
/**
|
|
1028
|
+
* @public
|
|
917
1029
|
* <p>Any validation errors that were found.</p>
|
|
918
1030
|
*/
|
|
919
1031
|
validationErrors?: ValidationError[];
|
|
920
1032
|
/**
|
|
1033
|
+
* @public
|
|
921
1034
|
* <p>Any validation warnings that were found.</p>
|
|
922
1035
|
*/
|
|
923
1036
|
validationWarnings?: ValidationWarning[];
|
|
924
1037
|
/**
|
|
1038
|
+
* @public
|
|
925
1039
|
* <p>Indicates whether there were validation errors.</p>
|
|
926
1040
|
*/
|
|
927
1041
|
errored: boolean | undefined;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-data-pipeline",
|
|
3
3
|
"description": "AWS SDK for JavaScript Data Pipeline Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.382.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,15 +21,15 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.382.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.382.0",
|
|
26
26
|
"@aws-sdk/middleware-host-header": "3.379.1",
|
|
27
27
|
"@aws-sdk/middleware-logger": "3.378.0",
|
|
28
28
|
"@aws-sdk/middleware-recursion-detection": "3.378.0",
|
|
29
29
|
"@aws-sdk/middleware-signing": "3.379.1",
|
|
30
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
30
|
+
"@aws-sdk/middleware-user-agent": "3.382.0",
|
|
31
31
|
"@aws-sdk/types": "3.378.0",
|
|
32
|
-
"@aws-sdk/util-endpoints": "3.
|
|
32
|
+
"@aws-sdk/util-endpoints": "3.382.0",
|
|
33
33
|
"@aws-sdk/util-user-agent-browser": "3.378.0",
|
|
34
34
|
"@aws-sdk/util-user-agent-node": "3.378.0",
|
|
35
35
|
"@smithy/config-resolver": "^2.0.1",
|