-
Notifications
You must be signed in to change notification settings - Fork 626
/
api_types.go
1624 lines (1315 loc) · 48.4 KB
/
api_types.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 s3control
import (
"fmt"
"time"
"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"
)
var _ aws.Config
var _ = awsutil.Prettify
// A container element for the job configuration and status information returned
// by a Describe Job request.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/JobDescriptor
type JobDescriptor struct {
_ struct{} `type:"structure"`
// Indicates whether confirmation is required before Amazon S3 begins running
// the specified job. Confirmation is required only for jobs created through
// the Amazon S3 console.
ConfirmationRequired *bool `type:"boolean"`
// A timestamp indicating when this job was created.
CreationTime *time.Time `type:"timestamp"`
// The description for this job, if one was provided in this job's Create Job
// request.
Description *string `min:"1" type:"string"`
// If the specified job failed, this field contains information describing the
// failure.
FailureReasons []JobFailure `type:"list"`
// The Amazon Resource Name (ARN) for this job.
JobArn *string `min:"1" type:"string"`
// The ID for the specified job.
JobId *string `min:"5" type:"string"`
// The configuration information for the specified job's manifest object.
Manifest *JobManifest `type:"structure"`
// The operation that the specified job is configured to execute on the objects
// listed in the manifest.
Operation *JobOperation `type:"structure"`
// The priority of the specified job.
Priority *int64 `type:"integer"`
// Describes the total number of tasks that the specified job has executed,
// the number of tasks that succeeded, and the number of tasks that failed.
ProgressSummary *JobProgressSummary `type:"structure"`
// Contains the configuration information for the job-completion report if you
// requested one in the Create Job request.
Report *JobReport `type:"structure"`
// The Amazon Resource Name (ARN) for the Identity and Access Management (IAM)
// Role assigned to execute the tasks for this job.
RoleArn *string `min:"1" type:"string"`
// The current status of the specified job.
Status JobStatus `type:"string" enum:"true"`
StatusUpdateReason *string `min:"1" type:"string"`
// The reason why the specified job was suspended. A job is only suspended if
// you create it through the Amazon S3 console. When you create the job, it
// enters the Suspended state to await confirmation before running. After you
// confirm the job, it automatically exits the Suspended state.
SuspendedCause *string `min:"1" type:"string"`
// The timestamp when this job was suspended, if it has been suspended.
SuspendedDate *time.Time `type:"timestamp"`
// A timestamp indicating when this job terminated. A job's termination date
// is the date and time when it succeeded, failed, or was canceled.
TerminationDate *time.Time `type:"timestamp"`
}
// String returns the string representation
func (s JobDescriptor) String() string {
return awsutil.Prettify(s)
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s JobDescriptor) MarshalFields(e protocol.FieldEncoder) error {
if s.ConfirmationRequired != nil {
v := *s.ConfirmationRequired
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "ConfirmationRequired", protocol.BoolValue(v), metadata)
}
if s.CreationTime != nil {
v := *s.CreationTime
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "CreationTime",
protocol.TimeValue{V: v, Format: protocol.ISO8601TimeFormatName, QuotedFormatTime: false}, metadata)
}
if s.Description != nil {
v := *s.Description
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "Description", protocol.StringValue(v), metadata)
}
if s.FailureReasons != nil {
v := s.FailureReasons
metadata := protocol.Metadata{}
ls0 := e.List(protocol.BodyTarget, "FailureReasons", metadata)
ls0.Start()
for _, v1 := range v {
ls0.ListAddFields(v1)
}
ls0.End()
}
if s.JobArn != nil {
v := *s.JobArn
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "JobArn", protocol.StringValue(v), metadata)
}
if s.JobId != nil {
v := *s.JobId
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "JobId", protocol.StringValue(v), metadata)
}
if s.Manifest != nil {
v := s.Manifest
metadata := protocol.Metadata{}
e.SetFields(protocol.BodyTarget, "Manifest", v, metadata)
}
if s.Operation != nil {
v := s.Operation
metadata := protocol.Metadata{}
e.SetFields(protocol.BodyTarget, "Operation", v, metadata)
}
if s.Priority != nil {
v := *s.Priority
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "Priority", protocol.Int64Value(v), metadata)
}
if s.ProgressSummary != nil {
v := s.ProgressSummary
metadata := protocol.Metadata{}
e.SetFields(protocol.BodyTarget, "ProgressSummary", v, metadata)
}
if s.Report != nil {
v := s.Report
metadata := protocol.Metadata{}
e.SetFields(protocol.BodyTarget, "Report", v, metadata)
}
if s.RoleArn != nil {
v := *s.RoleArn
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "RoleArn", protocol.StringValue(v), metadata)
}
if len(s.Status) > 0 {
v := s.Status
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "Status", v, metadata)
}
if s.StatusUpdateReason != nil {
v := *s.StatusUpdateReason
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "StatusUpdateReason", protocol.StringValue(v), metadata)
}
if s.SuspendedCause != nil {
v := *s.SuspendedCause
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "SuspendedCause", protocol.StringValue(v), metadata)
}
if s.SuspendedDate != nil {
v := *s.SuspendedDate
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "SuspendedDate",
protocol.TimeValue{V: v, Format: protocol.ISO8601TimeFormatName, QuotedFormatTime: false}, metadata)
}
if s.TerminationDate != nil {
v := *s.TerminationDate
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "TerminationDate",
protocol.TimeValue{V: v, Format: protocol.ISO8601TimeFormatName, QuotedFormatTime: false}, metadata)
}
return nil
}
// If this job failed, this element indicates why the job failed.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/JobFailure
type JobFailure struct {
_ struct{} `type:"structure"`
// The failure code, if any, for the specified job.
FailureCode *string `min:"1" type:"string"`
// The failure reason, if any, for the specified job.
FailureReason *string `min:"1" type:"string"`
}
// String returns the string representation
func (s JobFailure) String() string {
return awsutil.Prettify(s)
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s JobFailure) MarshalFields(e protocol.FieldEncoder) error {
if s.FailureCode != nil {
v := *s.FailureCode
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "FailureCode", protocol.StringValue(v), metadata)
}
if s.FailureReason != nil {
v := *s.FailureReason
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "FailureReason", protocol.StringValue(v), metadata)
}
return nil
}
// Contains the configuration and status information for a single job retrieved
// as part of a job list.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/JobListDescriptor
type JobListDescriptor struct {
_ struct{} `type:"structure"`
// A timestamp indicating when the specified job was created.
CreationTime *time.Time `type:"timestamp"`
// The user-specified description that was included in the specified job's Create
// Job request.
Description *string `min:"1" type:"string"`
// The ID for the specified job.
JobId *string `min:"5" type:"string"`
// The operation that the specified job is configured to run on each object
// listed in the manifest.
Operation OperationName `type:"string" enum:"true"`
// The current priority for the specified job.
Priority *int64 `type:"integer"`
// Describes the total number of tasks that the specified job has executed,
// the number of tasks that succeeded, and the number of tasks that failed.
ProgressSummary *JobProgressSummary `type:"structure"`
// The specified job's current status.
Status JobStatus `type:"string" enum:"true"`
// A timestamp indicating when the specified job terminated. A job's termination
// date is the date and time when it succeeded, failed, or was canceled.
TerminationDate *time.Time `type:"timestamp"`
}
// String returns the string representation
func (s JobListDescriptor) String() string {
return awsutil.Prettify(s)
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s JobListDescriptor) MarshalFields(e protocol.FieldEncoder) error {
if s.CreationTime != nil {
v := *s.CreationTime
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "CreationTime",
protocol.TimeValue{V: v, Format: protocol.ISO8601TimeFormatName, QuotedFormatTime: false}, metadata)
}
if s.Description != nil {
v := *s.Description
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "Description", protocol.StringValue(v), metadata)
}
if s.JobId != nil {
v := *s.JobId
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "JobId", protocol.StringValue(v), metadata)
}
if len(s.Operation) > 0 {
v := s.Operation
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "Operation", v, metadata)
}
if s.Priority != nil {
v := *s.Priority
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "Priority", protocol.Int64Value(v), metadata)
}
if s.ProgressSummary != nil {
v := s.ProgressSummary
metadata := protocol.Metadata{}
e.SetFields(protocol.BodyTarget, "ProgressSummary", v, metadata)
}
if len(s.Status) > 0 {
v := s.Status
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "Status", v, metadata)
}
if s.TerminationDate != nil {
v := *s.TerminationDate
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "TerminationDate",
protocol.TimeValue{V: v, Format: protocol.ISO8601TimeFormatName, QuotedFormatTime: false}, metadata)
}
return nil
}
// Contains the configuration information for a job's manifest.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/JobManifest
type JobManifest struct {
_ struct{} `type:"structure"`
// Contains the information required to locate the specified job's manifest.
//
// Location is a required field
Location *JobManifestLocation `type:"structure" required:"true"`
// Describes the format of the specified job's manifest. If the manifest is
// in CSV format, also describes the columns contained within the manifest.
//
// Spec is a required field
Spec *JobManifestSpec `type:"structure" required:"true"`
}
// String returns the string representation
func (s JobManifest) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *JobManifest) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "JobManifest"}
if s.Location == nil {
invalidParams.Add(aws.NewErrParamRequired("Location"))
}
if s.Spec == nil {
invalidParams.Add(aws.NewErrParamRequired("Spec"))
}
if s.Location != nil {
if err := s.Location.Validate(); err != nil {
invalidParams.AddNested("Location", err.(aws.ErrInvalidParams))
}
}
if s.Spec != nil {
if err := s.Spec.Validate(); err != nil {
invalidParams.AddNested("Spec", err.(aws.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s JobManifest) MarshalFields(e protocol.FieldEncoder) error {
if s.Location != nil {
v := s.Location
metadata := protocol.Metadata{}
e.SetFields(protocol.BodyTarget, "Location", v, metadata)
}
if s.Spec != nil {
v := s.Spec
metadata := protocol.Metadata{}
e.SetFields(protocol.BodyTarget, "Spec", v, metadata)
}
return nil
}
// Contains the information required to locate a manifest object.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/JobManifestLocation
type JobManifestLocation struct {
_ struct{} `type:"structure"`
// The ETag for the specified manifest object.
//
// ETag is a required field
ETag *string `min:"1" type:"string" required:"true"`
// The Amazon Resource Name (ARN) for a manifest object.
//
// ObjectArn is a required field
ObjectArn *string `min:"1" type:"string" required:"true"`
// The optional version ID to identify a specific version of the manifest object.
ObjectVersionId *string `min:"1" type:"string"`
}
// String returns the string representation
func (s JobManifestLocation) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *JobManifestLocation) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "JobManifestLocation"}
if s.ETag == nil {
invalidParams.Add(aws.NewErrParamRequired("ETag"))
}
if s.ETag != nil && len(*s.ETag) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("ETag", 1))
}
if s.ObjectArn == nil {
invalidParams.Add(aws.NewErrParamRequired("ObjectArn"))
}
if s.ObjectArn != nil && len(*s.ObjectArn) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("ObjectArn", 1))
}
if s.ObjectVersionId != nil && len(*s.ObjectVersionId) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("ObjectVersionId", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s JobManifestLocation) MarshalFields(e protocol.FieldEncoder) error {
if s.ETag != nil {
v := *s.ETag
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "ETag", protocol.StringValue(v), metadata)
}
if s.ObjectArn != nil {
v := *s.ObjectArn
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "ObjectArn", protocol.StringValue(v), metadata)
}
if s.ObjectVersionId != nil {
v := *s.ObjectVersionId
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "ObjectVersionId", protocol.StringValue(v), metadata)
}
return nil
}
// Describes the format of a manifest. If the manifest is in CSV format, also
// describes the columns contained within the manifest.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/JobManifestSpec
type JobManifestSpec struct {
_ struct{} `type:"structure"`
// If the specified manifest object is in the S3BatchOperations_CSV_20180820
// format, this element describes which columns contain the required data.
Fields []JobManifestFieldName `type:"list"`
// Indicates which of the available formats the specified manifest uses.
//
// Format is a required field
Format JobManifestFormat `type:"string" required:"true" enum:"true"`
}
// String returns the string representation
func (s JobManifestSpec) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *JobManifestSpec) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "JobManifestSpec"}
if len(s.Format) == 0 {
invalidParams.Add(aws.NewErrParamRequired("Format"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s JobManifestSpec) MarshalFields(e protocol.FieldEncoder) error {
if s.Fields != nil {
v := s.Fields
metadata := protocol.Metadata{}
ls0 := e.List(protocol.BodyTarget, "Fields", metadata)
ls0.Start()
for _, v1 := range v {
ls0.ListAddValue(protocol.StringValue(v1))
}
ls0.End()
}
if len(s.Format) > 0 {
v := s.Format
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "Format", v, metadata)
}
return nil
}
// The operation that you want this job to perform on each object listed in
// the manifest. For more information about the available operations, see Available
// Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-operations.html)
// in the Amazon Simple Storage Service Developer Guide.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/JobOperation
type JobOperation struct {
_ struct{} `type:"structure"`
// Directs the specified job to invoke an AWS Lambda function on each object
// in the manifest.
LambdaInvoke *LambdaInvokeOperation `type:"structure"`
// Directs the specified job to execute an Initiate Glacier Restore call on
// each object in the manifest.
S3InitiateRestoreObject *S3InitiateRestoreObjectOperation `type:"structure"`
// Directs the specified job to execute a PUT Object acl call on each object
// in the manifest.
S3PutObjectAcl *S3SetObjectAclOperation `type:"structure"`
// Directs the specified job to execute a PUT Copy object call on each object
// in the manifest.
S3PutObjectCopy *S3CopyObjectOperation `type:"structure"`
// Directs the specified job to execute a PUT Object tagging call on each object
// in the manifest.
S3PutObjectTagging *S3SetObjectTaggingOperation `type:"structure"`
}
// String returns the string representation
func (s JobOperation) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *JobOperation) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "JobOperation"}
if s.LambdaInvoke != nil {
if err := s.LambdaInvoke.Validate(); err != nil {
invalidParams.AddNested("LambdaInvoke", err.(aws.ErrInvalidParams))
}
}
if s.S3PutObjectAcl != nil {
if err := s.S3PutObjectAcl.Validate(); err != nil {
invalidParams.AddNested("S3PutObjectAcl", err.(aws.ErrInvalidParams))
}
}
if s.S3PutObjectCopy != nil {
if err := s.S3PutObjectCopy.Validate(); err != nil {
invalidParams.AddNested("S3PutObjectCopy", err.(aws.ErrInvalidParams))
}
}
if s.S3PutObjectTagging != nil {
if err := s.S3PutObjectTagging.Validate(); err != nil {
invalidParams.AddNested("S3PutObjectTagging", err.(aws.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s JobOperation) MarshalFields(e protocol.FieldEncoder) error {
if s.LambdaInvoke != nil {
v := s.LambdaInvoke
metadata := protocol.Metadata{}
e.SetFields(protocol.BodyTarget, "LambdaInvoke", v, metadata)
}
if s.S3InitiateRestoreObject != nil {
v := s.S3InitiateRestoreObject
metadata := protocol.Metadata{}
e.SetFields(protocol.BodyTarget, "S3InitiateRestoreObject", v, metadata)
}
if s.S3PutObjectAcl != nil {
v := s.S3PutObjectAcl
metadata := protocol.Metadata{}
e.SetFields(protocol.BodyTarget, "S3PutObjectAcl", v, metadata)
}
if s.S3PutObjectCopy != nil {
v := s.S3PutObjectCopy
metadata := protocol.Metadata{}
e.SetFields(protocol.BodyTarget, "S3PutObjectCopy", v, metadata)
}
if s.S3PutObjectTagging != nil {
v := s.S3PutObjectTagging
metadata := protocol.Metadata{}
e.SetFields(protocol.BodyTarget, "S3PutObjectTagging", v, metadata)
}
return nil
}
// Describes the total number of tasks that the specified job has executed,
// the number of tasks that succeeded, and the number of tasks that failed.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/JobProgressSummary
type JobProgressSummary struct {
_ struct{} `type:"structure"`
NumberOfTasksFailed *int64 `type:"long"`
NumberOfTasksSucceeded *int64 `type:"long"`
TotalNumberOfTasks *int64 `type:"long"`
}
// String returns the string representation
func (s JobProgressSummary) String() string {
return awsutil.Prettify(s)
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s JobProgressSummary) MarshalFields(e protocol.FieldEncoder) error {
if s.NumberOfTasksFailed != nil {
v := *s.NumberOfTasksFailed
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "NumberOfTasksFailed", protocol.Int64Value(v), metadata)
}
if s.NumberOfTasksSucceeded != nil {
v := *s.NumberOfTasksSucceeded
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "NumberOfTasksSucceeded", protocol.Int64Value(v), metadata)
}
if s.TotalNumberOfTasks != nil {
v := *s.TotalNumberOfTasks
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "TotalNumberOfTasks", protocol.Int64Value(v), metadata)
}
return nil
}
// Contains the configuration parameters for a job-completion report.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/JobReport
type JobReport struct {
_ struct{} `type:"structure"`
// The bucket where specified job-completion report will be stored.
Bucket *string `min:"1" type:"string"`
// Indicates whether the specified job will generate a job-completion report.
//
// Enabled is a required field
Enabled *bool `type:"boolean" required:"true"`
// The format of the specified job-completion report.
Format JobReportFormat `type:"string" enum:"true"`
// An optional prefix to describe where in the specified bucket the job-completion
// report will be stored. Amazon S3 will store the job-completion report at
// <prefix>/job-<job-id>/report.json.
Prefix *string `min:"1" type:"string"`
// Indicates whether the job-completion report will include details of all tasks
// or only failed tasks.
ReportScope JobReportScope `type:"string" enum:"true"`
}
// String returns the string representation
func (s JobReport) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *JobReport) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "JobReport"}
if s.Bucket != nil && len(*s.Bucket) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("Bucket", 1))
}
if s.Enabled == nil {
invalidParams.Add(aws.NewErrParamRequired("Enabled"))
}
if s.Prefix != nil && len(*s.Prefix) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("Prefix", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s JobReport) MarshalFields(e protocol.FieldEncoder) error {
if s.Bucket != nil {
v := *s.Bucket
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "Bucket", protocol.StringValue(v), metadata)
}
if s.Enabled != nil {
v := *s.Enabled
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "Enabled", protocol.BoolValue(v), metadata)
}
if len(s.Format) > 0 {
v := s.Format
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "Format", v, metadata)
}
if s.Prefix != nil {
v := *s.Prefix
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "Prefix", protocol.StringValue(v), metadata)
}
if len(s.ReportScope) > 0 {
v := s.ReportScope
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "ReportScope", v, metadata)
}
return nil
}
// Contains the configuration parameters for a Lambda Invoke operation.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/LambdaInvokeOperation
type LambdaInvokeOperation struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) for the AWS Lambda function that the specified
// job will invoke for each object in the manifest.
FunctionArn *string `min:"1" type:"string"`
}
// String returns the string representation
func (s LambdaInvokeOperation) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *LambdaInvokeOperation) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "LambdaInvokeOperation"}
if s.FunctionArn != nil && len(*s.FunctionArn) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("FunctionArn", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s LambdaInvokeOperation) MarshalFields(e protocol.FieldEncoder) error {
if s.FunctionArn != nil {
v := *s.FunctionArn
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "FunctionArn", protocol.StringValue(v), metadata)
}
return nil
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PublicAccessBlockConfiguration
type PublicAccessBlockConfiguration struct {
_ struct{} `type:"structure"`
BlockPublicAcls *bool `locationName:"BlockPublicAcls" type:"boolean"`
BlockPublicPolicy *bool `locationName:"BlockPublicPolicy" type:"boolean"`
IgnorePublicAcls *bool `locationName:"IgnorePublicAcls" type:"boolean"`
RestrictPublicBuckets *bool `locationName:"RestrictPublicBuckets" type:"boolean"`
}
// String returns the string representation
func (s PublicAccessBlockConfiguration) String() string {
return awsutil.Prettify(s)
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s PublicAccessBlockConfiguration) MarshalFields(e protocol.FieldEncoder) error {
if s.BlockPublicAcls != nil {
v := *s.BlockPublicAcls
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "BlockPublicAcls", protocol.BoolValue(v), metadata)
}
if s.BlockPublicPolicy != nil {
v := *s.BlockPublicPolicy
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "BlockPublicPolicy", protocol.BoolValue(v), metadata)
}
if s.IgnorePublicAcls != nil {
v := *s.IgnorePublicAcls
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "IgnorePublicAcls", protocol.BoolValue(v), metadata)
}
if s.RestrictPublicBuckets != nil {
v := *s.RestrictPublicBuckets
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "RestrictPublicBuckets", protocol.BoolValue(v), metadata)
}
return nil
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/S3AccessControlList
type S3AccessControlList struct {
_ struct{} `type:"structure"`
Grants []S3Grant `type:"list"`
// Owner is a required field
Owner *S3ObjectOwner `type:"structure" required:"true"`
}
// String returns the string representation
func (s S3AccessControlList) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *S3AccessControlList) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "S3AccessControlList"}
if s.Owner == nil {
invalidParams.Add(aws.NewErrParamRequired("Owner"))
}
if s.Grants != nil {
for i, v := range s.Grants {
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Grants", i), err.(aws.ErrInvalidParams))
}
}
}
if s.Owner != nil {
if err := s.Owner.Validate(); err != nil {
invalidParams.AddNested("Owner", err.(aws.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s S3AccessControlList) MarshalFields(e protocol.FieldEncoder) error {
if s.Grants != nil {
v := s.Grants
metadata := protocol.Metadata{}
ls0 := e.List(protocol.BodyTarget, "Grants", metadata)
ls0.Start()
for _, v1 := range v {
ls0.ListAddFields(v1)
}
ls0.End()
}
if s.Owner != nil {
v := s.Owner
metadata := protocol.Metadata{}
e.SetFields(protocol.BodyTarget, "Owner", v, metadata)
}
return nil
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/S3AccessControlPolicy
type S3AccessControlPolicy struct {
_ struct{} `type:"structure"`
AccessControlList *S3AccessControlList `type:"structure"`
CannedAccessControlList S3CannedAccessControlList `type:"string" enum:"true"`
}
// String returns the string representation
func (s S3AccessControlPolicy) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *S3AccessControlPolicy) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "S3AccessControlPolicy"}
if s.AccessControlList != nil {
if err := s.AccessControlList.Validate(); err != nil {
invalidParams.AddNested("AccessControlList", err.(aws.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s S3AccessControlPolicy) MarshalFields(e protocol.FieldEncoder) error {
if s.AccessControlList != nil {
v := s.AccessControlList
metadata := protocol.Metadata{}
e.SetFields(protocol.BodyTarget, "AccessControlList", v, metadata)
}
if len(s.CannedAccessControlList) > 0 {
v := s.CannedAccessControlList
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "CannedAccessControlList", v, metadata)
}
return nil
}
// Contains the configuration parameters for a PUT Copy object operation. Amazon
// S3 batch operations passes each value through to the underlying PUT Copy
// object API. For more information about the parameters for this operation,
// see PUT Object - Copy (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectCOPY.html).
// Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/S3CopyObjectOperation
type S3CopyObjectOperation struct {
_ struct{} `type:"structure"`
AccessControlGrants []S3Grant `type:"list"`
CannedAccessControlList S3CannedAccessControlList `type:"string" enum:"true"`
MetadataDirective S3MetadataDirective `type:"string" enum:"true"`
ModifiedSinceConstraint *time.Time `type:"timestamp"`
NewObjectMetadata *S3ObjectMetadata `type:"structure"`
NewObjectTagging []S3Tag `type:"list"`
ObjectLockLegalHoldStatus S3ObjectLockLegalHoldStatus `type:"string" enum:"true"`
ObjectLockMode S3ObjectLockMode `type:"string" enum:"true"`
ObjectLockRetainUntilDate *time.Time `type:"timestamp"`
RedirectLocation *string `min:"1" type:"string"`
RequesterPays *bool `type:"boolean"`
SSEAwsKmsKeyId *string `min:"1" type:"string"`
StorageClass S3StorageClass `type:"string" enum:"true"`
TargetKeyPrefix *string `min:"1" type:"string"`
TargetResource *string `min:"1" type:"string"`
UnModifiedSinceConstraint *time.Time `type:"timestamp"`
}
// String returns the string representation
func (s S3CopyObjectOperation) String() string {
return awsutil.Prettify(s)
}