forked from aws/aws-sdk-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.go
1955 lines (1579 loc) · 64.5 KB
/
api.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT.
// Package datapipeline provides a client for AWS Data Pipeline.
package datapipeline
import (
"time"
"github.com/aws/aws-sdk-go/aws/awsutil"
"github.com/aws/aws-sdk-go/aws/request"
"github.com/aws/aws-sdk-go/private/protocol"
"github.com/aws/aws-sdk-go/private/protocol/jsonrpc"
)
const opActivatePipeline = "ActivatePipeline"
// ActivatePipelineRequest generates a request for the ActivatePipeline operation.
func (c *DataPipeline) ActivatePipelineRequest(input *ActivatePipelineInput) (req *request.Request, output *ActivatePipelineOutput) {
op := &request.Operation{
Name: opActivatePipeline,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &ActivatePipelineInput{}
}
req = c.newRequest(op, input, output)
output = &ActivatePipelineOutput{}
req.Data = output
return
}
// Validates the specified pipeline and starts processing pipeline tasks. If
// the pipeline does not pass validation, activation fails.
//
// If you need to pause the pipeline to investigate an issue with a component,
// such as a data source or script, call DeactivatePipeline.
//
// To activate a finished pipeline, modify the end date for the pipeline and
// then activate it.
func (c *DataPipeline) ActivatePipeline(input *ActivatePipelineInput) (*ActivatePipelineOutput, error) {
req, out := c.ActivatePipelineRequest(input)
err := req.Send()
return out, err
}
const opAddTags = "AddTags"
// AddTagsRequest generates a request for the AddTags operation.
func (c *DataPipeline) AddTagsRequest(input *AddTagsInput) (req *request.Request, output *AddTagsOutput) {
op := &request.Operation{
Name: opAddTags,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &AddTagsInput{}
}
req = c.newRequest(op, input, output)
output = &AddTagsOutput{}
req.Data = output
return
}
// Adds or modifies tags for the specified pipeline.
func (c *DataPipeline) AddTags(input *AddTagsInput) (*AddTagsOutput, error) {
req, out := c.AddTagsRequest(input)
err := req.Send()
return out, err
}
const opCreatePipeline = "CreatePipeline"
// CreatePipelineRequest generates a request for the CreatePipeline operation.
func (c *DataPipeline) CreatePipelineRequest(input *CreatePipelineInput) (req *request.Request, output *CreatePipelineOutput) {
op := &request.Operation{
Name: opCreatePipeline,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &CreatePipelineInput{}
}
req = c.newRequest(op, input, output)
output = &CreatePipelineOutput{}
req.Data = output
return
}
// Creates a new, empty pipeline. Use PutPipelineDefinition to populate the
// pipeline.
func (c *DataPipeline) CreatePipeline(input *CreatePipelineInput) (*CreatePipelineOutput, error) {
req, out := c.CreatePipelineRequest(input)
err := req.Send()
return out, err
}
const opDeactivatePipeline = "DeactivatePipeline"
// DeactivatePipelineRequest generates a request for the DeactivatePipeline operation.
func (c *DataPipeline) DeactivatePipelineRequest(input *DeactivatePipelineInput) (req *request.Request, output *DeactivatePipelineOutput) {
op := &request.Operation{
Name: opDeactivatePipeline,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DeactivatePipelineInput{}
}
req = c.newRequest(op, input, output)
output = &DeactivatePipelineOutput{}
req.Data = output
return
}
// Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING
// state until the deactivation process completes.
//
// To resume a deactivated pipeline, use ActivatePipeline. By default, the
// pipeline resumes from the last completed execution. Optionally, you can specify
// the date and time to resume the pipeline.
func (c *DataPipeline) DeactivatePipeline(input *DeactivatePipelineInput) (*DeactivatePipelineOutput, error) {
req, out := c.DeactivatePipelineRequest(input)
err := req.Send()
return out, err
}
const opDeletePipeline = "DeletePipeline"
// DeletePipelineRequest generates a request for the DeletePipeline operation.
func (c *DataPipeline) DeletePipelineRequest(input *DeletePipelineInput) (req *request.Request, output *DeletePipelineOutput) {
op := &request.Operation{
Name: opDeletePipeline,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DeletePipelineInput{}
}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Remove(jsonrpc.UnmarshalHandler)
req.Handlers.Unmarshal.PushBackNamed(protocol.UnmarshalDiscardBodyHandler)
output = &DeletePipelineOutput{}
req.Data = output
return
}
// Deletes a pipeline, its pipeline definition, and its run history. AWS Data
// Pipeline attempts to cancel instances associated with the pipeline that are
// currently being processed by task runners.
//
// Deleting a pipeline cannot be undone. You cannot query or restore a deleted
// pipeline. To temporarily pause a pipeline instead of deleting it, call SetStatus
// with the status set to PAUSE on individual components. Components that are
// paused by SetStatus can be resumed.
func (c *DataPipeline) DeletePipeline(input *DeletePipelineInput) (*DeletePipelineOutput, error) {
req, out := c.DeletePipelineRequest(input)
err := req.Send()
return out, err
}
const opDescribeObjects = "DescribeObjects"
// DescribeObjectsRequest generates a request for the DescribeObjects operation.
func (c *DataPipeline) DescribeObjectsRequest(input *DescribeObjectsInput) (req *request.Request, output *DescribeObjectsOutput) {
op := &request.Operation{
Name: opDescribeObjects,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &request.Paginator{
InputTokens: []string{"marker"},
OutputTokens: []string{"marker"},
LimitToken: "",
TruncationToken: "hasMoreResults",
},
}
if input == nil {
input = &DescribeObjectsInput{}
}
req = c.newRequest(op, input, output)
output = &DescribeObjectsOutput{}
req.Data = output
return
}
// Gets the object definitions for a set of objects associated with the pipeline.
// Object definitions are composed of a set of fields that define the properties
// of the object.
func (c *DataPipeline) DescribeObjects(input *DescribeObjectsInput) (*DescribeObjectsOutput, error) {
req, out := c.DescribeObjectsRequest(input)
err := req.Send()
return out, err
}
func (c *DataPipeline) DescribeObjectsPages(input *DescribeObjectsInput, fn func(p *DescribeObjectsOutput, lastPage bool) (shouldContinue bool)) error {
page, _ := c.DescribeObjectsRequest(input)
page.Handlers.Build.PushBack(request.MakeAddToUserAgentFreeFormHandler("Paginator"))
return page.EachPage(func(p interface{}, lastPage bool) bool {
return fn(p.(*DescribeObjectsOutput), lastPage)
})
}
const opDescribePipelines = "DescribePipelines"
// DescribePipelinesRequest generates a request for the DescribePipelines operation.
func (c *DataPipeline) DescribePipelinesRequest(input *DescribePipelinesInput) (req *request.Request, output *DescribePipelinesOutput) {
op := &request.Operation{
Name: opDescribePipelines,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DescribePipelinesInput{}
}
req = c.newRequest(op, input, output)
output = &DescribePipelinesOutput{}
req.Data = output
return
}
// Retrieves metadata about one or more pipelines. The information retrieved
// includes the name of the pipeline, the pipeline identifier, its current state,
// and the user account that owns the pipeline. Using account credentials, you
// can retrieve metadata about pipelines that you or your IAM users have created.
// If you are using an IAM user account, you can retrieve metadata about only
// those pipelines for which you have read permissions.
//
// To retrieve the full pipeline definition instead of metadata about the pipeline,
// call GetPipelineDefinition.
func (c *DataPipeline) DescribePipelines(input *DescribePipelinesInput) (*DescribePipelinesOutput, error) {
req, out := c.DescribePipelinesRequest(input)
err := req.Send()
return out, err
}
const opEvaluateExpression = "EvaluateExpression"
// EvaluateExpressionRequest generates a request for the EvaluateExpression operation.
func (c *DataPipeline) EvaluateExpressionRequest(input *EvaluateExpressionInput) (req *request.Request, output *EvaluateExpressionOutput) {
op := &request.Operation{
Name: opEvaluateExpression,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &EvaluateExpressionInput{}
}
req = c.newRequest(op, input, output)
output = &EvaluateExpressionOutput{}
req.Data = output
return
}
// Task runners call EvaluateExpression to evaluate a string in the context
// of the specified object. For example, a task runner can evaluate SQL queries
// stored in Amazon S3.
func (c *DataPipeline) EvaluateExpression(input *EvaluateExpressionInput) (*EvaluateExpressionOutput, error) {
req, out := c.EvaluateExpressionRequest(input)
err := req.Send()
return out, err
}
const opGetPipelineDefinition = "GetPipelineDefinition"
// GetPipelineDefinitionRequest generates a request for the GetPipelineDefinition operation.
func (c *DataPipeline) GetPipelineDefinitionRequest(input *GetPipelineDefinitionInput) (req *request.Request, output *GetPipelineDefinitionOutput) {
op := &request.Operation{
Name: opGetPipelineDefinition,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &GetPipelineDefinitionInput{}
}
req = c.newRequest(op, input, output)
output = &GetPipelineDefinitionOutput{}
req.Data = output
return
}
// Gets the definition of the specified pipeline. You can call GetPipelineDefinition
// to retrieve the pipeline definition that you provided using PutPipelineDefinition.
func (c *DataPipeline) GetPipelineDefinition(input *GetPipelineDefinitionInput) (*GetPipelineDefinitionOutput, error) {
req, out := c.GetPipelineDefinitionRequest(input)
err := req.Send()
return out, err
}
const opListPipelines = "ListPipelines"
// ListPipelinesRequest generates a request for the ListPipelines operation.
func (c *DataPipeline) ListPipelinesRequest(input *ListPipelinesInput) (req *request.Request, output *ListPipelinesOutput) {
op := &request.Operation{
Name: opListPipelines,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &request.Paginator{
InputTokens: []string{"marker"},
OutputTokens: []string{"marker"},
LimitToken: "",
TruncationToken: "hasMoreResults",
},
}
if input == nil {
input = &ListPipelinesInput{}
}
req = c.newRequest(op, input, output)
output = &ListPipelinesOutput{}
req.Data = output
return
}
// Lists the pipeline identifiers for all active pipelines that you have permission
// to access.
func (c *DataPipeline) ListPipelines(input *ListPipelinesInput) (*ListPipelinesOutput, error) {
req, out := c.ListPipelinesRequest(input)
err := req.Send()
return out, err
}
func (c *DataPipeline) ListPipelinesPages(input *ListPipelinesInput, fn func(p *ListPipelinesOutput, lastPage bool) (shouldContinue bool)) error {
page, _ := c.ListPipelinesRequest(input)
page.Handlers.Build.PushBack(request.MakeAddToUserAgentFreeFormHandler("Paginator"))
return page.EachPage(func(p interface{}, lastPage bool) bool {
return fn(p.(*ListPipelinesOutput), lastPage)
})
}
const opPollForTask = "PollForTask"
// PollForTaskRequest generates a request for the PollForTask operation.
func (c *DataPipeline) PollForTaskRequest(input *PollForTaskInput) (req *request.Request, output *PollForTaskOutput) {
op := &request.Operation{
Name: opPollForTask,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &PollForTaskInput{}
}
req = c.newRequest(op, input, output)
output = &PollForTaskOutput{}
req.Data = output
return
}
// Task runners call PollForTask to receive a task to perform from AWS Data
// Pipeline. The task runner specifies which tasks it can perform by setting
// a value for the workerGroup parameter. The task returned can come from any
// of the pipelines that match the workerGroup value passed in by the task runner
// and that was launched using the IAM user credentials specified by the task
// runner.
//
// If tasks are ready in the work queue, PollForTask returns a response immediately.
// If no tasks are available in the queue, PollForTask uses long-polling and
// holds on to a poll connection for up to a 90 seconds, during which time the
// first newly scheduled task is handed to the task runner. To accomodate this,
// set the socket timeout in your task runner to 90 seconds. The task runner
// should not call PollForTask again on the same workerGroup until it receives
// a response, and this can take up to 90 seconds.
func (c *DataPipeline) PollForTask(input *PollForTaskInput) (*PollForTaskOutput, error) {
req, out := c.PollForTaskRequest(input)
err := req.Send()
return out, err
}
const opPutPipelineDefinition = "PutPipelineDefinition"
// PutPipelineDefinitionRequest generates a request for the PutPipelineDefinition operation.
func (c *DataPipeline) PutPipelineDefinitionRequest(input *PutPipelineDefinitionInput) (req *request.Request, output *PutPipelineDefinitionOutput) {
op := &request.Operation{
Name: opPutPipelineDefinition,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &PutPipelineDefinitionInput{}
}
req = c.newRequest(op, input, output)
output = &PutPipelineDefinitionOutput{}
req.Data = output
return
}
// Adds tasks, schedules, and preconditions to the specified pipeline. You can
// use PutPipelineDefinition to populate a new pipeline.
//
// PutPipelineDefinition also validates the configuration as it adds it to
// the pipeline. Changes to the pipeline are saved unless one of the following
// three validation errors exists in the pipeline.
//
// An object is missing a name or identifier field. A string or reference
// field is empty. The number of objects in the pipeline exceeds the maximum
// allowed objects. The pipeline is in a FINISHED state. Pipeline object definitions
// are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition
// action.
func (c *DataPipeline) PutPipelineDefinition(input *PutPipelineDefinitionInput) (*PutPipelineDefinitionOutput, error) {
req, out := c.PutPipelineDefinitionRequest(input)
err := req.Send()
return out, err
}
const opQueryObjects = "QueryObjects"
// QueryObjectsRequest generates a request for the QueryObjects operation.
func (c *DataPipeline) QueryObjectsRequest(input *QueryObjectsInput) (req *request.Request, output *QueryObjectsOutput) {
op := &request.Operation{
Name: opQueryObjects,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &request.Paginator{
InputTokens: []string{"marker"},
OutputTokens: []string{"marker"},
LimitToken: "limit",
TruncationToken: "hasMoreResults",
},
}
if input == nil {
input = &QueryObjectsInput{}
}
req = c.newRequest(op, input, output)
output = &QueryObjectsOutput{}
req.Data = output
return
}
// Queries the specified pipeline for the names of objects that match the specified
// set of conditions.
func (c *DataPipeline) QueryObjects(input *QueryObjectsInput) (*QueryObjectsOutput, error) {
req, out := c.QueryObjectsRequest(input)
err := req.Send()
return out, err
}
func (c *DataPipeline) QueryObjectsPages(input *QueryObjectsInput, fn func(p *QueryObjectsOutput, lastPage bool) (shouldContinue bool)) error {
page, _ := c.QueryObjectsRequest(input)
page.Handlers.Build.PushBack(request.MakeAddToUserAgentFreeFormHandler("Paginator"))
return page.EachPage(func(p interface{}, lastPage bool) bool {
return fn(p.(*QueryObjectsOutput), lastPage)
})
}
const opRemoveTags = "RemoveTags"
// RemoveTagsRequest generates a request for the RemoveTags operation.
func (c *DataPipeline) RemoveTagsRequest(input *RemoveTagsInput) (req *request.Request, output *RemoveTagsOutput) {
op := &request.Operation{
Name: opRemoveTags,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &RemoveTagsInput{}
}
req = c.newRequest(op, input, output)
output = &RemoveTagsOutput{}
req.Data = output
return
}
// Removes existing tags from the specified pipeline.
func (c *DataPipeline) RemoveTags(input *RemoveTagsInput) (*RemoveTagsOutput, error) {
req, out := c.RemoveTagsRequest(input)
err := req.Send()
return out, err
}
const opReportTaskProgress = "ReportTaskProgress"
// ReportTaskProgressRequest generates a request for the ReportTaskProgress operation.
func (c *DataPipeline) ReportTaskProgressRequest(input *ReportTaskProgressInput) (req *request.Request, output *ReportTaskProgressOutput) {
op := &request.Operation{
Name: opReportTaskProgress,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &ReportTaskProgressInput{}
}
req = c.newRequest(op, input, output)
output = &ReportTaskProgressOutput{}
req.Data = output
return
}
// Task runners call ReportTaskProgress when assigned a task to acknowledge
// that it has the task. If the web service does not receive this acknowledgement
// within 2 minutes, it assigns the task in a subsequent PollForTask call. After
// this initial acknowledgement, the task runner only needs to report progress
// every 15 minutes to maintain its ownership of the task. You can change this
// reporting time from 15 minutes by specifying a reportProgressTimeout field
// in your pipeline.
//
// 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 and reassigns
// the task in a subsequent response to PollForTask. Task runners should call
// ReportTaskProgress every 60 seconds.
func (c *DataPipeline) ReportTaskProgress(input *ReportTaskProgressInput) (*ReportTaskProgressOutput, error) {
req, out := c.ReportTaskProgressRequest(input)
err := req.Send()
return out, err
}
const opReportTaskRunnerHeartbeat = "ReportTaskRunnerHeartbeat"
// ReportTaskRunnerHeartbeatRequest generates a request for the ReportTaskRunnerHeartbeat operation.
func (c *DataPipeline) ReportTaskRunnerHeartbeatRequest(input *ReportTaskRunnerHeartbeatInput) (req *request.Request, output *ReportTaskRunnerHeartbeatOutput) {
op := &request.Operation{
Name: opReportTaskRunnerHeartbeat,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &ReportTaskRunnerHeartbeatInput{}
}
req = c.newRequest(op, input, output)
output = &ReportTaskRunnerHeartbeatOutput{}
req.Data = output
return
}
// Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate
// that they are operational. If the AWS Data Pipeline Task Runner is launched
// on a resource managed by AWS Data Pipeline, the web service can use this
// call to detect when the task runner application has failed and restart a
// new instance.
func (c *DataPipeline) ReportTaskRunnerHeartbeat(input *ReportTaskRunnerHeartbeatInput) (*ReportTaskRunnerHeartbeatOutput, error) {
req, out := c.ReportTaskRunnerHeartbeatRequest(input)
err := req.Send()
return out, err
}
const opSetStatus = "SetStatus"
// SetStatusRequest generates a request for the SetStatus operation.
func (c *DataPipeline) SetStatusRequest(input *SetStatusInput) (req *request.Request, output *SetStatusOutput) {
op := &request.Operation{
Name: opSetStatus,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &SetStatusInput{}
}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Remove(jsonrpc.UnmarshalHandler)
req.Handlers.Unmarshal.PushBackNamed(protocol.UnmarshalDiscardBodyHandler)
output = &SetStatusOutput{}
req.Data = output
return
}
// Requests that the status of the specified physical or logical pipeline objects
// be updated in the specified pipeline. 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). You cannot perform this operation
// on FINISHED pipelines and attempting to do so returns InvalidRequestException.
func (c *DataPipeline) SetStatus(input *SetStatusInput) (*SetStatusOutput, error) {
req, out := c.SetStatusRequest(input)
err := req.Send()
return out, err
}
const opSetTaskStatus = "SetTaskStatus"
// SetTaskStatusRequest generates a request for the SetTaskStatus operation.
func (c *DataPipeline) SetTaskStatusRequest(input *SetTaskStatusInput) (req *request.Request, output *SetTaskStatusOutput) {
op := &request.Operation{
Name: opSetTaskStatus,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &SetTaskStatusInput{}
}
req = c.newRequest(op, input, output)
output = &SetTaskStatusOutput{}
req.Data = output
return
}
// Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is
// completed and provide information about the final status. A task runner makes
// this call regardless of whether the task was sucessful. A task runner does
// not need to call SetTaskStatus for tasks that are canceled by the web service
// during a call to ReportTaskProgress.
func (c *DataPipeline) SetTaskStatus(input *SetTaskStatusInput) (*SetTaskStatusOutput, error) {
req, out := c.SetTaskStatusRequest(input)
err := req.Send()
return out, err
}
const opValidatePipelineDefinition = "ValidatePipelineDefinition"
// ValidatePipelineDefinitionRequest generates a request for the ValidatePipelineDefinition operation.
func (c *DataPipeline) ValidatePipelineDefinitionRequest(input *ValidatePipelineDefinitionInput) (req *request.Request, output *ValidatePipelineDefinitionOutput) {
op := &request.Operation{
Name: opValidatePipelineDefinition,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &ValidatePipelineDefinitionInput{}
}
req = c.newRequest(op, input, output)
output = &ValidatePipelineDefinitionOutput{}
req.Data = output
return
}
// Validates the specified pipeline definition to ensure that it is well formed
// and can be run without error.
func (c *DataPipeline) ValidatePipelineDefinition(input *ValidatePipelineDefinitionInput) (*ValidatePipelineDefinitionOutput, error) {
req, out := c.ValidatePipelineDefinitionRequest(input)
err := req.Send()
return out, err
}
// Contains the parameters for ActivatePipeline.
type ActivatePipelineInput struct {
_ struct{} `type:"structure"`
// A list of parameter values to pass to the pipeline at activation.
ParameterValues []*ParameterValue `locationName:"parameterValues" type:"list"`
// The ID of the pipeline.
PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
// The date and time to resume the pipeline. By default, the pipeline resumes
// from the last completed execution.
StartTimestamp *time.Time `locationName:"startTimestamp" type:"timestamp" timestampFormat:"unix"`
}
// String returns the string representation
func (s ActivatePipelineInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ActivatePipelineInput) GoString() string {
return s.String()
}
// Contains the output of ActivatePipeline.
type ActivatePipelineOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation
func (s ActivatePipelineOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ActivatePipelineOutput) GoString() string {
return s.String()
}
// Contains the parameters for AddTags.
type AddTagsInput struct {
_ struct{} `type:"structure"`
// The ID of the pipeline.
PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
// The tags to add, as key/value pairs.
Tags []*Tag `locationName:"tags" type:"list" required:"true"`
}
// String returns the string representation
func (s AddTagsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s AddTagsInput) GoString() string {
return s.String()
}
// Contains the output of AddTags.
type AddTagsOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation
func (s AddTagsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s AddTagsOutput) GoString() string {
return s.String()
}
// Contains the parameters for CreatePipeline.
type CreatePipelineInput struct {
_ struct{} `type:"structure"`
// The description for the pipeline.
Description *string `locationName:"description" type:"string"`
// The name for the pipeline. You can use the same name for multiple pipelines
// associated with your AWS account, because AWS Data Pipeline assigns each
// pipeline a unique pipeline identifier.
Name *string `locationName:"name" min:"1" type:"string" required:"true"`
// A list of tags to associate with the pipeline at creation. Tags let you control
// access to pipelines. For more information, see Controlling User Access to
// Pipelines (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html)
// in the AWS Data Pipeline Developer Guide.
Tags []*Tag `locationName:"tags" type:"list"`
// A unique identifier. This identifier is not the same as the pipeline identifier
// assigned by AWS Data Pipeline. You are responsible for defining the format
// and ensuring the uniqueness of this identifier. You use this parameter to
// ensure idempotency during repeated calls to CreatePipeline. For example,
// if the first call to CreatePipeline does not succeed, you can pass in the
// same unique identifier and pipeline name combination on a subsequent call
// to CreatePipeline. CreatePipeline ensures that if a pipeline already exists
// with the same name and unique identifier, a new pipeline is not created.
// Instead, you'll receive the pipeline identifier from the previous attempt.
// The uniqueness of the name and unique identifier combination is scoped to
// the AWS account or IAM user credentials.
UniqueId *string `locationName:"uniqueId" min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s CreatePipelineInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s CreatePipelineInput) GoString() string {
return s.String()
}
// Contains the output of CreatePipeline.
type CreatePipelineOutput struct {
_ struct{} `type:"structure"`
// The ID that AWS Data Pipeline assigns the newly created pipeline. For example,
// df-06372391ZG65EXAMPLE.
PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s CreatePipelineOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s CreatePipelineOutput) GoString() string {
return s.String()
}
// Contains the parameters for DeactivatePipeline.
type DeactivatePipelineInput struct {
_ struct{} `type:"structure"`
// Indicates whether to cancel any running objects. The default is true, which
// sets the state of any running objects to CANCELED. If this value is false,
// the pipeline is deactivated after all running objects finish.
CancelActive *bool `locationName:"cancelActive" type:"boolean"`
// The ID of the pipeline.
PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s DeactivatePipelineInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DeactivatePipelineInput) GoString() string {
return s.String()
}
// Contains the output of DeactivatePipeline.
type DeactivatePipelineOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation
func (s DeactivatePipelineOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DeactivatePipelineOutput) GoString() string {
return s.String()
}
// Contains the parameters for DeletePipeline.
type DeletePipelineInput struct {
_ struct{} `type:"structure"`
// The ID of the pipeline.
PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s DeletePipelineInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DeletePipelineInput) GoString() string {
return s.String()
}
type DeletePipelineOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation
func (s DeletePipelineOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DeletePipelineOutput) GoString() string {
return s.String()
}
// Contains the parameters for DescribeObjects.
type DescribeObjectsInput struct {
_ struct{} `type:"structure"`
// Indicates whether any expressions in the object should be evaluated when
// the object descriptions are returned.
EvaluateExpressions *bool `locationName:"evaluateExpressions" type:"boolean"`
// The starting point for the results to be returned. For the first call, this
// value should be empty. As long as there are more results, continue to call
// DescribeObjects with the marker value from the previous call to retrieve
// the next set of results.
Marker *string `locationName:"marker" type:"string"`
// 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 DescribeObjects.
ObjectIds []*string `locationName:"objectIds" type:"list" required:"true"`
// The ID of the pipeline that contains the object definitions.
PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s DescribeObjectsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribeObjectsInput) GoString() string {
return s.String()
}
// Contains the output of DescribeObjects.
type DescribeObjectsOutput struct {
_ struct{} `type:"structure"`
// Indicates whether there are more results to return.
HasMoreResults *bool `locationName:"hasMoreResults" type:"boolean"`
// The starting point for the next page of results. To view the next page of
// results, call DescribeObjects again with this marker value. If the value
// is null, there are no more results.
Marker *string `locationName:"marker" type:"string"`
// An array of object definitions.
PipelineObjects []*PipelineObject `locationName:"pipelineObjects" type:"list" required:"true"`
}
// String returns the string representation
func (s DescribeObjectsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribeObjectsOutput) GoString() string {
return s.String()
}
// Contains the parameters for DescribePipelines.
type DescribePipelinesInput struct {
_ struct{} `type:"structure"`
// The IDs of the pipelines to describe. You can pass as many as 25 identifiers
// in a single call. To obtain pipeline IDs, call ListPipelines.
PipelineIds []*string `locationName:"pipelineIds" type:"list" required:"true"`
}
// String returns the string representation
func (s DescribePipelinesInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribePipelinesInput) GoString() string {
return s.String()
}
// Contains the output of DescribePipelines.
type DescribePipelinesOutput struct {
_ struct{} `type:"structure"`
// An array of descriptions for the specified pipelines.
PipelineDescriptionList []*PipelineDescription `locationName:"pipelineDescriptionList" type:"list" required:"true"`
}
// String returns the string representation
func (s DescribePipelinesOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribePipelinesOutput) GoString() string {
return s.String()
}
// Contains the parameters for EvaluateExpression.
type EvaluateExpressionInput struct {
_ struct{} `type:"structure"`
// The expression to evaluate.
Expression *string `locationName:"expression" type:"string" required:"true"`
// The ID of the object.
ObjectId *string `locationName:"objectId" min:"1" type:"string" required:"true"`
// The ID of the pipeline.
PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s EvaluateExpressionInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s EvaluateExpressionInput) GoString() string {
return s.String()
}
// Contains the output of EvaluateExpression.
type EvaluateExpressionOutput struct {
_ struct{} `type:"structure"`
// The evaluated expression.
EvaluatedExpression *string `locationName:"evaluatedExpression" type:"string" required:"true"`
}
// String returns the string representation
func (s EvaluateExpressionOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s EvaluateExpressionOutput) GoString() string {
return s.String()
}