forked from aws/aws-sdk-go-v2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.go
2357 lines (1963 loc) · 79.5 KB
/
api.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package efs
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"
"github.com/aws/aws-sdk-go-v2/private/protocol/restjson"
)
const opCreateFileSystem = "CreateFileSystem"
// CreateFileSystemRequest is a API request type for the CreateFileSystem API operation.
type CreateFileSystemRequest struct {
*aws.Request
Input *CreateFileSystemInput
Copy func(*CreateFileSystemInput) CreateFileSystemRequest
}
// Send marshals and sends the CreateFileSystem API request.
func (r CreateFileSystemRequest) Send() (*CreateFileSystemOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*CreateFileSystemOutput), nil
}
// CreateFileSystemRequest returns a request value for making API operation for
// Amazon Elastic File System.
//
// Creates a new, empty file system. The operation requires a creation token
// in the request that Amazon EFS uses to ensure idempotent creation (calling
// the operation with same creation token has no effect). If a file system does
// not currently exist that is owned by the caller's AWS account with the specified
// creation token, this operation does the following:
//
// * Creates a new, empty file system. The file system will have an Amazon
// EFS assigned ID, and an initial lifecycle state creating.
//
// * Returns with the description of the created file system.
//
// Otherwise, this operation returns a FileSystemAlreadyExists error with the
// ID of the existing file system.
//
// For basic use cases, you can use a randomly generated UUID for the creation
// token.
//
// The idempotent operation allows you to retry a CreateFileSystem call without
// risk of creating an extra file system. This can happen when an initial call
// fails in a way that leaves it uncertain whether or not a file system was
// actually created. An example might be that a transport level timeout occurred
// or your connection was reset. As long as you use the same creation token,
// if the initial call had succeeded in creating a file system, the client can
// learn of its existence from the FileSystemAlreadyExists error.
//
// The CreateFileSystem call returns while the file system's lifecycle state
// is still creating. You can check the file system creation status by calling
// the DescribeFileSystems operation, which among other things returns the file
// system state.
//
// This operation also takes an optional PerformanceMode parameter that you
// choose for your file system. We recommend generalPurpose performance mode
// for most file systems. File systems using the maxIO performance mode can
// scale to higher levels of aggregate throughput and operations per second
// with a tradeoff of slightly higher latencies for most file operations. The
// performance mode can't be changed after the file system has been created.
// For more information, see Amazon EFS: Performance Modes (http://docs.aws.amazon.com/efs/latest/ug/performance.html#performancemodes.html).
//
// After the file system is fully created, Amazon EFS sets its lifecycle state
// to available, at which point you can create one or more mount targets for
// the file system in your VPC. For more information, see CreateMountTarget.
// You mount your Amazon EFS file system on an EC2 instances in your VPC via
// the mount target. For more information, see Amazon EFS: How it Works (http://docs.aws.amazon.com/efs/latest/ug/how-it-works.html).
//
// This operation requires permissions for the elasticfilesystem:CreateFileSystem
// action.
//
// // Example sending a request using the CreateFileSystemRequest method.
// req := client.CreateFileSystemRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateFileSystem
func (c *EFS) CreateFileSystemRequest(input *CreateFileSystemInput) CreateFileSystemRequest {
op := &aws.Operation{
Name: opCreateFileSystem,
HTTPMethod: "POST",
HTTPPath: "/2015-02-01/file-systems",
}
if input == nil {
input = &CreateFileSystemInput{}
}
output := &CreateFileSystemOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return CreateFileSystemRequest{Request: req, Input: input, Copy: c.CreateFileSystemRequest}
}
const opCreateMountTarget = "CreateMountTarget"
// CreateMountTargetRequest is a API request type for the CreateMountTarget API operation.
type CreateMountTargetRequest struct {
*aws.Request
Input *CreateMountTargetInput
Copy func(*CreateMountTargetInput) CreateMountTargetRequest
}
// Send marshals and sends the CreateMountTarget API request.
func (r CreateMountTargetRequest) Send() (*CreateMountTargetOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*CreateMountTargetOutput), nil
}
// CreateMountTargetRequest returns a request value for making API operation for
// Amazon Elastic File System.
//
// Creates a mount target for a file system. You can then mount the file system
// on EC2 instances via the mount target.
//
// You can create one mount target in each Availability Zone in your VPC. All
// EC2 instances in a VPC within a given Availability Zone share a single mount
// target for a given file system. If you have multiple subnets in an Availability
// Zone, you create a mount target in one of the subnets. EC2 instances do not
// need to be in the same subnet as the mount target in order to access their
// file system. For more information, see Amazon EFS: How it Works (http://docs.aws.amazon.com/efs/latest/ug/how-it-works.html).
//
// In the request, you also specify a file system ID for which you are creating
// the mount target and the file system's lifecycle state must be available.
// For more information, see DescribeFileSystems.
//
// In the request, you also provide a subnet ID, which determines the following:
//
// * VPC in which Amazon EFS creates the mount target
//
// * Availability Zone in which Amazon EFS creates the mount target
//
// * IP address range from which Amazon EFS selects the IP address of the
// mount target (if you don't specify an IP address in the request)
//
// After creating the mount target, Amazon EFS returns a response that includes,
// a MountTargetId and an IpAddress. You use this IP address when mounting the
// file system in an EC2 instance. You can also use the mount target's DNS name
// when mounting the file system. The EC2 instance on which you mount the file
// system via the mount target can resolve the mount target's DNS name to its
// IP address. For more information, see How it Works: Implementation Overview
// (http://docs.aws.amazon.com/efs/latest/ug/how-it-works.html#how-it-works-implementation).
//
// Note that you can create mount targets for a file system in only one VPC,
// and there can be only one mount target per Availability Zone. That is, if
// the file system already has one or more mount targets created for it, the
// subnet specified in the request to add another mount target must meet the
// following requirements:
//
// * Must belong to the same VPC as the subnets of the existing mount targets
//
// * Must not be in the same Availability Zone as any of the subnets of the
// existing mount targets
//
// If the request satisfies the requirements, Amazon EFS does the following:
//
// * Creates a new mount target in the specified subnet.
//
// * Also creates a new network interface in the subnet as follows:
//
// If the request provides an IpAddress, Amazon EFS assigns that IP address
// to the network interface. Otherwise, Amazon EFS assigns a free address
// in the subnet (in the same way that the Amazon EC2 CreateNetworkInterface
// call does when a request does not specify a primary private IP address).
//
// If the request provides SecurityGroups, this network interface is associated
// with those security groups. Otherwise, it belongs to the default security
// group for the subnet's VPC.
//
// Assigns the description Mount target fsmt-id for file system fs-id where
// fsmt-id is the mount target ID, and fs-id is the FileSystemId.
//
// Sets the requesterManaged property of the network interface to true, and
// the requesterId value to EFS.
//
// Each Amazon EFS mount target has one corresponding requester-managed EC2
// network interface. After the network interface is created, Amazon EFS
// sets the NetworkInterfaceId field in the mount target's description to
// the network interface ID, and the IpAddress field to its address. If network
// interface creation fails, the entire CreateMountTarget operation fails.
//
// The CreateMountTarget call returns only after creating the network interface,
// but while the mount target state is still creating, you can check the mount
// target creation status by calling the DescribeMountTargets operation, which
// among other things returns the mount target state.
//
// We recommend you create a mount target in each of the Availability Zones.
// There are cost considerations for using a file system in an Availability
// Zone through a mount target created in another Availability Zone. For more
// information, see Amazon EFS (http://aws.amazon.com/efs/). In addition, by
// always using a mount target local to the instance's Availability Zone, you
// eliminate a partial failure scenario. If the Availability Zone in which your
// mount target is created goes down, then you won't be able to access your
// file system through that mount target.
//
// This operation requires permissions for the following action on the file
// system:
//
// * elasticfilesystem:CreateMountTarget
//
// This operation also requires permissions for the following Amazon EC2 actions:
//
// * ec2:DescribeSubnets
//
// * ec2:DescribeNetworkInterfaces
//
// * ec2:CreateNetworkInterface
//
// // Example sending a request using the CreateMountTargetRequest method.
// req := client.CreateMountTargetRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateMountTarget
func (c *EFS) CreateMountTargetRequest(input *CreateMountTargetInput) CreateMountTargetRequest {
op := &aws.Operation{
Name: opCreateMountTarget,
HTTPMethod: "POST",
HTTPPath: "/2015-02-01/mount-targets",
}
if input == nil {
input = &CreateMountTargetInput{}
}
output := &CreateMountTargetOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return CreateMountTargetRequest{Request: req, Input: input, Copy: c.CreateMountTargetRequest}
}
const opCreateTags = "CreateTags"
// CreateTagsRequest is a API request type for the CreateTags API operation.
type CreateTagsRequest struct {
*aws.Request
Input *CreateTagsInput
Copy func(*CreateTagsInput) CreateTagsRequest
}
// Send marshals and sends the CreateTags API request.
func (r CreateTagsRequest) Send() (*CreateTagsOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*CreateTagsOutput), nil
}
// CreateTagsRequest returns a request value for making API operation for
// Amazon Elastic File System.
//
// Creates or overwrites tags associated with a file system. Each tag is a key-value
// pair. If a tag key specified in the request already exists on the file system,
// this operation overwrites its value with the value provided in the request.
// If you add the Name tag to your file system, Amazon EFS returns it in the
// response to the DescribeFileSystems operation.
//
// This operation requires permission for the elasticfilesystem:CreateTags action.
//
// // Example sending a request using the CreateTagsRequest method.
// req := client.CreateTagsRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateTags
func (c *EFS) CreateTagsRequest(input *CreateTagsInput) CreateTagsRequest {
op := &aws.Operation{
Name: opCreateTags,
HTTPMethod: "POST",
HTTPPath: "/2015-02-01/create-tags/{FileSystemId}",
}
if input == nil {
input = &CreateTagsInput{}
}
output := &CreateTagsOutput{}
req := c.newRequest(op, input, output)
req.Handlers.Unmarshal.Remove(restjson.UnmarshalHandler)
req.Handlers.Unmarshal.PushBackNamed(protocol.UnmarshalDiscardBodyHandler)
output.responseMetadata = aws.Response{Request: req}
return CreateTagsRequest{Request: req, Input: input, Copy: c.CreateTagsRequest}
}
const opDeleteFileSystem = "DeleteFileSystem"
// DeleteFileSystemRequest is a API request type for the DeleteFileSystem API operation.
type DeleteFileSystemRequest struct {
*aws.Request
Input *DeleteFileSystemInput
Copy func(*DeleteFileSystemInput) DeleteFileSystemRequest
}
// Send marshals and sends the DeleteFileSystem API request.
func (r DeleteFileSystemRequest) Send() (*DeleteFileSystemOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*DeleteFileSystemOutput), nil
}
// DeleteFileSystemRequest returns a request value for making API operation for
// Amazon Elastic File System.
//
// Deletes a file system, permanently severing access to its contents. Upon
// return, the file system no longer exists and you can't access any contents
// of the deleted file system.
//
// You can't delete a file system that is in use. That is, if the file system
// has any mount targets, you must first delete them. For more information,
// see DescribeMountTargets and DeleteMountTarget.
//
// The DeleteFileSystem call returns while the file system state is still deleting.
// You can check the file system deletion status by calling the DescribeFileSystems
// operation, which returns a list of file systems in your account. If you pass
// file system ID or creation token for the deleted file system, the DescribeFileSystems
// returns a 404 FileSystemNotFound error.
//
// This operation requires permissions for the elasticfilesystem:DeleteFileSystem
// action.
//
// // Example sending a request using the DeleteFileSystemRequest method.
// req := client.DeleteFileSystemRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteFileSystem
func (c *EFS) DeleteFileSystemRequest(input *DeleteFileSystemInput) DeleteFileSystemRequest {
op := &aws.Operation{
Name: opDeleteFileSystem,
HTTPMethod: "DELETE",
HTTPPath: "/2015-02-01/file-systems/{FileSystemId}",
}
if input == nil {
input = &DeleteFileSystemInput{}
}
output := &DeleteFileSystemOutput{}
req := c.newRequest(op, input, output)
req.Handlers.Unmarshal.Remove(restjson.UnmarshalHandler)
req.Handlers.Unmarshal.PushBackNamed(protocol.UnmarshalDiscardBodyHandler)
output.responseMetadata = aws.Response{Request: req}
return DeleteFileSystemRequest{Request: req, Input: input, Copy: c.DeleteFileSystemRequest}
}
const opDeleteMountTarget = "DeleteMountTarget"
// DeleteMountTargetRequest is a API request type for the DeleteMountTarget API operation.
type DeleteMountTargetRequest struct {
*aws.Request
Input *DeleteMountTargetInput
Copy func(*DeleteMountTargetInput) DeleteMountTargetRequest
}
// Send marshals and sends the DeleteMountTarget API request.
func (r DeleteMountTargetRequest) Send() (*DeleteMountTargetOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*DeleteMountTargetOutput), nil
}
// DeleteMountTargetRequest returns a request value for making API operation for
// Amazon Elastic File System.
//
// Deletes the specified mount target.
//
// This operation forcibly breaks any mounts of the file system via the mount
// target that is being deleted, which might disrupt instances or applications
// using those mounts. To avoid applications getting cut off abruptly, you might
// consider unmounting any mounts of the mount target, if feasible. The operation
// also deletes the associated network interface. Uncommitted writes may be
// lost, but breaking a mount target using this operation does not corrupt the
// file system itself. The file system you created remains. You can mount an
// EC2 instance in your VPC via another mount target.
//
// This operation requires permissions for the following action on the file
// system:
//
// * elasticfilesystem:DeleteMountTarget
//
// The DeleteMountTarget call returns while the mount target state is still
// deleting. You can check the mount target deletion by calling the DescribeMountTargets
// operation, which returns a list of mount target descriptions for the given
// file system.
//
// The operation also requires permissions for the following Amazon EC2 action
// on the mount target's network interface:
//
// * ec2:DeleteNetworkInterface
//
// // Example sending a request using the DeleteMountTargetRequest method.
// req := client.DeleteMountTargetRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteMountTarget
func (c *EFS) DeleteMountTargetRequest(input *DeleteMountTargetInput) DeleteMountTargetRequest {
op := &aws.Operation{
Name: opDeleteMountTarget,
HTTPMethod: "DELETE",
HTTPPath: "/2015-02-01/mount-targets/{MountTargetId}",
}
if input == nil {
input = &DeleteMountTargetInput{}
}
output := &DeleteMountTargetOutput{}
req := c.newRequest(op, input, output)
req.Handlers.Unmarshal.Remove(restjson.UnmarshalHandler)
req.Handlers.Unmarshal.PushBackNamed(protocol.UnmarshalDiscardBodyHandler)
output.responseMetadata = aws.Response{Request: req}
return DeleteMountTargetRequest{Request: req, Input: input, Copy: c.DeleteMountTargetRequest}
}
const opDeleteTags = "DeleteTags"
// DeleteTagsRequest is a API request type for the DeleteTags API operation.
type DeleteTagsRequest struct {
*aws.Request
Input *DeleteTagsInput
Copy func(*DeleteTagsInput) DeleteTagsRequest
}
// Send marshals and sends the DeleteTags API request.
func (r DeleteTagsRequest) Send() (*DeleteTagsOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*DeleteTagsOutput), nil
}
// DeleteTagsRequest returns a request value for making API operation for
// Amazon Elastic File System.
//
// Deletes the specified tags from a file system. If the DeleteTags request
// includes a tag key that does not exist, Amazon EFS ignores it and doesn't
// cause an error. For more information about tags and related restrictions,
// see Tag Restrictions (http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html)
// in the AWS Billing and Cost Management User Guide.
//
// This operation requires permissions for the elasticfilesystem:DeleteTags
// action.
//
// // Example sending a request using the DeleteTagsRequest method.
// req := client.DeleteTagsRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteTags
func (c *EFS) DeleteTagsRequest(input *DeleteTagsInput) DeleteTagsRequest {
op := &aws.Operation{
Name: opDeleteTags,
HTTPMethod: "POST",
HTTPPath: "/2015-02-01/delete-tags/{FileSystemId}",
}
if input == nil {
input = &DeleteTagsInput{}
}
output := &DeleteTagsOutput{}
req := c.newRequest(op, input, output)
req.Handlers.Unmarshal.Remove(restjson.UnmarshalHandler)
req.Handlers.Unmarshal.PushBackNamed(protocol.UnmarshalDiscardBodyHandler)
output.responseMetadata = aws.Response{Request: req}
return DeleteTagsRequest{Request: req, Input: input, Copy: c.DeleteTagsRequest}
}
const opDescribeFileSystems = "DescribeFileSystems"
// DescribeFileSystemsRequest is a API request type for the DescribeFileSystems API operation.
type DescribeFileSystemsRequest struct {
*aws.Request
Input *DescribeFileSystemsInput
Copy func(*DescribeFileSystemsInput) DescribeFileSystemsRequest
}
// Send marshals and sends the DescribeFileSystems API request.
func (r DescribeFileSystemsRequest) Send() (*DescribeFileSystemsOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*DescribeFileSystemsOutput), nil
}
// DescribeFileSystemsRequest returns a request value for making API operation for
// Amazon Elastic File System.
//
// Returns the description of a specific Amazon EFS file system if either the
// file system CreationToken or the FileSystemId is provided. Otherwise, it
// returns descriptions of all file systems owned by the caller's AWS account
// in the AWS Region of the endpoint that you're calling.
//
// When retrieving all file system descriptions, you can optionally specify
// the MaxItems parameter to limit the number of descriptions in a response.
// If more file system descriptions remain, Amazon EFS returns a NextMarker,
// an opaque token, in the response. In this case, you should send a subsequent
// request with the Marker request parameter set to the value of NextMarker.
//
// To retrieve a list of your file system descriptions, this operation is used
// in an iterative process, where DescribeFileSystems is called first without
// the Marker and then the operation continues to call it with the Marker parameter
// set to the value of the NextMarker from the previous response until the response
// has no NextMarker.
//
// The implementation may return fewer than MaxItems file system descriptions
// while still including a NextMarker value.
//
// The order of file systems returned in the response of one DescribeFileSystems
// call and the order of file systems returned across the responses of a multi-call
// iteration is unspecified.
//
// This operation requires permissions for the elasticfilesystem:DescribeFileSystems
// action.
//
// // Example sending a request using the DescribeFileSystemsRequest method.
// req := client.DescribeFileSystemsRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeFileSystems
func (c *EFS) DescribeFileSystemsRequest(input *DescribeFileSystemsInput) DescribeFileSystemsRequest {
op := &aws.Operation{
Name: opDescribeFileSystems,
HTTPMethod: "GET",
HTTPPath: "/2015-02-01/file-systems",
}
if input == nil {
input = &DescribeFileSystemsInput{}
}
output := &DescribeFileSystemsOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return DescribeFileSystemsRequest{Request: req, Input: input, Copy: c.DescribeFileSystemsRequest}
}
const opDescribeMountTargetSecurityGroups = "DescribeMountTargetSecurityGroups"
// DescribeMountTargetSecurityGroupsRequest is a API request type for the DescribeMountTargetSecurityGroups API operation.
type DescribeMountTargetSecurityGroupsRequest struct {
*aws.Request
Input *DescribeMountTargetSecurityGroupsInput
Copy func(*DescribeMountTargetSecurityGroupsInput) DescribeMountTargetSecurityGroupsRequest
}
// Send marshals and sends the DescribeMountTargetSecurityGroups API request.
func (r DescribeMountTargetSecurityGroupsRequest) Send() (*DescribeMountTargetSecurityGroupsOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*DescribeMountTargetSecurityGroupsOutput), nil
}
// DescribeMountTargetSecurityGroupsRequest returns a request value for making API operation for
// Amazon Elastic File System.
//
// Returns the security groups currently in effect for a mount target. This
// operation requires that the network interface of the mount target has been
// created and the lifecycle state of the mount target is not deleted.
//
// This operation requires permissions for the following actions:
//
// * elasticfilesystem:DescribeMountTargetSecurityGroups action on the mount
// target's file system.
//
// * ec2:DescribeNetworkInterfaceAttribute action on the mount target's network
// interface.
//
// // Example sending a request using the DescribeMountTargetSecurityGroupsRequest method.
// req := client.DescribeMountTargetSecurityGroupsRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeMountTargetSecurityGroups
func (c *EFS) DescribeMountTargetSecurityGroupsRequest(input *DescribeMountTargetSecurityGroupsInput) DescribeMountTargetSecurityGroupsRequest {
op := &aws.Operation{
Name: opDescribeMountTargetSecurityGroups,
HTTPMethod: "GET",
HTTPPath: "/2015-02-01/mount-targets/{MountTargetId}/security-groups",
}
if input == nil {
input = &DescribeMountTargetSecurityGroupsInput{}
}
output := &DescribeMountTargetSecurityGroupsOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return DescribeMountTargetSecurityGroupsRequest{Request: req, Input: input, Copy: c.DescribeMountTargetSecurityGroupsRequest}
}
const opDescribeMountTargets = "DescribeMountTargets"
// DescribeMountTargetsRequest is a API request type for the DescribeMountTargets API operation.
type DescribeMountTargetsRequest struct {
*aws.Request
Input *DescribeMountTargetsInput
Copy func(*DescribeMountTargetsInput) DescribeMountTargetsRequest
}
// Send marshals and sends the DescribeMountTargets API request.
func (r DescribeMountTargetsRequest) Send() (*DescribeMountTargetsOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*DescribeMountTargetsOutput), nil
}
// DescribeMountTargetsRequest returns a request value for making API operation for
// Amazon Elastic File System.
//
// Returns the descriptions of all the current mount targets, or a specific
// mount target, for a file system. When requesting all of the current mount
// targets, the order of mount targets returned in the response is unspecified.
//
// This operation requires permissions for the elasticfilesystem:DescribeMountTargets
// action, on either the file system ID that you specify in FileSystemId, or
// on the file system of the mount target that you specify in MountTargetId.
//
// // Example sending a request using the DescribeMountTargetsRequest method.
// req := client.DescribeMountTargetsRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeMountTargets
func (c *EFS) DescribeMountTargetsRequest(input *DescribeMountTargetsInput) DescribeMountTargetsRequest {
op := &aws.Operation{
Name: opDescribeMountTargets,
HTTPMethod: "GET",
HTTPPath: "/2015-02-01/mount-targets",
}
if input == nil {
input = &DescribeMountTargetsInput{}
}
output := &DescribeMountTargetsOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return DescribeMountTargetsRequest{Request: req, Input: input, Copy: c.DescribeMountTargetsRequest}
}
const opDescribeTags = "DescribeTags"
// DescribeTagsRequest is a API request type for the DescribeTags API operation.
type DescribeTagsRequest struct {
*aws.Request
Input *DescribeTagsInput
Copy func(*DescribeTagsInput) DescribeTagsRequest
}
// Send marshals and sends the DescribeTags API request.
func (r DescribeTagsRequest) Send() (*DescribeTagsOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*DescribeTagsOutput), nil
}
// DescribeTagsRequest returns a request value for making API operation for
// Amazon Elastic File System.
//
// Returns the tags associated with a file system. The order of tags returned
// in the response of one DescribeTags call and the order of tags returned across
// the responses of a multi-call iteration (when using pagination) is unspecified.
//
// This operation requires permissions for the elasticfilesystem:DescribeTags
// action.
//
// // Example sending a request using the DescribeTagsRequest method.
// req := client.DescribeTagsRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeTags
func (c *EFS) DescribeTagsRequest(input *DescribeTagsInput) DescribeTagsRequest {
op := &aws.Operation{
Name: opDescribeTags,
HTTPMethod: "GET",
HTTPPath: "/2015-02-01/tags/{FileSystemId}/",
}
if input == nil {
input = &DescribeTagsInput{}
}
output := &DescribeTagsOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return DescribeTagsRequest{Request: req, Input: input, Copy: c.DescribeTagsRequest}
}
const opModifyMountTargetSecurityGroups = "ModifyMountTargetSecurityGroups"
// ModifyMountTargetSecurityGroupsRequest is a API request type for the ModifyMountTargetSecurityGroups API operation.
type ModifyMountTargetSecurityGroupsRequest struct {
*aws.Request
Input *ModifyMountTargetSecurityGroupsInput
Copy func(*ModifyMountTargetSecurityGroupsInput) ModifyMountTargetSecurityGroupsRequest
}
// Send marshals and sends the ModifyMountTargetSecurityGroups API request.
func (r ModifyMountTargetSecurityGroupsRequest) Send() (*ModifyMountTargetSecurityGroupsOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*ModifyMountTargetSecurityGroupsOutput), nil
}
// ModifyMountTargetSecurityGroupsRequest returns a request value for making API operation for
// Amazon Elastic File System.
//
// Modifies the set of security groups in effect for a mount target.
//
// When you create a mount target, Amazon EFS also creates a new network interface.
// For more information, see CreateMountTarget. This operation replaces the
// security groups in effect for the network interface associated with a mount
// target, with the SecurityGroups provided in the request. This operation requires
// that the network interface of the mount target has been created and the lifecycle
// state of the mount target is not deleted.
//
// The operation requires permissions for the following actions:
//
// * elasticfilesystem:ModifyMountTargetSecurityGroups action on the mount
// target's file system.
//
// * ec2:ModifyNetworkInterfaceAttribute action on the mount target's network
// interface.
//
// // Example sending a request using the ModifyMountTargetSecurityGroupsRequest method.
// req := client.ModifyMountTargetSecurityGroupsRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/ModifyMountTargetSecurityGroups
func (c *EFS) ModifyMountTargetSecurityGroupsRequest(input *ModifyMountTargetSecurityGroupsInput) ModifyMountTargetSecurityGroupsRequest {
op := &aws.Operation{
Name: opModifyMountTargetSecurityGroups,
HTTPMethod: "PUT",
HTTPPath: "/2015-02-01/mount-targets/{MountTargetId}/security-groups",
}
if input == nil {
input = &ModifyMountTargetSecurityGroupsInput{}
}
output := &ModifyMountTargetSecurityGroupsOutput{}
req := c.newRequest(op, input, output)
req.Handlers.Unmarshal.Remove(restjson.UnmarshalHandler)
req.Handlers.Unmarshal.PushBackNamed(protocol.UnmarshalDiscardBodyHandler)
output.responseMetadata = aws.Response{Request: req}
return ModifyMountTargetSecurityGroupsRequest{Request: req, Input: input, Copy: c.ModifyMountTargetSecurityGroupsRequest}
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateFileSystemRequest
type CreateFileSystemInput struct {
_ struct{} `type:"structure"`
// String of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent
// creation.
//
// CreationToken is a required field
CreationToken *string `min:"1" type:"string" required:"true"`
// A boolean value that, if true, creates an encrypted file system. When creating
// an encrypted file system, you have the option of specifying a CreateFileSystemRequest$KmsKeyId
// for an existing AWS Key Management Service (AWS KMS) customer master key
// (CMK). If you don't specify a CMK, then the default CMK for Amazon EFS, /aws/elasticfilesystem,
// is used to protect the encrypted file system.
Encrypted *bool `type:"boolean"`
// The id of the AWS KMS CMK that will be used to protect the encrypted file
// system. This parameter is only required if you want to use a non-default
// CMK. If this parameter is not specified, the default CMK for Amazon EFS is
// used. This id can be in one of the following formats:
//
// * Key ID - A unique identifier of the key. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
//
// * ARN - An Amazon Resource Name for the key. For example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
//
// * Key alias - A previously created display name for a key. For example,
// alias/projectKey1.
//
// * Key alias ARN - An Amazon Resource Name for a key alias. For example,
// arn:aws:kms:us-west-2:444455556666:alias/projectKey1.
//
// Note that if the KmsKeyId is specified, the CreateFileSystemRequest$Encrypted
// parameter must be set to true.
KmsKeyId *string `min:"1" type:"string"`
// The PerformanceMode of the file system. We recommend generalPurpose performance
// mode for most file systems. File systems using the maxIO performance mode
// can scale to higher levels of aggregate throughput and operations per second
// with a tradeoff of slightly higher latencies for most file operations. This
// can't be changed after the file system has been created.
PerformanceMode PerformanceMode `type:"string" enum:"true"`
}
// String returns the string representation
func (s CreateFileSystemInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s CreateFileSystemInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *CreateFileSystemInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "CreateFileSystemInput"}
if s.CreationToken == nil {
invalidParams.Add(aws.NewErrParamRequired("CreationToken"))
}
if s.CreationToken != nil && len(*s.CreationToken) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("CreationToken", 1))
}
if s.KmsKeyId != nil && len(*s.KmsKeyId) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("KmsKeyId", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s CreateFileSystemInput) MarshalFields(e protocol.FieldEncoder) error {
if s.CreationToken != nil {
v := *s.CreationToken
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "CreationToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.Encrypted != nil {
v := *s.Encrypted
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "Encrypted", protocol.BoolValue(v), metadata)
}
if s.KmsKeyId != nil {
v := *s.KmsKeyId
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "KmsKeyId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if len(s.PerformanceMode) > 0 {
v := s.PerformanceMode
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "PerformanceMode", protocol.QuotedValue{ValueMarshaler: v}, metadata)
}
return nil
}
// Description of the file system.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/FileSystemDescription
type CreateFileSystemOutput struct {
_ struct{} `type:"structure"`
responseMetadata aws.Response
// Time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
//
// CreationTime is a required field
CreationTime *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"`
// Opaque string specified in the request.
//
// CreationToken is a required field
CreationToken *string `min:"1" type:"string" required:"true"`
// A boolean value that, if true, indicates that the file system is encrypted.
Encrypted *bool `type:"boolean"`
// ID of the file system, assigned by Amazon EFS.
//
// FileSystemId is a required field
FileSystemId *string `type:"string" required:"true"`
// The id of an AWS Key Management Service (AWS KMS) customer master key (CMK)
// that was used to protect the encrypted file system.
KmsKeyId *string `min:"1" type:"string"`
// Lifecycle phase of the file system.
//
// LifeCycleState is a required field
LifeCycleState LifeCycleState `type:"string" required:"true" enum:"true"`
// You can add tags to a file system, including a Name tag. For more information,
// see CreateTags. If the file system has a Name tag, Amazon EFS returns the
// value in this field.
Name *string `type:"string"`
// Current number of mount targets that the file system has. For more information,
// see CreateMountTarget.
//
// NumberOfMountTargets is a required field
NumberOfMountTargets *int64 `type:"integer" required:"true"`
// AWS account that created the file system. If the file system was created
// by an IAM user, the parent account to which the user belongs is the owner.
//
// OwnerId is a required field
OwnerId *string `type:"string" required:"true"`
// The PerformanceMode of the file system.
//
// PerformanceMode is a required field
PerformanceMode PerformanceMode `type:"string" required:"true" enum:"true"`
// Latest known metered size (in bytes) of data stored in the file system, in
// bytes, in its Value field, and the time at which that size was determined
// in its Timestamp field. The Timestamp value is the integer number of seconds
// since 1970-01-01T00:00:00Z. Note that the value does not represent the size
// of a consistent snapshot of the file system, but it is eventually consistent
// when there are no writes to the file system. That is, the value will represent
// actual size only if the file system is not modified for a period longer than
// a couple of hours. Otherwise, the value is not the exact size the file system
// was at any instant in time.
//
// SizeInBytes is a required field
SizeInBytes *FileSystemSize `type:"structure" required:"true"`
}