terraform/vendor/github.com/aws/aws-sdk-go/service/efs/api.go

2765 lines
101 KiB
Go
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

// 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 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
// successfuly.
//
// 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 *UpdateFileSystemOutput) {
op := &request.Operation{
Name: opCreateFileSystem,
HTTPMethod: "POST",
HTTPPath: "/2015-02-01/file-systems",
}
if input == nil {
input = &CreateFileSystemInput{}
}
output = &UpdateFileSystemOutput{}
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 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.
//
// 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 Codes:
// * ErrCodeBadRequest "BadRequest"
// Returned if the request is malformed or contains an error such as an invalid
// parameter value or a missing required parameter.
//
// * ErrCodeInternalServerError "InternalServerError"
// Returned if an error occurred on the server side.
//
// * ErrCodeFileSystemAlreadyExists "FileSystemAlreadyExists"
// Returned if the file system you are trying to create already exists, with
// the creation token you provided.
//
// * ErrCodeFileSystemLimitExceeded "FileSystemLimitExceeded"
// Returned if the AWS account has already created the maximum number of file
// systems allowed per account.
//
// * ErrCodeInsufficientThroughputCapacity "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 to provisioned throughput mode.
//
// * ErrCodeThroughputLimitExceeded "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.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateFileSystem
func (c *EFS) CreateFileSystem(input *CreateFileSystemInput) (*UpdateFileSystemOutput, 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) (*UpdateFileSystemOutput, 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
// successfuly.
//
// 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 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
//
// 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 Codes:
// * ErrCodeBadRequest "BadRequest"
// Returned if the request is malformed or contains an error such as an invalid
// parameter value or a missing required parameter.
//
// * ErrCodeInternalServerError "InternalServerError"
// Returned if an error occurred on the server side.
//
// * ErrCodeFileSystemNotFound "FileSystemNotFound"
// Returned if the specified FileSystemId value doesn't exist in the requester's
// AWS account.
//
// * ErrCodeIncorrectFileSystemLifeCycleState "IncorrectFileSystemLifeCycleState"
// Returned if the file system's lifecycle state is not "available".
//
// * ErrCodeMountTargetConflict "MountTargetConflict"
// Returned if the mount target would violate one of the specified restrictions
// based on the file system's existing mount targets.
//
// * ErrCodeSubnetNotFound "SubnetNotFound"
// Returned if there is no subnet with ID SubnetId provided in the request.
//
// * ErrCodeNoFreeAddressesInSubnet "NoFreeAddressesInSubnet"
// Returned if IpAddress was not specified in the request and there are no free
// IP addresses in the subnet.
//
// * ErrCodeIpAddressInUse "IpAddressInUse"
// Returned if the request specified an IpAddress that is already in use in
// the subnet.
//
// * ErrCodeNetworkInterfaceLimitExceeded "NetworkInterfaceLimitExceeded"
// The calling account has reached the limit for elastic network interfaces
// for the specific AWS Region. The client should try to delete some elastic
// network interfaces or get the account limit raised. For more information,
// see Amazon VPC Limits (http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Appendix_Limits.html)
// in the Amazon VPC User Guide (see the Network interfaces per VPC entry in
// the table).
//
// * ErrCodeSecurityGroupLimitExceeded "SecurityGroupLimitExceeded"
// Returned if the size of SecurityGroups specified in the request is greater
// than five.
//
// * ErrCodeSecurityGroupNotFound "SecurityGroupNotFound"
// Returned if one of the specified security groups doesn't exist in the subnet's
// VPC.
//
// * ErrCodeUnsupportedAvailabilityZone "UnsupportedAvailabilityZone"
//
// 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 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
// successfuly.
//
// 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
func (c *EFS) CreateTagsRequest(input *CreateTagsInput) (req *request.Request, output *CreateTagsOutput) {
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.Remove(restjson.UnmarshalHandler)
req.Handlers.Unmarshal.PushBackNamed(protocol.UnmarshalDiscardBodyHandler)
return
}
// CreateTags 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.
//
// 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 Codes:
// * ErrCodeBadRequest "BadRequest"
// Returned if the request is malformed or contains an error such as an invalid
// parameter value or a missing required parameter.
//
// * ErrCodeInternalServerError "InternalServerError"
// Returned if an error occurred on the server side.
//
// * ErrCodeFileSystemNotFound "FileSystemNotFound"
// Returned if the specified FileSystemId value doesn't exist in the requester's
// AWS account.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateTags
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.
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 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
// successfuly.
//
// 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.Remove(restjson.UnmarshalHandler)
req.Handlers.Unmarshal.PushBackNamed(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 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 Codes:
// * ErrCodeBadRequest "BadRequest"
// Returned if the request is malformed or contains an error such as an invalid
// parameter value or a missing required parameter.
//
// * ErrCodeInternalServerError "InternalServerError"
// Returned if an error occurred on the server side.
//
// * ErrCodeFileSystemNotFound "FileSystemNotFound"
// Returned if the specified FileSystemId value doesn't exist in the requester's
// AWS account.
//
// * ErrCodeFileSystemInUse "FileSystemInUse"
// Returned if a file system has mount targets.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteFileSystem
func (c *EFS) DeleteFileSystem(input *DeleteFileSystemInput) (*DeleteFileSystemOutput, error) {
req, out := c.DeleteFileSystemRequest(input)
return out, req.Send()
}
// DeleteFileSystemWithContext is the same as DeleteFileSystem with the addition of
// the ability to pass a context and additional request options.
//
// See DeleteFileSystem 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) DeleteFileSystemWithContext(ctx aws.Context, input *DeleteFileSystemInput, opts ...request.Option) (*DeleteFileSystemOutput, error) {
req, out := c.DeleteFileSystemRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDeleteMountTarget = "DeleteMountTarget"
// DeleteMountTargetRequest generates a "aws/request.Request" representing the
// client's request for the DeleteMountTarget operation. The "output" return
// value will be populated with the request's response once the request completes
// successfuly.
//
// 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 DeleteMountTarget for more information on using the DeleteMountTarget
// 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 DeleteMountTargetRequest method.
// req, resp := client.DeleteMountTargetRequest(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/DeleteMountTarget
func (c *EFS) DeleteMountTargetRequest(input *DeleteMountTargetInput) (req *request.Request, output *DeleteMountTargetOutput) {
op := &request.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)
return
}
// DeleteMountTarget 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
//
// 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 DeleteMountTarget for usage and error information.
//
// Returned Error Codes:
// * ErrCodeBadRequest "BadRequest"
// Returned if the request is malformed or contains an error such as an invalid
// parameter value or a missing required parameter.
//
// * ErrCodeInternalServerError "InternalServerError"
// Returned if an error occurred on the server side.
//
// * ErrCodeDependencyTimeout "DependencyTimeout"
// The service timed out trying to fulfill the request, and the client should
// try the call again.
//
// * ErrCodeMountTargetNotFound "MountTargetNotFound"
// Returned if there is no mount target with the specified ID found in the caller's
// account.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteMountTarget
func (c *EFS) DeleteMountTarget(input *DeleteMountTargetInput) (*DeleteMountTargetOutput, error) {
req, out := c.DeleteMountTargetRequest(input)
return out, req.Send()
}
// DeleteMountTargetWithContext is the same as DeleteMountTarget with the addition of
// the ability to pass a context and additional request options.
//
// See DeleteMountTarget 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) DeleteMountTargetWithContext(ctx aws.Context, input *DeleteMountTargetInput, opts ...request.Option) (*DeleteMountTargetOutput, error) {
req, out := c.DeleteMountTargetRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDeleteTags = "DeleteTags"
// DeleteTagsRequest generates a "aws/request.Request" representing the
// client's request for the DeleteTags operation. The "output" return
// value will be populated with the request's response once the request completes
// successfuly.
//
// 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 DeleteTags for more information on using the DeleteTags
// 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 DeleteTagsRequest method.
// req, resp := client.DeleteTagsRequest(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/DeleteTags
func (c *EFS) DeleteTagsRequest(input *DeleteTagsInput) (req *request.Request, output *DeleteTagsOutput) {
op := &request.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)
return
}
// DeleteTags 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.
//
// 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 DeleteTags for usage and error information.
//
// Returned Error Codes:
// * ErrCodeBadRequest "BadRequest"
// Returned if the request is malformed or contains an error such as an invalid
// parameter value or a missing required parameter.
//
// * ErrCodeInternalServerError "InternalServerError"
// Returned if an error occurred on the server side.
//
// * ErrCodeFileSystemNotFound "FileSystemNotFound"
// Returned if the specified FileSystemId value doesn't exist in the requester's
// AWS account.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteTags
func (c *EFS) DeleteTags(input *DeleteTagsInput) (*DeleteTagsOutput, error) {
req, out := c.DeleteTagsRequest(input)
return out, req.Send()
}
// DeleteTagsWithContext is the same as DeleteTags with the addition of
// the ability to pass a context and additional request options.
//
// See DeleteTags 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) DeleteTagsWithContext(ctx aws.Context, input *DeleteTagsInput, opts ...request.Option) (*DeleteTagsOutput, error) {
req, out := c.DeleteTagsRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDescribeFileSystems = "DescribeFileSystems"
// DescribeFileSystemsRequest generates a "aws/request.Request" representing the
// client's request for the DescribeFileSystems operation. The "output" return
// value will be populated with the request's response once the request completes
// successfuly.
//
// 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 DescribeFileSystems for more information on using the DescribeFileSystems
// 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 DescribeFileSystemsRequest method.
// req, resp := client.DescribeFileSystemsRequest(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/DescribeFileSystems
func (c *EFS) DescribeFileSystemsRequest(input *DescribeFileSystemsInput) (req *request.Request, output *DescribeFileSystemsOutput) {
op := &request.Operation{
Name: opDescribeFileSystems,
HTTPMethod: "GET",
HTTPPath: "/2015-02-01/file-systems",
}
if input == nil {
input = &DescribeFileSystemsInput{}
}
output = &DescribeFileSystemsOutput{}
req = c.newRequest(op, input, output)
return
}
// DescribeFileSystems 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.
//
// 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 DescribeFileSystems for usage and error information.
//
// Returned Error Codes:
// * ErrCodeBadRequest "BadRequest"
// Returned if the request is malformed or contains an error such as an invalid
// parameter value or a missing required parameter.
//
// * ErrCodeInternalServerError "InternalServerError"
// Returned if an error occurred on the server side.
//
// * ErrCodeFileSystemNotFound "FileSystemNotFound"
// Returned if the specified FileSystemId value doesn't exist in the requester's
// AWS account.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeFileSystems
func (c *EFS) DescribeFileSystems(input *DescribeFileSystemsInput) (*DescribeFileSystemsOutput, error) {
req, out := c.DescribeFileSystemsRequest(input)
return out, req.Send()
}
// DescribeFileSystemsWithContext is the same as DescribeFileSystems with the addition of
// the ability to pass a context and additional request options.
//
// See DescribeFileSystems 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) DescribeFileSystemsWithContext(ctx aws.Context, input *DescribeFileSystemsInput, opts ...request.Option) (*DescribeFileSystemsOutput, error) {
req, out := c.DescribeFileSystemsRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDescribeMountTargetSecurityGroups = "DescribeMountTargetSecurityGroups"
// DescribeMountTargetSecurityGroupsRequest generates a "aws/request.Request" representing the
// client's request for the DescribeMountTargetSecurityGroups operation. The "output" return
// value will be populated with the request's response once the request completes
// successfuly.
//
// 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 DescribeMountTargetSecurityGroups for more information on using the DescribeMountTargetSecurityGroups
// 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 DescribeMountTargetSecurityGroupsRequest method.
// req, resp := client.DescribeMountTargetSecurityGroupsRequest(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/DescribeMountTargetSecurityGroups
func (c *EFS) DescribeMountTargetSecurityGroupsRequest(input *DescribeMountTargetSecurityGroupsInput) (req *request.Request, output *DescribeMountTargetSecurityGroupsOutput) {
op := &request.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)
return
}
// DescribeMountTargetSecurityGroups 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.
//
// 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 DescribeMountTargetSecurityGroups for usage and error information.
//
// Returned Error Codes:
// * ErrCodeBadRequest "BadRequest"
// Returned if the request is malformed or contains an error such as an invalid
// parameter value or a missing required parameter.
//
// * ErrCodeInternalServerError "InternalServerError"
// Returned if an error occurred on the server side.
//
// * ErrCodeMountTargetNotFound "MountTargetNotFound"
// Returned if there is no mount target with the specified ID found in the caller's
// account.
//
// * ErrCodeIncorrectMountTargetState "IncorrectMountTargetState"
// Returned if the mount target is not in the correct state for the operation.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeMountTargetSecurityGroups
func (c *EFS) DescribeMountTargetSecurityGroups(input *DescribeMountTargetSecurityGroupsInput) (*DescribeMountTargetSecurityGroupsOutput, error) {
req, out := c.DescribeMountTargetSecurityGroupsRequest(input)
return out, req.Send()
}
// DescribeMountTargetSecurityGroupsWithContext is the same as DescribeMountTargetSecurityGroups with the addition of
// the ability to pass a context and additional request options.
//
// See DescribeMountTargetSecurityGroups 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) DescribeMountTargetSecurityGroupsWithContext(ctx aws.Context, input *DescribeMountTargetSecurityGroupsInput, opts ...request.Option) (*DescribeMountTargetSecurityGroupsOutput, error) {
req, out := c.DescribeMountTargetSecurityGroupsRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDescribeMountTargets = "DescribeMountTargets"
// DescribeMountTargetsRequest generates a "aws/request.Request" representing the
// client's request for the DescribeMountTargets operation. The "output" return
// value will be populated with the request's response once the request completes
// successfuly.
//
// 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 DescribeMountTargets for more information on using the DescribeMountTargets
// 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 DescribeMountTargetsRequest method.
// req, resp := client.DescribeMountTargetsRequest(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/DescribeMountTargets
func (c *EFS) DescribeMountTargetsRequest(input *DescribeMountTargetsInput) (req *request.Request, output *DescribeMountTargetsOutput) {
op := &request.Operation{
Name: opDescribeMountTargets,
HTTPMethod: "GET",
HTTPPath: "/2015-02-01/mount-targets",
}
if input == nil {
input = &DescribeMountTargetsInput{}
}
output = &DescribeMountTargetsOutput{}
req = c.newRequest(op, input, output)
return
}
// DescribeMountTargets 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.
//
// 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 DescribeMountTargets for usage and error information.
//
// Returned Error Codes:
// * ErrCodeBadRequest "BadRequest"
// Returned if the request is malformed or contains an error such as an invalid
// parameter value or a missing required parameter.
//
// * ErrCodeInternalServerError "InternalServerError"
// Returned if an error occurred on the server side.
//
// * ErrCodeFileSystemNotFound "FileSystemNotFound"
// Returned if the specified FileSystemId value doesn't exist in the requester's
// AWS account.
//
// * ErrCodeMountTargetNotFound "MountTargetNotFound"
// Returned if there is no mount target with the specified ID found in the caller's
// account.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeMountTargets
func (c *EFS) DescribeMountTargets(input *DescribeMountTargetsInput) (*DescribeMountTargetsOutput, error) {
req, out := c.DescribeMountTargetsRequest(input)
return out, req.Send()
}
// DescribeMountTargetsWithContext is the same as DescribeMountTargets with the addition of
// the ability to pass a context and additional request options.
//
// See DescribeMountTargets 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) DescribeMountTargetsWithContext(ctx aws.Context, input *DescribeMountTargetsInput, opts ...request.Option) (*DescribeMountTargetsOutput, error) {
req, out := c.DescribeMountTargetsRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDescribeTags = "DescribeTags"
// DescribeTagsRequest generates a "aws/request.Request" representing the
// client's request for the DescribeTags operation. The "output" return
// value will be populated with the request's response once the request completes
// successfuly.
//
// 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 DescribeTags for more information on using the DescribeTags
// 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 DescribeTagsRequest method.
// req, resp := client.DescribeTagsRequest(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/DescribeTags
func (c *EFS) DescribeTagsRequest(input *DescribeTagsInput) (req *request.Request, output *DescribeTagsOutput) {
op := &request.Operation{
Name: opDescribeTags,
HTTPMethod: "GET",
HTTPPath: "/2015-02-01/tags/{FileSystemId}/",
}
if input == nil {
input = &DescribeTagsInput{}
}
output = &DescribeTagsOutput{}
req = c.newRequest(op, input, output)
return
}
// DescribeTags 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.
//
// 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 DescribeTags for usage and error information.
//
// Returned Error Codes:
// * ErrCodeBadRequest "BadRequest"
// Returned if the request is malformed or contains an error such as an invalid
// parameter value or a missing required parameter.
//
// * ErrCodeInternalServerError "InternalServerError"
// Returned if an error occurred on the server side.
//
// * ErrCodeFileSystemNotFound "FileSystemNotFound"
// Returned if the specified FileSystemId value doesn't exist in the requester's
// AWS account.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeTags
func (c *EFS) DescribeTags(input *DescribeTagsInput) (*DescribeTagsOutput, error) {
req, out := c.DescribeTagsRequest(input)
return out, req.Send()
}
// DescribeTagsWithContext is the same as DescribeTags with the addition of
// the ability to pass a context and additional request options.
//
// See DescribeTags 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) DescribeTagsWithContext(ctx aws.Context, input *DescribeTagsInput, opts ...request.Option) (*DescribeTagsOutput, error) {
req, out := c.DescribeTagsRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opModifyMountTargetSecurityGroups = "ModifyMountTargetSecurityGroups"
// ModifyMountTargetSecurityGroupsRequest generates a "aws/request.Request" representing the
// client's request for the ModifyMountTargetSecurityGroups operation. The "output" return
// value will be populated with the request's response once the request completes
// successfuly.
//
// 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 ModifyMountTargetSecurityGroups for more information on using the ModifyMountTargetSecurityGroups
// 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 ModifyMountTargetSecurityGroupsRequest method.
// req, resp := client.ModifyMountTargetSecurityGroupsRequest(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/ModifyMountTargetSecurityGroups
func (c *EFS) ModifyMountTargetSecurityGroupsRequest(input *ModifyMountTargetSecurityGroupsInput) (req *request.Request, output *ModifyMountTargetSecurityGroupsOutput) {
op := &request.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)
return
}
// ModifyMountTargetSecurityGroups 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.
//
// 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 ModifyMountTargetSecurityGroups for usage and error information.
//
// Returned Error Codes:
// * ErrCodeBadRequest "BadRequest"
// Returned if the request is malformed or contains an error such as an invalid
// parameter value or a missing required parameter.
//
// * ErrCodeInternalServerError "InternalServerError"
// Returned if an error occurred on the server side.
//
// * ErrCodeMountTargetNotFound "MountTargetNotFound"
// Returned if there is no mount target with the specified ID found in the caller's
// account.
//
// * ErrCodeIncorrectMountTargetState "IncorrectMountTargetState"
// Returned if the mount target is not in the correct state for the operation.
//
// * ErrCodeSecurityGroupLimitExceeded "SecurityGroupLimitExceeded"
// Returned if the size of SecurityGroups specified in the request is greater
// than five.
//
// * ErrCodeSecurityGroupNotFound "SecurityGroupNotFound"
// Returned if one of the specified security groups doesn't exist in the subnet's
// VPC.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/ModifyMountTargetSecurityGroups
func (c *EFS) ModifyMountTargetSecurityGroups(input *ModifyMountTargetSecurityGroupsInput) (*ModifyMountTargetSecurityGroupsOutput, error) {
req, out := c.ModifyMountTargetSecurityGroupsRequest(input)
return out, req.Send()
}
// ModifyMountTargetSecurityGroupsWithContext is the same as ModifyMountTargetSecurityGroups with the addition of
// the ability to pass a context and additional request options.
//
// See ModifyMountTargetSecurityGroups 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) ModifyMountTargetSecurityGroupsWithContext(ctx aws.Context, input *ModifyMountTargetSecurityGroupsInput, opts ...request.Option) (*ModifyMountTargetSecurityGroupsOutput, error) {
req, out := c.ModifyMountTargetSecurityGroupsRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opUpdateFileSystem = "UpdateFileSystem"
// UpdateFileSystemRequest generates a "aws/request.Request" representing the
// client's request for the UpdateFileSystem operation. The "output" return
// value will be populated with the request's response once the request completes
// successfuly.
//
// 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 UpdateFileSystem for more information on using the UpdateFileSystem
// 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 UpdateFileSystemRequest method.
// req, resp := client.UpdateFileSystemRequest(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/UpdateFileSystem
func (c *EFS) UpdateFileSystemRequest(input *UpdateFileSystemInput) (req *request.Request, output *UpdateFileSystemOutput) {
op := &request.Operation{
Name: opUpdateFileSystem,
HTTPMethod: "PUT",
HTTPPath: "/2015-02-01/file-systems/{FileSystemId}",
}
if input == nil {
input = &UpdateFileSystemInput{}
}
output = &UpdateFileSystemOutput{}
req = c.newRequest(op, input, output)
return
}
// UpdateFileSystem API operation for Amazon Elastic File System.
//
// Updates the throughput mode or the amount of provisioned throughput of an
// existing file system.
//
// 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 UpdateFileSystem for usage and error information.
//
// Returned Error Codes:
// * ErrCodeBadRequest "BadRequest"
// Returned if the request is malformed or contains an error such as an invalid
// parameter value or a missing required parameter.
//
// * ErrCodeFileSystemNotFound "FileSystemNotFound"
// Returned if the specified FileSystemId value doesn't exist in the requester's
// AWS account.
//
// * ErrCodeIncorrectFileSystemLifeCycleState "IncorrectFileSystemLifeCycleState"
// Returned if the file system's lifecycle state is not "available".
//
// * ErrCodeInsufficientThroughputCapacity "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 to provisioned throughput mode.
//
// * ErrCodeInternalServerError "InternalServerError"
// Returned if an error occurred on the server side.
//
// * ErrCodeThroughputLimitExceeded "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.
//
// * ErrCodeTooManyRequests "TooManyRequests"
// Returned if you dont wait at least 24 hours before changing the throughput
// mode, or decreasing the Provisioned Throughput value.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/UpdateFileSystem
func (c *EFS) UpdateFileSystem(input *UpdateFileSystemInput) (*UpdateFileSystemOutput, error) {
req, out := c.UpdateFileSystemRequest(input)
return out, req.Send()
}
// UpdateFileSystemWithContext is the same as UpdateFileSystem with the addition of
// the ability to pass a context and additional request options.
//
// See UpdateFileSystem 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) UpdateFileSystemWithContext(ctx aws.Context, input *UpdateFileSystemInput, opts ...request.Option) (*UpdateFileSystemOutput, error) {
req, out := c.UpdateFileSystemRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
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 to 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 (ARN) 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 ARN for a key alias, for example, arn:aws:kms:us-west-2:444455556666:alias/projectKey1.
//
// If 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 *string `type:"string" enum:"PerformanceMode"`
// The throughput, measured in MiB/s, that you want to provision for a file
// system that you're creating. The limit on throughput is 1024 MiB/s. You can
// get these limits increased by contacting AWS Support. For more information,
// see Amazon EFS Limits That You Can Increase (http://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits)
// in the Amazon EFS User Guide.
ProvisionedThroughputInMibps *float64 `type:"double"`
// The throughput mode for the file system to be created. There are two throughput
// modes to choose from for your file system: bursting and provisioned. You
// can decrease your file system's throughput in Provisioned Throughput mode
// or change between the throughput modes as long as its been more than 24
// hours since the last decrease or throughput mode change.
ThroughputMode *string `type:"string" enum:"ThroughputMode"`
}
// 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 := request.ErrInvalidParams{Context: "CreateFileSystemInput"}
if s.CreationToken == nil {
invalidParams.Add(request.NewErrParamRequired("CreationToken"))
}
if s.CreationToken != nil && len(*s.CreationToken) < 1 {
invalidParams.Add(request.NewErrParamMinLen("CreationToken", 1))
}
if s.KmsKeyId != nil && len(*s.KmsKeyId) < 1 {
invalidParams.Add(request.NewErrParamMinLen("KmsKeyId", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetCreationToken sets the CreationToken field's value.
func (s *CreateFileSystemInput) SetCreationToken(v string) *CreateFileSystemInput {
s.CreationToken = &v
return s
}
// SetEncrypted sets the Encrypted field's value.
func (s *CreateFileSystemInput) SetEncrypted(v bool) *CreateFileSystemInput {
s.Encrypted = &v
return s
}
// SetKmsKeyId sets the KmsKeyId field's value.
func (s *CreateFileSystemInput) SetKmsKeyId(v string) *CreateFileSystemInput {
s.KmsKeyId = &v
return s
}
// SetPerformanceMode sets the PerformanceMode field's value.
func (s *CreateFileSystemInput) SetPerformanceMode(v string) *CreateFileSystemInput {
s.PerformanceMode = &v
return s
}
// SetProvisionedThroughputInMibps sets the ProvisionedThroughputInMibps field's value.
func (s *CreateFileSystemInput) SetProvisionedThroughputInMibps(v float64) *CreateFileSystemInput {
s.ProvisionedThroughputInMibps = &v
return s
}
// SetThroughputMode sets the ThroughputMode field's value.
func (s *CreateFileSystemInput) SetThroughputMode(v string) *CreateFileSystemInput {
s.ThroughputMode = &v
return s
}
type CreateMountTargetInput struct {
_ struct{} `type:"structure"`
// ID of the file system for which to create the mount target.
//
// FileSystemId is a required field
FileSystemId *string `type:"string" required:"true"`
// Valid IPv4 address within the address range of the specified subnet.
IpAddress *string `type:"string"`
// Up to five VPC security group IDs, of the form sg-xxxxxxxx. These must be
// for the same VPC as subnet specified.
SecurityGroups []*string `type:"list"`
// ID of the subnet to add the mount target in.
//
// SubnetId is a required field
SubnetId *string `type:"string" required:"true"`
}
// String returns the string representation
func (s CreateMountTargetInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s CreateMountTargetInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *CreateMountTargetInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "CreateMountTargetInput"}
if s.FileSystemId == nil {
invalidParams.Add(request.NewErrParamRequired("FileSystemId"))
}
if s.SubnetId == nil {
invalidParams.Add(request.NewErrParamRequired("SubnetId"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetFileSystemId sets the FileSystemId field's value.
func (s *CreateMountTargetInput) SetFileSystemId(v string) *CreateMountTargetInput {
s.FileSystemId = &v
return s
}
// SetIpAddress sets the IpAddress field's value.
func (s *CreateMountTargetInput) SetIpAddress(v string) *CreateMountTargetInput {
s.IpAddress = &v
return s
}
// SetSecurityGroups sets the SecurityGroups field's value.
func (s *CreateMountTargetInput) SetSecurityGroups(v []*string) *CreateMountTargetInput {
s.SecurityGroups = v
return s
}
// SetSubnetId sets the SubnetId field's value.
func (s *CreateMountTargetInput) SetSubnetId(v string) *CreateMountTargetInput {
s.SubnetId = &v
return s
}
type CreateTagsInput struct {
_ struct{} `type:"structure"`
// ID of the file system whose tags you want to modify (String). This operation
// modifies the tags only, not the file system.
//
// FileSystemId is a required field
FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`
// Array of Tag objects to add. Each Tag object is a key-value pair.
//
// Tags is a required field
Tags []*Tag `type:"list" required:"true"`
}
// String returns the string representation
func (s CreateTagsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s CreateTagsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *CreateTagsInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "CreateTagsInput"}
if s.FileSystemId == nil {
invalidParams.Add(request.NewErrParamRequired("FileSystemId"))
}
if s.Tags == nil {
invalidParams.Add(request.NewErrParamRequired("Tags"))
}
if s.Tags != nil {
for i, v := range s.Tags {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetFileSystemId sets the FileSystemId field's value.
func (s *CreateTagsInput) SetFileSystemId(v string) *CreateTagsInput {
s.FileSystemId = &v
return s
}
// SetTags sets the Tags field's value.
func (s *CreateTagsInput) SetTags(v []*Tag) *CreateTagsInput {
s.Tags = v
return s
}
type CreateTagsOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation
func (s CreateTagsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s CreateTagsOutput) GoString() string {
return s.String()
}
type DeleteFileSystemInput struct {
_ struct{} `type:"structure"`
// ID of the file system you want to delete.
//
// FileSystemId is a required field
FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`
}
// String returns the string representation
func (s DeleteFileSystemInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DeleteFileSystemInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DeleteFileSystemInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DeleteFileSystemInput"}
if s.FileSystemId == nil {
invalidParams.Add(request.NewErrParamRequired("FileSystemId"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetFileSystemId sets the FileSystemId field's value.
func (s *DeleteFileSystemInput) SetFileSystemId(v string) *DeleteFileSystemInput {
s.FileSystemId = &v
return s
}
type DeleteFileSystemOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation
func (s DeleteFileSystemOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DeleteFileSystemOutput) GoString() string {
return s.String()
}
type DeleteMountTargetInput struct {
_ struct{} `type:"structure"`
// ID of the mount target to delete (String).
//
// MountTargetId is a required field
MountTargetId *string `location:"uri" locationName:"MountTargetId" type:"string" required:"true"`
}
// String returns the string representation
func (s DeleteMountTargetInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DeleteMountTargetInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DeleteMountTargetInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DeleteMountTargetInput"}
if s.MountTargetId == nil {
invalidParams.Add(request.NewErrParamRequired("MountTargetId"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetMountTargetId sets the MountTargetId field's value.
func (s *DeleteMountTargetInput) SetMountTargetId(v string) *DeleteMountTargetInput {
s.MountTargetId = &v
return s
}
type DeleteMountTargetOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation
func (s DeleteMountTargetOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DeleteMountTargetOutput) GoString() string {
return s.String()
}
type DeleteTagsInput struct {
_ struct{} `type:"structure"`
// ID of the file system whose tags you want to delete (String).
//
// FileSystemId is a required field
FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`
// List of tag keys to delete.
//
// TagKeys is a required field
TagKeys []*string `type:"list" required:"true"`
}
// String returns the string representation
func (s DeleteTagsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DeleteTagsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DeleteTagsInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DeleteTagsInput"}
if s.FileSystemId == nil {
invalidParams.Add(request.NewErrParamRequired("FileSystemId"))
}
if s.TagKeys == nil {
invalidParams.Add(request.NewErrParamRequired("TagKeys"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetFileSystemId sets the FileSystemId field's value.
func (s *DeleteTagsInput) SetFileSystemId(v string) *DeleteTagsInput {
s.FileSystemId = &v
return s
}
// SetTagKeys sets the TagKeys field's value.
func (s *DeleteTagsInput) SetTagKeys(v []*string) *DeleteTagsInput {
s.TagKeys = v
return s
}
type DeleteTagsOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation
func (s DeleteTagsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DeleteTagsOutput) GoString() string {
return s.String()
}
type DescribeFileSystemsInput struct {
_ struct{} `type:"structure"`
// (Optional) Restricts the list to the file system with this creation token
// (String). You specify a creation token when you create an Amazon EFS file
// system.
CreationToken *string `location:"querystring" locationName:"CreationToken" min:"1" type:"string"`
// (Optional) ID of the file system whose description you want to retrieve (String).
FileSystemId *string `location:"querystring" locationName:"FileSystemId" type:"string"`
// (Optional) Opaque pagination token returned from a previous DescribeFileSystems
// operation (String). If present, specifies to continue the list from where
// the returning call had left off.
Marker *string `location:"querystring" locationName:"Marker" type:"string"`
// (Optional) Specifies the maximum number of file systems to return in the
// response (integer). This parameter value must be greater than 0. The number
// of items that Amazon EFS returns is the minimum of the MaxItems parameter
// specified in the request and the service's internal maximum number of items
// per page.
MaxItems *int64 `location:"querystring" locationName:"MaxItems" min:"1" type:"integer"`
}
// String returns the string representation
func (s DescribeFileSystemsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribeFileSystemsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeFileSystemsInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DescribeFileSystemsInput"}
if s.CreationToken != nil && len(*s.CreationToken) < 1 {
invalidParams.Add(request.NewErrParamMinLen("CreationToken", 1))
}
if s.MaxItems != nil && *s.MaxItems < 1 {
invalidParams.Add(request.NewErrParamMinValue("MaxItems", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetCreationToken sets the CreationToken field's value.
func (s *DescribeFileSystemsInput) SetCreationToken(v string) *DescribeFileSystemsInput {
s.CreationToken = &v
return s
}
// SetFileSystemId sets the FileSystemId field's value.
func (s *DescribeFileSystemsInput) SetFileSystemId(v string) *DescribeFileSystemsInput {
s.FileSystemId = &v
return s
}
// SetMarker sets the Marker field's value.
func (s *DescribeFileSystemsInput) SetMarker(v string) *DescribeFileSystemsInput {
s.Marker = &v
return s
}
// SetMaxItems sets the MaxItems field's value.
func (s *DescribeFileSystemsInput) SetMaxItems(v int64) *DescribeFileSystemsInput {
s.MaxItems = &v
return s
}
type DescribeFileSystemsOutput struct {
_ struct{} `type:"structure"`
// Array of file system descriptions.
FileSystems []*UpdateFileSystemOutput `type:"list"`
// Present if provided by caller in the request (String).
Marker *string `type:"string"`
// Present if there are more file systems than returned in the response (String).
// You can use the NextMarker in the subsequent request to fetch the descriptions.
NextMarker *string `type:"string"`
}
// String returns the string representation
func (s DescribeFileSystemsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribeFileSystemsOutput) GoString() string {
return s.String()
}
// SetFileSystems sets the FileSystems field's value.
func (s *DescribeFileSystemsOutput) SetFileSystems(v []*UpdateFileSystemOutput) *DescribeFileSystemsOutput {
s.FileSystems = v
return s
}
// SetMarker sets the Marker field's value.
func (s *DescribeFileSystemsOutput) SetMarker(v string) *DescribeFileSystemsOutput {
s.Marker = &v
return s
}
// SetNextMarker sets the NextMarker field's value.
func (s *DescribeFileSystemsOutput) SetNextMarker(v string) *DescribeFileSystemsOutput {
s.NextMarker = &v
return s
}
type DescribeMountTargetSecurityGroupsInput struct {
_ struct{} `type:"structure"`
// ID of the mount target whose security groups you want to retrieve.
//
// MountTargetId is a required field
MountTargetId *string `location:"uri" locationName:"MountTargetId" type:"string" required:"true"`
}
// String returns the string representation
func (s DescribeMountTargetSecurityGroupsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribeMountTargetSecurityGroupsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeMountTargetSecurityGroupsInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DescribeMountTargetSecurityGroupsInput"}
if s.MountTargetId == nil {
invalidParams.Add(request.NewErrParamRequired("MountTargetId"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetMountTargetId sets the MountTargetId field's value.
func (s *DescribeMountTargetSecurityGroupsInput) SetMountTargetId(v string) *DescribeMountTargetSecurityGroupsInput {
s.MountTargetId = &v
return s
}
type DescribeMountTargetSecurityGroupsOutput struct {
_ struct{} `type:"structure"`
// Array of security groups.
//
// SecurityGroups is a required field
SecurityGroups []*string `type:"list" required:"true"`
}
// String returns the string representation
func (s DescribeMountTargetSecurityGroupsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribeMountTargetSecurityGroupsOutput) GoString() string {
return s.String()
}
// SetSecurityGroups sets the SecurityGroups field's value.
func (s *DescribeMountTargetSecurityGroupsOutput) SetSecurityGroups(v []*string) *DescribeMountTargetSecurityGroupsOutput {
s.SecurityGroups = v
return s
}
type DescribeMountTargetsInput struct {
_ struct{} `type:"structure"`
// (Optional) ID of the file system whose mount targets you want to list (String).
// It must be included in your request if MountTargetId is not included.
FileSystemId *string `location:"querystring" locationName:"FileSystemId" type:"string"`
// (Optional) Opaque pagination token returned from a previous DescribeMountTargets
// operation (String). If present, it specifies to continue the list from where
// the previous returning call left off.
Marker *string `location:"querystring" locationName:"Marker" type:"string"`
// (Optional) Maximum number of mount targets to return in the response. It
// must be an integer with a value greater than zero.
MaxItems *int64 `location:"querystring" locationName:"MaxItems" min:"1" type:"integer"`
// (Optional) ID of the mount target that you want to have described (String).
// It must be included in your request if FileSystemId is not included.
MountTargetId *string `location:"querystring" locationName:"MountTargetId" type:"string"`
}
// String returns the string representation
func (s DescribeMountTargetsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribeMountTargetsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeMountTargetsInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DescribeMountTargetsInput"}
if s.MaxItems != nil && *s.MaxItems < 1 {
invalidParams.Add(request.NewErrParamMinValue("MaxItems", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetFileSystemId sets the FileSystemId field's value.
func (s *DescribeMountTargetsInput) SetFileSystemId(v string) *DescribeMountTargetsInput {
s.FileSystemId = &v
return s
}
// SetMarker sets the Marker field's value.
func (s *DescribeMountTargetsInput) SetMarker(v string) *DescribeMountTargetsInput {
s.Marker = &v
return s
}
// SetMaxItems sets the MaxItems field's value.
func (s *DescribeMountTargetsInput) SetMaxItems(v int64) *DescribeMountTargetsInput {
s.MaxItems = &v
return s
}
// SetMountTargetId sets the MountTargetId field's value.
func (s *DescribeMountTargetsInput) SetMountTargetId(v string) *DescribeMountTargetsInput {
s.MountTargetId = &v
return s
}
type DescribeMountTargetsOutput struct {
_ struct{} `type:"structure"`
// If the request included the Marker, the response returns that value in this
// field.
Marker *string `type:"string"`
// Returns the file system's mount targets as an array of MountTargetDescription
// objects.
MountTargets []*MountTargetDescription `type:"list"`
// If a value is present, there are more mount targets to return. In a subsequent
// request, you can provide Marker in your request with this value to retrieve
// the next set of mount targets.
NextMarker *string `type:"string"`
}
// String returns the string representation
func (s DescribeMountTargetsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribeMountTargetsOutput) GoString() string {
return s.String()
}
// SetMarker sets the Marker field's value.
func (s *DescribeMountTargetsOutput) SetMarker(v string) *DescribeMountTargetsOutput {
s.Marker = &v
return s
}
// SetMountTargets sets the MountTargets field's value.
func (s *DescribeMountTargetsOutput) SetMountTargets(v []*MountTargetDescription) *DescribeMountTargetsOutput {
s.MountTargets = v
return s
}
// SetNextMarker sets the NextMarker field's value.
func (s *DescribeMountTargetsOutput) SetNextMarker(v string) *DescribeMountTargetsOutput {
s.NextMarker = &v
return s
}
type DescribeTagsInput struct {
_ struct{} `type:"structure"`
// ID of the file system whose tag set you want to retrieve.
//
// FileSystemId is a required field
FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`
// (Optional) Opaque pagination token returned from a previous DescribeTags
// operation (String). If present, it specifies to continue the list from where
// the previous call left off.
Marker *string `location:"querystring" locationName:"Marker" type:"string"`
// (Optional) Maximum number of file system tags to return in the response.
// It must be an integer with a value greater than zero.
MaxItems *int64 `location:"querystring" locationName:"MaxItems" min:"1" type:"integer"`
}
// String returns the string representation
func (s DescribeTagsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribeTagsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeTagsInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DescribeTagsInput"}
if s.FileSystemId == nil {
invalidParams.Add(request.NewErrParamRequired("FileSystemId"))
}
if s.MaxItems != nil && *s.MaxItems < 1 {
invalidParams.Add(request.NewErrParamMinValue("MaxItems", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetFileSystemId sets the FileSystemId field's value.
func (s *DescribeTagsInput) SetFileSystemId(v string) *DescribeTagsInput {
s.FileSystemId = &v
return s
}
// SetMarker sets the Marker field's value.
func (s *DescribeTagsInput) SetMarker(v string) *DescribeTagsInput {
s.Marker = &v
return s
}
// SetMaxItems sets the MaxItems field's value.
func (s *DescribeTagsInput) SetMaxItems(v int64) *DescribeTagsInput {
s.MaxItems = &v
return s
}
type DescribeTagsOutput struct {
_ struct{} `type:"structure"`
// If the request included a Marker, the response returns that value in this
// field.
Marker *string `type:"string"`
// If a value is present, there are more tags to return. In a subsequent request,
// you can provide the value of NextMarker as the value of the Marker parameter
// in your next request to retrieve the next set of tags.
NextMarker *string `type:"string"`
// Returns tags associated with the file system as an array of Tag objects.
//
// Tags is a required field
Tags []*Tag `type:"list" required:"true"`
}
// String returns the string representation
func (s DescribeTagsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribeTagsOutput) GoString() string {
return s.String()
}
// SetMarker sets the Marker field's value.
func (s *DescribeTagsOutput) SetMarker(v string) *DescribeTagsOutput {
s.Marker = &v
return s
}
// SetNextMarker sets the NextMarker field's value.
func (s *DescribeTagsOutput) SetNextMarker(v string) *DescribeTagsOutput {
s.NextMarker = &v
return s
}
// SetTags sets the Tags field's value.
func (s *DescribeTagsOutput) SetTags(v []*Tag) *DescribeTagsOutput {
s.Tags = v
return s
}
// Latest known metered size (in bytes) of data stored in the file system, in
// its Value field, and the time at which that size was determined in its Timestamp
// field. 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 the actual size only
// if the file system is not modified for a period longer than a couple of hours.
// Otherwise, the value is not necessarily the exact size the file system was
// at any instant in time.
type FileSystemSize struct {
_ struct{} `type:"structure"`
// Time at which the size of data, returned in the Value field, was determined.
// The value is the integer number of seconds since 1970-01-01T00:00:00Z.
Timestamp *time.Time `type:"timestamp"`
// Latest known metered size (in bytes) of data stored in the file system.
//
// Value is a required field
Value *int64 `type:"long" required:"true"`
}
// String returns the string representation
func (s FileSystemSize) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s FileSystemSize) GoString() string {
return s.String()
}
// SetTimestamp sets the Timestamp field's value.
func (s *FileSystemSize) SetTimestamp(v time.Time) *FileSystemSize {
s.Timestamp = &v
return s
}
// SetValue sets the Value field's value.
func (s *FileSystemSize) SetValue(v int64) *FileSystemSize {
s.Value = &v
return s
}
type ModifyMountTargetSecurityGroupsInput struct {
_ struct{} `type:"structure"`
// ID of the mount target whose security groups you want to modify.
//
// MountTargetId is a required field
MountTargetId *string `location:"uri" locationName:"MountTargetId" type:"string" required:"true"`
// Array of up to five VPC security group IDs.
SecurityGroups []*string `type:"list"`
}
// String returns the string representation
func (s ModifyMountTargetSecurityGroupsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ModifyMountTargetSecurityGroupsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ModifyMountTargetSecurityGroupsInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ModifyMountTargetSecurityGroupsInput"}
if s.MountTargetId == nil {
invalidParams.Add(request.NewErrParamRequired("MountTargetId"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetMountTargetId sets the MountTargetId field's value.
func (s *ModifyMountTargetSecurityGroupsInput) SetMountTargetId(v string) *ModifyMountTargetSecurityGroupsInput {
s.MountTargetId = &v
return s
}
// SetSecurityGroups sets the SecurityGroups field's value.
func (s *ModifyMountTargetSecurityGroupsInput) SetSecurityGroups(v []*string) *ModifyMountTargetSecurityGroupsInput {
s.SecurityGroups = v
return s
}
type ModifyMountTargetSecurityGroupsOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation
func (s ModifyMountTargetSecurityGroupsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ModifyMountTargetSecurityGroupsOutput) GoString() string {
return s.String()
}
// Provides a description of a mount target.
type MountTargetDescription struct {
_ struct{} `type:"structure"`
// ID of the file system for which the mount target is intended.
//
// FileSystemId is a required field
FileSystemId *string `type:"string" required:"true"`
// Address at which the file system may be mounted via the mount target.
IpAddress *string `type:"string"`
// Lifecycle state of the mount target.
//
// LifeCycleState is a required field
LifeCycleState *string `type:"string" required:"true" enum:"LifeCycleState"`
// System-assigned mount target ID.
//
// MountTargetId is a required field
MountTargetId *string `type:"string" required:"true"`
// ID of the network interface that Amazon EFS created when it created the mount
// target.
NetworkInterfaceId *string `type:"string"`
// AWS account ID that owns the resource.
OwnerId *string `type:"string"`
// ID of the mount target's subnet.
//
// SubnetId is a required field
SubnetId *string `type:"string" required:"true"`
}
// String returns the string representation
func (s MountTargetDescription) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s MountTargetDescription) GoString() string {
return s.String()
}
// SetFileSystemId sets the FileSystemId field's value.
func (s *MountTargetDescription) SetFileSystemId(v string) *MountTargetDescription {
s.FileSystemId = &v
return s
}
// SetIpAddress sets the IpAddress field's value.
func (s *MountTargetDescription) SetIpAddress(v string) *MountTargetDescription {
s.IpAddress = &v
return s
}
// SetLifeCycleState sets the LifeCycleState field's value.
func (s *MountTargetDescription) SetLifeCycleState(v string) *MountTargetDescription {
s.LifeCycleState = &v
return s
}
// SetMountTargetId sets the MountTargetId field's value.
func (s *MountTargetDescription) SetMountTargetId(v string) *MountTargetDescription {
s.MountTargetId = &v
return s
}
// SetNetworkInterfaceId sets the NetworkInterfaceId field's value.
func (s *MountTargetDescription) SetNetworkInterfaceId(v string) *MountTargetDescription {
s.NetworkInterfaceId = &v
return s
}
// SetOwnerId sets the OwnerId field's value.
func (s *MountTargetDescription) SetOwnerId(v string) *MountTargetDescription {
s.OwnerId = &v
return s
}
// SetSubnetId sets the SubnetId field's value.
func (s *MountTargetDescription) SetSubnetId(v string) *MountTargetDescription {
s.SubnetId = &v
return s
}
// A tag is a key-value pair. Allowed characters: letters, whitespace, and numbers,
// representable in UTF-8, and the following characters: + - = . _ : /
type Tag struct {
_ struct{} `type:"structure"`
// Tag key (String). The key can't start with aws:.
//
// Key is a required field
Key *string `min:"1" type:"string" required:"true"`
// Value of the tag key.
//
// Value is a required field
Value *string `type:"string" required:"true"`
}
// String returns the string representation
func (s Tag) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s Tag) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *Tag) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "Tag"}
if s.Key == nil {
invalidParams.Add(request.NewErrParamRequired("Key"))
}
if s.Key != nil && len(*s.Key) < 1 {
invalidParams.Add(request.NewErrParamMinLen("Key", 1))
}
if s.Value == nil {
invalidParams.Add(request.NewErrParamRequired("Value"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetKey sets the Key field's value.
func (s *Tag) SetKey(v string) *Tag {
s.Key = &v
return s
}
// SetValue sets the Value field's value.
func (s *Tag) SetValue(v string) *Tag {
s.Value = &v
return s
}
type UpdateFileSystemInput struct {
_ struct{} `type:"structure"`
// The ID of the file system that you want to update.
//
// FileSystemId is a required field
FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`
// (Optional) The amount of throughput, in MiB/s, that you want to provision
// for your file system. If you're not updating the amount of provisioned throughput
// for your file system, you don't need to provide this value in your request.
ProvisionedThroughputInMibps *float64 `type:"double"`
// (Optional) The throughput mode that you want your file system to use. If
// you're not updating your throughput mode, you don't need to provide this
// value in your request.
ThroughputMode *string `type:"string" enum:"ThroughputMode"`
}
// String returns the string representation
func (s UpdateFileSystemInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s UpdateFileSystemInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *UpdateFileSystemInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "UpdateFileSystemInput"}
if s.FileSystemId == nil {
invalidParams.Add(request.NewErrParamRequired("FileSystemId"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetFileSystemId sets the FileSystemId field's value.
func (s *UpdateFileSystemInput) SetFileSystemId(v string) *UpdateFileSystemInput {
s.FileSystemId = &v
return s
}
// SetProvisionedThroughputInMibps sets the ProvisionedThroughputInMibps field's value.
func (s *UpdateFileSystemInput) SetProvisionedThroughputInMibps(v float64) *UpdateFileSystemInput {
s.ProvisionedThroughputInMibps = &v
return s
}
// SetThroughputMode sets the ThroughputMode field's value.
func (s *UpdateFileSystemInput) SetThroughputMode(v string) *UpdateFileSystemInput {
s.ThroughputMode = &v
return s
}
// Description of the file system.
type UpdateFileSystemOutput struct {
_ struct{} `type:"structure"`
// 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" 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 *string `type:"string" required:"true" enum:"LifeCycleState"`
// 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 *string `type:"string" required:"true" enum:"PerformanceMode"`
// The throughput, measured in MiB/s, that you want to provision for a file
// system. The limit on throughput is 1024 MiB/s. You can get these limits increased
// by contacting AWS Support. For more information, see Amazon EFS Limits That
// You Can Increase (http://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits)
// in the Amazon EFS User Guide.
ProvisionedThroughputInMibps *float64 `type:"double"`
// Latest known metered size (in bytes) of data stored in the file system, 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.
// The SizeInBytes value doesn't 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, SizeInBytes represents 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 that the file system was at any point in
// time.
//
// SizeInBytes is a required field
SizeInBytes *FileSystemSize `type:"structure" required:"true"`
// The throughput mode for a file system. There are two throughput modes to
// choose from for your file system: bursting and provisioned. You can decrease
// your file system's throughput in Provisioned Throughput mode or change between
// the throughput modes as long as its been more than 24 hours since the last
// decrease or throughput mode change.
ThroughputMode *string `type:"string" enum:"ThroughputMode"`
}
// String returns the string representation
func (s UpdateFileSystemOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s UpdateFileSystemOutput) GoString() string {
return s.String()
}
// SetCreationTime sets the CreationTime field's value.
func (s *UpdateFileSystemOutput) SetCreationTime(v time.Time) *UpdateFileSystemOutput {
s.CreationTime = &v
return s
}
// SetCreationToken sets the CreationToken field's value.
func (s *UpdateFileSystemOutput) SetCreationToken(v string) *UpdateFileSystemOutput {
s.CreationToken = &v
return s
}
// SetEncrypted sets the Encrypted field's value.
func (s *UpdateFileSystemOutput) SetEncrypted(v bool) *UpdateFileSystemOutput {
s.Encrypted = &v
return s
}
// SetFileSystemId sets the FileSystemId field's value.
func (s *UpdateFileSystemOutput) SetFileSystemId(v string) *UpdateFileSystemOutput {
s.FileSystemId = &v
return s
}
// SetKmsKeyId sets the KmsKeyId field's value.
func (s *UpdateFileSystemOutput) SetKmsKeyId(v string) *UpdateFileSystemOutput {
s.KmsKeyId = &v
return s
}
// SetLifeCycleState sets the LifeCycleState field's value.
func (s *UpdateFileSystemOutput) SetLifeCycleState(v string) *UpdateFileSystemOutput {
s.LifeCycleState = &v
return s
}
// SetName sets the Name field's value.
func (s *UpdateFileSystemOutput) SetName(v string) *UpdateFileSystemOutput {
s.Name = &v
return s
}
// SetNumberOfMountTargets sets the NumberOfMountTargets field's value.
func (s *UpdateFileSystemOutput) SetNumberOfMountTargets(v int64) *UpdateFileSystemOutput {
s.NumberOfMountTargets = &v
return s
}
// SetOwnerId sets the OwnerId field's value.
func (s *UpdateFileSystemOutput) SetOwnerId(v string) *UpdateFileSystemOutput {
s.OwnerId = &v
return s
}
// SetPerformanceMode sets the PerformanceMode field's value.
func (s *UpdateFileSystemOutput) SetPerformanceMode(v string) *UpdateFileSystemOutput {
s.PerformanceMode = &v
return s
}
// SetProvisionedThroughputInMibps sets the ProvisionedThroughputInMibps field's value.
func (s *UpdateFileSystemOutput) SetProvisionedThroughputInMibps(v float64) *UpdateFileSystemOutput {
s.ProvisionedThroughputInMibps = &v
return s
}
// SetSizeInBytes sets the SizeInBytes field's value.
func (s *UpdateFileSystemOutput) SetSizeInBytes(v *FileSystemSize) *UpdateFileSystemOutput {
s.SizeInBytes = v
return s
}
// SetThroughputMode sets the ThroughputMode field's value.
func (s *UpdateFileSystemOutput) SetThroughputMode(v string) *UpdateFileSystemOutput {
s.ThroughputMode = &v
return s
}
const (
// LifeCycleStateCreating is a LifeCycleState enum value
LifeCycleStateCreating = "creating"
// LifeCycleStateAvailable is a LifeCycleState enum value
LifeCycleStateAvailable = "available"
// LifeCycleStateUpdating is a LifeCycleState enum value
LifeCycleStateUpdating = "updating"
// LifeCycleStateDeleting is a LifeCycleState enum value
LifeCycleStateDeleting = "deleting"
// LifeCycleStateDeleted is a LifeCycleState enum value
LifeCycleStateDeleted = "deleted"
)
const (
// PerformanceModeGeneralPurpose is a PerformanceMode enum value
PerformanceModeGeneralPurpose = "generalPurpose"
// PerformanceModeMaxIo is a PerformanceMode enum value
PerformanceModeMaxIo = "maxIO"
)
const (
// ThroughputModeBursting is a ThroughputMode enum value
ThroughputModeBursting = "bursting"
// ThroughputModeProvisioned is a ThroughputMode enum value
ThroughputModeProvisioned = "provisioned"
)