-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
api.go
11468 lines (10088 loc) · 421 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/aws"
"github.com/aws/aws-sdk-go/aws/awsutil"
"github.com/aws/aws-sdk-go/aws/request"
"github.com/aws/aws-sdk-go/private/protocol"
"github.com/aws/aws-sdk-go/private/protocol/restjson"
)
const opCreateAccessPoint = "CreateAccessPoint"
// CreateAccessPointRequest generates a "aws/request.Request" representing the
// client's request for the CreateAccessPoint operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See CreateAccessPoint for more information on using the CreateAccessPoint
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the CreateAccessPointRequest method.
// req, resp := client.CreateAccessPointRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateAccessPoint
func (c *EFS) CreateAccessPointRequest(input *CreateAccessPointInput) (req *request.Request, output *CreateAccessPointOutput) {
op := &request.Operation{
Name: opCreateAccessPoint,
HTTPMethod: "POST",
HTTPPath: "/2015-02-01/access-points",
}
if input == nil {
input = &CreateAccessPointInput{}
}
output = &CreateAccessPointOutput{}
req = c.newRequest(op, input, output)
return
}
// CreateAccessPoint API operation for Amazon Elastic File System.
//
// Creates an EFS access point. An access point is an application-specific view
// into an EFS file system that applies an operating system user and group,
// and a file system path, to any file system request made through the access
// point. The operating system user and group override any identity information
// provided by the NFS client. The file system path is exposed as the access
// point's root directory. Applications using the access point can only access
// data in the application's own directory and any subdirectories. To learn
// more, see Mounting a file system using EFS access points (https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html).
//
// If multiple requests to create access points on the same file system are
// sent in quick succession, and the file system is near the limit of 1,000
// access points, you may experience a throttling response for these requests.
// This is to ensure that the file system does not exceed the stated access
// point limit.
//
// This operation requires permissions for the elasticfilesystem:CreateAccessPoint
// action.
//
// Access points can be tagged on creation. If tags are specified in the creation
// action, IAM performs additional authorization on the elasticfilesystem:TagResource
// action to verify if users have permissions to create tags. Therefore, you
// must grant explicit permissions to use the elasticfilesystem:TagResource
// action. For more information, see Granting permissions to tag resources during
// creation (https://docs.aws.amazon.com/efs/latest/ug/using-tags-efs.html#supported-iam-actions-tagging.html).
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Elastic File System's
// API operation CreateAccessPoint for usage and error information.
//
// Returned Error Types:
//
// - BadRequest
// Returned if the request is malformed or contains an error such as an invalid
// parameter value or a missing required parameter.
//
// - AccessPointAlreadyExists
// Returned if the access point that you are trying to create already exists,
// with the creation token you provided in the request.
//
// - IncorrectFileSystemLifeCycleState
// Returned if the file system's lifecycle state is not "available".
//
// - InternalServerError
// Returned if an error occurred on the server side.
//
// - FileSystemNotFound
// Returned if the specified FileSystemId value doesn't exist in the requester's
// Amazon Web Services account.
//
// - AccessPointLimitExceeded
// Returned if the Amazon Web Services account has already created the maximum
// number of access points allowed per file system. For more informaton, see
// https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region
// (https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region).
//
// - ThrottlingException
// Returned when the CreateAccessPoint API action is called too quickly and
// the number of Access Points on the file system is nearing the limit of 120
// (https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region).
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateAccessPoint
func (c *EFS) CreateAccessPoint(input *CreateAccessPointInput) (*CreateAccessPointOutput, error) {
req, out := c.CreateAccessPointRequest(input)
return out, req.Send()
}
// CreateAccessPointWithContext is the same as CreateAccessPoint with the addition of
// the ability to pass a context and additional request options.
//
// See CreateAccessPoint for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *EFS) CreateAccessPointWithContext(ctx aws.Context, input *CreateAccessPointInput, opts ...request.Option) (*CreateAccessPointOutput, error) {
req, out := c.CreateAccessPointRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opCreateFileSystem = "CreateFileSystem"
// CreateFileSystemRequest generates a "aws/request.Request" representing the
// client's request for the CreateFileSystem operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See CreateFileSystem for more information on using the CreateFileSystem
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the CreateFileSystemRequest method.
// req, resp := client.CreateFileSystemRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateFileSystem
func (c *EFS) CreateFileSystemRequest(input *CreateFileSystemInput) (req *request.Request, output *FileSystemDescription) {
op := &request.Operation{
Name: opCreateFileSystem,
HTTPMethod: "POST",
HTTPPath: "/2015-02-01/file-systems",
}
if input == nil {
input = &CreateFileSystemInput{}
}
output = &FileSystemDescription{}
req = c.newRequest(op, input, output)
return
}
// CreateFileSystem 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 Amazon Web Services 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.
//
// For more information, see Creating a file system (https://docs.aws.amazon.com/efs/latest/ug/creating-using-create-fs.html#creating-using-create-fs-part1)
// in the Amazon EFS User Guide.
//
// 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 accepts an optional PerformanceMode parameter that you choose
// for your file system. We recommend generalPurpose performance mode for all
// file systems. File systems using the maxIO mode is a previous generation
// performance type that is designed for highly parallelized workloads that
// can tolerate higher latencies than the General Purpose mode. Max I/O mode
// is not supported for One Zone file systems or file systems that use Elastic
// throughput.
//
// Due to the higher per-operation latencies with Max I/O, we recommend using
// General Purpose performance mode for all file systems.
//
// The performance mode can't be changed after the file system has been created.
// For more information, see Amazon EFS performance modes (https://docs.aws.amazon.com/efs/latest/ug/performance.html#performancemodes.html).
//
// You can set the throughput mode for the file system using the ThroughputMode
// parameter.
//
// 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 by
// using the mount target. For more information, see Amazon EFS: How it Works
// (https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html).
//
// This operation requires permissions for the elasticfilesystem:CreateFileSystem
// action.
//
// File systems can be tagged on creation. If tags are specified in the creation
// action, IAM performs additional authorization on the elasticfilesystem:TagResource
// action to verify if users have permissions to create tags. Therefore, you
// must grant explicit permissions to use the elasticfilesystem:TagResource
// action. For more information, see Granting permissions to tag resources during
// creation (https://docs.aws.amazon.com/efs/latest/ug/using-tags-efs.html#supported-iam-actions-tagging.html).
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Elastic File System's
// API operation CreateFileSystem for usage and error information.
//
// Returned Error Types:
//
// - BadRequest
// Returned if the request is malformed or contains an error such as an invalid
// parameter value or a missing required parameter.
//
// - InternalServerError
// Returned if an error occurred on the server side.
//
// - FileSystemAlreadyExists
// Returned if the file system you are trying to create already exists, with
// the creation token you provided.
//
// - FileSystemLimitExceeded
// Returned if the Amazon Web Services account has already created the maximum
// number of file systems allowed per account.
//
// - InsufficientThroughputCapacity
// Returned if there's not enough capacity to provision additional throughput.
// This value might be returned when you try to create a file system in provisioned
// throughput mode, when you attempt to increase the provisioned throughput
// of an existing file system, or when you attempt to change an existing file
// system from Bursting Throughput to Provisioned Throughput mode. Try again
// later.
//
// - ThroughputLimitExceeded
// Returned if the throughput mode or amount of provisioned throughput can't
// be changed because the throughput limit of 1024 MiB/s has been reached.
//
// - UnsupportedAvailabilityZone
// Returned if the requested Amazon EFS functionality is not available in the
// specified Availability Zone.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateFileSystem
func (c *EFS) CreateFileSystem(input *CreateFileSystemInput) (*FileSystemDescription, error) {
req, out := c.CreateFileSystemRequest(input)
return out, req.Send()
}
// CreateFileSystemWithContext is the same as CreateFileSystem with the addition of
// the ability to pass a context and additional request options.
//
// See CreateFileSystem for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *EFS) CreateFileSystemWithContext(ctx aws.Context, input *CreateFileSystemInput, opts ...request.Option) (*FileSystemDescription, error) {
req, out := c.CreateFileSystemRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opCreateMountTarget = "CreateMountTarget"
// CreateMountTargetRequest generates a "aws/request.Request" representing the
// client's request for the CreateMountTarget operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See CreateMountTarget for more information on using the CreateMountTarget
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the CreateMountTargetRequest method.
// req, resp := client.CreateMountTargetRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateMountTarget
func (c *EFS) CreateMountTargetRequest(input *CreateMountTargetInput) (req *request.Request, output *MountTargetDescription) {
op := &request.Operation{
Name: opCreateMountTarget,
HTTPMethod: "POST",
HTTPPath: "/2015-02-01/mount-targets",
}
if input == nil {
input = &CreateMountTargetInput{}
}
output = &MountTargetDescription{}
req = c.newRequest(op, input, output)
return
}
// CreateMountTarget 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 by using 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.
//
// You can create only one mount target for a One Zone file system. You must
// create that mount target in the same Availability Zone in which the file
// system is located. Use the AvailabilityZoneName and AvailabiltyZoneId properties
// in the DescribeFileSystems response object to get this information. Use the
// subnetId associated with the file system's Availability Zone when creating
// the mount target.
//
// For more information, see Amazon EFS: How it Works (https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html).
//
// To create a mount target for a file system, the file system's lifecycle state
// must be available. For more information, see DescribeFileSystems.
//
// In the request, provide the following:
//
// - The file system ID for which you are creating the mount target.
//
// - A subnet ID, which determines the following: The VPC in which Amazon
// EFS creates the mount target The Availability Zone in which Amazon EFS
// creates the mount target The 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 by using the mount target can resolve the mount target's DNS name
// to its IP address. For more information, see How it Works: Implementation
// Overview (https://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 that 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 can't 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
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Elastic File System's
// API operation CreateMountTarget for usage and error information.
//
// Returned Error Types:
//
// - BadRequest
// Returned if the request is malformed or contains an error such as an invalid
// parameter value or a missing required parameter.
//
// - InternalServerError
// Returned if an error occurred on the server side.
//
// - FileSystemNotFound
// Returned if the specified FileSystemId value doesn't exist in the requester's
// Amazon Web Services account.
//
// - IncorrectFileSystemLifeCycleState
// Returned if the file system's lifecycle state is not "available".
//
// - MountTargetConflict
// Returned if the mount target would violate one of the specified restrictions
// based on the file system's existing mount targets.
//
// - SubnetNotFound
// Returned if there is no subnet with ID SubnetId provided in the request.
//
// - NoFreeAddressesInSubnet
// Returned if IpAddress was not specified in the request and there are no free
// IP addresses in the subnet.
//
// - IpAddressInUse
// Returned if the request specified an IpAddress that is already in use in
// the subnet.
//
// - NetworkInterfaceLimitExceeded
// The calling account has reached the limit for elastic network interfaces
// for the specific Amazon Web Services Region. Either delete some network interfaces
// or request that the account quota be raised. For more information, see Amazon
// VPC Quotas (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Appendix_Limits.html)
// in the Amazon VPC User Guide (see the Network interfaces per Region entry
// in the Network interfaces table).
//
// - SecurityGroupLimitExceeded
// Returned if the size of SecurityGroups specified in the request is greater
// than five.
//
// - SecurityGroupNotFound
// Returned if one of the specified security groups doesn't exist in the subnet's
// virtual private cloud (VPC).
//
// - UnsupportedAvailabilityZone
// Returned if the requested Amazon EFS functionality is not available in the
// specified Availability Zone.
//
// - AvailabilityZonesMismatch
// Returned if the Availability Zone that was specified for a mount target is
// different from the Availability Zone that was specified for One Zone storage.
// For more information, see Regional and One Zone storage redundancy (https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html).
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateMountTarget
func (c *EFS) CreateMountTarget(input *CreateMountTargetInput) (*MountTargetDescription, error) {
req, out := c.CreateMountTargetRequest(input)
return out, req.Send()
}
// CreateMountTargetWithContext is the same as CreateMountTarget with the addition of
// the ability to pass a context and additional request options.
//
// See CreateMountTarget for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *EFS) CreateMountTargetWithContext(ctx aws.Context, input *CreateMountTargetInput, opts ...request.Option) (*MountTargetDescription, error) {
req, out := c.CreateMountTargetRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opCreateReplicationConfiguration = "CreateReplicationConfiguration"
// CreateReplicationConfigurationRequest generates a "aws/request.Request" representing the
// client's request for the CreateReplicationConfiguration operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See CreateReplicationConfiguration for more information on using the CreateReplicationConfiguration
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the CreateReplicationConfigurationRequest method.
// req, resp := client.CreateReplicationConfigurationRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateReplicationConfiguration
func (c *EFS) CreateReplicationConfigurationRequest(input *CreateReplicationConfigurationInput) (req *request.Request, output *CreateReplicationConfigurationOutput) {
op := &request.Operation{
Name: opCreateReplicationConfiguration,
HTTPMethod: "POST",
HTTPPath: "/2015-02-01/file-systems/{SourceFileSystemId}/replication-configuration",
}
if input == nil {
input = &CreateReplicationConfigurationInput{}
}
output = &CreateReplicationConfigurationOutput{}
req = c.newRequest(op, input, output)
return
}
// CreateReplicationConfiguration API operation for Amazon Elastic File System.
//
// Creates a replication configuration that replicates an existing EFS file
// system to a new, read-only file system. For more information, see Amazon
// EFS replication (https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html)
// in the Amazon EFS User Guide. The replication configuration specifies the
// following:
//
// - Source file system – The EFS file system that you want replicated.
// The source file system cannot be a destination file system in an existing
// replication configuration.
//
// - Amazon Web Services Region – The Amazon Web Services Region in which
// the destination file system is created. Amazon EFS replication is available
// in all Amazon Web Services Regions in which EFS is available. The Region
// must be enabled. For more information, see Managing Amazon Web Services
// Regions (https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable)
// in the Amazon Web Services General Reference Reference Guide.
//
// - Destination file system configuration – The configuration of the destination
// file system to which the source file system will be replicated. There
// can only be one destination file system in a replication configuration.
// Parameters for the replication configuration include: File system ID –
// The ID of the destination file system for the replication. If no ID is
// provided, then EFS creates a new file system with the default settings.
// For existing file systems, the file system's replication overwrite protection
// must be disabled. For more information, see Replicating to an existing
// file system (https://docs.aws.amazon.com/efs/latest/ug/efs-replication#replicate-existing-destination).
// Availability Zone – If you want the destination file system to use One
// Zone storage, you must specify the Availability Zone to create the file
// system in. For more information, see EFS file system types (https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html)
// in the Amazon EFS User Guide. Encryption – All destination file systems
// are created with encryption at rest enabled. You can specify the Key Management
// Service (KMS) key that is used to encrypt the destination file system.
// If you don't specify a KMS key, your service-managed KMS key for Amazon
// EFS is used. After the file system is created, you cannot change the KMS
// key.
//
// After the file system is created, you cannot change the KMS key.
//
// For new destination file systems, the following properties are set by default:
//
// - Performance mode - The destination file system's performance mode matches
// that of the source file system, unless the destination file system uses
// EFS One Zone storage. In that case, the General Purpose performance mode
// is used. The performance mode cannot be changed.
//
// - Throughput mode - The destination file system's throughput mode matches
// that of the source file system. After the file system is created, you
// can modify the throughput mode.
//
// - Lifecycle management – Lifecycle management is not enabled on the
// destination file system. After the destination file system is created,
// you can enable lifecycle management.
//
// - Automatic backups – Automatic daily backups are enabled on the destination
// file system. After the file system is created, you can change this setting.
//
// For more information, see Amazon EFS replication (https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html)
// in the Amazon EFS User Guide.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Elastic File System's
// API operation CreateReplicationConfiguration for usage and error information.
//
// Returned Error Types:
//
// - BadRequest
// Returned if the request is malformed or contains an error such as an invalid
// parameter value or a missing required parameter.
//
// - IncorrectFileSystemLifeCycleState
// Returned if the file system's lifecycle state is not "available".
//
// - ValidationException
// Returned if the Backup service is not available in the Amazon Web Services
// Region in which the request was made.
//
// - ReplicationNotFound
// Returned if the specified file system does not have a replication configuration.
//
// - FileSystemNotFound
// Returned if the specified FileSystemId value doesn't exist in the requester's
// Amazon Web Services account.
//
// - UnsupportedAvailabilityZone
// Returned if the requested Amazon EFS functionality is not available in the
// specified Availability Zone.
//
// - FileSystemLimitExceeded
// Returned if the Amazon Web Services account has already created the maximum
// number of file systems allowed per account.
//
// - InsufficientThroughputCapacity
// Returned if there's not enough capacity to provision additional throughput.
// This value might be returned when you try to create a file system in provisioned
// throughput mode, when you attempt to increase the provisioned throughput
// of an existing file system, or when you attempt to change an existing file
// system from Bursting Throughput to Provisioned Throughput mode. Try again
// later.
//
// - ThroughputLimitExceeded
// Returned if the throughput mode or amount of provisioned throughput can't
// be changed because the throughput limit of 1024 MiB/s has been reached.
//
// - ConflictException
// Returned if the source file system in a replication is encrypted but the
// destination file system is unencrypted.
//
// - InternalServerError
// Returned if an error occurred on the server side.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateReplicationConfiguration
func (c *EFS) CreateReplicationConfiguration(input *CreateReplicationConfigurationInput) (*CreateReplicationConfigurationOutput, error) {
req, out := c.CreateReplicationConfigurationRequest(input)
return out, req.Send()
}
// CreateReplicationConfigurationWithContext is the same as CreateReplicationConfiguration with the addition of
// the ability to pass a context and additional request options.
//
// See CreateReplicationConfiguration for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *EFS) CreateReplicationConfigurationWithContext(ctx aws.Context, input *CreateReplicationConfigurationInput, opts ...request.Option) (*CreateReplicationConfigurationOutput, error) {
req, out := c.CreateReplicationConfigurationRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opCreateTags = "CreateTags"
// CreateTagsRequest generates a "aws/request.Request" representing the
// client's request for the CreateTags operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See CreateTags for more information on using the CreateTags
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the CreateTagsRequest method.
// req, resp := client.CreateTagsRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateTags
//
// Deprecated: Use TagResource.
func (c *EFS) CreateTagsRequest(input *CreateTagsInput) (req *request.Request, output *CreateTagsOutput) {
if c.Client.Config.Logger != nil {
c.Client.Config.Logger.Log("This operation, CreateTags, has been deprecated")
}
op := &request.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.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
return
}
// CreateTags API operation for Amazon Elastic File System.
//
// DEPRECATED - CreateTags is deprecated and not maintained. To create tags
// for EFS resources, use the API action.
//
// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Elastic File System's
// API operation CreateTags for usage and error information.
//
// Returned Error Types:
//
// - BadRequest
// Returned if the request is malformed or contains an error such as an invalid
// parameter value or a missing required parameter.
//
// - InternalServerError
// Returned if an error occurred on the server side.
//
// - FileSystemNotFound
// Returned if the specified FileSystemId value doesn't exist in the requester's
// Amazon Web Services account.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateTags
//
// Deprecated: Use TagResource.
func (c *EFS) CreateTags(input *CreateTagsInput) (*CreateTagsOutput, error) {
req, out := c.CreateTagsRequest(input)
return out, req.Send()
}
// CreateTagsWithContext is the same as CreateTags with the addition of
// the ability to pass a context and additional request options.
//
// See CreateTags for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
//
// Deprecated: Use TagResource.
func (c *EFS) CreateTagsWithContext(ctx aws.Context, input *CreateTagsInput, opts ...request.Option) (*CreateTagsOutput, error) {
req, out := c.CreateTagsRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDeleteAccessPoint = "DeleteAccessPoint"
// DeleteAccessPointRequest generates a "aws/request.Request" representing the
// client's request for the DeleteAccessPoint operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DeleteAccessPoint for more information on using the DeleteAccessPoint
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DeleteAccessPointRequest method.
// req, resp := client.DeleteAccessPointRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteAccessPoint
func (c *EFS) DeleteAccessPointRequest(input *DeleteAccessPointInput) (req *request.Request, output *DeleteAccessPointOutput) {
op := &request.Operation{
Name: opDeleteAccessPoint,
HTTPMethod: "DELETE",
HTTPPath: "/2015-02-01/access-points/{AccessPointId}",
}
if input == nil {
input = &DeleteAccessPointInput{}
}
output = &DeleteAccessPointOutput{}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
return
}
// DeleteAccessPoint API operation for Amazon Elastic File System.
//
// Deletes the specified access point. After deletion is complete, new clients
// can no longer connect to the access points. Clients connected to the access
// point at the time of deletion will continue to function until they terminate
// their connection.
//
// This operation requires permissions for the elasticfilesystem:DeleteAccessPoint
// action.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Elastic File System's
// API operation DeleteAccessPoint for usage and error information.
//
// Returned Error Types:
//
// - BadRequest
// Returned if the request is malformed or contains an error such as an invalid
// parameter value or a missing required parameter.
//
// - InternalServerError
// Returned if an error occurred on the server side.
//
// - AccessPointNotFound
// Returned if the specified AccessPointId value doesn't exist in the requester's
// Amazon Web Services account.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteAccessPoint
func (c *EFS) DeleteAccessPoint(input *DeleteAccessPointInput) (*DeleteAccessPointOutput, error) {
req, out := c.DeleteAccessPointRequest(input)
return out, req.Send()
}
// DeleteAccessPointWithContext is the same as DeleteAccessPoint with the addition of
// the ability to pass a context and additional request options.
//
// See DeleteAccessPoint for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *EFS) DeleteAccessPointWithContext(ctx aws.Context, input *DeleteAccessPointInput, opts ...request.Option) (*DeleteAccessPointOutput, error) {
req, out := c.DeleteAccessPointRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDeleteFileSystem = "DeleteFileSystem"
// DeleteFileSystemRequest generates a "aws/request.Request" representing the
// client's request for the DeleteFileSystem operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DeleteFileSystem for more information on using the DeleteFileSystem
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DeleteFileSystemRequest method.
// req, resp := client.DeleteFileSystemRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteFileSystem
func (c *EFS) DeleteFileSystemRequest(input *DeleteFileSystemInput) (req *request.Request, output *DeleteFileSystemOutput) {
op := &request.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.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
return
}
// DeleteFileSystem 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 need to manually delete mount targets attached to a file system before
// you can delete an EFS file system. This step is performed for you when you
// use the Amazon Web Services console to delete a file system.
//
// You cannot delete a file system that is part of an EFS Replication configuration.
// You need to delete the replication configuration first.
//
// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Elastic File System's
// API operation DeleteFileSystem for usage and error information.
//
// Returned Error Types:
//
// - BadRequest
// Returned if the request is malformed or contains an error such as an invalid
// parameter value or a missing required parameter.