efs

package
v1.8.22-0...-952498f Latest Latest
Warning

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

 Go to latest Published: May 10, 2017 License: Apache-2.0 Imports: 9 Imported by: 0

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 (http://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 use the client for Amazon Elastic File System you will first need to create a new instance of it.

When creating a client for an AWS service you'll first need to have a Session already created. The Session provides configuration that can be shared between multiple service clients. Additional configuration can be applied to the Session and service's client when they are constructed. The aws package's Config type contains several fields such as Region for the AWS Region the client should make API requests too. The optional Config value can be provided as the variadic argument for Sessions and client creation.

Once the service's client is created you can use it to make API requests the AWS service. These clients are safe to use concurrently. 

// Create a session to share configuration, and load external configuration.
sess := session.Must(session.NewSession())

// Create the service's client with the session.
svc := efs.New(sess)

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

See aws package's Config type for more information on configuration options. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

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

Once the client is created you can make an API request to the service. Each API method takes a input parameter, and returns the service response and an error.

The API method will document which error codes the service can be returned by the operation if the service models the API operation's errors. These errors will also be available as const strings prefixed with "ErrCode". 

result, err := svc.CreateFileSystem(params)
if err != nil {
    // Cast err to awserr.Error to handle specific error codes.
    aerr, ok := err.(awserr.Error)
    if ok && aerr.Code() == <error code to check for> {
        // Specific error code handling
    }
    return err
}

fmt.Println("CreateFileSystem result:")
fmt.Println(result)

Using the Client with Context

The service's client also provides methods to make API requests with a Context value. This allows you to control the timeout, and cancellation of pending requests. These methods also take request Option as variadic parameter to apply additional configuration to the API request. 

ctx := context.Background()

result, err := svc.CreateFileSystemWithContext(ctx, params)

See the request package documentation for more information on using Context pattern with the SDK. https://docs.aws.amazon.com/sdk-for-go/api/aws/request/

Index

Examples

Constants

View Source 
const (
	// LifeCycleStateCreating is a LifeCycleState enum value
	LifeCycleStateCreating = "creating"

	// LifeCycleStateAvailable is a LifeCycleState enum value
	LifeCycleStateAvailable = "available"

	// 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 (

	// 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 maximum number of file systems
	// allowed per account.
	ErrCodeFileSystemLimitExceeded = "FileSystemLimitExceeded"

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

	// ErrCodeIncorrectFileSystemLifeCycleState for service response error code
	// "IncorrectFileSystemLifeCycleState".
	//
	// Returned if the file system's life cycle state is not "created".
	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"

	// 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 ENI limit for the specific AWS region.
	// Client should try to delete some ENIs or get its account limit raised. For
	// more information, see Amazon VPC Limits (http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Appendix_Limits.html)
	// in the Amazon Virtual Private Cloud 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 does not 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"

	// ErrCodeUnsupportedAvailabilityZone for service response error code
	// "UnsupportedAvailabilityZone".
	ErrCodeUnsupportedAvailabilityZone = "UnsupportedAvailabilityZone"
)
View Source 
const (
	ServiceName = "elasticfilesystem" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName         // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateFileSystemInput 

type CreateFileSystemInput struct {

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

	// The PerformanceMode of the file system. We recommend generalPurpose performance
	// mode for most file systems. File systems using the maxIO performance mode
	// can scale to higher levels of aggregate throughput and operations per second
	// with a tradeoff of slightly higher latencies for most file operations. This
	// can't be changed after the file system has been created.
	PerformanceMode *string `type:"string" enum:"PerformanceMode"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateFileSystemRequest

func (CreateFileSystemInput) GoString 

func (s CreateFileSystemInput) GoString() string

GoString returns the string representation

func (*CreateFileSystemInput) SetCreationToken 

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

SetCreationToken sets the CreationToken field's value.

func (*CreateFileSystemInput) SetPerformanceMode 

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

SetPerformanceMode sets the PerformanceMode field's value.

func (CreateFileSystemInput) String 

func (s CreateFileSystemInput) String() string

String returns the string representation

func (*CreateFileSystemInput) Validate 

func (s *CreateFileSystemInput) Validate() error

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

type CreateMountTargetInput 

type CreateMountTargetInput struct {

	// ID of the file system for which to create the mount target.
	//
	// FileSystemId is a required field
	FileSystemId *string `type:"string" required:"true"`

	// Valid IPv4 address within the address range of the specified subnet.
	IpAddress *string `type:"string"`

	// Up to five VPC security group IDs, of the form sg-xxxxxxxx. These must be
	// for the same VPC as subnet specified.
	SecurityGroups []*string `type:"list"`

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateMountTargetRequest

func (CreateMountTargetInput) GoString 

func (s CreateMountTargetInput) GoString() string

GoString returns the string representation

func (*CreateMountTargetInput) SetFileSystemId 

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

SetFileSystemId sets the FileSystemId field's value.

func (*CreateMountTargetInput) SetIpAddress 

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

SetIpAddress sets the IpAddress field's value.

func (*CreateMountTargetInput) SetSecurityGroups 

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

SetSecurityGroups sets the SecurityGroups field's value.

func (*CreateMountTargetInput) SetSubnetId 

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

SetSubnetId sets the SubnetId field's value.

func (CreateMountTargetInput) String 

func (s CreateMountTargetInput) String() string

String returns the string representation

func (*CreateMountTargetInput) Validate 

func (s *CreateMountTargetInput) Validate() error

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

type CreateTagsInput 

type CreateTagsInput struct {

	// ID of the file system whose tags you want to modify (String). This operation
	// modifies the tags only, not the file system.
	//
	// FileSystemId is a required field
	FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`

	// Array of Tag objects to add. Each Tag object is a key-value pair.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateTagsRequest

func (CreateTagsInput) GoString 

func (s CreateTagsInput) GoString() string

GoString returns the string representation

func (*CreateTagsInput) SetFileSystemId 

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

SetFileSystemId sets the FileSystemId field's value.

func (*CreateTagsInput) SetTags 

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

SetTags sets the Tags field's value.

func (CreateTagsInput) String 

func (s CreateTagsInput) String() string

String returns the string representation

func (*CreateTagsInput) Validate 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateTagsOutput

func (CreateTagsOutput) GoString 

func (s CreateTagsOutput) GoString() string

GoString returns the string representation

func (CreateTagsOutput) String 

func (s CreateTagsOutput) String() string

String returns the string representation

type DeleteFileSystemInput 

type DeleteFileSystemInput struct {

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteFileSystemRequest

func (DeleteFileSystemInput) GoString 

func (s DeleteFileSystemInput) GoString() string

GoString returns the string representation

func (*DeleteFileSystemInput) SetFileSystemId 

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

SetFileSystemId sets the FileSystemId field's value.

func (DeleteFileSystemInput) String 

func (s DeleteFileSystemInput) String() string

String returns the string representation

func (*DeleteFileSystemInput) Validate 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteFileSystemOutput

func (DeleteFileSystemOutput) GoString 

func (s DeleteFileSystemOutput) GoString() string

GoString returns the string representation

func (DeleteFileSystemOutput) String 

func (s DeleteFileSystemOutput) String() string

String returns the string representation

type DeleteMountTargetInput 

type DeleteMountTargetInput struct {

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteMountTargetRequest

func (DeleteMountTargetInput) GoString 

func (s DeleteMountTargetInput) GoString() string

GoString returns the string representation

func (*DeleteMountTargetInput) SetMountTargetId 

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

SetMountTargetId sets the MountTargetId field's value.

func (DeleteMountTargetInput) String 

func (s DeleteMountTargetInput) String() string

String returns the string representation

func (*DeleteMountTargetInput) Validate 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteMountTargetOutput

func (DeleteMountTargetOutput) GoString 

func (s DeleteMountTargetOutput) GoString() string

GoString returns the string representation

func (DeleteMountTargetOutput) String 

func (s DeleteMountTargetOutput) String() string

String returns the string representation

type DeleteTagsInput 

type DeleteTagsInput struct {

	// ID of the file system whose tags you want to delete (String).
	//
	// FileSystemId is a required field
	FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteTagsRequest

func (DeleteTagsInput) GoString 

func (s DeleteTagsInput) GoString() string

GoString returns the string representation

func (*DeleteTagsInput) SetFileSystemId 

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

SetFileSystemId sets the FileSystemId field's value.

func (*DeleteTagsInput) SetTagKeys 

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

SetTagKeys sets the TagKeys field's value.

func (DeleteTagsInput) String 

func (s DeleteTagsInput) String() string

String returns the string representation

func (*DeleteTagsInput) Validate 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteTagsOutput

func (DeleteTagsOutput) GoString 

func (s DeleteTagsOutput) GoString() string

GoString returns the string representation

func (DeleteTagsOutput) String 

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). This parameter value must be greater than 0. The number
	// of items that Amazon EFS returns is the minimum of the MaxItems parameter
	// specified in the request and the service's internal maximum number of items
	// per page.
	MaxItems *int64 `location:"querystring" locationName:"MaxItems" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeFileSystemsRequest

func (DescribeFileSystemsInput) GoString 

func (s DescribeFileSystemsInput) GoString() string

GoString returns the string representation

func (*DescribeFileSystemsInput) SetCreationToken 

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

SetCreationToken sets the CreationToken field's value.

func (*DescribeFileSystemsInput) SetFileSystemId 

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

SetFileSystemId sets the FileSystemId field's value.

func (*DescribeFileSystemsInput) SetMarker 

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

SetMarker sets the Marker field's value.

func (*DescribeFileSystemsInput) SetMaxItems 

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

SetMaxItems sets the MaxItems field's value.

func (DescribeFileSystemsInput) String 

func (s DescribeFileSystemsInput) String() string

String returns the string representation

func (*DescribeFileSystemsInput) Validate 

func (s *DescribeFileSystemsInput) Validate() error

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

type DescribeFileSystemsOutput 

type DescribeFileSystemsOutput struct {

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeFileSystemsResponse

func (DescribeFileSystemsOutput) GoString 

func (s DescribeFileSystemsOutput) GoString() string

GoString returns the string representation

func (*DescribeFileSystemsOutput) SetFileSystems 

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

SetFileSystems sets the FileSystems field's value.

func (*DescribeFileSystemsOutput) SetMarker 

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

SetMarker sets the Marker field's value.

func (*DescribeFileSystemsOutput) SetNextMarker 

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

SetNextMarker sets the NextMarker field's value.

func (DescribeFileSystemsOutput) String 

func (s DescribeFileSystemsOutput) String() string

String returns the string representation

type DescribeMountTargetSecurityGroupsInput 

type DescribeMountTargetSecurityGroupsInput struct {

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeMountTargetSecurityGroupsRequest

func (DescribeMountTargetSecurityGroupsInput) GoString 

func (s DescribeMountTargetSecurityGroupsInput) GoString() string

GoString returns the string representation

func (*DescribeMountTargetSecurityGroupsInput) SetMountTargetId 

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

SetMountTargetId sets the MountTargetId field's value.

func (DescribeMountTargetSecurityGroupsInput) String 

func (s DescribeMountTargetSecurityGroupsInput) String() string

String returns the string representation

func (*DescribeMountTargetSecurityGroupsInput) Validate 

func (s *DescribeMountTargetSecurityGroupsInput) Validate() error

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

type DescribeMountTargetSecurityGroupsOutput 

type DescribeMountTargetSecurityGroupsOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeMountTargetSecurityGroupsResponse

func (DescribeMountTargetSecurityGroupsOutput) GoString 

func (s DescribeMountTargetSecurityGroupsOutput) GoString() string

GoString returns the string representation

func (*DescribeMountTargetSecurityGroupsOutput) SetSecurityGroups 

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

SetSecurityGroups sets the SecurityGroups field's value.

func (DescribeMountTargetSecurityGroupsOutput) String 

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. It
	// must be an integer with a value greater than zero.
	MaxItems *int64 `location:"querystring" locationName:"MaxItems" min:"1" type:"integer"`

	// (Optional) ID of the mount target that you want to have described (String).
	// It must be included in your request if FileSystemId is not included.
	MountTargetId *string `location:"querystring" locationName:"MountTargetId" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeMountTargetsRequest

func (DescribeMountTargetsInput) GoString 

func (s DescribeMountTargetsInput) GoString() string

GoString returns the string representation

func (*DescribeMountTargetsInput) SetFileSystemId 

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

SetFileSystemId sets the FileSystemId field's value.

func (*DescribeMountTargetsInput) SetMarker 

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

SetMarker sets the Marker field's value.

func (*DescribeMountTargetsInput) SetMaxItems 

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

SetMaxItems sets the MaxItems field's value.

func (*DescribeMountTargetsInput) SetMountTargetId 

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

SetMountTargetId sets the MountTargetId field's value.

func (DescribeMountTargetsInput) String 

func (s DescribeMountTargetsInput) String() string

String returns the string representation

func (*DescribeMountTargetsInput) Validate 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeMountTargetsResponse

func (DescribeMountTargetsOutput) GoString 

func (s DescribeMountTargetsOutput) GoString() string

GoString returns the string representation

func (*DescribeMountTargetsOutput) SetMarker 

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

SetMarker sets the Marker field's value.

func (*DescribeMountTargetsOutput) SetMountTargets 

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

SetMountTargets sets the MountTargets field's value.

func (*DescribeMountTargetsOutput) SetNextMarker 

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

SetNextMarker sets the NextMarker field's value.

func (DescribeMountTargetsOutput) String 

func (s DescribeMountTargetsOutput) String() string

String returns the string representation

type DescribeTagsInput 

type DescribeTagsInput struct {

	// ID of the file system whose tag set you want to retrieve.
	//
	// FileSystemId is a required field
	FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`

	// (Optional) Opaque pagination token returned from a previous DescribeTags
	// operation (String). If present, it specifies to continue the list from where
	// the previous call left off.
	Marker *string `location:"querystring" locationName:"Marker" type:"string"`

	// (Optional) Maximum number of file system tags to return in the response.
	// It must be an integer with a value greater than zero.
	MaxItems *int64 `location:"querystring" locationName:"MaxItems" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeTagsRequest

func (DescribeTagsInput) GoString 

func (s DescribeTagsInput) GoString() string

GoString returns the string representation

func (*DescribeTagsInput) SetFileSystemId 

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

SetFileSystemId sets the FileSystemId field's value.

func (*DescribeTagsInput) SetMarker 

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

SetMarker sets the Marker field's value.

func (*DescribeTagsInput) SetMaxItems 

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

SetMaxItems sets the MaxItems field's value.

func (DescribeTagsInput) String 

func (s DescribeTagsInput) String() string

String returns the string representation

func (*DescribeTagsInput) Validate 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeTagsResponse

func (DescribeTagsOutput) GoString 

func (s DescribeTagsOutput) GoString() string

GoString returns the string representation

func (*DescribeTagsOutput) SetMarker 

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

SetMarker sets the Marker field's value.

func (*DescribeTagsOutput) SetNextMarker 

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

SetNextMarker sets the NextMarker field's value.

func (*DescribeTagsOutput) SetTags 

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

SetTags sets the Tags field's value.

func (DescribeTagsOutput) String 

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 (http://docs.aws.amazon.com/efs/latest/ug/performance.html#performancemodes.html).

After the file system is fully created, Amazon EFS sets its lifecycle state to available, at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC via the mount target. For more information, see Amazon EFS: How it Works (http://docs.aws.amazon.com/efs/latest/ug/how-it-works.html).

This operation requires permissions for the elasticfilesystem:CreateFileSystem action.

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

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

Returned Error Codes:

  • ErrCodeBadRequest "BadRequest" Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

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

  • ErrCodeFileSystemAlreadyExists "FileSystemAlreadyExists" Returned if the file system you are trying to create already exists, with the creation token you provided.

  • ErrCodeFileSystemLimitExceeded "FileSystemLimitExceeded" Returned if the AWS account has already created maximum number of file systems allowed per account.

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

Example 
package main

import (
	"fmt"

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

func main() {
	sess := session.Must(session.NewSession())

	svc := efs.New(sess)

	params := &efs.CreateFileSystemInput{
		CreationToken:   aws.String("CreationToken"), // Required
		PerformanceMode: aws.String("PerformanceMode"),
	}
	resp, err := svc.CreateFileSystem(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

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 can be used to capture response data after the request's "Send" method is called.

See CreateFileSystem for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateFileSystem method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

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

func (*EFS) CreateFileSystemWithContext 

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 via the mount target.

You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system. For more information, see Amazon EFS: How it Works (http://docs.aws.amazon.com/efs/latest/ug/how-it-works.html).

In the request, you also specify a file system ID for which you are creating the mount target and the file system's lifecycle state must be available. For more information, see DescribeFileSystems.

In the request, you also provide a subnet ID, which determines the following:

  • VPC in which Amazon EFS creates the mount target

  • Availability Zone in which Amazon EFS creates the mount target

  • IP address range from which Amazon EFS selects the IP address of the mount target (if you don't specify an IP address in the request)

After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId and an IpAddress. You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system via the mount target can resolve the mount target's DNS name to its IP address. For more information, see How it Works: Implementation Overview (http://docs.aws.amazon.com/efs/latest/ug/how-it-works.html#how-it-works-implementation).

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

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

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

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

  • Creates a new mount target in the specified subnet.

  • Also creates a new network interface in the subnet as follows:

If the request provides an IpAddress, Amazon EFS assigns that IP address 

to the network interface. Otherwise, Amazon EFS assigns a free address
in the subnet (in the same way that the Amazon EC2 CreateNetworkInterface
call does when a request does not specify a primary private IP address).

If the request provides SecurityGroups, this network interface is associated 

with those security groups. Otherwise, it belongs to the default security
group for the subnet's VPC.

Assigns the description Mount target fsmt-id for file system fs-id where 

fsmt-id is the mount target ID, and fs-id is the FileSystemId.

Sets the requesterManaged property of the network interface to true, and 

the requesterId value to EFS.

Each Amazon EFS mount target has one corresponding requester-managed EC2 

network interface. After the network interface is created, Amazon EFS
sets the NetworkInterfaceId field in the mount target's description to
the network interface ID, and the IpAddress field to its address. If network
interface creation fails, the entire CreateMountTarget operation fails.

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

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

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

  • elasticfilesystem:CreateMountTarget

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

  • ec2:DescribeSubnets

  • ec2:DescribeNetworkInterfaces

  • ec2:CreateNetworkInterface

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

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

Returned Error Codes:

  • ErrCodeBadRequest "BadRequest" Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

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

  • ErrCodeFileSystemNotFound "FileSystemNotFound" Returned if the specified FileSystemId does not exist in the requester's AWS account.

  • ErrCodeIncorrectFileSystemLifeCycleState "IncorrectFileSystemLifeCycleState" Returned if the file system's life cycle state is not "created".

  • 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 ENI limit for the specific AWS region. Client should try to delete some ENIs or get its account limit raised. For more information, see Amazon VPC Limits (http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Appendix_Limits.html) in the Amazon Virtual Private Cloud 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 does not exist in the subnet's VPC.

  • ErrCodeUnsupportedAvailabilityZone "UnsupportedAvailabilityZone"

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

Example 
package main

import (
	"fmt"

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

func main() {
	sess := session.Must(session.NewSession())

	svc := efs.New(sess)

	params := &efs.CreateMountTargetInput{
		FileSystemId: aws.String("FileSystemId"), // Required
		SubnetId:     aws.String("SubnetId"),     // Required
		IpAddress:    aws.String("IpAddress"),
		SecurityGroups: []*string{
			aws.String("SecurityGroup"), // Required
			// More values...
		},
	}
	resp, err := svc.CreateMountTarget(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

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 can be used to capture response data after the request's "Send" method is called.

See CreateMountTarget for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateMountTarget method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

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

func (*EFS) CreateMountTargetWithContext 

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 does not exist in the requester's AWS account.

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

Example 
package main

import (
	"fmt"

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

func main() {
	sess := session.Must(session.NewSession())

	svc := efs.New(sess)

	params := &efs.CreateTagsInput{
		FileSystemId: aws.String("FileSystemId"), // Required
		Tags: []*efs.Tag{ // Required
			{ // Required
				Key:   aws.String("TagKey"),   // Required
				Value: aws.String("TagValue"), // Required
			},
			// More values...
		},
	}
	resp, err := svc.CreateTags(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

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 can be used to capture response data after the request's "Send" method is called.

See CreateTags for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateTags method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

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

func (*EFS) CreateTagsWithContext 

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 does not exist in the requester's AWS account.

  • ErrCodeFileSystemInUse "FileSystemInUse" Returned if a file system has mount targets.

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

Example 
package main

import (
	"fmt"

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

func main() {
	sess := session.Must(session.NewSession())

	svc := efs.New(sess)

	params := &efs.DeleteFileSystemInput{
		FileSystemId: aws.String("FileSystemId"), // Required
	}
	resp, err := svc.DeleteFileSystem(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

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 can be used to capture response data after the request's "Send" method is called.

See DeleteFileSystem for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteFileSystem method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

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

func (*EFS) DeleteFileSystemWithContext 

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 via the mount target that is being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes may be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC via another mount target.

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

  • elasticfilesystem:DeleteMountTarget

The DeleteMountTarget call returns while the mount target state is still deleting. You can check the mount target deletion by calling the DescribeMountTargets operation, which returns a list of mount target descriptions for the given file system.

The operation also requires permissions for the following Amazon EC2 action on the mount target's network interface:

  • ec2:DeleteNetworkInterface

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

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

Returned Error Codes:

  • ErrCodeBadRequest "BadRequest" Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

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

  • ErrCodeDependencyTimeout "DependencyTimeout" The service timed out trying to fulfill the request, and the client should try the call again.

  • ErrCodeMountTargetNotFound "MountTargetNotFound" Returned if there is no mount target with the specified ID found in the caller's account.

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteMountTarget

Example 
package main

import (
	"fmt"

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

func main() {
	sess := session.Must(session.NewSession())

	svc := efs.New(sess)

	params := &efs.DeleteMountTargetInput{
		MountTargetId: aws.String("MountTargetId"), // Required
	}
	resp, err := svc.DeleteMountTarget(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

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 can be used to capture response data after the request's "Send" method is called.

See DeleteMountTarget for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteMountTarget method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteMountTarget

func (*EFS) DeleteMountTargetWithContext 

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 does not exist, Amazon EFS ignores it and doesn't cause an error. For more information about tags and related restrictions, see Tag Restrictions (http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the AWS Billing and Cost Management User Guide.

This operation requires permissions for the elasticfilesystem:DeleteTags action.

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

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

Returned Error Codes:

  • ErrCodeBadRequest "BadRequest" Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

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

  • ErrCodeFileSystemNotFound "FileSystemNotFound" Returned if the specified FileSystemId does not exist in the requester's AWS account.

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteTags

Example 
package main

import (
	"fmt"

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

func main() {
	sess := session.Must(session.NewSession())

	svc := efs.New(sess)

	params := &efs.DeleteTagsInput{
		FileSystemId: aws.String("FileSystemId"), // Required
		TagKeys: []*string{ // Required
			aws.String("TagKey"), // Required
			// More values...
		},
	}
	resp, err := svc.DeleteTags(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

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 can be used to capture response data after the request's "Send" method is called.

See DeleteTags for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteTags method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteTags

func (*EFS) DeleteTagsWithContext 

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. If more file system descriptions remain, Amazon EFS returns a NextMarker, an opaque token, in the response. In this case, you should send a subsequent request with the Marker request parameter set to the value of NextMarker.

To retrieve a list of your file system descriptions, this operation is used in an iterative process, where DescribeFileSystems is called first without the Marker and then the operation continues to call it with the Marker parameter set to the value of the NextMarker from the previous response until the response has no NextMarker.

The implementation may return fewer than MaxItems file system descriptions while still including a NextMarker value.

The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multi-call iteration is unspecified.

This operation requires permissions for the elasticfilesystem:DescribeFileSystems action.

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

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

Returned Error Codes:

  • ErrCodeBadRequest "BadRequest" Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

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

  • ErrCodeFileSystemNotFound "FileSystemNotFound" Returned if the specified FileSystemId does not exist in the requester's AWS account.

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeFileSystems

Example 
package main

import (
	"fmt"

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

func main() {
	sess := session.Must(session.NewSession())

	svc := efs.New(sess)

	params := &efs.DescribeFileSystemsInput{
		CreationToken: aws.String("CreationToken"),
		FileSystemId:  aws.String("FileSystemId"),
		Marker:        aws.String("Marker"),
		MaxItems:      aws.Int64(1),
	}
	resp, err := svc.DescribeFileSystems(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

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 can be used to capture response data after the request's "Send" method is called.

See DescribeFileSystems for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeFileSystems method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeFileSystems

func (*EFS) DescribeFileSystemsWithContext 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeMountTargetSecurityGroups

Example 
package main

import (
	"fmt"

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

func main() {
	sess := session.Must(session.NewSession())

	svc := efs.New(sess)

	params := &efs.DescribeMountTargetSecurityGroupsInput{
		MountTargetId: aws.String("MountTargetId"), // Required
	}
	resp, err := svc.DescribeMountTargetSecurityGroups(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

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 can be used to capture response data after the request's "Send" method is called.

See DescribeMountTargetSecurityGroups for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeMountTargetSecurityGroups method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeMountTargetSecurityGroups

func (*EFS) DescribeMountTargetSecurityGroupsWithContext 

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 does not 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.

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeMountTargets

Example 
package main

import (
	"fmt"

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

func main() {
	sess := session.Must(session.NewSession())

	svc := efs.New(sess)

	params := &efs.DescribeMountTargetsInput{
		FileSystemId:  aws.String("FileSystemId"),
		Marker:        aws.String("Marker"),
		MaxItems:      aws.Int64(1),
		MountTargetId: aws.String("MountTargetId"),
	}
	resp, err := svc.DescribeMountTargets(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

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 can be used to capture response data after the request's "Send" method is called.

See DescribeMountTargets for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeMountTargets method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeMountTargets

func (*EFS) DescribeMountTargetsWithContext 

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 multi-call iteration (when using pagination) is unspecified.

This operation requires permissions for the elasticfilesystem:DescribeTags action.

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

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

Returned Error Codes:

  • ErrCodeBadRequest "BadRequest" Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

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

  • ErrCodeFileSystemNotFound "FileSystemNotFound" Returned if the specified FileSystemId does not exist in the requester's AWS account.

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeTags

Example 
package main

import (
	"fmt"

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

func main() {
	sess := session.Must(session.NewSession())

	svc := efs.New(sess)

	params := &efs.DescribeTagsInput{
		FileSystemId: aws.String("FileSystemId"), // Required
		Marker:       aws.String("Marker"),
		MaxItems:     aws.Int64(1),
	}
	resp, err := svc.DescribeTags(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

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 can be used to capture response data after the request's "Send" method is called.

See DescribeTags for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeTags method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeTags

func (*EFS) DescribeTagsWithContext 

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 does not exist in the subnet's VPC.

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/ModifyMountTargetSecurityGroups

Example 
package main

import (
	"fmt"

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

func main() {
	sess := session.Must(session.NewSession())

	svc := efs.New(sess)

	params := &efs.ModifyMountTargetSecurityGroupsInput{
		MountTargetId: aws.String("MountTargetId"), // Required
		SecurityGroups: []*string{
			aws.String("SecurityGroup"), // Required
			// More values...
		},
	}
	resp, err := svc.ModifyMountTargetSecurityGroups(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

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 can be used to capture response data after the request's "Send" method is called.

See ModifyMountTargetSecurityGroups for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ModifyMountTargetSecurityGroups method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/ModifyMountTargetSecurityGroups

func (*EFS) ModifyMountTargetSecurityGroupsWithContext 

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.

type FileSystemDescription 

type FileSystemDescription struct {

	// Time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
	//
	// CreationTime is a required field
	CreationTime *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"`

	// Opaque string specified in the request.
	//
	// CreationToken is a required field
	CreationToken *string `min:"1" type:"string" required:"true"`

	// ID of the file system, assigned by Amazon EFS.
	//
	// FileSystemId is a required field
	FileSystemId *string `type:"string" required:"true"`

	// Lifecycle phase of the file system.
	//
	// LifeCycleState is a required field
	LifeCycleState *string `type:"string" required:"true" enum:"LifeCycleState"`

	// You can add tags to a file system, including a Name tag. For more information,
	// see CreateTags. If the file system has a Name tag, Amazon EFS returns the
	// value in this field.
	Name *string `type:"string"`

	// Current number of mount targets that the file system has. For more information,
	// see CreateMountTarget.
	//
	// NumberOfMountTargets is a required field
	NumberOfMountTargets *int64 `type:"integer" required:"true"`

	// AWS account that created the file system. If the file system was created
	// by an IAM user, the parent account to which the user belongs is the owner.
	//
	// OwnerId is a required field
	OwnerId *string `type:"string" required:"true"`

	// The PerformanceMode of the file system.
	//
	// PerformanceMode is a required field
	PerformanceMode *string `type:"string" required:"true" enum:"PerformanceMode"`

	// Latest known metered size (in bytes) of data stored in the file system, in
	// bytes, in its Value field, and the time at which that size was determined
	// in its Timestamp field. The Timestamp value is the integer number of seconds
	// since 1970-01-01T00:00:00Z. Note that the value does not represent the size
	// of a consistent snapshot of the file system, but it is eventually consistent
	// when there are no writes to the file system. That is, the value will represent
	// actual size only if the file system is not modified for a period longer than
	// a couple of hours. Otherwise, the value is not the exact size the file system
	// was at any instant in time.
	//
	// SizeInBytes is a required field
	SizeInBytes *FileSystemSize `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Description of the file system. Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/FileSystemDescription

func (FileSystemDescription) GoString 

func (s FileSystemDescription) GoString() string

GoString returns the string representation

func (*FileSystemDescription) SetCreationTime 

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

SetCreationTime sets the CreationTime field's value.

func (*FileSystemDescription) SetCreationToken 

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

SetCreationToken sets the CreationToken field's value.

func (*FileSystemDescription) SetFileSystemId 

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

SetFileSystemId sets the FileSystemId field's value.

func (*FileSystemDescription) SetLifeCycleState 

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

SetLifeCycleState sets the LifeCycleState field's value.

func (*FileSystemDescription) SetName 

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

SetName sets the Name field's value.

func (*FileSystemDescription) SetNumberOfMountTargets 

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

SetNumberOfMountTargets sets the NumberOfMountTargets field's value.

func (*FileSystemDescription) SetOwnerId 

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

SetOwnerId sets the OwnerId field's value.

func (*FileSystemDescription) SetPerformanceMode 

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

SetPerformanceMode sets the PerformanceMode field's value.

func (*FileSystemDescription) SetSizeInBytes 

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

SetSizeInBytes sets the SizeInBytes field's value.

func (FileSystemDescription) String 

func (s FileSystemDescription) String() string

String returns the string representation

type FileSystemSize 

type FileSystemSize struct {

	// 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" timestampFormat:"unix"`

	// Latest known metered size (in bytes) of data stored in the file system.
	//
	// Value is a required field
	Value *int64 `type:"long" required:"true"`
	// contains filtered or unexported fields
}

Latest known metered size (in bytes) of data stored in the file system, in its Value field, and the time at which that size was determined in its Timestamp field. Note that the value does not represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, the value will represent the actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not necessarily the exact size the file system was at any instant in time. Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/FileSystemSize

func (FileSystemSize) GoString 

func (s FileSystemSize) GoString() string

GoString returns the string representation

func (*FileSystemSize) SetTimestamp 

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

SetTimestamp sets the Timestamp field's value.

func (*FileSystemSize) SetValue 

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

SetValue sets the Value field's value.

func (FileSystemSize) String 

func (s FileSystemSize) String() string

String returns the string representation

type ModifyMountTargetSecurityGroupsInput 

type ModifyMountTargetSecurityGroupsInput struct {

	// ID of the mount target whose security groups you want to modify.
	//
	// MountTargetId is a required field
	MountTargetId *string `location:"uri" locationName:"MountTargetId" type:"string" required:"true"`

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/ModifyMountTargetSecurityGroupsRequest

func (ModifyMountTargetSecurityGroupsInput) GoString 

func (s ModifyMountTargetSecurityGroupsInput) GoString() string

GoString returns the string representation

func (*ModifyMountTargetSecurityGroupsInput) SetMountTargetId 

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

SetMountTargetId sets the MountTargetId field's value.

func (*ModifyMountTargetSecurityGroupsInput) SetSecurityGroups 

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

SetSecurityGroups sets the SecurityGroups field's value.

func (ModifyMountTargetSecurityGroupsInput) String 

func (s ModifyMountTargetSecurityGroupsInput) String() string

String returns the string representation

func (*ModifyMountTargetSecurityGroupsInput) Validate 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/ModifyMountTargetSecurityGroupsOutput

func (ModifyMountTargetSecurityGroupsOutput) GoString 

func (s ModifyMountTargetSecurityGroupsOutput) GoString() string

GoString returns the string representation

func (ModifyMountTargetSecurityGroupsOutput) String 

func (s ModifyMountTargetSecurityGroupsOutput) String() string

String returns the string representation

type MountTargetDescription 

type MountTargetDescription struct {

	// ID of the file system for which the mount target is intended.
	//
	// FileSystemId is a required field
	FileSystemId *string `type:"string" required:"true"`

	// Address at which the file system may be mounted via the mount target.
	IpAddress *string `type:"string"`

	// Lifecycle state of the mount target.
	//
	// LifeCycleState is a required field
	LifeCycleState *string `type:"string" required:"true" enum:"LifeCycleState"`

	// System-assigned mount target ID.
	//
	// MountTargetId is a required field
	MountTargetId *string `type:"string" required:"true"`

	// ID of the network interface that Amazon EFS created when it created the mount
	// target.
	NetworkInterfaceId *string `type:"string"`

	// AWS account ID that owns the resource.
	OwnerId *string `type:"string"`

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

Provides a description of a mount target. Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/MountTargetDescription

func (MountTargetDescription) GoString 

func (s MountTargetDescription) GoString() string

GoString returns the string representation

func (*MountTargetDescription) SetFileSystemId 

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

SetFileSystemId sets the FileSystemId field's value.

func (*MountTargetDescription) SetIpAddress 

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

SetIpAddress sets the IpAddress field's value.

func (*MountTargetDescription) SetLifeCycleState 

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

SetLifeCycleState sets the LifeCycleState field's value.

func (*MountTargetDescription) SetMountTargetId 

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

SetMountTargetId sets the MountTargetId field's value.

func (*MountTargetDescription) SetNetworkInterfaceId 

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

SetNetworkInterfaceId sets the NetworkInterfaceId field's value.

func (*MountTargetDescription) SetOwnerId 

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

SetOwnerId sets the OwnerId field's value.

func (*MountTargetDescription) SetSubnetId 

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

SetSubnetId sets the SubnetId field's value.

func (MountTargetDescription) String 

func (s MountTargetDescription) String() string

String returns the string representation

type Tag 

type Tag struct {

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

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

A tag is a key-value pair. Allowed characters: letters, whitespace, and numbers, representable in UTF-8, and the following characters: + - = . _ : / Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/Tag

func (Tag) GoString 

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey 

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

SetKey sets the Key field's value.

func (*Tag) SetValue 

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

SetValue sets the Value field's value.

func (Tag) String 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate 

func (s *Tag) Validate() error

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

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.