forked from aws/aws-sdk-go-v2
/
api.go
5252 lines (4286 loc) · 171 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
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package batch
import (
"fmt"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
"github.com/aws/aws-sdk-go-v2/private/protocol"
)
const opCancelJob = "CancelJob"
// CancelJobRequest is a API request type for the CancelJob API operation.
type CancelJobRequest struct {
*aws.Request
Input *CancelJobInput
Copy func(*CancelJobInput) CancelJobRequest
}
// Send marshals and sends the CancelJob API request.
func (r CancelJobRequest) Send() (*CancelJobOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*CancelJobOutput), nil
}
// CancelJobRequest returns a request value for making API operation for
// AWS Batch.
//
// Cancels a job in an AWS Batch job queue. Jobs that are in the SUBMITTED,
// PENDING, or RUNNABLE state are cancelled. Jobs that have progressed to STARTING
// or RUNNING are not cancelled (but the API operation still succeeds, even
// if no job is cancelled); these jobs must be terminated with the TerminateJob
// operation.
//
// // Example sending a request using the CancelJobRequest method.
// req := client.CancelJobRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CancelJob
func (c *Batch) CancelJobRequest(input *CancelJobInput) CancelJobRequest {
op := &aws.Operation{
Name: opCancelJob,
HTTPMethod: "POST",
HTTPPath: "/v1/canceljob",
}
if input == nil {
input = &CancelJobInput{}
}
output := &CancelJobOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return CancelJobRequest{Request: req, Input: input, Copy: c.CancelJobRequest}
}
const opCreateComputeEnvironment = "CreateComputeEnvironment"
// CreateComputeEnvironmentRequest is a API request type for the CreateComputeEnvironment API operation.
type CreateComputeEnvironmentRequest struct {
*aws.Request
Input *CreateComputeEnvironmentInput
Copy func(*CreateComputeEnvironmentInput) CreateComputeEnvironmentRequest
}
// Send marshals and sends the CreateComputeEnvironment API request.
func (r CreateComputeEnvironmentRequest) Send() (*CreateComputeEnvironmentOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*CreateComputeEnvironmentOutput), nil
}
// CreateComputeEnvironmentRequest returns a request value for making API operation for
// AWS Batch.
//
// Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED
// compute environments.
//
// In a managed compute environment, AWS Batch manages the compute resources
// within the environment, based on the compute resources that you specify.
// Instances launched into a managed compute environment use a recent, approved
// version of the Amazon ECS-optimized AMI. You can choose to use Amazon EC2
// On-Demand Instances in your managed compute environment, or you can use Amazon
// EC2 Spot Instances that only launch when the Spot bid price is below a specified
// percentage of the On-Demand price.
//
// In an unmanaged compute environment, you can manage your own compute resources.
// This provides more compute resource configuration options, such as using
// a custom AMI, but you must ensure that your AMI meets the Amazon ECS container
// instance AMI specification. For more information, see Container Instance
// AMIs (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html)
// in the Amazon Elastic Container Service Developer Guide. After you have created
// your unmanaged compute environment, you can use the DescribeComputeEnvironments
// operation to find the Amazon ECS cluster that is associated with it and then
// manually launch your container instances into that Amazon ECS cluster. For
// more information, see Launching an Amazon ECS Container Instance (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html)
// in the Amazon Elastic Container Service Developer Guide.
//
// // Example sending a request using the CreateComputeEnvironmentRequest method.
// req := client.CreateComputeEnvironmentRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateComputeEnvironment
func (c *Batch) CreateComputeEnvironmentRequest(input *CreateComputeEnvironmentInput) CreateComputeEnvironmentRequest {
op := &aws.Operation{
Name: opCreateComputeEnvironment,
HTTPMethod: "POST",
HTTPPath: "/v1/createcomputeenvironment",
}
if input == nil {
input = &CreateComputeEnvironmentInput{}
}
output := &CreateComputeEnvironmentOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return CreateComputeEnvironmentRequest{Request: req, Input: input, Copy: c.CreateComputeEnvironmentRequest}
}
const opCreateJobQueue = "CreateJobQueue"
// CreateJobQueueRequest is a API request type for the CreateJobQueue API operation.
type CreateJobQueueRequest struct {
*aws.Request
Input *CreateJobQueueInput
Copy func(*CreateJobQueueInput) CreateJobQueueRequest
}
// Send marshals and sends the CreateJobQueue API request.
func (r CreateJobQueueRequest) Send() (*CreateJobQueueOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*CreateJobQueueOutput), nil
}
// CreateJobQueueRequest returns a request value for making API operation for
// AWS Batch.
//
// Creates an AWS Batch job queue. When you create a job queue, you associate
// one or more compute environments to the queue and assign an order of preference
// for the compute environments.
//
// You also set a priority to the job queue that determines the order in which
// the AWS Batch scheduler places jobs onto its associated compute environments.
// For example, if a compute environment is associated with more than one job
// queue, the job queue with a higher priority is given preference for scheduling
// jobs to that compute environment.
//
// // Example sending a request using the CreateJobQueueRequest method.
// req := client.CreateJobQueueRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateJobQueue
func (c *Batch) CreateJobQueueRequest(input *CreateJobQueueInput) CreateJobQueueRequest {
op := &aws.Operation{
Name: opCreateJobQueue,
HTTPMethod: "POST",
HTTPPath: "/v1/createjobqueue",
}
if input == nil {
input = &CreateJobQueueInput{}
}
output := &CreateJobQueueOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return CreateJobQueueRequest{Request: req, Input: input, Copy: c.CreateJobQueueRequest}
}
const opDeleteComputeEnvironment = "DeleteComputeEnvironment"
// DeleteComputeEnvironmentRequest is a API request type for the DeleteComputeEnvironment API operation.
type DeleteComputeEnvironmentRequest struct {
*aws.Request
Input *DeleteComputeEnvironmentInput
Copy func(*DeleteComputeEnvironmentInput) DeleteComputeEnvironmentRequest
}
// Send marshals and sends the DeleteComputeEnvironment API request.
func (r DeleteComputeEnvironmentRequest) Send() (*DeleteComputeEnvironmentOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*DeleteComputeEnvironmentOutput), nil
}
// DeleteComputeEnvironmentRequest returns a request value for making API operation for
// AWS Batch.
//
// Deletes an AWS Batch compute environment.
//
// Before you can delete a compute environment, you must set its state to DISABLED
// with the UpdateComputeEnvironment API operation and disassociate it from
// any job queues with the UpdateJobQueue API operation.
//
// // Example sending a request using the DeleteComputeEnvironmentRequest method.
// req := client.DeleteComputeEnvironmentRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeleteComputeEnvironment
func (c *Batch) DeleteComputeEnvironmentRequest(input *DeleteComputeEnvironmentInput) DeleteComputeEnvironmentRequest {
op := &aws.Operation{
Name: opDeleteComputeEnvironment,
HTTPMethod: "POST",
HTTPPath: "/v1/deletecomputeenvironment",
}
if input == nil {
input = &DeleteComputeEnvironmentInput{}
}
output := &DeleteComputeEnvironmentOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return DeleteComputeEnvironmentRequest{Request: req, Input: input, Copy: c.DeleteComputeEnvironmentRequest}
}
const opDeleteJobQueue = "DeleteJobQueue"
// DeleteJobQueueRequest is a API request type for the DeleteJobQueue API operation.
type DeleteJobQueueRequest struct {
*aws.Request
Input *DeleteJobQueueInput
Copy func(*DeleteJobQueueInput) DeleteJobQueueRequest
}
// Send marshals and sends the DeleteJobQueue API request.
func (r DeleteJobQueueRequest) Send() (*DeleteJobQueueOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*DeleteJobQueueOutput), nil
}
// DeleteJobQueueRequest returns a request value for making API operation for
// AWS Batch.
//
// Deletes the specified job queue. You must first disable submissions for a
// queue with the UpdateJobQueue operation. All jobs in the queue are terminated
// when you delete a job queue.
//
// It is not necessary to disassociate compute environments from a queue before
// submitting a DeleteJobQueue request.
//
// // Example sending a request using the DeleteJobQueueRequest method.
// req := client.DeleteJobQueueRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeleteJobQueue
func (c *Batch) DeleteJobQueueRequest(input *DeleteJobQueueInput) DeleteJobQueueRequest {
op := &aws.Operation{
Name: opDeleteJobQueue,
HTTPMethod: "POST",
HTTPPath: "/v1/deletejobqueue",
}
if input == nil {
input = &DeleteJobQueueInput{}
}
output := &DeleteJobQueueOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return DeleteJobQueueRequest{Request: req, Input: input, Copy: c.DeleteJobQueueRequest}
}
const opDeregisterJobDefinition = "DeregisterJobDefinition"
// DeregisterJobDefinitionRequest is a API request type for the DeregisterJobDefinition API operation.
type DeregisterJobDefinitionRequest struct {
*aws.Request
Input *DeregisterJobDefinitionInput
Copy func(*DeregisterJobDefinitionInput) DeregisterJobDefinitionRequest
}
// Send marshals and sends the DeregisterJobDefinition API request.
func (r DeregisterJobDefinitionRequest) Send() (*DeregisterJobDefinitionOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*DeregisterJobDefinitionOutput), nil
}
// DeregisterJobDefinitionRequest returns a request value for making API operation for
// AWS Batch.
//
// Deregisters an AWS Batch job definition.
//
// // Example sending a request using the DeregisterJobDefinitionRequest method.
// req := client.DeregisterJobDefinitionRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeregisterJobDefinition
func (c *Batch) DeregisterJobDefinitionRequest(input *DeregisterJobDefinitionInput) DeregisterJobDefinitionRequest {
op := &aws.Operation{
Name: opDeregisterJobDefinition,
HTTPMethod: "POST",
HTTPPath: "/v1/deregisterjobdefinition",
}
if input == nil {
input = &DeregisterJobDefinitionInput{}
}
output := &DeregisterJobDefinitionOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return DeregisterJobDefinitionRequest{Request: req, Input: input, Copy: c.DeregisterJobDefinitionRequest}
}
const opDescribeComputeEnvironments = "DescribeComputeEnvironments"
// DescribeComputeEnvironmentsRequest is a API request type for the DescribeComputeEnvironments API operation.
type DescribeComputeEnvironmentsRequest struct {
*aws.Request
Input *DescribeComputeEnvironmentsInput
Copy func(*DescribeComputeEnvironmentsInput) DescribeComputeEnvironmentsRequest
}
// Send marshals and sends the DescribeComputeEnvironments API request.
func (r DescribeComputeEnvironmentsRequest) Send() (*DescribeComputeEnvironmentsOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*DescribeComputeEnvironmentsOutput), nil
}
// DescribeComputeEnvironmentsRequest returns a request value for making API operation for
// AWS Batch.
//
// Describes one or more of your compute environments.
//
// If you are using an unmanaged compute environment, you can use the DescribeComputeEnvironment
// operation to determine the ecsClusterArn that you should launch your Amazon
// ECS container instances into.
//
// // Example sending a request using the DescribeComputeEnvironmentsRequest method.
// req := client.DescribeComputeEnvironmentsRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeComputeEnvironments
func (c *Batch) DescribeComputeEnvironmentsRequest(input *DescribeComputeEnvironmentsInput) DescribeComputeEnvironmentsRequest {
op := &aws.Operation{
Name: opDescribeComputeEnvironments,
HTTPMethod: "POST",
HTTPPath: "/v1/describecomputeenvironments",
}
if input == nil {
input = &DescribeComputeEnvironmentsInput{}
}
output := &DescribeComputeEnvironmentsOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return DescribeComputeEnvironmentsRequest{Request: req, Input: input, Copy: c.DescribeComputeEnvironmentsRequest}
}
const opDescribeJobDefinitions = "DescribeJobDefinitions"
// DescribeJobDefinitionsRequest is a API request type for the DescribeJobDefinitions API operation.
type DescribeJobDefinitionsRequest struct {
*aws.Request
Input *DescribeJobDefinitionsInput
Copy func(*DescribeJobDefinitionsInput) DescribeJobDefinitionsRequest
}
// Send marshals and sends the DescribeJobDefinitions API request.
func (r DescribeJobDefinitionsRequest) Send() (*DescribeJobDefinitionsOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*DescribeJobDefinitionsOutput), nil
}
// DescribeJobDefinitionsRequest returns a request value for making API operation for
// AWS Batch.
//
// Describes a list of job definitions. You can specify a status (such as ACTIVE)
// to only return job definitions that match that status.
//
// // Example sending a request using the DescribeJobDefinitionsRequest method.
// req := client.DescribeJobDefinitionsRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobDefinitions
func (c *Batch) DescribeJobDefinitionsRequest(input *DescribeJobDefinitionsInput) DescribeJobDefinitionsRequest {
op := &aws.Operation{
Name: opDescribeJobDefinitions,
HTTPMethod: "POST",
HTTPPath: "/v1/describejobdefinitions",
}
if input == nil {
input = &DescribeJobDefinitionsInput{}
}
output := &DescribeJobDefinitionsOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return DescribeJobDefinitionsRequest{Request: req, Input: input, Copy: c.DescribeJobDefinitionsRequest}
}
const opDescribeJobQueues = "DescribeJobQueues"
// DescribeJobQueuesRequest is a API request type for the DescribeJobQueues API operation.
type DescribeJobQueuesRequest struct {
*aws.Request
Input *DescribeJobQueuesInput
Copy func(*DescribeJobQueuesInput) DescribeJobQueuesRequest
}
// Send marshals and sends the DescribeJobQueues API request.
func (r DescribeJobQueuesRequest) Send() (*DescribeJobQueuesOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*DescribeJobQueuesOutput), nil
}
// DescribeJobQueuesRequest returns a request value for making API operation for
// AWS Batch.
//
// Describes one or more of your job queues.
//
// // Example sending a request using the DescribeJobQueuesRequest method.
// req := client.DescribeJobQueuesRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobQueues
func (c *Batch) DescribeJobQueuesRequest(input *DescribeJobQueuesInput) DescribeJobQueuesRequest {
op := &aws.Operation{
Name: opDescribeJobQueues,
HTTPMethod: "POST",
HTTPPath: "/v1/describejobqueues",
}
if input == nil {
input = &DescribeJobQueuesInput{}
}
output := &DescribeJobQueuesOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return DescribeJobQueuesRequest{Request: req, Input: input, Copy: c.DescribeJobQueuesRequest}
}
const opDescribeJobs = "DescribeJobs"
// DescribeJobsRequest is a API request type for the DescribeJobs API operation.
type DescribeJobsRequest struct {
*aws.Request
Input *DescribeJobsInput
Copy func(*DescribeJobsInput) DescribeJobsRequest
}
// Send marshals and sends the DescribeJobs API request.
func (r DescribeJobsRequest) Send() (*DescribeJobsOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*DescribeJobsOutput), nil
}
// DescribeJobsRequest returns a request value for making API operation for
// AWS Batch.
//
// Describes a list of AWS Batch jobs.
//
// // Example sending a request using the DescribeJobsRequest method.
// req := client.DescribeJobsRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobs
func (c *Batch) DescribeJobsRequest(input *DescribeJobsInput) DescribeJobsRequest {
op := &aws.Operation{
Name: opDescribeJobs,
HTTPMethod: "POST",
HTTPPath: "/v1/describejobs",
}
if input == nil {
input = &DescribeJobsInput{}
}
output := &DescribeJobsOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return DescribeJobsRequest{Request: req, Input: input, Copy: c.DescribeJobsRequest}
}
const opListJobs = "ListJobs"
// ListJobsRequest is a API request type for the ListJobs API operation.
type ListJobsRequest struct {
*aws.Request
Input *ListJobsInput
Copy func(*ListJobsInput) ListJobsRequest
}
// Send marshals and sends the ListJobs API request.
func (r ListJobsRequest) Send() (*ListJobsOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*ListJobsOutput), nil
}
// ListJobsRequest returns a request value for making API operation for
// AWS Batch.
//
// Returns a list of task jobs for a specified job queue. You can filter the
// results by job status with the jobStatus parameter. If you do not specify
// a status, only RUNNING jobs are returned.
//
// // Example sending a request using the ListJobsRequest method.
// req := client.ListJobsRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListJobs
func (c *Batch) ListJobsRequest(input *ListJobsInput) ListJobsRequest {
op := &aws.Operation{
Name: opListJobs,
HTTPMethod: "POST",
HTTPPath: "/v1/listjobs",
}
if input == nil {
input = &ListJobsInput{}
}
output := &ListJobsOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return ListJobsRequest{Request: req, Input: input, Copy: c.ListJobsRequest}
}
const opRegisterJobDefinition = "RegisterJobDefinition"
// RegisterJobDefinitionRequest is a API request type for the RegisterJobDefinition API operation.
type RegisterJobDefinitionRequest struct {
*aws.Request
Input *RegisterJobDefinitionInput
Copy func(*RegisterJobDefinitionInput) RegisterJobDefinitionRequest
}
// Send marshals and sends the RegisterJobDefinition API request.
func (r RegisterJobDefinitionRequest) Send() (*RegisterJobDefinitionOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*RegisterJobDefinitionOutput), nil
}
// RegisterJobDefinitionRequest returns a request value for making API operation for
// AWS Batch.
//
// Registers an AWS Batch job definition.
//
// // Example sending a request using the RegisterJobDefinitionRequest method.
// req := client.RegisterJobDefinitionRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/RegisterJobDefinition
func (c *Batch) RegisterJobDefinitionRequest(input *RegisterJobDefinitionInput) RegisterJobDefinitionRequest {
op := &aws.Operation{
Name: opRegisterJobDefinition,
HTTPMethod: "POST",
HTTPPath: "/v1/registerjobdefinition",
}
if input == nil {
input = &RegisterJobDefinitionInput{}
}
output := &RegisterJobDefinitionOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return RegisterJobDefinitionRequest{Request: req, Input: input, Copy: c.RegisterJobDefinitionRequest}
}
const opSubmitJob = "SubmitJob"
// SubmitJobRequest is a API request type for the SubmitJob API operation.
type SubmitJobRequest struct {
*aws.Request
Input *SubmitJobInput
Copy func(*SubmitJobInput) SubmitJobRequest
}
// Send marshals and sends the SubmitJob API request.
func (r SubmitJobRequest) Send() (*SubmitJobOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*SubmitJobOutput), nil
}
// SubmitJobRequest returns a request value for making API operation for
// AWS Batch.
//
// Submits an AWS Batch job from a job definition. Parameters specified during
// SubmitJob override parameters defined in the job definition.
//
// // Example sending a request using the SubmitJobRequest method.
// req := client.SubmitJobRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/SubmitJob
func (c *Batch) SubmitJobRequest(input *SubmitJobInput) SubmitJobRequest {
op := &aws.Operation{
Name: opSubmitJob,
HTTPMethod: "POST",
HTTPPath: "/v1/submitjob",
}
if input == nil {
input = &SubmitJobInput{}
}
output := &SubmitJobOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return SubmitJobRequest{Request: req, Input: input, Copy: c.SubmitJobRequest}
}
const opTerminateJob = "TerminateJob"
// TerminateJobRequest is a API request type for the TerminateJob API operation.
type TerminateJobRequest struct {
*aws.Request
Input *TerminateJobInput
Copy func(*TerminateJobInput) TerminateJobRequest
}
// Send marshals and sends the TerminateJob API request.
func (r TerminateJobRequest) Send() (*TerminateJobOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*TerminateJobOutput), nil
}
// TerminateJobRequest returns a request value for making API operation for
// AWS Batch.
//
// Terminates a job in a job queue. Jobs that are in the STARTING or RUNNING
// state are terminated, which causes them to transition to FAILED. Jobs that
// have not progressed to the STARTING state are cancelled.
//
// // Example sending a request using the TerminateJobRequest method.
// req := client.TerminateJobRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/TerminateJob
func (c *Batch) TerminateJobRequest(input *TerminateJobInput) TerminateJobRequest {
op := &aws.Operation{
Name: opTerminateJob,
HTTPMethod: "POST",
HTTPPath: "/v1/terminatejob",
}
if input == nil {
input = &TerminateJobInput{}
}
output := &TerminateJobOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return TerminateJobRequest{Request: req, Input: input, Copy: c.TerminateJobRequest}
}
const opUpdateComputeEnvironment = "UpdateComputeEnvironment"
// UpdateComputeEnvironmentRequest is a API request type for the UpdateComputeEnvironment API operation.
type UpdateComputeEnvironmentRequest struct {
*aws.Request
Input *UpdateComputeEnvironmentInput
Copy func(*UpdateComputeEnvironmentInput) UpdateComputeEnvironmentRequest
}
// Send marshals and sends the UpdateComputeEnvironment API request.
func (r UpdateComputeEnvironmentRequest) Send() (*UpdateComputeEnvironmentOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*UpdateComputeEnvironmentOutput), nil
}
// UpdateComputeEnvironmentRequest returns a request value for making API operation for
// AWS Batch.
//
// Updates an AWS Batch compute environment.
//
// // Example sending a request using the UpdateComputeEnvironmentRequest method.
// req := client.UpdateComputeEnvironmentRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateComputeEnvironment
func (c *Batch) UpdateComputeEnvironmentRequest(input *UpdateComputeEnvironmentInput) UpdateComputeEnvironmentRequest {
op := &aws.Operation{
Name: opUpdateComputeEnvironment,
HTTPMethod: "POST",
HTTPPath: "/v1/updatecomputeenvironment",
}
if input == nil {
input = &UpdateComputeEnvironmentInput{}
}
output := &UpdateComputeEnvironmentOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return UpdateComputeEnvironmentRequest{Request: req, Input: input, Copy: c.UpdateComputeEnvironmentRequest}
}
const opUpdateJobQueue = "UpdateJobQueue"
// UpdateJobQueueRequest is a API request type for the UpdateJobQueue API operation.
type UpdateJobQueueRequest struct {
*aws.Request
Input *UpdateJobQueueInput
Copy func(*UpdateJobQueueInput) UpdateJobQueueRequest
}
// Send marshals and sends the UpdateJobQueue API request.
func (r UpdateJobQueueRequest) Send() (*UpdateJobQueueOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*UpdateJobQueueOutput), nil
}
// UpdateJobQueueRequest returns a request value for making API operation for
// AWS Batch.
//
// Updates a job queue.
//
// // Example sending a request using the UpdateJobQueueRequest method.
// req := client.UpdateJobQueueRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateJobQueue
func (c *Batch) UpdateJobQueueRequest(input *UpdateJobQueueInput) UpdateJobQueueRequest {
op := &aws.Operation{
Name: opUpdateJobQueue,
HTTPMethod: "POST",
HTTPPath: "/v1/updatejobqueue",
}
if input == nil {
input = &UpdateJobQueueInput{}
}
output := &UpdateJobQueueOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return UpdateJobQueueRequest{Request: req, Input: input, Copy: c.UpdateJobQueueRequest}
}
// An object representing an AWS Batch array job.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ArrayProperties
type ArrayProperties struct {
_ struct{} `type:"structure"`
// The size of the array job.
Size *int64 `locationName:"size" type:"integer"`
}
// String returns the string representation
func (s ArrayProperties) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ArrayProperties) GoString() string {
return s.String()
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s ArrayProperties) MarshalFields(e protocol.FieldEncoder) error {
if s.Size != nil {
v := *s.Size
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "size", protocol.Int64Value(v), metadata)
}
return nil
}
// An object representing the array properties of a job.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ArrayPropertiesDetail
type ArrayPropertiesDetail struct {
_ struct{} `type:"structure"`
// The job index within the array that is associated with this job. This parameter
// is returned for array job children.
Index *int64 `locationName:"index" type:"integer"`
// The size of the array job. This parameter is returned for parent array jobs.
Size *int64 `locationName:"size" type:"integer"`
// A summary of the number of array job children in each available job status.
// This parameter is returned for parent array jobs.
StatusSummary map[string]int64 `locationName:"statusSummary" type:"map"`
}
// String returns the string representation
func (s ArrayPropertiesDetail) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ArrayPropertiesDetail) GoString() string {
return s.String()
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s ArrayPropertiesDetail) MarshalFields(e protocol.FieldEncoder) error {
if s.Index != nil {
v := *s.Index
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "index", protocol.Int64Value(v), metadata)
}
if s.Size != nil {
v := *s.Size
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "size", protocol.Int64Value(v), metadata)
}
if len(s.StatusSummary) > 0 {
v := s.StatusSummary
metadata := protocol.Metadata{}
ms0 := e.Map(protocol.BodyTarget, "statusSummary", metadata)
ms0.Start()
for k1, v1 := range v {
ms0.MapSetValue(k1, protocol.Int64Value(v1))
}
ms0.End()
}
return nil
}
// An object representing the array properties of a job.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ArrayPropertiesSummary
type ArrayPropertiesSummary struct {
_ struct{} `type:"structure"`
// The job index within the array that is associated with this job. This parameter
// is returned for children of array jobs.
Index *int64 `locationName:"index" type:"integer"`
// The size of the array job. This parameter is returned for parent array jobs.
Size *int64 `locationName:"size" type:"integer"`
}
// String returns the string representation
func (s ArrayPropertiesSummary) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ArrayPropertiesSummary) GoString() string {
return s.String()
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s ArrayPropertiesSummary) MarshalFields(e protocol.FieldEncoder) error {
if s.Index != nil {
v := *s.Index
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "index", protocol.Int64Value(v), metadata)
}
if s.Size != nil {
v := *s.Size
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "size", protocol.Int64Value(v), metadata)
}
return nil
}
// An object representing the details of a container that is part of a job attempt.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/AttemptContainerDetail
type AttemptContainerDetail struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the Amazon ECS container instance that
// hosts the job attempt.
ContainerInstanceArn *string `locationName:"containerInstanceArn" type:"string"`
// The exit code for the job attempt. A non-zero exit code is considered a failure.