-
Notifications
You must be signed in to change notification settings - Fork 623
/
api.go
1044 lines (844 loc) · 34.3 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 iotjobsdataplane
import (
"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 opDescribeJobExecution = "DescribeJobExecution"
// DescribeJobExecutionRequest is a API request type for the DescribeJobExecution API operation.
type DescribeJobExecutionRequest struct {
*aws.Request
Input *DescribeJobExecutionInput
Copy func(*DescribeJobExecutionInput) DescribeJobExecutionRequest
}
// Send marshals and sends the DescribeJobExecution API request.
func (r DescribeJobExecutionRequest) Send() (*DescribeJobExecutionOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*DescribeJobExecutionOutput), nil
}
// DescribeJobExecutionRequest returns a request value for making API operation for
// AWS IoT Jobs Data Plane.
//
// Gets details of a job execution.
//
// // Example sending a request using the DescribeJobExecutionRequest method.
// req := client.DescribeJobExecutionRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/DescribeJobExecution
func (c *IoTJobsDataPlane) DescribeJobExecutionRequest(input *DescribeJobExecutionInput) DescribeJobExecutionRequest {
op := &aws.Operation{
Name: opDescribeJobExecution,
HTTPMethod: "GET",
HTTPPath: "/things/{thingName}/jobs/{jobId}",
}
if input == nil {
input = &DescribeJobExecutionInput{}
}
output := &DescribeJobExecutionOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return DescribeJobExecutionRequest{Request: req, Input: input, Copy: c.DescribeJobExecutionRequest}
}
const opGetPendingJobExecutions = "GetPendingJobExecutions"
// GetPendingJobExecutionsRequest is a API request type for the GetPendingJobExecutions API operation.
type GetPendingJobExecutionsRequest struct {
*aws.Request
Input *GetPendingJobExecutionsInput
Copy func(*GetPendingJobExecutionsInput) GetPendingJobExecutionsRequest
}
// Send marshals and sends the GetPendingJobExecutions API request.
func (r GetPendingJobExecutionsRequest) Send() (*GetPendingJobExecutionsOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*GetPendingJobExecutionsOutput), nil
}
// GetPendingJobExecutionsRequest returns a request value for making API operation for
// AWS IoT Jobs Data Plane.
//
// Gets the list of all jobs for a thing that are not in a terminal status.
//
// // Example sending a request using the GetPendingJobExecutionsRequest method.
// req := client.GetPendingJobExecutionsRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/GetPendingJobExecutions
func (c *IoTJobsDataPlane) GetPendingJobExecutionsRequest(input *GetPendingJobExecutionsInput) GetPendingJobExecutionsRequest {
op := &aws.Operation{
Name: opGetPendingJobExecutions,
HTTPMethod: "GET",
HTTPPath: "/things/{thingName}/jobs",
}
if input == nil {
input = &GetPendingJobExecutionsInput{}
}
output := &GetPendingJobExecutionsOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return GetPendingJobExecutionsRequest{Request: req, Input: input, Copy: c.GetPendingJobExecutionsRequest}
}
const opStartNextPendingJobExecution = "StartNextPendingJobExecution"
// StartNextPendingJobExecutionRequest is a API request type for the StartNextPendingJobExecution API operation.
type StartNextPendingJobExecutionRequest struct {
*aws.Request
Input *StartNextPendingJobExecutionInput
Copy func(*StartNextPendingJobExecutionInput) StartNextPendingJobExecutionRequest
}
// Send marshals and sends the StartNextPendingJobExecution API request.
func (r StartNextPendingJobExecutionRequest) Send() (*StartNextPendingJobExecutionOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*StartNextPendingJobExecutionOutput), nil
}
// StartNextPendingJobExecutionRequest returns a request value for making API operation for
// AWS IoT Jobs Data Plane.
//
// Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution
// for a thing.
//
// // Example sending a request using the StartNextPendingJobExecutionRequest method.
// req := client.StartNextPendingJobExecutionRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/StartNextPendingJobExecution
func (c *IoTJobsDataPlane) StartNextPendingJobExecutionRequest(input *StartNextPendingJobExecutionInput) StartNextPendingJobExecutionRequest {
op := &aws.Operation{
Name: opStartNextPendingJobExecution,
HTTPMethod: "PUT",
HTTPPath: "/things/{thingName}/jobs/$next",
}
if input == nil {
input = &StartNextPendingJobExecutionInput{}
}
output := &StartNextPendingJobExecutionOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return StartNextPendingJobExecutionRequest{Request: req, Input: input, Copy: c.StartNextPendingJobExecutionRequest}
}
const opUpdateJobExecution = "UpdateJobExecution"
// UpdateJobExecutionRequest is a API request type for the UpdateJobExecution API operation.
type UpdateJobExecutionRequest struct {
*aws.Request
Input *UpdateJobExecutionInput
Copy func(*UpdateJobExecutionInput) UpdateJobExecutionRequest
}
// Send marshals and sends the UpdateJobExecution API request.
func (r UpdateJobExecutionRequest) Send() (*UpdateJobExecutionOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*UpdateJobExecutionOutput), nil
}
// UpdateJobExecutionRequest returns a request value for making API operation for
// AWS IoT Jobs Data Plane.
//
// Updates the status of a job execution.
//
// // Example sending a request using the UpdateJobExecutionRequest method.
// req := client.UpdateJobExecutionRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/UpdateJobExecution
func (c *IoTJobsDataPlane) UpdateJobExecutionRequest(input *UpdateJobExecutionInput) UpdateJobExecutionRequest {
op := &aws.Operation{
Name: opUpdateJobExecution,
HTTPMethod: "POST",
HTTPPath: "/things/{thingName}/jobs/{jobId}",
}
if input == nil {
input = &UpdateJobExecutionInput{}
}
output := &UpdateJobExecutionOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return UpdateJobExecutionRequest{Request: req, Input: input, Copy: c.UpdateJobExecutionRequest}
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/DescribeJobExecutionRequest
type DescribeJobExecutionInput struct {
_ struct{} `type:"structure"`
// Optional. A number that identifies a particular job execution on a particular
// device. If not specified, the latest job execution is returned.
ExecutionNumber *int64 `location:"querystring" locationName:"executionNumber" type:"long"`
// Optional. When set to true, the response contains the job document. The default
// is false.
IncludeJobDocument *bool `location:"querystring" locationName:"includeJobDocument" type:"boolean"`
// The unique identifier assigned to this job when it was created.
//
// JobId is a required field
JobId *string `location:"uri" locationName:"jobId" type:"string" required:"true"`
// The thing name associated with the device the job execution is running on.
//
// ThingName is a required field
ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s DescribeJobExecutionInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribeJobExecutionInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeJobExecutionInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "DescribeJobExecutionInput"}
if s.JobId == nil {
invalidParams.Add(aws.NewErrParamRequired("JobId"))
}
if s.ThingName == nil {
invalidParams.Add(aws.NewErrParamRequired("ThingName"))
}
if s.ThingName != nil && len(*s.ThingName) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("ThingName", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s DescribeJobExecutionInput) MarshalFields(e protocol.FieldEncoder) error {
if s.JobId != nil {
v := *s.JobId
metadata := protocol.Metadata{}
e.SetValue(protocol.PathTarget, "jobId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.ThingName != nil {
v := *s.ThingName
metadata := protocol.Metadata{}
e.SetValue(protocol.PathTarget, "thingName", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.ExecutionNumber != nil {
v := *s.ExecutionNumber
metadata := protocol.Metadata{}
e.SetValue(protocol.QueryTarget, "executionNumber", protocol.Int64Value(v), metadata)
}
if s.IncludeJobDocument != nil {
v := *s.IncludeJobDocument
metadata := protocol.Metadata{}
e.SetValue(protocol.QueryTarget, "includeJobDocument", protocol.BoolValue(v), metadata)
}
return nil
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/DescribeJobExecutionResponse
type DescribeJobExecutionOutput struct {
_ struct{} `type:"structure"`
responseMetadata aws.Response
// Contains data about a job execution.
Execution *JobExecution `locationName:"execution" type:"structure"`
}
// String returns the string representation
func (s DescribeJobExecutionOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribeJobExecutionOutput) GoString() string {
return s.String()
}
// SDKResponseMetdata return sthe response metadata for the API.
func (s DescribeJobExecutionOutput) SDKResponseMetadata() aws.Response {
return s.responseMetadata
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s DescribeJobExecutionOutput) MarshalFields(e protocol.FieldEncoder) error {
if s.Execution != nil {
v := s.Execution
metadata := protocol.Metadata{}
e.SetFields(protocol.BodyTarget, "execution", v, metadata)
}
return nil
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/GetPendingJobExecutionsRequest
type GetPendingJobExecutionsInput struct {
_ struct{} `type:"structure"`
// The name of the thing that is executing the job.
//
// ThingName is a required field
ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s GetPendingJobExecutionsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s GetPendingJobExecutionsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *GetPendingJobExecutionsInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "GetPendingJobExecutionsInput"}
if s.ThingName == nil {
invalidParams.Add(aws.NewErrParamRequired("ThingName"))
}
if s.ThingName != nil && len(*s.ThingName) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("ThingName", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s GetPendingJobExecutionsInput) MarshalFields(e protocol.FieldEncoder) error {
if s.ThingName != nil {
v := *s.ThingName
metadata := protocol.Metadata{}
e.SetValue(protocol.PathTarget, "thingName", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
return nil
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/GetPendingJobExecutionsResponse
type GetPendingJobExecutionsOutput struct {
_ struct{} `type:"structure"`
responseMetadata aws.Response
// A list of JobExecutionSummary objects with status IN_PROGRESS.
InProgressJobs []JobExecutionSummary `locationName:"inProgressJobs" type:"list"`
// A list of JobExecutionSummary objects with status QUEUED.
QueuedJobs []JobExecutionSummary `locationName:"queuedJobs" type:"list"`
}
// String returns the string representation
func (s GetPendingJobExecutionsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s GetPendingJobExecutionsOutput) GoString() string {
return s.String()
}
// SDKResponseMetdata return sthe response metadata for the API.
func (s GetPendingJobExecutionsOutput) SDKResponseMetadata() aws.Response {
return s.responseMetadata
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s GetPendingJobExecutionsOutput) MarshalFields(e protocol.FieldEncoder) error {
if len(s.InProgressJobs) > 0 {
v := s.InProgressJobs
metadata := protocol.Metadata{}
ls0 := e.List(protocol.BodyTarget, "inProgressJobs", metadata)
ls0.Start()
for _, v1 := range v {
ls0.ListAddFields(v1)
}
ls0.End()
}
if len(s.QueuedJobs) > 0 {
v := s.QueuedJobs
metadata := protocol.Metadata{}
ls0 := e.List(protocol.BodyTarget, "queuedJobs", metadata)
ls0.Start()
for _, v1 := range v {
ls0.ListAddFields(v1)
}
ls0.End()
}
return nil
}
// Contains data about a job execution.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/JobExecution
type JobExecution struct {
_ struct{} `type:"structure"`
// The estimated number of seconds that remain before the job execution status
// will be changed to TIMED_OUT.
ApproximateSecondsBeforeTimedOut *int64 `locationName:"approximateSecondsBeforeTimedOut" type:"long"`
// A number that identifies a particular job execution on a particular device.
// It can be used later in commands that return or update job execution information.
ExecutionNumber *int64 `locationName:"executionNumber" type:"long"`
// The content of the job document.
JobDocument *string `locationName:"jobDocument" type:"string"`
// The unique identifier you assigned to this job when it was created.
JobId *string `locationName:"jobId" min:"1" type:"string"`
// The time, in milliseconds since the epoch, when the job execution was last
// updated.
LastUpdatedAt *int64 `locationName:"lastUpdatedAt" type:"long"`
// The time, in milliseconds since the epoch, when the job execution was enqueued.
QueuedAt *int64 `locationName:"queuedAt" type:"long"`
// The time, in milliseconds since the epoch, when the job execution was started.
StartedAt *int64 `locationName:"startedAt" type:"long"`
// The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS",
// "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
Status JobExecutionStatus `locationName:"status" type:"string" enum:"true"`
// A collection of name/value pairs that describe the status of the job execution.
StatusDetails map[string]string `locationName:"statusDetails" type:"map"`
// The name of the thing that is executing the job.
ThingName *string `locationName:"thingName" min:"1" type:"string"`
// The version of the job execution. Job execution versions are incremented
// each time they are updated by a device.
VersionNumber *int64 `locationName:"versionNumber" type:"long"`
}
// String returns the string representation
func (s JobExecution) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s JobExecution) GoString() string {
return s.String()
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s JobExecution) MarshalFields(e protocol.FieldEncoder) error {
if s.ApproximateSecondsBeforeTimedOut != nil {
v := *s.ApproximateSecondsBeforeTimedOut
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "approximateSecondsBeforeTimedOut", protocol.Int64Value(v), metadata)
}
if s.ExecutionNumber != nil {
v := *s.ExecutionNumber
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "executionNumber", protocol.Int64Value(v), metadata)
}
if s.JobDocument != nil {
v := *s.JobDocument
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "jobDocument", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.JobId != nil {
v := *s.JobId
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "jobId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.LastUpdatedAt != nil {
v := *s.LastUpdatedAt
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "lastUpdatedAt", protocol.Int64Value(v), metadata)
}
if s.QueuedAt != nil {
v := *s.QueuedAt
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "queuedAt", protocol.Int64Value(v), metadata)
}
if s.StartedAt != nil {
v := *s.StartedAt
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "startedAt", protocol.Int64Value(v), metadata)
}
if len(s.Status) > 0 {
v := s.Status
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "status", protocol.QuotedValue{ValueMarshaler: v}, metadata)
}
if len(s.StatusDetails) > 0 {
v := s.StatusDetails
metadata := protocol.Metadata{}
ms0 := e.Map(protocol.BodyTarget, "statusDetails", metadata)
ms0.Start()
for k1, v1 := range v {
ms0.MapSetValue(k1, protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v1)})
}
ms0.End()
}
if s.ThingName != nil {
v := *s.ThingName
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "thingName", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.VersionNumber != nil {
v := *s.VersionNumber
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "versionNumber", protocol.Int64Value(v), metadata)
}
return nil
}
// Contains data about the state of a job execution.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/JobExecutionState
type JobExecutionState struct {
_ struct{} `type:"structure"`
// The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS",
// "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
Status JobExecutionStatus `locationName:"status" type:"string" enum:"true"`
// A collection of name/value pairs that describe the status of the job execution.
StatusDetails map[string]string `locationName:"statusDetails" type:"map"`
// The version of the job execution. Job execution versions are incremented
// each time they are updated by a device.
VersionNumber *int64 `locationName:"versionNumber" type:"long"`
}
// String returns the string representation
func (s JobExecutionState) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s JobExecutionState) GoString() string {
return s.String()
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s JobExecutionState) MarshalFields(e protocol.FieldEncoder) error {
if len(s.Status) > 0 {
v := s.Status
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "status", protocol.QuotedValue{ValueMarshaler: v}, metadata)
}
if len(s.StatusDetails) > 0 {
v := s.StatusDetails
metadata := protocol.Metadata{}
ms0 := e.Map(protocol.BodyTarget, "statusDetails", metadata)
ms0.Start()
for k1, v1 := range v {
ms0.MapSetValue(k1, protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v1)})
}
ms0.End()
}
if s.VersionNumber != nil {
v := *s.VersionNumber
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "versionNumber", protocol.Int64Value(v), metadata)
}
return nil
}
// Contains a subset of information about a job execution.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/JobExecutionSummary
type JobExecutionSummary struct {
_ struct{} `type:"structure"`
// A number that identifies a particular job execution on a particular device.
ExecutionNumber *int64 `locationName:"executionNumber" type:"long"`
// The unique identifier you assigned to this job when it was created.
JobId *string `locationName:"jobId" min:"1" type:"string"`
// The time, in milliseconds since the epoch, when the job execution was last
// updated.
LastUpdatedAt *int64 `locationName:"lastUpdatedAt" type:"long"`
// The time, in milliseconds since the epoch, when the job execution was enqueued.
QueuedAt *int64 `locationName:"queuedAt" type:"long"`
// The time, in milliseconds since the epoch, when the job execution started.
StartedAt *int64 `locationName:"startedAt" type:"long"`
// The version of the job execution. Job execution versions are incremented
// each time AWS IoT Jobs receives an update from a device.
VersionNumber *int64 `locationName:"versionNumber" type:"long"`
}
// String returns the string representation
func (s JobExecutionSummary) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s JobExecutionSummary) GoString() string {
return s.String()
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s JobExecutionSummary) MarshalFields(e protocol.FieldEncoder) error {
if s.ExecutionNumber != nil {
v := *s.ExecutionNumber
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "executionNumber", protocol.Int64Value(v), metadata)
}
if s.JobId != nil {
v := *s.JobId
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "jobId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.LastUpdatedAt != nil {
v := *s.LastUpdatedAt
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "lastUpdatedAt", protocol.Int64Value(v), metadata)
}
if s.QueuedAt != nil {
v := *s.QueuedAt
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "queuedAt", protocol.Int64Value(v), metadata)
}
if s.StartedAt != nil {
v := *s.StartedAt
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "startedAt", protocol.Int64Value(v), metadata)
}
if s.VersionNumber != nil {
v := *s.VersionNumber
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "versionNumber", protocol.Int64Value(v), metadata)
}
return nil
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/StartNextPendingJobExecutionRequest
type StartNextPendingJobExecutionInput struct {
_ struct{} `type:"structure"`
// A collection of name/value pairs that describe the status of the job execution.
// If not specified, the statusDetails are unchanged.
StatusDetails map[string]string `locationName:"statusDetails" type:"map"`
// Specifies the amount of time this device has to finish execution of this
// job. If the job execution status is not set to a terminal state before this
// timer expires, or before the timer is reset (by calling UpdateJobExecution,
// setting the status to IN_PROGRESS and specifying a new timeout value in field
// stepTimeoutInMinutes) the job execution status will be automatically set
// to TIMED_OUT. Note that setting this timeout has no effect on that job execution
// timeout which may have been specified when the job was created (CreateJob
// using field timeoutConfig).
StepTimeoutInMinutes *int64 `locationName:"stepTimeoutInMinutes" type:"long"`
// The name of the thing associated with the device.
//
// ThingName is a required field
ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s StartNextPendingJobExecutionInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s StartNextPendingJobExecutionInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *StartNextPendingJobExecutionInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "StartNextPendingJobExecutionInput"}
if s.ThingName == nil {
invalidParams.Add(aws.NewErrParamRequired("ThingName"))
}
if s.ThingName != nil && len(*s.ThingName) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("ThingName", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s StartNextPendingJobExecutionInput) MarshalFields(e protocol.FieldEncoder) error {
if len(s.StatusDetails) > 0 {
v := s.StatusDetails
metadata := protocol.Metadata{}
ms0 := e.Map(protocol.BodyTarget, "statusDetails", metadata)
ms0.Start()
for k1, v1 := range v {
ms0.MapSetValue(k1, protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v1)})
}
ms0.End()
}
if s.StepTimeoutInMinutes != nil {
v := *s.StepTimeoutInMinutes
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "stepTimeoutInMinutes", protocol.Int64Value(v), metadata)
}
if s.ThingName != nil {
v := *s.ThingName
metadata := protocol.Metadata{}
e.SetValue(protocol.PathTarget, "thingName", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
return nil
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/StartNextPendingJobExecutionResponse
type StartNextPendingJobExecutionOutput struct {
_ struct{} `type:"structure"`
responseMetadata aws.Response
// A JobExecution object.
Execution *JobExecution `locationName:"execution" type:"structure"`
}
// String returns the string representation
func (s StartNextPendingJobExecutionOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s StartNextPendingJobExecutionOutput) GoString() string {
return s.String()
}
// SDKResponseMetdata return sthe response metadata for the API.
func (s StartNextPendingJobExecutionOutput) SDKResponseMetadata() aws.Response {
return s.responseMetadata
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s StartNextPendingJobExecutionOutput) MarshalFields(e protocol.FieldEncoder) error {
if s.Execution != nil {
v := s.Execution
metadata := protocol.Metadata{}
e.SetFields(protocol.BodyTarget, "execution", v, metadata)
}
return nil
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/UpdateJobExecutionRequest
type UpdateJobExecutionInput struct {
_ struct{} `type:"structure"`
// Optional. A number that identifies a particular job execution on a particular
// device.
ExecutionNumber *int64 `locationName:"executionNumber" type:"long"`
// Optional. The expected current version of the job execution. Each time you
// update the job execution, its version is incremented. If the version of the
// job execution stored in Jobs does not match, the update is rejected with
// a VersionMismatch error, and an ErrorResponse that contains the current job
// execution status data is returned. (This makes it unnecessary to perform
// a separate DescribeJobExecution request in order to obtain the job execution
// status data.)
ExpectedVersion *int64 `locationName:"expectedVersion" type:"long"`
// Optional. When set to true, the response contains the job document. The default
// is false.
IncludeJobDocument *bool `locationName:"includeJobDocument" type:"boolean"`
// Optional. When included and set to true, the response contains the JobExecutionState
// data. The default is false.
IncludeJobExecutionState *bool `locationName:"includeJobExecutionState" type:"boolean"`
// The unique identifier assigned to this job when it was created.
//
// JobId is a required field
JobId *string `location:"uri" locationName:"jobId" min:"1" type:"string" required:"true"`
// The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED).
// This must be specified on every update.
//
// Status is a required field
Status JobExecutionStatus `locationName:"status" type:"string" required:"true" enum:"true"`
// Optional. A collection of name/value pairs that describe the status of the
// job execution. If not specified, the statusDetails are unchanged.
StatusDetails map[string]string `locationName:"statusDetails" type:"map"`
// Specifies the amount of time this device has to finish execution of this
// job. If the job execution status is not set to a terminal state before this
// timer expires, or before the timer is reset (by again calling UpdateJobExecution,
// setting the status to IN_PROGRESS and specifying a new timeout value in this
// field) the job execution status will be automatically set to TIMED_OUT. Note
// that setting or resetting this timeout has no effect on that job execution
// timeout which may have been specified when the job was created (CreateJob
// using field timeoutConfig).
StepTimeoutInMinutes *int64 `locationName:"stepTimeoutInMinutes" type:"long"`
// The name of the thing associated with the device.
//
// ThingName is a required field
ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s UpdateJobExecutionInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s UpdateJobExecutionInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *UpdateJobExecutionInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "UpdateJobExecutionInput"}
if s.JobId == nil {
invalidParams.Add(aws.NewErrParamRequired("JobId"))
}
if s.JobId != nil && len(*s.JobId) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("JobId", 1))
}
if len(s.Status) == 0 {
invalidParams.Add(aws.NewErrParamRequired("Status"))
}
if s.ThingName == nil {
invalidParams.Add(aws.NewErrParamRequired("ThingName"))
}
if s.ThingName != nil && len(*s.ThingName) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("ThingName", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s UpdateJobExecutionInput) MarshalFields(e protocol.FieldEncoder) error {
if s.ExecutionNumber != nil {
v := *s.ExecutionNumber
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "executionNumber", protocol.Int64Value(v), metadata)
}
if s.ExpectedVersion != nil {
v := *s.ExpectedVersion
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "expectedVersion", protocol.Int64Value(v), metadata)
}
if s.IncludeJobDocument != nil {
v := *s.IncludeJobDocument
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "includeJobDocument", protocol.BoolValue(v), metadata)
}
if s.IncludeJobExecutionState != nil {
v := *s.IncludeJobExecutionState
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "includeJobExecutionState", protocol.BoolValue(v), metadata)
}
if len(s.Status) > 0 {
v := s.Status
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "status", protocol.QuotedValue{ValueMarshaler: v}, metadata)
}
if len(s.StatusDetails) > 0 {
v := s.StatusDetails
metadata := protocol.Metadata{}
ms0 := e.Map(protocol.BodyTarget, "statusDetails", metadata)
ms0.Start()
for k1, v1 := range v {
ms0.MapSetValue(k1, protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v1)})
}
ms0.End()
}
if s.StepTimeoutInMinutes != nil {
v := *s.StepTimeoutInMinutes
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "stepTimeoutInMinutes", protocol.Int64Value(v), metadata)
}
if s.JobId != nil {
v := *s.JobId
metadata := protocol.Metadata{}
e.SetValue(protocol.PathTarget, "jobId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.ThingName != nil {
v := *s.ThingName
metadata := protocol.Metadata{}
e.SetValue(protocol.PathTarget, "thingName", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
return nil
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/iot-jobs-data-2017-09-29/UpdateJobExecutionResponse
type UpdateJobExecutionOutput struct {
_ struct{} `type:"structure"`
responseMetadata aws.Response
// A JobExecutionState object.
ExecutionState *JobExecutionState `locationName:"executionState" type:"structure"`
// The contents of the Job Documents.
JobDocument *string `locationName:"jobDocument" type:"string"`
}
// String returns the string representation
func (s UpdateJobExecutionOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s UpdateJobExecutionOutput) GoString() string {
return s.String()
}