efs

package
v1.20.14 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 2, 2019 License: Apache-2.0 Imports: 10 Imported by: 366

Documentation

Overview

Package efs provides the client and types for making API requests to Amazon Elastic File System.

Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use with Amazon EC2 instances in the AWS Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and remove files, so your applications have the storage they need, when they need it. For more information, see the User Guide (https://docs.aws.amazon.com/efs/latest/ug/api-reference.html).

See https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01 for more information on this service.

See efs package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/efs/

Using the Client

To contact Amazon Elastic File System with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Elastic File System client EFS for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/efs/#New

Index

Examples

Constants

View Source 
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"
)
View Source 
const (
	// PerformanceModeGeneralPurpose is a PerformanceMode enum value
	PerformanceModeGeneralPurpose = "generalPurpose"

	// PerformanceModeMaxIo is a PerformanceMode enum value
	PerformanceModeMaxIo = "maxIO"
)
View Source 
const (
	// ThroughputModeBursting is a ThroughputMode enum value
	ThroughputModeBursting = "bursting"

	// ThroughputModeProvisioned is a ThroughputMode enum value
	ThroughputModeProvisioned = "provisioned"
)
View Source 
const (

	// ErrCodeBadRequest for service response error code
	// "BadRequest".
	//
	// Returned if the request is malformed or contains an error such as an invalid
	// parameter value or a missing required parameter.
	ErrCodeBadRequest = "BadRequest"

	// ErrCodeDependencyTimeout for service response error code
	// "DependencyTimeout".
	//
	// The service timed out trying to fulfill the request, and the client should
	// try the call again.
	ErrCodeDependencyTimeout = "DependencyTimeout"

	// ErrCodeFileSystemAlreadyExists for service response error code
	// "FileSystemAlreadyExists".
	//
	// Returned if the file system you are trying to create already exists, with
	// the creation token you provided.
	ErrCodeFileSystemAlreadyExists = "FileSystemAlreadyExists"

	// ErrCodeFileSystemInUse for service response error code
	// "FileSystemInUse".
	//
	// Returned if a file system has mount targets.
	ErrCodeFileSystemInUse = "FileSystemInUse"

	// ErrCodeFileSystemLimitExceeded for service response error code
	// "FileSystemLimitExceeded".
	//
	// Returned if the AWS account has already created the maximum number of file
	// systems allowed per account.
	ErrCodeFileSystemLimitExceeded = "FileSystemLimitExceeded"

	// ErrCodeFileSystemNotFound for service response error code
	// "FileSystemNotFound".
	//
	// Returned if the specified FileSystemId value doesn't exist in the requester's
	// AWS account.
	ErrCodeFileSystemNotFound = "FileSystemNotFound"

	// ErrCodeIncorrectFileSystemLifeCycleState for service response error code
	// "IncorrectFileSystemLifeCycleState".
	//
	// Returned if the file system's lifecycle state is not "available".
	ErrCodeIncorrectFileSystemLifeCycleState = "IncorrectFileSystemLifeCycleState"

	// ErrCodeIncorrectMountTargetState for service response error code
	// "IncorrectMountTargetState".
	//
	// Returned if the mount target is not in the correct state for the operation.
	ErrCodeIncorrectMountTargetState = "IncorrectMountTargetState"

	// ErrCodeInsufficientThroughputCapacity for service response error code
	// "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.
	ErrCodeInsufficientThroughputCapacity = "InsufficientThroughputCapacity"

	// ErrCodeInternalServerError for service response error code
	// "InternalServerError".
	//
	// Returned if an error occurred on the server side.
	ErrCodeInternalServerError = "InternalServerError"

	// ErrCodeIpAddressInUse for service response error code
	// "IpAddressInUse".
	//
	// Returned if the request specified an IpAddress that is already in use in
	// the subnet.
	ErrCodeIpAddressInUse = "IpAddressInUse"

	// ErrCodeMountTargetConflict for service response error code
	// "MountTargetConflict".
	//
	// Returned if the mount target would violate one of the specified restrictions
	// based on the file system's existing mount targets.
	ErrCodeMountTargetConflict = "MountTargetConflict"

	// ErrCodeMountTargetNotFound for service response error code
	// "MountTargetNotFound".
	//
	// Returned if there is no mount target with the specified ID found in the caller's
	// account.
	ErrCodeMountTargetNotFound = "MountTargetNotFound"

	// ErrCodeNetworkInterfaceLimitExceeded for service response error code
	// "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 (https://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).
	ErrCodeNetworkInterfaceLimitExceeded = "NetworkInterfaceLimitExceeded"

	// ErrCodeNoFreeAddressesInSubnet for service response error code
	// "NoFreeAddressesInSubnet".
	//
	// Returned if IpAddress was not specified in the request and there are no free
	// IP addresses in the subnet.
	ErrCodeNoFreeAddressesInSubnet = "NoFreeAddressesInSubnet"

	// ErrCodeSecurityGroupLimitExceeded for service response error code
	// "SecurityGroupLimitExceeded".
	//
	// Returned if the size of SecurityGroups specified in the request is greater
	// than five.
	ErrCodeSecurityGroupLimitExceeded = "SecurityGroupLimitExceeded"

	// ErrCodeSecurityGroupNotFound for service response error code
	// "SecurityGroupNotFound".
	//
	// Returned if one of the specified security groups doesn't exist in the subnet's
	// VPC.
	ErrCodeSecurityGroupNotFound = "SecurityGroupNotFound"

	// ErrCodeSubnetNotFound for service response error code
	// "SubnetNotFound".
	//
	// Returned if there is no subnet with ID SubnetId provided in the request.
	ErrCodeSubnetNotFound = "SubnetNotFound"

	// ErrCodeThroughputLimitExceeded for service response error code
	// "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.
	ErrCodeThroughputLimitExceeded = "ThroughputLimitExceeded"

	// ErrCodeTooManyRequests for service response error code
	// "TooManyRequests".
	//
	// Returned if you don’t wait at least 24 hours before changing the throughput
	// mode, or decreasing the Provisioned Throughput value.
	ErrCodeTooManyRequests = "TooManyRequests"

	// ErrCodeUnsupportedAvailabilityZone for service response error code
	// "UnsupportedAvailabilityZone".
	ErrCodeUnsupportedAvailabilityZone = "UnsupportedAvailabilityZone"
)
View Source 
const (
	ServiceName = "elasticfilesystem" // Name of service.
	EndpointsID = ServiceName         // ID to lookup a service endpoint with.
	ServiceID   = "EFS"               // ServiceID is a unique identifer of a specific service.
)

Service information constants

View Source 
const (
	// TransitionToIARulesAfter30Days is a TransitionToIARules enum value
	TransitionToIARulesAfter30Days = "AFTER_30_DAYS"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateFileSystemInput 

type CreateFileSystemInput struct {

	// A 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 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 nondefault 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 performance mode 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. The
	// performance mode 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. Valid values are 1-1024. Required if ThroughputMode
	// is set to provisioned. The upper limit for throughput is 1024 MiB/s. You
	// can get this limit increased by contacting AWS Support. For more information,
	// see Amazon EFS Limits That You Can Increase (https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits)
	// in the Amazon EFS User Guide.
	ProvisionedThroughputInMibps *float64 `min:"1" type:"double"`

	// A value that specifies to create one or more tags associated with the file
	// system. Each tag is a user-defined key-value pair. Name your file system
	// on creation by including a "Key":"Name","Value":"{value}" key-value pair.
	Tags []*Tag `type:"list"`

	// 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. If you
	// set ThroughputMode to provisioned, you must also set a value for ProvisionedThroughPutInMibps.
	// You can decrease your file system's throughput in Provisioned Throughput
	// mode or change between the throughput modes as long as it’s been more than
	// 24 hours since the last decrease or throughput mode change. For more, see
	// Specifying Throughput with Provisioned Mode (https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput)
	// in the Amazon EFS User Guide.
	ThroughputMode *string `type:"string" enum:"ThroughputMode"`
	// contains filtered or unexported fields
}

func (CreateFileSystemInput) GoString added in v0.6.5 

func (s CreateFileSystemInput) GoString() string

GoString returns the string representation

func (*CreateFileSystemInput) SetCreationToken added in v1.5.0 

func (s *CreateFileSystemInput) SetCreationToken(v string) *CreateFileSystemInput

SetCreationToken sets the CreationToken field's value.

func (*CreateFileSystemInput) SetEncrypted added in v1.10.25 

func (s *CreateFileSystemInput) SetEncrypted(v bool) *CreateFileSystemInput

SetEncrypted sets the Encrypted field's value.

func (*CreateFileSystemInput) SetKmsKeyId added in v1.10.25 

func (s *CreateFileSystemInput) SetKmsKeyId(v string) *CreateFileSystemInput

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateFileSystemInput) SetPerformanceMode added in v1.5.0 

func (s *CreateFileSystemInput) SetPerformanceMode(v string) *CreateFileSystemInput

SetPerformanceMode sets the PerformanceMode field's value.

func (*CreateFileSystemInput) SetProvisionedThroughputInMibps added in v1.14.26 

func (s *CreateFileSystemInput) SetProvisionedThroughputInMibps(v float64) *CreateFileSystemInput

SetProvisionedThroughputInMibps sets the ProvisionedThroughputInMibps field's value.

func (*CreateFileSystemInput) SetTags added in v1.17.1 

func (s *CreateFileSystemInput) SetTags(v []*Tag) *CreateFileSystemInput

SetTags sets the Tags field's value.

func (*CreateFileSystemInput) SetThroughputMode added in v1.14.26 

func (s *CreateFileSystemInput) SetThroughputMode(v string) *CreateFileSystemInput

SetThroughputMode sets the ThroughputMode field's value.

func (CreateFileSystemInput) String added in v0.6.5 

func (s CreateFileSystemInput) String() string

String returns the string representation

func (*CreateFileSystemInput) Validate added in v1.1.21 

func (s *CreateFileSystemInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateMountTargetInput 

type CreateMountTargetInput struct {

	// The 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"`

	// The ID of the subnet to add the mount target in.
	//
	// SubnetId is a required field
	SubnetId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateMountTargetInput) GoString added in v0.6.5 

func (s CreateMountTargetInput) GoString() string

GoString returns the string representation

func (*CreateMountTargetInput) SetFileSystemId added in v1.5.0 

func (s *CreateMountTargetInput) SetFileSystemId(v string) *CreateMountTargetInput

SetFileSystemId sets the FileSystemId field's value.

func (*CreateMountTargetInput) SetIpAddress added in v1.5.0 

func (s *CreateMountTargetInput) SetIpAddress(v string) *CreateMountTargetInput

SetIpAddress sets the IpAddress field's value.

func (*CreateMountTargetInput) SetSecurityGroups added in v1.5.0 

func (s *CreateMountTargetInput) SetSecurityGroups(v []*string) *CreateMountTargetInput

SetSecurityGroups sets the SecurityGroups field's value.

func (*CreateMountTargetInput) SetSubnetId added in v1.5.0 

func (s *CreateMountTargetInput) SetSubnetId(v string) *CreateMountTargetInput

SetSubnetId sets the SubnetId field's value.

func (CreateMountTargetInput) String added in v0.6.5 

func (s CreateMountTargetInput) String() string

String returns the string representation

func (*CreateMountTargetInput) Validate added in v1.1.21 

func (s *CreateMountTargetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateTagsInput 

type CreateTagsInput struct {

	// The 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"`

	// An 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"`
	// contains filtered or unexported fields
}

func (CreateTagsInput) GoString added in v0.6.5 

func (s CreateTagsInput) GoString() string

GoString returns the string representation

func (*CreateTagsInput) SetFileSystemId added in v1.5.0 

func (s *CreateTagsInput) SetFileSystemId(v string) *CreateTagsInput

SetFileSystemId sets the FileSystemId field's value.

func (*CreateTagsInput) SetTags added in v1.5.0 

func (s *CreateTagsInput) SetTags(v []*Tag) *CreateTagsInput

SetTags sets the Tags field's value.

func (CreateTagsInput) String added in v0.6.5 

func (s CreateTagsInput) String() string

String returns the string representation

func (*CreateTagsInput) Validate added in v1.1.21 

func (s *CreateTagsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateTagsOutput 

type CreateTagsOutput struct {
	// contains filtered or unexported fields
}

func (CreateTagsOutput) GoString added in v0.6.5 

func (s CreateTagsOutput) GoString() string

GoString returns the string representation

func (CreateTagsOutput) String added in v0.6.5 

func (s CreateTagsOutput) String() string

String returns the string representation

type DeleteFileSystemInput 

type DeleteFileSystemInput struct {

	// The ID of the file system you want to delete.
	//
	// FileSystemId is a required field
	FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteFileSystemInput) GoString added in v0.6.5 

func (s DeleteFileSystemInput) GoString() string

GoString returns the string representation

func (*DeleteFileSystemInput) SetFileSystemId added in v1.5.0 

func (s *DeleteFileSystemInput) SetFileSystemId(v string) *DeleteFileSystemInput

SetFileSystemId sets the FileSystemId field's value.

func (DeleteFileSystemInput) String added in v0.6.5 

func (s DeleteFileSystemInput) String() string

String returns the string representation

func (*DeleteFileSystemInput) Validate added in v1.1.21 

func (s *DeleteFileSystemInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteFileSystemOutput 

type DeleteFileSystemOutput struct {
	// contains filtered or unexported fields
}

func (DeleteFileSystemOutput) GoString added in v0.6.5 

func (s DeleteFileSystemOutput) GoString() string

GoString returns the string representation

func (DeleteFileSystemOutput) String added in v0.6.5 

func (s DeleteFileSystemOutput) String() string

String returns the string representation

type DeleteMountTargetInput 

type DeleteMountTargetInput struct {

	// The ID of the mount target to delete (String).
	//
	// MountTargetId is a required field
	MountTargetId *string `location:"uri" locationName:"MountTargetId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteMountTargetInput) GoString added in v0.6.5 

func (s DeleteMountTargetInput) GoString() string

GoString returns the string representation

func (*DeleteMountTargetInput) SetMountTargetId added in v1.5.0 

func (s *DeleteMountTargetInput) SetMountTargetId(v string) *DeleteMountTargetInput

SetMountTargetId sets the MountTargetId field's value.

func (DeleteMountTargetInput) String added in v0.6.5 

func (s DeleteMountTargetInput) String() string

String returns the string representation

func (*DeleteMountTargetInput) Validate added in v1.1.21 

func (s *DeleteMountTargetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteMountTargetOutput 

type DeleteMountTargetOutput struct {
	// contains filtered or unexported fields
}

func (DeleteMountTargetOutput) GoString added in v0.6.5 

func (s DeleteMountTargetOutput) GoString() string

GoString returns the string representation

func (DeleteMountTargetOutput) String added in v0.6.5 

func (s DeleteMountTargetOutput) String() string

String returns the string representation

type DeleteTagsInput 

type DeleteTagsInput struct {

	// The 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"`

	// A list of tag keys to delete.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteTagsInput) GoString added in v0.6.5 

func (s DeleteTagsInput) GoString() string

GoString returns the string representation

func (*DeleteTagsInput) SetFileSystemId added in v1.5.0 

func (s *DeleteTagsInput) SetFileSystemId(v string) *DeleteTagsInput

SetFileSystemId sets the FileSystemId field's value.

func (*DeleteTagsInput) SetTagKeys added in v1.5.0 

func (s *DeleteTagsInput) SetTagKeys(v []*string) *DeleteTagsInput

SetTagKeys sets the TagKeys field's value.

func (DeleteTagsInput) String added in v0.6.5 

func (s DeleteTagsInput) String() string

String returns the string representation

func (*DeleteTagsInput) Validate added in v1.1.21 

func (s *DeleteTagsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteTagsOutput 

type DeleteTagsOutput struct {
	// contains filtered or unexported fields
}

func (DeleteTagsOutput) GoString added in v0.6.5 

func (s DeleteTagsOutput) GoString() string

GoString returns the string representation

func (DeleteTagsOutput) String added in v0.6.5 

func (s DeleteTagsOutput) String() string

String returns the string representation

type DescribeFileSystemsInput 

type DescribeFileSystemsInput struct {

	// (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). Currently, this number is automatically set to 10, and
	// other values are ignored. The response is paginated at 10 per page if you
	// have more than 10 file systems.
	MaxItems *int64 `location:"querystring" locationName:"MaxItems" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeFileSystemsInput) GoString added in v0.6.5 

func (s DescribeFileSystemsInput) GoString() string

GoString returns the string representation

func (*DescribeFileSystemsInput) SetCreationToken added in v1.5.0 

func (s *DescribeFileSystemsInput) SetCreationToken(v string) *DescribeFileSystemsInput

SetCreationToken sets the CreationToken field's value.

func (*DescribeFileSystemsInput) SetFileSystemId added in v1.5.0 

func (s *DescribeFileSystemsInput) SetFileSystemId(v string) *DescribeFileSystemsInput

SetFileSystemId sets the FileSystemId field's value.

func (*DescribeFileSystemsInput) SetMarker added in v1.5.0 

func (s *DescribeFileSystemsInput) SetMarker(v string) *DescribeFileSystemsInput

SetMarker sets the Marker field's value.

func (*DescribeFileSystemsInput) SetMaxItems added in v1.5.0 

func (s *DescribeFileSystemsInput) SetMaxItems(v int64) *DescribeFileSystemsInput

SetMaxItems sets the MaxItems field's value.

func (DescribeFileSystemsInput) String added in v0.6.5 

func (s DescribeFileSystemsInput) String() string

String returns the string representation

func (*DescribeFileSystemsInput) Validate added in v1.1.21 

func (s *DescribeFileSystemsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeFileSystemsOutput 

type DescribeFileSystemsOutput struct {

	// An array of file system descriptions.
	FileSystems []*FileSystemDescription `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"`
	// contains filtered or unexported fields
}

func (DescribeFileSystemsOutput) GoString added in v0.6.5 

func (s DescribeFileSystemsOutput) GoString() string

GoString returns the string representation

func (*DescribeFileSystemsOutput) SetFileSystems added in v1.5.0 

func (s *DescribeFileSystemsOutput) SetFileSystems(v []*FileSystemDescription) *DescribeFileSystemsOutput

SetFileSystems sets the FileSystems field's value.

func (*DescribeFileSystemsOutput) SetMarker added in v1.5.0 

func (s *DescribeFileSystemsOutput) SetMarker(v string) *DescribeFileSystemsOutput

SetMarker sets the Marker field's value.

func (*DescribeFileSystemsOutput) SetNextMarker added in v1.5.0 

func (s *DescribeFileSystemsOutput) SetNextMarker(v string) *DescribeFileSystemsOutput

SetNextMarker sets the NextMarker field's value.

func (DescribeFileSystemsOutput) String added in v0.6.5 

func (s DescribeFileSystemsOutput) String() string

String returns the string representation

type DescribeLifecycleConfigurationInput added in v1.16.34 

type DescribeLifecycleConfigurationInput struct {

	// The ID of the file system whose LifecycleConfiguration object you want to
	// retrieve (String).
	//
	// FileSystemId is a required field
	FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeLifecycleConfigurationInput) GoString added in v1.16.34 

func (s DescribeLifecycleConfigurationInput) GoString() string

GoString returns the string representation

func (*DescribeLifecycleConfigurationInput) SetFileSystemId added in v1.16.34 

func (s *DescribeLifecycleConfigurationInput) SetFileSystemId(v string) *DescribeLifecycleConfigurationInput

SetFileSystemId sets the FileSystemId field's value.

func (DescribeLifecycleConfigurationInput) String added in v1.16.34 

func (s DescribeLifecycleConfigurationInput) String() string

String returns the string representation

func (*DescribeLifecycleConfigurationInput) Validate added in v1.16.34 

func (s *DescribeLifecycleConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeLifecycleConfigurationOutput added in v1.16.34 

type DescribeLifecycleConfigurationOutput struct {

	// An array of lifecycle management policies. Currently, EFS supports a maximum
	// of one policy per file system.
	LifecyclePolicies []*LifecyclePolicy `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeLifecycleConfigurationOutput) GoString added in v1.16.34 

func (s DescribeLifecycleConfigurationOutput) GoString() string

GoString returns the string representation

func (*DescribeLifecycleConfigurationOutput) SetLifecyclePolicies added in v1.16.34 

func (s *DescribeLifecycleConfigurationOutput) SetLifecyclePolicies(v []*LifecyclePolicy) *DescribeLifecycleConfigurationOutput

SetLifecyclePolicies sets the LifecyclePolicies field's value.

func (DescribeLifecycleConfigurationOutput) String added in v1.16.34 

func (s DescribeLifecycleConfigurationOutput) String() string

String returns the string representation

type DescribeMountTargetSecurityGroupsInput 

type DescribeMountTargetSecurityGroupsInput struct {

	// The 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"`
	// contains filtered or unexported fields
}

func (DescribeMountTargetSecurityGroupsInput) GoString added in v0.6.5 

func (s DescribeMountTargetSecurityGroupsInput) GoString() string

GoString returns the string representation

func (*DescribeMountTargetSecurityGroupsInput) SetMountTargetId added in v1.5.0 

func (s *DescribeMountTargetSecurityGroupsInput) SetMountTargetId(v string) *DescribeMountTargetSecurityGroupsInput

SetMountTargetId sets the MountTargetId field's value.

func (DescribeMountTargetSecurityGroupsInput) String added in v0.6.5 

func (s DescribeMountTargetSecurityGroupsInput) String() string

String returns the string representation

func (*DescribeMountTargetSecurityGroupsInput) Validate added in v1.1.21 

func (s *DescribeMountTargetSecurityGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeMountTargetSecurityGroupsOutput 

type DescribeMountTargetSecurityGroupsOutput struct {

	// An array of security groups.
	//
	// SecurityGroups is a required field
	SecurityGroups []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeMountTargetSecurityGroupsOutput) GoString added in v0.6.5 

func (s DescribeMountTargetSecurityGroupsOutput) GoString() string

GoString returns the string representation

func (*DescribeMountTargetSecurityGroupsOutput) SetSecurityGroups added in v1.5.0 

func (s *DescribeMountTargetSecurityGroupsOutput) SetSecurityGroups(v []*string) *DescribeMountTargetSecurityGroupsOutput

SetSecurityGroups sets the SecurityGroups field's value.

func (DescribeMountTargetSecurityGroupsOutput) String added in v0.6.5 

func (s DescribeMountTargetSecurityGroupsOutput) String() string

String returns the string representation

type DescribeMountTargetsInput 

type DescribeMountTargetsInput struct {

	// (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. Currently,
	// this number is automatically set to 10, and other values are ignored. The
	// response is paginated at 10 per page if you have more than 10 mount targets.
	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"`
	// contains filtered or unexported fields
}

func (DescribeMountTargetsInput) GoString added in v0.6.5 

func (s DescribeMountTargetsInput) GoString() string

GoString returns the string representation

func (*DescribeMountTargetsInput) SetFileSystemId added in v1.5.0 

func (s *DescribeMountTargetsInput) SetFileSystemId(v string) *DescribeMountTargetsInput

SetFileSystemId sets the FileSystemId field's value.

func (*DescribeMountTargetsInput) SetMarker added in v1.5.0 

func (s *DescribeMountTargetsInput) SetMarker(v string) *DescribeMountTargetsInput

SetMarker sets the Marker field's value.

func (*DescribeMountTargetsInput) SetMaxItems added in v1.5.0 

func (s *DescribeMountTargetsInput) SetMaxItems(v int64) *DescribeMountTargetsInput

SetMaxItems sets the MaxItems field's value.

func (*DescribeMountTargetsInput) SetMountTargetId added in v1.5.0 

func (s *DescribeMountTargetsInput) SetMountTargetId(v string) *DescribeMountTargetsInput

SetMountTargetId sets the MountTargetId field's value.

func (DescribeMountTargetsInput) String added in v0.6.5 

func (s DescribeMountTargetsInput) String() string

String returns the string representation

func (*DescribeMountTargetsInput) Validate added in v1.1.21 

func (s *DescribeMountTargetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeMountTargetsOutput 

type DescribeMountTargetsOutput struct {

	// 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"`
	// contains filtered or unexported fields
}

func (DescribeMountTargetsOutput) GoString added in v0.6.5 

func (s DescribeMountTargetsOutput) GoString() string

GoString returns the string representation

func (*DescribeMountTargetsOutput) SetMarker added in v1.5.0 

func (s *DescribeMountTargetsOutput) SetMarker(v string) *DescribeMountTargetsOutput

SetMarker sets the Marker field's value.

func (*DescribeMountTargetsOutput) SetMountTargets added in v1.5.0 

func (s *DescribeMountTargetsOutput) SetMountTargets(v []*MountTargetDescription) *DescribeMountTargetsOutput

SetMountTargets sets the MountTargets field's value.

func (*DescribeMountTargetsOutput) SetNextMarker added in v1.5.0 

func (s *DescribeMountTargetsOutput) SetNextMarker(v string) *DescribeMountTargetsOutput

SetNextMarker sets the NextMarker field's value.

func (DescribeMountTargetsOutput) String added in v0.6.5 

func (s DescribeMountTargetsOutput) String() string

String returns the string representation

type DescribeTagsInput 

type DescribeTagsInput struct {

	// The 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) An 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) The maximum number of file system tags to return in the response.
	// Currently, this number is automatically set to 10, and other values are ignored.
	// The response is paginated at 10 per page if you have more than 10 tags.
	MaxItems *int64 `location:"querystring" locationName:"MaxItems" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeTagsInput) GoString added in v0.6.5 

func (s DescribeTagsInput) GoString() string

GoString returns the string representation

func (*DescribeTagsInput) SetFileSystemId added in v1.5.0 

func (s *DescribeTagsInput) SetFileSystemId(v string) *DescribeTagsInput

SetFileSystemId sets the FileSystemId field's value.

func (*DescribeTagsInput) SetMarker added in v1.5.0 

func (s *DescribeTagsInput) SetMarker(v string) *DescribeTagsInput

SetMarker sets the Marker field's value.

func (*DescribeTagsInput) SetMaxItems added in v1.5.0 

func (s *DescribeTagsInput) SetMaxItems(v int64) *DescribeTagsInput

SetMaxItems sets the MaxItems field's value.

func (DescribeTagsInput) String added in v0.6.5 

func (s DescribeTagsInput) String() string

String returns the string representation

func (*DescribeTagsInput) Validate added in v1.1.21 

func (s *DescribeTagsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeTagsOutput 

type DescribeTagsOutput struct {

	// 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"`
	// contains filtered or unexported fields
}

func (DescribeTagsOutput) GoString added in v0.6.5 

func (s DescribeTagsOutput) GoString() string

GoString returns the string representation

func (*DescribeTagsOutput) SetMarker added in v1.5.0 

func (s *DescribeTagsOutput) SetMarker(v string) *DescribeTagsOutput

SetMarker sets the Marker field's value.

func (*DescribeTagsOutput) SetNextMarker added in v1.5.0 

func (s *DescribeTagsOutput) SetNextMarker(v string) *DescribeTagsOutput

SetNextMarker sets the NextMarker field's value.

func (*DescribeTagsOutput) SetTags added in v1.5.0 

func (s *DescribeTagsOutput) SetTags(v []*Tag) *DescribeTagsOutput

SetTags sets the Tags field's value.

func (DescribeTagsOutput) String added in v0.6.5 

func (s DescribeTagsOutput) String() string

String returns the string representation

type EFS 

type EFS struct {
	*client.Client
}

EFS provides the API operation methods for making requests to Amazon Elastic File System. See this package's package overview docs for details on the service.

EFS methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *EFS

New creates a new instance of the EFS client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a EFS client from just a session.
svc := efs.New(mySession)

// Create a EFS client with additional configuration
svc := efs.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*EFS) CreateFileSystem 

func (c *EFS) CreateFileSystem(input *CreateFileSystemInput) (*FileSystemDescription, error)

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 (https://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 by using the mount target. For more information, see Amazon EFS: How it Works (https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html).

This operation requires permissions for the elasticfilesystem:CreateFileSystem action.

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

Example (Shared00)

To create a new file system

This operation creates a new file system with the default generalpurpose performance mode. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/efs"
)

func main() {
	svc := efs.New(session.New())
	input := &efs.CreateFileSystemInput{
		CreationToken:   aws.String("tokenstring"),
		PerformanceMode: aws.String("generalPurpose"),
		Tags: []*efs.Tag{
			{
				Key:   aws.String("Name"),
				Value: aws.String("MyFileSystem"),
			},
		},
	}

	result, err := svc.CreateFileSystem(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case efs.ErrCodeBadRequest:
				fmt.Println(efs.ErrCodeBadRequest, aerr.Error())
			case efs.ErrCodeInternalServerError:
				fmt.Println(efs.ErrCodeInternalServerError, aerr.Error())
			case efs.ErrCodeFileSystemAlreadyExists:
				fmt.Println(efs.ErrCodeFileSystemAlreadyExists, aerr.Error())
			case efs.ErrCodeFileSystemLimitExceeded:
				fmt.Println(efs.ErrCodeFileSystemLimitExceeded, aerr.Error())
			case efs.ErrCodeInsufficientThroughputCapacity:
				fmt.Println(efs.ErrCodeInsufficientThroughputCapacity, aerr.Error())
			case efs.ErrCodeThroughputLimitExceeded:
				fmt.Println(efs.ErrCodeThroughputLimitExceeded, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*EFS) CreateFileSystemRequest 

func (c *EFS) CreateFileSystemRequest(input *CreateFileSystemInput) (req *request.Request, output *FileSystemDescription)

CreateFileSystemRequest generates a "aws/request.Request" representing the client's request for the CreateFileSystem operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateFileSystem for more information on using the CreateFileSystem API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateFileSystemRequest method.
req, resp := client.CreateFileSystemRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateFileSystem

func (*EFS) CreateFileSystemWithContext added in v1.8.0 

func (c *EFS) CreateFileSystemWithContext(ctx aws.Context, input *CreateFileSystemInput, opts ...request.Option) (*FileSystemDescription, error)

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 (*EFS) CreateMountTarget 

func (c *EFS) CreateMountTarget(input *CreateMountTargetInput) (*MountTargetDescription, error)

CreateMountTarget API operation for Amazon Elastic File System.

Creates a mount target for a file system. You can then mount the file system on EC2 instances by using the mount target.

You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system. For more information, see Amazon EFS: How it Works (https://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 by using the mount target can resolve the mount target's DNS name to its IP address. For more information, see How it Works: Implementation Overview (https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html#how-it-works-implementation).

Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the subnet specified in the request to add another mount target must meet the following requirements:

  • Must belong to the same VPC as the subnets of the existing mount targets

  • Must not be in the same Availability Zone as any of the subnets of the existing mount targets

If the request satisfies the requirements, Amazon EFS does the following:

  • Creates a new mount target in the specified subnet.

  • Also creates a new network interface in the subnet as follows: If the request provides an IpAddress, Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2 CreateNetworkInterface call does when a request does not specify a primary private IP address). If the request provides SecurityGroups, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC. Assigns the description Mount target fsmt-id for file system fs-id where fsmt-id is the mount target ID, and fs-id is the FileSystemId. Sets the requesterManaged property of the network interface to true, and the requesterId value to EFS. Each Amazon EFS mount target has one corresponding requester-managed EC2 network interface. After the network interface is created, Amazon EFS sets the NetworkInterfaceId field in the mount target's description to the network interface ID, and the IpAddress field to its address. If network interface creation fails, the entire CreateMountTarget operation fails.

The CreateMountTarget call returns only after creating the network interface, but while the mount target state is still creating, you can check the mount target creation status by calling the DescribeMountTargets operation, which among other things returns the mount target state.

We recommend that you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, see Amazon EFS (http://aws.amazon.com/efs/). In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario. If the Availability Zone in which your mount target is created goes down, then you can't access your file system through that mount target.

This operation requires permissions for the following action on the file system:

  • elasticfilesystem:CreateMountTarget

This operation also requires permissions for the following Amazon EC2 actions:

  • ec2:DescribeSubnets

  • ec2:DescribeNetworkInterfaces

  • ec2:CreateNetworkInterface

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Elastic File System's API operation CreateMountTarget for usage and error information.

Returned Error 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 (https://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

Example (Shared00)

To create a new mount target

This operation creates a new mount target for an EFS file system. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/efs"
)

func main() {
	svc := efs.New(session.New())
	input := &efs.CreateMountTargetInput{
		FileSystemId: aws.String("fs-01234567"),
		SubnetId:     aws.String("subnet-1234abcd"),
	}

	result, err := svc.CreateMountTarget(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case efs.ErrCodeBadRequest:
				fmt.Println(efs.ErrCodeBadRequest, aerr.Error())
			case efs.ErrCodeInternalServerError:
				fmt.Println(efs.ErrCodeInternalServerError, aerr.Error())
			case efs.ErrCodeFileSystemNotFound:
				fmt.Println(efs.ErrCodeFileSystemNotFound, aerr.Error())
			case efs.ErrCodeIncorrectFileSystemLifeCycleState:
				fmt.Println(efs.ErrCodeIncorrectFileSystemLifeCycleState, aerr.Error())
			case efs.ErrCodeMountTargetConflict:
				fmt.Println(efs.ErrCodeMountTargetConflict, aerr.Error())
			case efs.ErrCodeSubnetNotFound:
				fmt.Println(efs.ErrCodeSubnetNotFound, aerr.Error())
			case efs.ErrCodeNoFreeAddressesInSubnet:
				fmt.Println(efs.ErrCodeNoFreeAddressesInSubnet, aerr.Error())
			case efs.ErrCodeIpAddressInUse:
				fmt.Println(efs.ErrCodeIpAddressInUse, aerr.Error())
			case efs.ErrCodeNetworkInterfaceLimitExceeded:
				fmt.Println(efs.ErrCodeNetworkInterfaceLimitExceeded, aerr.Error())
			case efs.ErrCodeSecurityGroupLimitExceeded:
				fmt.Println(efs.ErrCodeSecurityGroupLimitExceeded, aerr.Error())
			case efs.ErrCodeSecurityGroupNotFound:
				fmt.Println(efs.ErrCodeSecurityGroupNotFound, aerr.Error())
			case efs.ErrCodeUnsupportedAvailabilityZone:
				fmt.Println(efs.ErrCodeUnsupportedAvailabilityZone, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*EFS) CreateMountTargetRequest 

func (c *EFS) CreateMountTargetRequest(input *CreateMountTargetInput) (req *request.Request, output *MountTargetDescription)

CreateMountTargetRequest generates a "aws/request.Request" representing the client's request for the CreateMountTarget operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateMountTarget for more information on using the CreateMountTarget API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateMountTargetRequest method.
req, resp := client.CreateMountTargetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateMountTarget

func (*EFS) CreateMountTargetWithContext added in v1.8.0 

func (c *EFS) CreateMountTargetWithContext(ctx aws.Context, input *CreateMountTargetInput, opts ...request.Option) (*MountTargetDescription, error)

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 (*EFS) CreateTags 

func (c *EFS) CreateTags(input *CreateTagsInput) (*CreateTagsOutput, error)

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

Example (Shared00)

To create a new tag

This operation creates a new tag for an EFS file system. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/efs"
)

func main() {
	svc := efs.New(session.New())
	input := &efs.CreateTagsInput{
		FileSystemId: aws.String("fs-01234567"),
		Tags: []*efs.Tag{
			{
				Key:   aws.String("Name"),
				Value: aws.String("MyFileSystem"),
			},
		},
	}

	result, err := svc.CreateTags(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case efs.ErrCodeBadRequest:
				fmt.Println(efs.ErrCodeBadRequest, aerr.Error())
			case efs.ErrCodeInternalServerError:
				fmt.Println(efs.ErrCodeInternalServerError, aerr.Error())
			case efs.ErrCodeFileSystemNotFound:
				fmt.Println(efs.ErrCodeFileSystemNotFound, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*EFS) CreateTagsRequest 

func (c *EFS) CreateTagsRequest(input *CreateTagsInput) (req *request.Request, output *CreateTagsOutput)

CreateTagsRequest generates a "aws/request.Request" representing the client's request for the CreateTags operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateTags for more information on using the CreateTags API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateTagsRequest method.
req, resp := client.CreateTagsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateTags

func (*EFS) CreateTagsWithContext added in v1.8.0 

func (c *EFS) CreateTagsWithContext(ctx aws.Context, input *CreateTagsInput, opts ...request.Option) (*CreateTagsOutput, error)

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 (*EFS) DeleteFileSystem 

func (c *EFS) DeleteFileSystem(input *DeleteFileSystemInput) (*DeleteFileSystemOutput, error)

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

Example (Shared00)

To delete a file system

This operation deletes an EFS file system. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/efs"
)

func main() {
	svc := efs.New(session.New())
	input := &efs.DeleteFileSystemInput{
		FileSystemId: aws.String("fs-01234567"),
	}

	result, err := svc.DeleteFileSystem(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case efs.ErrCodeBadRequest:
				fmt.Println(efs.ErrCodeBadRequest, aerr.Error())
			case efs.ErrCodeInternalServerError:
				fmt.Println(efs.ErrCodeInternalServerError, aerr.Error())
			case efs.ErrCodeFileSystemNotFound:
				fmt.Println(efs.ErrCodeFileSystemNotFound, aerr.Error())
			case efs.ErrCodeFileSystemInUse:
				fmt.Println(efs.ErrCodeFileSystemInUse, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*EFS) DeleteFileSystemRequest 

func (c *EFS) DeleteFileSystemRequest(input *DeleteFileSystemInput) (req *request.Request, output *DeleteFileSystemOutput)

DeleteFileSystemRequest generates a "aws/request.Request" representing the client's request for the DeleteFileSystem operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteFileSystem for more information on using the DeleteFileSystem API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteFileSystemRequest method.
req, resp := client.DeleteFileSystemRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteFileSystem

func (*EFS) DeleteFileSystemWithContext added in v1.8.0 

func (c *EFS) DeleteFileSystemWithContext(ctx aws.Context, input *DeleteFileSystemInput, opts ...request.Option) (*DeleteFileSystemOutput, error)

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 (*EFS) DeleteMountTarget 

func (c *EFS) DeleteMountTarget(input *DeleteMountTargetInput) (*DeleteMountTargetOutput, error)

DeleteMountTarget API operation for Amazon Elastic File System.

Deletes the specified mount target.

This operation forcibly breaks any mounts of the file system by using 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 might 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 by using 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

Example (Shared00)

To delete a mount target

This operation deletes a mount target. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/efs"
)

func main() {
	svc := efs.New(session.New())
	input := &efs.DeleteMountTargetInput{
		MountTargetId: aws.String("fsmt-12340abc"),
	}

	result, err := svc.DeleteMountTarget(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case efs.ErrCodeBadRequest:
				fmt.Println(efs.ErrCodeBadRequest, aerr.Error())
			case efs.ErrCodeInternalServerError:
				fmt.Println(efs.ErrCodeInternalServerError, aerr.Error())
			case efs.ErrCodeDependencyTimeout:
				fmt.Println(efs.ErrCodeDependencyTimeout, aerr.Error())
			case efs.ErrCodeMountTargetNotFound:
				fmt.Println(efs.ErrCodeMountTargetNotFound, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*EFS) DeleteMountTargetRequest 

func (c *EFS) DeleteMountTargetRequest(input *DeleteMountTargetInput) (req *request.Request, output *DeleteMountTargetOutput)

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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 (*EFS) DeleteMountTargetWithContext added in v1.8.0 

func (c *EFS) DeleteMountTargetWithContext(ctx aws.Context, input *DeleteMountTargetInput, opts ...request.Option) (*DeleteMountTargetOutput, error)

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 (*EFS) DeleteTags 

func (c *EFS) DeleteTags(input *DeleteTagsInput) (*DeleteTagsOutput, error)

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 doesn't exist, Amazon EFS ignores it and doesn't cause an error. For more information about tags and related restrictions, see Tag Restrictions (https://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

Example (Shared00)

To delete tags for an EFS file system

This operation deletes tags for an EFS file system. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/efs"
)

func main() {
	svc := efs.New(session.New())
	input := &efs.DeleteTagsInput{
		FileSystemId: aws.String("fs-01234567"),
		TagKeys: []*string{
			aws.String("Name"),
		},
	}

	result, err := svc.DeleteTags(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case efs.ErrCodeBadRequest:
				fmt.Println(efs.ErrCodeBadRequest, aerr.Error())
			case efs.ErrCodeInternalServerError:
				fmt.Println(efs.ErrCodeInternalServerError, aerr.Error())
			case efs.ErrCodeFileSystemNotFound:
				fmt.Println(efs.ErrCodeFileSystemNotFound, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*EFS) DeleteTagsRequest 

func (c *EFS) DeleteTagsRequest(input *DeleteTagsInput) (req *request.Request, output *DeleteTagsOutput)

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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 (*EFS) DeleteTagsWithContext added in v1.8.0 

func (c *EFS) DeleteTagsWithContext(ctx aws.Context, input *DeleteTagsInput, opts ...request.Option) (*DeleteTagsOutput, error)

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 (*EFS) DescribeFileSystems 

func (c *EFS) DescribeFileSystems(input *DescribeFileSystemsInput) (*DescribeFileSystemsOutput, error)

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. Currently, this number is automatically set to 10. 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 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

Example (Shared00)

To describe an EFS file system

This operation describes all of the EFS file systems in an account. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/efs"
)

func main() {
	svc := efs.New(session.New())
	input := &efs.DescribeFileSystemsInput{}

	result, err := svc.DescribeFileSystems(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case efs.ErrCodeBadRequest:
				fmt.Println(efs.ErrCodeBadRequest, aerr.Error())
			case efs.ErrCodeInternalServerError:
				fmt.Println(efs.ErrCodeInternalServerError, aerr.Error())
			case efs.ErrCodeFileSystemNotFound:
				fmt.Println(efs.ErrCodeFileSystemNotFound, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*EFS) DescribeFileSystemsRequest 

func (c *EFS) DescribeFileSystemsRequest(input *DescribeFileSystemsInput) (req *request.Request, output *DescribeFileSystemsOutput)

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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 (*EFS) DescribeFileSystemsWithContext added in v1.8.0 

func (c *EFS) DescribeFileSystemsWithContext(ctx aws.Context, input *DescribeFileSystemsInput, opts ...request.Option) (*DescribeFileSystemsOutput, error)

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 (*EFS) DescribeLifecycleConfiguration added in v1.16.34 

func (c *EFS) DescribeLifecycleConfiguration(input *DescribeLifecycleConfigurationInput) (*DescribeLifecycleConfigurationOutput, error)

DescribeLifecycleConfiguration API operation for Amazon Elastic File System.

Returns the current LifecycleConfiguration object for the specified Amazon EFS file system. EFS lifecycle management uses the LifecycleConfiguration object to identify which files to move to the EFS Infrequent Access (IA) storage class. For a file system without a LifecycleConfiguration object, the call returns an empty array in the response.

This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration operation.

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 DescribeLifecycleConfiguration for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" Returned if an error occurred on the server side.

  • 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeLifecycleConfiguration

Example (Shared00)

To describe the lifecycle configuration for a file system

This operation describes a file system's LifecycleConfiguration. EFS lifecycle management uses the LifecycleConfiguration object to identify which files to move to the EFS Infrequent Access (IA) storage class. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/efs"
)

func main() {
	svc := efs.New(session.New())
	input := &efs.DescribeLifecycleConfigurationInput{
		FileSystemId: aws.String("fs-01234567"),
	}

	result, err := svc.DescribeLifecycleConfiguration(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case efs.ErrCodeInternalServerError:
				fmt.Println(efs.ErrCodeInternalServerError, aerr.Error())
			case efs.ErrCodeBadRequest:
				fmt.Println(efs.ErrCodeBadRequest, aerr.Error())
			case efs.ErrCodeFileSystemNotFound:
				fmt.Println(efs.ErrCodeFileSystemNotFound, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*EFS) DescribeLifecycleConfigurationRequest added in v1.16.34 

func (c *EFS) DescribeLifecycleConfigurationRequest(input *DescribeLifecycleConfigurationInput) (req *request.Request, output *DescribeLifecycleConfigurationOutput)

DescribeLifecycleConfigurationRequest generates a "aws/request.Request" representing the client's request for the DescribeLifecycleConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeLifecycleConfiguration for more information on using the DescribeLifecycleConfiguration 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 DescribeLifecycleConfigurationRequest method.
req, resp := client.DescribeLifecycleConfigurationRequest(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/DescribeLifecycleConfiguration

func (*EFS) DescribeLifecycleConfigurationWithContext added in v1.16.34 

func (c *EFS) DescribeLifecycleConfigurationWithContext(ctx aws.Context, input *DescribeLifecycleConfigurationInput, opts ...request.Option) (*DescribeLifecycleConfigurationOutput, error)

DescribeLifecycleConfigurationWithContext is the same as DescribeLifecycleConfiguration with the addition of the ability to pass a context and additional request options.

See DescribeLifecycleConfiguration 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 (*EFS) DescribeMountTargetSecurityGroups 

func (c *EFS) DescribeMountTargetSecurityGroups(input *DescribeMountTargetSecurityGroupsInput) (*DescribeMountTargetSecurityGroupsOutput, error)

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

Example (Shared00)

To describe the security groups for a mount target

This operation describes all of the security groups for a file system's mount target. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/efs"
)

func main() {
	svc := efs.New(session.New())
	input := &efs.DescribeMountTargetSecurityGroupsInput{
		MountTargetId: aws.String("fsmt-12340abc"),
	}

	result, err := svc.DescribeMountTargetSecurityGroups(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case efs.ErrCodeBadRequest:
				fmt.Println(efs.ErrCodeBadRequest, aerr.Error())
			case efs.ErrCodeInternalServerError:
				fmt.Println(efs.ErrCodeInternalServerError, aerr.Error())
			case efs.ErrCodeMountTargetNotFound:
				fmt.Println(efs.ErrCodeMountTargetNotFound, aerr.Error())
			case efs.ErrCodeIncorrectMountTargetState:
				fmt.Println(efs.ErrCodeIncorrectMountTargetState, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*EFS) DescribeMountTargetSecurityGroupsRequest 

func (c *EFS) DescribeMountTargetSecurityGroupsRequest(input *DescribeMountTargetSecurityGroupsInput) (req *request.Request, output *DescribeMountTargetSecurityGroupsOutput)

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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 (*EFS) DescribeMountTargetSecurityGroupsWithContext added in v1.8.0 

func (c *EFS) DescribeMountTargetSecurityGroupsWithContext(ctx aws.Context, input *DescribeMountTargetSecurityGroupsInput, opts ...request.Option) (*DescribeMountTargetSecurityGroupsOutput, error)

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 (*EFS) DescribeMountTargets 

func (c *EFS) DescribeMountTargets(input *DescribeMountTargetsInput) (*DescribeMountTargetsOutput, error)

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

Example (Shared00)

To describe the mount targets for a file system

This operation describes all of a file system's mount targets. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/efs"
)

func main() {
	svc := efs.New(session.New())
	input := &efs.DescribeMountTargetsInput{
		FileSystemId: aws.String("fs-01234567"),
	}

	result, err := svc.DescribeMountTargets(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case efs.ErrCodeBadRequest:
				fmt.Println(efs.ErrCodeBadRequest, aerr.Error())
			case efs.ErrCodeInternalServerError:
				fmt.Println(efs.ErrCodeInternalServerError, aerr.Error())
			case efs.ErrCodeFileSystemNotFound:
				fmt.Println(efs.ErrCodeFileSystemNotFound, aerr.Error())
			case efs.ErrCodeMountTargetNotFound:
				fmt.Println(efs.ErrCodeMountTargetNotFound, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*EFS) DescribeMountTargetsRequest 

func (c *EFS) DescribeMountTargetsRequest(input *DescribeMountTargetsInput) (req *request.Request, output *DescribeMountTargetsOutput)

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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 (*EFS) DescribeMountTargetsWithContext added in v1.8.0 

func (c *EFS) DescribeMountTargetsWithContext(ctx aws.Context, input *DescribeMountTargetsInput, opts ...request.Option) (*DescribeMountTargetsOutput, error)

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 (*EFS) DescribeTags 

func (c *EFS) DescribeTags(input *DescribeTagsInput) (*DescribeTagsOutput, error)

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 multiple-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

Example (Shared00)

To describe the tags for a file system

This operation describes all of a file system's tags. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/efs"
)

func main() {
	svc := efs.New(session.New())
	input := &efs.DescribeTagsInput{
		FileSystemId: aws.String("fs-01234567"),
	}

	result, err := svc.DescribeTags(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case efs.ErrCodeBadRequest:
				fmt.Println(efs.ErrCodeBadRequest, aerr.Error())
			case efs.ErrCodeInternalServerError:
				fmt.Println(efs.ErrCodeInternalServerError, aerr.Error())
			case efs.ErrCodeFileSystemNotFound:
				fmt.Println(efs.ErrCodeFileSystemNotFound, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*EFS) DescribeTagsRequest 

func (c *EFS) DescribeTagsRequest(input *DescribeTagsInput) (req *request.Request, output *DescribeTagsOutput)

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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 (*EFS) DescribeTagsWithContext added in v1.8.0 

func (c *EFS) DescribeTagsWithContext(ctx aws.Context, input *DescribeTagsInput, opts ...request.Option) (*DescribeTagsOutput, error)

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 (*EFS) ModifyMountTargetSecurityGroups 

func (c *EFS) ModifyMountTargetSecurityGroups(input *ModifyMountTargetSecurityGroupsInput) (*ModifyMountTargetSecurityGroupsOutput, error)

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

Example (Shared00)

To modify the security groups associated with a mount target for a file system

This operation modifies the security groups associated with a mount target for a file system. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/efs"
)

func main() {
	svc := efs.New(session.New())
	input := &efs.ModifyMountTargetSecurityGroupsInput{
		MountTargetId: aws.String("fsmt-12340abc"),
		SecurityGroups: []*string{
			aws.String("sg-abcd1234"),
		},
	}

	result, err := svc.ModifyMountTargetSecurityGroups(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case efs.ErrCodeBadRequest:
				fmt.Println(efs.ErrCodeBadRequest, aerr.Error())
			case efs.ErrCodeInternalServerError:
				fmt.Println(efs.ErrCodeInternalServerError, aerr.Error())
			case efs.ErrCodeMountTargetNotFound:
				fmt.Println(efs.ErrCodeMountTargetNotFound, aerr.Error())
			case efs.ErrCodeIncorrectMountTargetState:
				fmt.Println(efs.ErrCodeIncorrectMountTargetState, aerr.Error())
			case efs.ErrCodeSecurityGroupLimitExceeded:
				fmt.Println(efs.ErrCodeSecurityGroupLimitExceeded, aerr.Error())
			case efs.ErrCodeSecurityGroupNotFound:
				fmt.Println(efs.ErrCodeSecurityGroupNotFound, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*EFS) ModifyMountTargetSecurityGroupsRequest 

func (c *EFS) ModifyMountTargetSecurityGroupsRequest(input *ModifyMountTargetSecurityGroupsInput) (req *request.Request, output *ModifyMountTargetSecurityGroupsOutput)

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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 (*EFS) ModifyMountTargetSecurityGroupsWithContext added in v1.8.0 

func (c *EFS) ModifyMountTargetSecurityGroupsWithContext(ctx aws.Context, input *ModifyMountTargetSecurityGroupsInput, opts ...request.Option) (*ModifyMountTargetSecurityGroupsOutput, error)

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 (*EFS) PutLifecycleConfiguration added in v1.16.34 

func (c *EFS) PutLifecycleConfiguration(input *PutLifecycleConfigurationInput) (*PutLifecycleConfigurationOutput, error)

PutLifecycleConfiguration API operation for Amazon Elastic File System.

Enables lifecycle management by creating a new LifecycleConfiguration object. A LifecycleConfiguration object defines when files in an Amazon EFS file system are automatically transitioned to the lower-cost EFS Infrequent Access (IA) storage class. A LifecycleConfiguration applies to all files in a file system.

Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a LifecycleConfiguration object already exists for the specified file system, a PutLifecycleConfiguration call modifies the existing configuration. A PutLifecycleConfiguration call with an empty LifecyclePolicies array in the request body deletes any existing LifecycleConfiguration and disables lifecycle management.

You can enable lifecycle management only for EFS file systems created after the release of EFS infrequent access.

In the request, specify the following:

  • The ID for the file system for which you are creating a lifecycle management configuration.

  • A LifecyclePolicies array of LifecyclePolicy objects that define when files are moved to the IA storage class. The array can contain only one "TransitionToIA": "AFTER_30_DAYS" LifecyclePolicy item.

This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation.

To apply a LifecycleConfiguration object to an encrypted file system, you need the same AWS Key Management Service (AWS KMS) permissions as when you created the encrypted 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 PutLifecycleConfiguration 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".

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/PutLifecycleConfiguration

Example (Shared00)

Creates a new lifecycleconfiguration object for a file system

This operation enables lifecycle management on a file system by creating a new LifecycleConfiguration object. A LifecycleConfiguration object defines when files in an Amazon EFS file system are automatically transitioned to the lower-cost EFS Infrequent Access (IA) storage class. A LifecycleConfiguration applies to all files in a file system. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/efs"
)

func main() {
	svc := efs.New(session.New())
	input := &efs.PutLifecycleConfigurationInput{
		FileSystemId: aws.String("fs-01234567"),
		LifecyclePolicies: []*efs.LifecyclePolicy{
			{
				TransitionToIA: aws.String("AFTER_30_DAYS"),
			},
		},
	}

	result, err := svc.PutLifecycleConfiguration(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case efs.ErrCodeBadRequest:
				fmt.Println(efs.ErrCodeBadRequest, aerr.Error())
			case efs.ErrCodeInternalServerError:
				fmt.Println(efs.ErrCodeInternalServerError, aerr.Error())
			case efs.ErrCodeFileSystemNotFound:
				fmt.Println(efs.ErrCodeFileSystemNotFound, aerr.Error())
			case efs.ErrCodeIncorrectFileSystemLifeCycleState:
				fmt.Println(efs.ErrCodeIncorrectFileSystemLifeCycleState, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*EFS) PutLifecycleConfigurationRequest added in v1.16.34 

func (c *EFS) PutLifecycleConfigurationRequest(input *PutLifecycleConfigurationInput) (req *request.Request, output *PutLifecycleConfigurationOutput)

PutLifecycleConfigurationRequest generates a "aws/request.Request" representing the client's request for the PutLifecycleConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutLifecycleConfiguration for more information on using the PutLifecycleConfiguration 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 PutLifecycleConfigurationRequest method.
req, resp := client.PutLifecycleConfigurationRequest(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/PutLifecycleConfiguration

func (*EFS) PutLifecycleConfigurationWithContext added in v1.16.34 

func (c *EFS) PutLifecycleConfigurationWithContext(ctx aws.Context, input *PutLifecycleConfigurationInput, opts ...request.Option) (*PutLifecycleConfigurationOutput, error)

PutLifecycleConfigurationWithContext is the same as PutLifecycleConfiguration with the addition of the ability to pass a context and additional request options.

See PutLifecycleConfiguration 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 (*EFS) UpdateFileSystem added in v1.14.26 

func (c *EFS) UpdateFileSystem(input *UpdateFileSystemInput) (*UpdateFileSystemOutput, error)

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 don’t 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 (*EFS) UpdateFileSystemRequest added in v1.14.26 

func (c *EFS) UpdateFileSystemRequest(input *UpdateFileSystemInput) (req *request.Request, output *UpdateFileSystemOutput)

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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 (*EFS) UpdateFileSystemWithContext added in v1.14.26 

func (c *EFS) UpdateFileSystemWithContext(ctx aws.Context, input *UpdateFileSystemInput, opts ...request.Option) (*UpdateFileSystemOutput, error)

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.

type FileSystemDescription 

type FileSystemDescription struct {

	// The 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"`

	// The 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"`

	// The 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"`

	// The 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 CreateFileSystem. If the file system has a Name tag, Amazon EFS returns
	// the value in this field.
	Name *string `type:"string"`

	// The 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"`

	// The 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 performance mode 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. Valid values are 1-1024. Required if ThroughputMode is set to provisioned.
	// 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 (https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits)
	// in the Amazon EFS User Guide.
	ProvisionedThroughputInMibps *float64 `min:"1" type:"double"`

	// The 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 tags associated with the file system, presented as an array of Tag objects.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`

	// The throughput mode for a file system. There are two throughput modes to
	// choose from for your file system: bursting and provisioned. If you set ThroughputMode
	// to provisioned, you must also set a value for ProvisionedThroughPutInMibps.
	// You can decrease your file system's throughput in Provisioned Throughput
	// mode or change between the throughput modes as long as it’s been more than
	// 24 hours since the last decrease or throughput mode change.
	ThroughputMode *string `type:"string" enum:"ThroughputMode"`
	// contains filtered or unexported fields
}

A description of the file system.

func (FileSystemDescription) GoString added in v0.6.5 

func (s FileSystemDescription) GoString() string

GoString returns the string representation

func (*FileSystemDescription) SetCreationTime added in v1.5.0 

func (s *FileSystemDescription) SetCreationTime(v time.Time) *FileSystemDescription

SetCreationTime sets the CreationTime field's value.

func (*FileSystemDescription) SetCreationToken added in v1.5.0 

func (s *FileSystemDescription) SetCreationToken(v string) *FileSystemDescription

SetCreationToken sets the CreationToken field's value.

func (*FileSystemDescription) SetEncrypted added in v1.10.25 

func (s *FileSystemDescription) SetEncrypted(v bool) *FileSystemDescription

SetEncrypted sets the Encrypted field's value.

func (*FileSystemDescription) SetFileSystemId added in v1.5.0 

func (s *FileSystemDescription) SetFileSystemId(v string) *FileSystemDescription

SetFileSystemId sets the FileSystemId field's value.

func (*FileSystemDescription) SetKmsKeyId added in v1.10.25 

func (s *FileSystemDescription) SetKmsKeyId(v string) *FileSystemDescription

SetKmsKeyId sets the KmsKeyId field's value.

func (*FileSystemDescription) SetLifeCycleState added in v1.5.0 

func (s *FileSystemDescription) SetLifeCycleState(v string) *FileSystemDescription

SetLifeCycleState sets the LifeCycleState field's value.

func (*FileSystemDescription) SetName added in v1.5.0 

func (s *FileSystemDescription) SetName(v string) *FileSystemDescription

SetName sets the Name field's value.

func (*FileSystemDescription) SetNumberOfMountTargets added in v1.5.0 

func (s *FileSystemDescription) SetNumberOfMountTargets(v int64) *FileSystemDescription

SetNumberOfMountTargets sets the NumberOfMountTargets field's value.

func (*FileSystemDescription) SetOwnerId added in v1.5.0 

func (s *FileSystemDescription) SetOwnerId(v string) *FileSystemDescription

SetOwnerId sets the OwnerId field's value.

func (*FileSystemDescription) SetPerformanceMode added in v1.5.0 

func (s *FileSystemDescription) SetPerformanceMode(v string) *FileSystemDescription

SetPerformanceMode sets the PerformanceMode field's value.

func (*FileSystemDescription) SetProvisionedThroughputInMibps added in v1.15.0 

func (s *FileSystemDescription) SetProvisionedThroughputInMibps(v float64) *FileSystemDescription

SetProvisionedThroughputInMibps sets the ProvisionedThroughputInMibps field's value.

func (*FileSystemDescription) SetSizeInBytes added in v1.5.0 

func (s *FileSystemDescription) SetSizeInBytes(v *FileSystemSize) *FileSystemDescription

SetSizeInBytes sets the SizeInBytes field's value.

func (*FileSystemDescription) SetTags added in v1.17.1 

func (s *FileSystemDescription) SetTags(v []*Tag) *FileSystemDescription

SetTags sets the Tags field's value.

func (*FileSystemDescription) SetThroughputMode added in v1.15.0 

func (s *FileSystemDescription) SetThroughputMode(v string) *FileSystemDescription

SetThroughputMode sets the ThroughputMode field's value.

func (FileSystemDescription) String added in v0.6.5 

func (s FileSystemDescription) String() string

String returns the string representation

type FileSystemSize 

type FileSystemSize struct {

	// The 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"`

	// The latest known metered size (in bytes) of data stored in the file system.
	//
	// Value is a required field
	Value *int64 `type:"long" required:"true"`

	// The latest known metered size (in bytes) of data stored in the Infrequent
	// Access storage class.
	ValueInIA *int64 `type:"long"`

	// The latest known metered size (in bytes) of data stored in the Standard storage
	// class.
	ValueInStandard *int64 `type:"long"`
	// contains filtered or unexported fields
}

The 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 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, the value represents 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.

func (FileSystemSize) GoString added in v0.6.5 

func (s FileSystemSize) GoString() string

GoString returns the string representation

func (*FileSystemSize) SetTimestamp added in v1.5.0 

func (s *FileSystemSize) SetTimestamp(v time.Time) *FileSystemSize

SetTimestamp sets the Timestamp field's value.

func (*FileSystemSize) SetValue added in v1.5.0 

func (s *FileSystemSize) SetValue(v int64) *FileSystemSize

SetValue sets the Value field's value.

func (*FileSystemSize) SetValueInIA added in v1.16.34 

func (s *FileSystemSize) SetValueInIA(v int64) *FileSystemSize

SetValueInIA sets the ValueInIA field's value.

func (*FileSystemSize) SetValueInStandard added in v1.16.34 

func (s *FileSystemSize) SetValueInStandard(v int64) *FileSystemSize

SetValueInStandard sets the ValueInStandard field's value.

func (FileSystemSize) String added in v0.6.5 

func (s FileSystemSize) String() string

String returns the string representation

type LifecyclePolicy added in v1.16.34 

type LifecyclePolicy struct {

	// A value that indicates how long it takes to transition files to the IA storage
	// class. Currently, the only valid value is AFTER_30_DAYS.
	//
	// AFTER_30_DAYS indicates files that have not been read from or written to
	// for 30 days are transitioned from the Standard storage class to the IA storage
	// class. Metadata operations such as listing the contents of a directory don't
	// count as a file access event.
	TransitionToIA *string `type:"string" enum:"TransitionToIARules"`
	// contains filtered or unexported fields
}

Describes a policy used by EFS lifecycle management to transition files to the Infrequent Access (IA) storage class.

func (LifecyclePolicy) GoString added in v1.16.34 

func (s LifecyclePolicy) GoString() string

GoString returns the string representation

func (*LifecyclePolicy) SetTransitionToIA added in v1.16.34 

func (s *LifecyclePolicy) SetTransitionToIA(v string) *LifecyclePolicy

SetTransitionToIA sets the TransitionToIA field's value.

func (LifecyclePolicy) String added in v1.16.34 

func (s LifecyclePolicy) String() string

String returns the string representation

type ModifyMountTargetSecurityGroupsInput 

type ModifyMountTargetSecurityGroupsInput struct {

	// The 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"`

	// An array of up to five VPC security group IDs.
	SecurityGroups []*string `type:"list"`
	// contains filtered or unexported fields
}

func (ModifyMountTargetSecurityGroupsInput) GoString added in v0.6.5 

func (s ModifyMountTargetSecurityGroupsInput) GoString() string

GoString returns the string representation

func (*ModifyMountTargetSecurityGroupsInput) SetMountTargetId added in v1.5.0 

func (s *ModifyMountTargetSecurityGroupsInput) SetMountTargetId(v string) *ModifyMountTargetSecurityGroupsInput

SetMountTargetId sets the MountTargetId field's value.

func (*ModifyMountTargetSecurityGroupsInput) SetSecurityGroups added in v1.5.0 

func (s *ModifyMountTargetSecurityGroupsInput) SetSecurityGroups(v []*string) *ModifyMountTargetSecurityGroupsInput

SetSecurityGroups sets the SecurityGroups field's value.

func (ModifyMountTargetSecurityGroupsInput) String added in v0.6.5 

func (s ModifyMountTargetSecurityGroupsInput) String() string

String returns the string representation

func (*ModifyMountTargetSecurityGroupsInput) Validate added in v1.1.21 

func (s *ModifyMountTargetSecurityGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ModifyMountTargetSecurityGroupsOutput 

type ModifyMountTargetSecurityGroupsOutput struct {
	// contains filtered or unexported fields
}

func (ModifyMountTargetSecurityGroupsOutput) GoString added in v0.6.5 

func (s ModifyMountTargetSecurityGroupsOutput) GoString() string

GoString returns the string representation

func (ModifyMountTargetSecurityGroupsOutput) String added in v0.6.5 

func (s ModifyMountTargetSecurityGroupsOutput) String() string

String returns the string representation

type MountTargetDescription 

type MountTargetDescription struct {

	// The 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 can be mounted by using 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"`

	// The 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"`

	// The ID of the mount target's subnet.
	//
	// SubnetId is a required field
	SubnetId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides a description of a mount target.

func (MountTargetDescription) GoString added in v0.6.5 

func (s MountTargetDescription) GoString() string

GoString returns the string representation

func (*MountTargetDescription) SetFileSystemId added in v1.5.0 

func (s *MountTargetDescription) SetFileSystemId(v string) *MountTargetDescription

SetFileSystemId sets the FileSystemId field's value.

func (*MountTargetDescription) SetIpAddress added in v1.5.0 

func (s *MountTargetDescription) SetIpAddress(v string) *MountTargetDescription

SetIpAddress sets the IpAddress field's value.

func (*MountTargetDescription) SetLifeCycleState added in v1.5.0 

func (s *MountTargetDescription) SetLifeCycleState(v string) *MountTargetDescription

SetLifeCycleState sets the LifeCycleState field's value.

func (*MountTargetDescription) SetMountTargetId added in v1.5.0 

func (s *MountTargetDescription) SetMountTargetId(v string) *MountTargetDescription

SetMountTargetId sets the MountTargetId field's value.

func (*MountTargetDescription) SetNetworkInterfaceId added in v1.5.0 

func (s *MountTargetDescription) SetNetworkInterfaceId(v string) *MountTargetDescription

SetNetworkInterfaceId sets the NetworkInterfaceId field's value.

func (*MountTargetDescription) SetOwnerId added in v1.5.0 

func (s *MountTargetDescription) SetOwnerId(v string) *MountTargetDescription

SetOwnerId sets the OwnerId field's value.

func (*MountTargetDescription) SetSubnetId added in v1.5.0 

func (s *MountTargetDescription) SetSubnetId(v string) *MountTargetDescription

SetSubnetId sets the SubnetId field's value.

func (MountTargetDescription) String added in v0.6.5 

func (s MountTargetDescription) String() string

String returns the string representation

type PutLifecycleConfigurationInput added in v1.16.34 

type PutLifecycleConfigurationInput struct {

	// The ID of the file system for which you are creating the LifecycleConfiguration
	// object (String).
	//
	// FileSystemId is a required field
	FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`

	// An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration
	// object. A LifecycleConfiguration object tells lifecycle management when to
	// transition files from the Standard storage class to the Infrequent Access
	// storage class.
	//
	// LifecyclePolicies is a required field
	LifecyclePolicies []*LifecyclePolicy `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (PutLifecycleConfigurationInput) GoString added in v1.16.34 

func (s PutLifecycleConfigurationInput) GoString() string

GoString returns the string representation

func (*PutLifecycleConfigurationInput) SetFileSystemId added in v1.16.34 

func (s *PutLifecycleConfigurationInput) SetFileSystemId(v string) *PutLifecycleConfigurationInput

SetFileSystemId sets the FileSystemId field's value.

func (*PutLifecycleConfigurationInput) SetLifecyclePolicies added in v1.16.34 

func (s *PutLifecycleConfigurationInput) SetLifecyclePolicies(v []*LifecyclePolicy) *PutLifecycleConfigurationInput

SetLifecyclePolicies sets the LifecyclePolicies field's value.

func (PutLifecycleConfigurationInput) String added in v1.16.34 

func (s PutLifecycleConfigurationInput) String() string

String returns the string representation

func (*PutLifecycleConfigurationInput) Validate added in v1.16.34 

func (s *PutLifecycleConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutLifecycleConfigurationOutput added in v1.16.34 

type PutLifecycleConfigurationOutput struct {

	// An array of lifecycle management policies. Currently, EFS supports a maximum
	// of one policy per file system.
	LifecyclePolicies []*LifecyclePolicy `type:"list"`
	// contains filtered or unexported fields
}

func (PutLifecycleConfigurationOutput) GoString added in v1.16.34 

func (s PutLifecycleConfigurationOutput) GoString() string

GoString returns the string representation

func (*PutLifecycleConfigurationOutput) SetLifecyclePolicies added in v1.16.34 

func (s *PutLifecycleConfigurationOutput) SetLifecyclePolicies(v []*LifecyclePolicy) *PutLifecycleConfigurationOutput

SetLifecyclePolicies sets the LifecyclePolicies field's value.

func (PutLifecycleConfigurationOutput) String added in v1.16.34 

func (s PutLifecycleConfigurationOutput) String() string

String returns the string representation

type Tag 

type Tag struct {

	// The tag key (String). The key can't start with aws:.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The value of the tag key.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters:+ - = . _ : /

func (Tag) GoString added in v0.6.5 

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey added in v1.5.0 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.5.0 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v0.6.5 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate added in v1.1.21 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateFileSystemInput added in v1.14.26 

type UpdateFileSystemInput struct {

	// 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. Valid values are 1-1024. Required if ThroughputMode
	// is changed to provisioned on update. 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 `min:"1" 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. If you are changing the ThroughputMode to provisioned,
	// you must also set a value for ProvisionedThroughputInMibps.
	ThroughputMode *string `type:"string" enum:"ThroughputMode"`
	// contains filtered or unexported fields
}

func (UpdateFileSystemInput) GoString added in v1.14.26 

func (s UpdateFileSystemInput) GoString() string

GoString returns the string representation

func (*UpdateFileSystemInput) SetFileSystemId added in v1.14.26 

func (s *UpdateFileSystemInput) SetFileSystemId(v string) *UpdateFileSystemInput

SetFileSystemId sets the FileSystemId field's value.

func (*UpdateFileSystemInput) SetProvisionedThroughputInMibps added in v1.14.26 

func (s *UpdateFileSystemInput) SetProvisionedThroughputInMibps(v float64) *UpdateFileSystemInput

SetProvisionedThroughputInMibps sets the ProvisionedThroughputInMibps field's value.

func (*UpdateFileSystemInput) SetThroughputMode added in v1.14.26 

func (s *UpdateFileSystemInput) SetThroughputMode(v string) *UpdateFileSystemInput

SetThroughputMode sets the ThroughputMode field's value.

func (UpdateFileSystemInput) String added in v1.14.26 

func (s UpdateFileSystemInput) String() string

String returns the string representation

func (*UpdateFileSystemInput) Validate added in v1.14.26 

func (s *UpdateFileSystemInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateFileSystemOutput added in v1.14.26 

type UpdateFileSystemOutput struct {

	// The 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"`

	// The 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"`

	// The 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"`

	// The 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 CreateFileSystem. If the file system has a Name tag, Amazon EFS returns
	// the value in this field.
	Name *string `type:"string"`

	// The 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"`

	// The 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 performance mode 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. Valid values are 1-1024. Required if ThroughputMode is set to provisioned.
	// 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 (https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits)
	// in the Amazon EFS User Guide.
	ProvisionedThroughputInMibps *float64 `min:"1" type:"double"`

	// The 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 tags associated with the file system, presented as an array of Tag objects.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`

	// The throughput mode for a file system. There are two throughput modes to
	// choose from for your file system: bursting and provisioned. If you set ThroughputMode
	// to provisioned, you must also set a value for ProvisionedThroughPutInMibps.
	// You can decrease your file system's throughput in Provisioned Throughput
	// mode or change between the throughput modes as long as it’s been more than
	// 24 hours since the last decrease or throughput mode change.
	ThroughputMode *string `type:"string" enum:"ThroughputMode"`
	// contains filtered or unexported fields
}

A description of the file system.

func (UpdateFileSystemOutput) GoString added in v1.14.26 

func (s UpdateFileSystemOutput) GoString() string

GoString returns the string representation

func (*UpdateFileSystemOutput) SetCreationTime added in v1.14.26 

func (s *UpdateFileSystemOutput) SetCreationTime(v time.Time) *UpdateFileSystemOutput

SetCreationTime sets the CreationTime field's value.

func (*UpdateFileSystemOutput) SetCreationToken added in v1.14.26 

func (s *UpdateFileSystemOutput) SetCreationToken(v string) *UpdateFileSystemOutput

SetCreationToken sets the CreationToken field's value.

func (*UpdateFileSystemOutput) SetEncrypted added in v1.14.26 

func (s *UpdateFileSystemOutput) SetEncrypted(v bool) *UpdateFileSystemOutput

SetEncrypted sets the Encrypted field's value.

func (*UpdateFileSystemOutput) SetFileSystemId added in v1.14.26 

func (s *UpdateFileSystemOutput) SetFileSystemId(v string) *UpdateFileSystemOutput

SetFileSystemId sets the FileSystemId field's value.

func (*UpdateFileSystemOutput) SetKmsKeyId added in v1.14.26 

func (s *UpdateFileSystemOutput) SetKmsKeyId(v string) *UpdateFileSystemOutput

SetKmsKeyId sets the KmsKeyId field's value.

func (*UpdateFileSystemOutput) SetLifeCycleState added in v1.14.26 

func (s *UpdateFileSystemOutput) SetLifeCycleState(v string) *UpdateFileSystemOutput

SetLifeCycleState sets the LifeCycleState field's value.

func (*UpdateFileSystemOutput) SetName added in v1.14.26 

func (s *UpdateFileSystemOutput) SetName(v string) *UpdateFileSystemOutput

SetName sets the Name field's value.

func (*UpdateFileSystemOutput) SetNumberOfMountTargets added in v1.14.26 

func (s *UpdateFileSystemOutput) SetNumberOfMountTargets(v int64) *UpdateFileSystemOutput

SetNumberOfMountTargets sets the NumberOfMountTargets field's value.

func (*UpdateFileSystemOutput) SetOwnerId added in v1.14.26 

func (s *UpdateFileSystemOutput) SetOwnerId(v string) *UpdateFileSystemOutput

SetOwnerId sets the OwnerId field's value.

func (*UpdateFileSystemOutput) SetPerformanceMode added in v1.14.26 

func (s *UpdateFileSystemOutput) SetPerformanceMode(v string) *UpdateFileSystemOutput

SetPerformanceMode sets the PerformanceMode field's value.

func (*UpdateFileSystemOutput) SetProvisionedThroughputInMibps added in v1.14.26 

func (s *UpdateFileSystemOutput) SetProvisionedThroughputInMibps(v float64) *UpdateFileSystemOutput

SetProvisionedThroughputInMibps sets the ProvisionedThroughputInMibps field's value.

func (*UpdateFileSystemOutput) SetSizeInBytes added in v1.14.26 

func (s *UpdateFileSystemOutput) SetSizeInBytes(v *FileSystemSize) *UpdateFileSystemOutput

SetSizeInBytes sets the SizeInBytes field's value.

func (*UpdateFileSystemOutput) SetTags added in v1.17.1 

func (s *UpdateFileSystemOutput) SetTags(v []*Tag) *UpdateFileSystemOutput

SetTags sets the Tags field's value.

func (*UpdateFileSystemOutput) SetThroughputMode added in v1.14.26 

func (s *UpdateFileSystemOutput) SetThroughputMode(v string) *UpdateFileSystemOutput

SetThroughputMode sets the ThroughputMode field's value.

func (UpdateFileSystemOutput) String added in v1.14.26 

func (s UpdateFileSystemOutput) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package efsiface provides an interface to enable mocking the Amazon Elastic File System service client for testing your code.
 Package efsiface provides an interface to enable mocking the Amazon Elastic File System service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.