efs

package
v1.54.8 Latest Latest
Warning

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

 Go to latest Published: Jun 25, 2024 License: Apache-2.0 Imports: 10 Imported by: 386

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 Linux and Mac instances in the Amazon Web Services Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and remove files, so that your applications have the storage they need, when they need it. For more information, see the Amazon Elastic File System API Reference (https://docs.aws.amazon.com/efs/latest/ug/api-reference.html) and the Amazon Elastic File System User Guide (https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html).

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

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

Using the Client

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

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

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

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

Index

Examples

Constants

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

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

	// LifeCycleStateUpdating is a LifeCycleState enum value
	LifeCycleStateUpdating = "updating"

	// LifeCycleStateDeleting is a LifeCycleState enum value
	LifeCycleStateDeleting = "deleting"

	// LifeCycleStateDeleted is a LifeCycleState enum value
	LifeCycleStateDeleted = "deleted"

	// LifeCycleStateError is a LifeCycleState enum value
	LifeCycleStateError = "error"
)
View Source 
const (
	// PerformanceModeGeneralPurpose is a PerformanceMode enum value
	PerformanceModeGeneralPurpose = "generalPurpose"

	// PerformanceModeMaxIo is a PerformanceMode enum value
	PerformanceModeMaxIo = "maxIO"
)
View Source 
const (
	// ReplicationOverwriteProtectionEnabled is a ReplicationOverwriteProtection enum value
	ReplicationOverwriteProtectionEnabled = "ENABLED"

	// ReplicationOverwriteProtectionDisabled is a ReplicationOverwriteProtection enum value
	ReplicationOverwriteProtectionDisabled = "DISABLED"

	// ReplicationOverwriteProtectionReplicating is a ReplicationOverwriteProtection enum value
	ReplicationOverwriteProtectionReplicating = "REPLICATING"
)
View Source 
const (
	// ReplicationStatusEnabled is a ReplicationStatus enum value
	ReplicationStatusEnabled = "ENABLED"

	// ReplicationStatusEnabling is a ReplicationStatus enum value
	ReplicationStatusEnabling = "ENABLING"

	// ReplicationStatusDeleting is a ReplicationStatus enum value
	ReplicationStatusDeleting = "DELETING"

	// ReplicationStatusError is a ReplicationStatus enum value
	ReplicationStatusError = "ERROR"

	// ReplicationStatusPaused is a ReplicationStatus enum value
	ReplicationStatusPaused = "PAUSED"

	// ReplicationStatusPausing is a ReplicationStatus enum value
	ReplicationStatusPausing = "PAUSING"
)
View Source 
const (
	// ResourceFileSystem is a Resource enum value
	ResourceFileSystem = "FILE_SYSTEM"

	// ResourceMountTarget is a Resource enum value
	ResourceMountTarget = "MOUNT_TARGET"
)

An EFS resource, for example a file system or a mount target.

View Source 
const (
	// ResourceIdTypeLongId is a ResourceIdType enum value
	ResourceIdTypeLongId = "LONG_ID"

	// ResourceIdTypeShortId is a ResourceIdType enum value
	ResourceIdTypeShortId = "SHORT_ID"
)

A preference indicating a choice to use 63bit/32bit IDs for all applicable resources.

View Source 
const (
	// StatusEnabled is a Status enum value
	StatusEnabled = "ENABLED"

	// StatusEnabling is a Status enum value
	StatusEnabling = "ENABLING"

	// StatusDisabled is a Status enum value
	StatusDisabled = "DISABLED"

	// StatusDisabling is a Status enum value
	StatusDisabling = "DISABLING"
)
View Source 
const (
	// ThroughputModeBursting is a ThroughputMode enum value
	ThroughputModeBursting = "bursting"

	// ThroughputModeProvisioned is a ThroughputMode enum value
	ThroughputModeProvisioned = "provisioned"

	// ThroughputModeElastic is a ThroughputMode enum value
	ThroughputModeElastic = "elastic"
)
View Source 
const (
	// TransitionToArchiveRulesAfter1Day is a TransitionToArchiveRules enum value
	TransitionToArchiveRulesAfter1Day = "AFTER_1_DAY"

	// TransitionToArchiveRulesAfter7Days is a TransitionToArchiveRules enum value
	TransitionToArchiveRulesAfter7Days = "AFTER_7_DAYS"

	// TransitionToArchiveRulesAfter14Days is a TransitionToArchiveRules enum value
	TransitionToArchiveRulesAfter14Days = "AFTER_14_DAYS"

	// TransitionToArchiveRulesAfter30Days is a TransitionToArchiveRules enum value
	TransitionToArchiveRulesAfter30Days = "AFTER_30_DAYS"

	// TransitionToArchiveRulesAfter60Days is a TransitionToArchiveRules enum value
	TransitionToArchiveRulesAfter60Days = "AFTER_60_DAYS"

	// TransitionToArchiveRulesAfter90Days is a TransitionToArchiveRules enum value
	TransitionToArchiveRulesAfter90Days = "AFTER_90_DAYS"

	// TransitionToArchiveRulesAfter180Days is a TransitionToArchiveRules enum value
	TransitionToArchiveRulesAfter180Days = "AFTER_180_DAYS"

	// TransitionToArchiveRulesAfter270Days is a TransitionToArchiveRules enum value
	TransitionToArchiveRulesAfter270Days = "AFTER_270_DAYS"

	// TransitionToArchiveRulesAfter365Days is a TransitionToArchiveRules enum value
	TransitionToArchiveRulesAfter365Days = "AFTER_365_DAYS"
)
View Source 
const (
	// TransitionToIARulesAfter7Days is a TransitionToIARules enum value
	TransitionToIARulesAfter7Days = "AFTER_7_DAYS"

	// TransitionToIARulesAfter14Days is a TransitionToIARules enum value
	TransitionToIARulesAfter14Days = "AFTER_14_DAYS"

	// TransitionToIARulesAfter30Days is a TransitionToIARules enum value
	TransitionToIARulesAfter30Days = "AFTER_30_DAYS"

	// TransitionToIARulesAfter60Days is a TransitionToIARules enum value
	TransitionToIARulesAfter60Days = "AFTER_60_DAYS"

	// TransitionToIARulesAfter90Days is a TransitionToIARules enum value
	TransitionToIARulesAfter90Days = "AFTER_90_DAYS"

	// TransitionToIARulesAfter1Day is a TransitionToIARules enum value
	TransitionToIARulesAfter1Day = "AFTER_1_DAY"

	// TransitionToIARulesAfter180Days is a TransitionToIARules enum value
	TransitionToIARulesAfter180Days = "AFTER_180_DAYS"

	// TransitionToIARulesAfter270Days is a TransitionToIARules enum value
	TransitionToIARulesAfter270Days = "AFTER_270_DAYS"

	// TransitionToIARulesAfter365Days is a TransitionToIARules enum value
	TransitionToIARulesAfter365Days = "AFTER_365_DAYS"
)
View Source 
const (

	// ErrCodeAccessPointAlreadyExists for service response error code
	// "AccessPointAlreadyExists".
	//
	// Returned if the access point that you are trying to create already exists,
	// with the creation token you provided in the request.
	ErrCodeAccessPointAlreadyExists = "AccessPointAlreadyExists"

	// ErrCodeAccessPointLimitExceeded for service response error code
	// "AccessPointLimitExceeded".
	//
	// Returned if the Amazon Web Services account has already created the maximum
	// number of access points allowed per file system. For more informaton, see
	// https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region
	// (https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region).
	ErrCodeAccessPointLimitExceeded = "AccessPointLimitExceeded"

	// ErrCodeAccessPointNotFound for service response error code
	// "AccessPointNotFound".
	//
	// Returned if the specified AccessPointId value doesn't exist in the requester's
	// Amazon Web Services account.
	ErrCodeAccessPointNotFound = "AccessPointNotFound"

	// ErrCodeAvailabilityZonesMismatch for service response error code
	// "AvailabilityZonesMismatch".
	//
	// Returned if the Availability Zone that was specified for a mount target is
	// different from the Availability Zone that was specified for One Zone storage.
	// For more information, see Regional and One Zone storage redundancy (https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html).
	ErrCodeAvailabilityZonesMismatch = "AvailabilityZonesMismatch"

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

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// Returned if the source file system in a replication is encrypted but the
	// destination file system is unencrypted.
	ErrCodeConflictException = "ConflictException"

	// 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 Amazon Web Services account has already created the maximum
	// number of file systems allowed per account.
	ErrCodeFileSystemLimitExceeded = "FileSystemLimitExceeded"

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

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

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

	// ErrCodeInsufficientThroughputCapacity for service response error code
	// "InsufficientThroughputCapacity".
	//
	// Returned if there's not enough capacity to provision additional throughput.
	// This value might be returned when you try to create a file system in provisioned
	// throughput mode, when you attempt to increase the provisioned throughput
	// of an existing file system, or when you attempt to change an existing file
	// system from Bursting Throughput to Provisioned Throughput mode. Try again
	// later.
	ErrCodeInsufficientThroughputCapacity = "InsufficientThroughputCapacity"

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

	// ErrCodeInvalidPolicyException for service response error code
	// "InvalidPolicyException".
	//
	// Returned if the FileSystemPolicy is malformed or contains an error such as
	// a parameter value that is not valid or a missing required parameter. Returned
	// in the case of a policy lockout safety check error.
	ErrCodeInvalidPolicyException = "InvalidPolicyException"

	// 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
	// Amazon Web Services account.
	ErrCodeMountTargetNotFound = "MountTargetNotFound"

	// ErrCodeNetworkInterfaceLimitExceeded for service response error code
	// "NetworkInterfaceLimitExceeded".
	//
	// The calling account has reached the limit for elastic network interfaces
	// for the specific Amazon Web Services Region. Either delete some network interfaces
	// or request that the account quota be raised. For more information, see Amazon
	// VPC Quotas (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Appendix_Limits.html)
	// in the Amazon VPC User Guide (see the Network interfaces per Region entry
	// in the Network interfaces table).
	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"

	// ErrCodePolicyNotFound for service response error code
	// "PolicyNotFound".
	//
	// Returned if the default file system policy is in effect for the EFS file
	// system specified.
	ErrCodePolicyNotFound = "PolicyNotFound"

	// ErrCodeReplicationAlreadyExists for service response error code
	// "ReplicationAlreadyExists".
	//
	// Returned if the file system is already included in a replication configuration.>
	ErrCodeReplicationAlreadyExists = "ReplicationAlreadyExists"

	// ErrCodeReplicationNotFound for service response error code
	// "ReplicationNotFound".
	//
	// Returned if the specified file system does not have a replication configuration.
	ErrCodeReplicationNotFound = "ReplicationNotFound"

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

	// ErrCodeSecurityGroupNotFound for service response error code
	// "SecurityGroupNotFound".
	//
	// Returned if one of the specified security groups doesn't exist in the subnet's
	// virtual private cloud (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"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// Returned when the CreateAccessPoint API action is called too quickly and
	// the number of Access Points on the file system is nearing the limit of 120
	// (https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region).
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeThroughputLimitExceeded for service response error code
	// "ThroughputLimitExceeded".
	//
	// Returned if the throughput mode or amount of provisioned throughput can't
	// be changed because the throughput limit of 1024 MiB/s has been reached.
	ErrCodeThroughputLimitExceeded = "ThroughputLimitExceeded"

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

	// ErrCodeUnsupportedAvailabilityZone for service response error code
	// "UnsupportedAvailabilityZone".
	//
	// Returned if the requested Amazon EFS functionality is not available in the
	// specified Availability Zone.
	ErrCodeUnsupportedAvailabilityZone = "UnsupportedAvailabilityZone"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// Returned if the Backup service is not available in the Amazon Web Services
	// Region in which the request was made.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "elasticfilesystem" // Name of service.
	EndpointsID = ServiceName         // ID to lookup a service endpoint with.
	ServiceID   = "EFS"               // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// TransitionToPrimaryStorageClassRulesAfter1Access is a TransitionToPrimaryStorageClassRules enum value
	TransitionToPrimaryStorageClassRulesAfter1Access = "AFTER_1_ACCESS"
)

Variables

This section is empty.

Functions

func LifeCycleState_Values added in v1.34.3 

func LifeCycleState_Values() []string

LifeCycleState_Values returns all elements of the LifeCycleState enum

func PerformanceMode_Values added in v1.34.3 

func PerformanceMode_Values() []string

PerformanceMode_Values returns all elements of the PerformanceMode enum

func ReplicationOverwriteProtection_Values added in v1.48.5 

func ReplicationOverwriteProtection_Values() []string

ReplicationOverwriteProtection_Values returns all elements of the ReplicationOverwriteProtection enum

func ReplicationStatus_Values added in v1.42.41 

func ReplicationStatus_Values() []string

ReplicationStatus_Values returns all elements of the ReplicationStatus enum

func ResourceIdType_Values added in v1.38.45 

func ResourceIdType_Values() []string

ResourceIdType_Values returns all elements of the ResourceIdType enum

func Resource_Values added in v1.38.45 

func Resource_Values() []string

Resource_Values returns all elements of the Resource enum

func Status_Values added in v1.34.3 

func Status_Values() []string

Status_Values returns all elements of the Status enum

func ThroughputMode_Values added in v1.34.3 

func ThroughputMode_Values() []string

ThroughputMode_Values returns all elements of the ThroughputMode enum

func TransitionToArchiveRules_Values added in v1.48.4 

func TransitionToArchiveRules_Values() []string

TransitionToArchiveRules_Values returns all elements of the TransitionToArchiveRules enum

func TransitionToIARules_Values added in v1.34.3 

func TransitionToIARules_Values() []string

TransitionToIARules_Values returns all elements of the TransitionToIARules enum

func TransitionToPrimaryStorageClassRules_Values added in v1.40.36 

func TransitionToPrimaryStorageClassRules_Values() []string

TransitionToPrimaryStorageClassRules_Values returns all elements of the TransitionToPrimaryStorageClassRules enum

Types

type AccessPointAlreadyExists added in v1.28.1 

type AccessPointAlreadyExists struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// AccessPointId is a required field
	AccessPointId *string `type:"string" required:"true"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	//
	// ErrorCode is a required field
	ErrorCode *string `min:"1" type:"string" required:"true"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if the access point that you are trying to create already exists, with the creation token you provided in the request.

func (*AccessPointAlreadyExists) Code added in v1.28.1 

func (s *AccessPointAlreadyExists) Code() string

Code returns the exception type name.

func (*AccessPointAlreadyExists) Error added in v1.28.1 

func (s *AccessPointAlreadyExists) Error() string

func (AccessPointAlreadyExists) GoString added in v1.28.1 

func (s AccessPointAlreadyExists) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessPointAlreadyExists) Message added in v1.28.1 

func (s *AccessPointAlreadyExists) Message() string

Message returns the exception's message.

func (*AccessPointAlreadyExists) OrigErr added in v1.28.1 

func (s *AccessPointAlreadyExists) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessPointAlreadyExists) RequestID added in v1.28.1 

func (s *AccessPointAlreadyExists) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessPointAlreadyExists) StatusCode added in v1.28.1 

func (s *AccessPointAlreadyExists) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessPointAlreadyExists) String added in v1.28.1 

func (s AccessPointAlreadyExists) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AccessPointDescription added in v1.28.1 

type AccessPointDescription struct {

	// The unique Amazon Resource Name (ARN) associated with the access point.
	AccessPointArn *string `type:"string"`

	// The ID of the access point, assigned by Amazon EFS.
	AccessPointId *string `type:"string"`

	// The opaque string specified in the request to ensure idempotent creation.
	ClientToken *string `min:"1" type:"string"`

	// The ID of the EFS file system that the access point applies to.
	FileSystemId *string `type:"string"`

	// Identifies the lifecycle phase of the access point.
	LifeCycleState *string `type:"string" enum:"LifeCycleState"`

	// The name of the access point. This is the value of the Name tag.
	Name *string `type:"string"`

	// Identifies the Amazon Web Services account that owns the access point resource.
	OwnerId *string `type:"string"`

	// The full POSIX identity, including the user ID, group ID, and secondary group
	// IDs on the access point that is used for all file operations by NFS clients
	// using the access point.
	PosixUser *PosixUser `type:"structure"`

	// The directory on the EFS file system that the access point exposes as the
	// root directory to NFS clients using the access point.
	RootDirectory *RootDirectory `type:"structure"`

	// The tags associated with the access point, presented as an array of Tag objects.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

Provides a description of an EFS file system access point.

func (AccessPointDescription) GoString added in v1.28.1 

func (s AccessPointDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessPointDescription) SetAccessPointArn added in v1.28.1 

func (s *AccessPointDescription) SetAccessPointArn(v string) *AccessPointDescription

SetAccessPointArn sets the AccessPointArn field's value.

func (*AccessPointDescription) SetAccessPointId added in v1.28.1 

func (s *AccessPointDescription) SetAccessPointId(v string) *AccessPointDescription

SetAccessPointId sets the AccessPointId field's value.

func (*AccessPointDescription) SetClientToken added in v1.28.1 

func (s *AccessPointDescription) SetClientToken(v string) *AccessPointDescription

SetClientToken sets the ClientToken field's value.

func (*AccessPointDescription) SetFileSystemId added in v1.28.1 

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

SetFileSystemId sets the FileSystemId field's value.

func (*AccessPointDescription) SetLifeCycleState added in v1.28.1 

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

SetLifeCycleState sets the LifeCycleState field's value.

func (*AccessPointDescription) SetName added in v1.28.1 

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

SetName sets the Name field's value.

func (*AccessPointDescription) SetOwnerId added in v1.28.1 

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

SetOwnerId sets the OwnerId field's value.

func (*AccessPointDescription) SetPosixUser added in v1.28.1 

func (s *AccessPointDescription) SetPosixUser(v *PosixUser) *AccessPointDescription

SetPosixUser sets the PosixUser field's value.

func (*AccessPointDescription) SetRootDirectory added in v1.28.1 

func (s *AccessPointDescription) SetRootDirectory(v *RootDirectory) *AccessPointDescription

SetRootDirectory sets the RootDirectory field's value.

func (*AccessPointDescription) SetTags added in v1.28.1 

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

SetTags sets the Tags field's value.

func (AccessPointDescription) String added in v1.28.1 

func (s AccessPointDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AccessPointLimitExceeded added in v1.28.1 

type AccessPointLimitExceeded struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	//
	// ErrorCode is a required field
	ErrorCode *string `min:"1" type:"string" required:"true"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if the Amazon Web Services account has already created the maximum number of access points allowed per file system. For more informaton, see https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region (https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region).

func (*AccessPointLimitExceeded) Code added in v1.28.1 

func (s *AccessPointLimitExceeded) Code() string

Code returns the exception type name.

func (*AccessPointLimitExceeded) Error added in v1.28.1 

func (s *AccessPointLimitExceeded) Error() string

func (AccessPointLimitExceeded) GoString added in v1.28.1 

func (s AccessPointLimitExceeded) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessPointLimitExceeded) Message added in v1.28.1 

func (s *AccessPointLimitExceeded) Message() string

Message returns the exception's message.

func (*AccessPointLimitExceeded) OrigErr added in v1.28.1 

func (s *AccessPointLimitExceeded) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessPointLimitExceeded) RequestID added in v1.28.1 

func (s *AccessPointLimitExceeded) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessPointLimitExceeded) StatusCode added in v1.28.1 

func (s *AccessPointLimitExceeded) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessPointLimitExceeded) String added in v1.28.1 

func (s AccessPointLimitExceeded) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AccessPointNotFound added in v1.28.1 

type AccessPointNotFound struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	//
	// ErrorCode is a required field
	ErrorCode *string `min:"1" type:"string" required:"true"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.

func (*AccessPointNotFound) Code added in v1.28.1 

func (s *AccessPointNotFound) Code() string

Code returns the exception type name.

func (*AccessPointNotFound) Error added in v1.28.1 

func (s *AccessPointNotFound) Error() string

func (AccessPointNotFound) GoString added in v1.28.1 

func (s AccessPointNotFound) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessPointNotFound) Message added in v1.28.1 

func (s *AccessPointNotFound) Message() string

Message returns the exception's message.

func (*AccessPointNotFound) OrigErr added in v1.28.1 

func (s *AccessPointNotFound) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessPointNotFound) RequestID added in v1.28.1 

func (s *AccessPointNotFound) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessPointNotFound) StatusCode added in v1.28.1 

func (s *AccessPointNotFound) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessPointNotFound) String added in v1.28.1 

func (s AccessPointNotFound) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AvailabilityZonesMismatch added in v1.37.27 

type AvailabilityZonesMismatch struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	ErrorCode *string `min:"1" type:"string"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if the Availability Zone that was specified for a mount target is different from the Availability Zone that was specified for One Zone storage. For more information, see Regional and One Zone storage redundancy (https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html).

func (*AvailabilityZonesMismatch) Code added in v1.37.27 

func (s *AvailabilityZonesMismatch) Code() string

Code returns the exception type name.

func (*AvailabilityZonesMismatch) Error added in v1.37.27 

func (s *AvailabilityZonesMismatch) Error() string

func (AvailabilityZonesMismatch) GoString added in v1.37.27 

func (s AvailabilityZonesMismatch) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AvailabilityZonesMismatch) Message added in v1.37.27 

func (s *AvailabilityZonesMismatch) Message() string

Message returns the exception's message.

func (*AvailabilityZonesMismatch) OrigErr added in v1.37.27 

func (s *AvailabilityZonesMismatch) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AvailabilityZonesMismatch) RequestID added in v1.37.27 

func (s *AvailabilityZonesMismatch) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AvailabilityZonesMismatch) StatusCode added in v1.37.27 

func (s *AvailabilityZonesMismatch) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AvailabilityZonesMismatch) String added in v1.37.27 

func (s AvailabilityZonesMismatch) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BackupPolicy added in v1.33.3 

type BackupPolicy struct {

	// Describes the status of the file system's backup policy.
	//
	//    * ENABLED – EFS is automatically backing up the file system.
	//
	//    * ENABLING – EFS is turning on automatic backups for the file system.
	//
	//    * DISABLED – Automatic back ups are turned off for the file system.
	//
	//    * DISABLING – EFS is turning off automatic backups for the file system.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"Status"`
	// contains filtered or unexported fields
}

The backup policy for the file system used to create automatic daily backups. If status has a value of ENABLED, the file system is being automatically backed up. For more information, see Automatic backups (https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#automatic-backups).

func (BackupPolicy) GoString added in v1.33.3 

func (s BackupPolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BackupPolicy) SetStatus added in v1.33.3 

func (s *BackupPolicy) SetStatus(v string) *BackupPolicy

SetStatus sets the Status field's value.

func (BackupPolicy) String added in v1.33.3 

func (s BackupPolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BackupPolicy) Validate added in v1.33.3 

func (s *BackupPolicy) Validate() error

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

type BadRequest added in v1.28.0 

type BadRequest struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	//
	// ErrorCode is a required field
	ErrorCode *string `min:"1" type:"string" required:"true"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*BadRequest) Code added in v1.28.0 

func (s *BadRequest) Code() string

Code returns the exception type name.

func (*BadRequest) Error added in v1.28.0 

func (s *BadRequest) Error() string

func (BadRequest) GoString added in v1.28.0 

func (s BadRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BadRequest) Message added in v1.28.0 

func (s *BadRequest) Message() string

Message returns the exception's message.

func (*BadRequest) OrigErr added in v1.28.0 

func (s *BadRequest) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BadRequest) RequestID added in v1.28.0 

func (s *BadRequest) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadRequest) StatusCode added in v1.28.0 

func (s *BadRequest) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (BadRequest) String added in v1.28.0 

func (s BadRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictException added in v1.48.5 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	ErrorCode *string `min:"1" type:"string"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if the source file system in a replication is encrypted but the destination file system is unencrypted.

func (*ConflictException) Code added in v1.48.5 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error added in v1.48.5 

func (s *ConflictException) Error() string

func (ConflictException) GoString added in v1.48.5 

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message added in v1.48.5 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr added in v1.48.5 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID added in v1.48.5 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode added in v1.48.5 

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String added in v1.48.5 

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateAccessPointInput added in v1.28.1 

type CreateAccessPointInput struct {

	// A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent
	// creation.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The ID of the EFS file system that the access point provides access to.
	//
	// FileSystemId is a required field
	FileSystemId *string `type:"string" required:"true"`

	// The operating system user and group applied to all file system requests made
	// using the access point.
	PosixUser *PosixUser `type:"structure"`

	// Specifies the directory on the EFS file system that the access point exposes
	// as the root directory of your file system to NFS clients using the access
	// point. The clients using the access point can only access the root directory
	// and below. If the RootDirectory > Path specified does not exist, Amazon EFS
	// creates it and applies the CreationInfo settings when a client connects to
	// an access point. When specifying a RootDirectory, you must provide the Path,
	// and the CreationInfo.
	//
	// Amazon EFS creates a root directory only if you have provided the CreationInfo:
	// OwnUid, OwnGID, and permissions for the directory. If you do not provide
	// this information, Amazon EFS does not create the root directory. If the root
	// directory does not exist, attempts to mount using the access point will fail.
	RootDirectory *RootDirectory `type:"structure"`

	// Creates tags associated with the access point. Each tag is a key-value pair,
	// each key must be unique. For more information, see Tagging Amazon Web Services
	// resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// in the Amazon Web Services General Reference Guide.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateAccessPointInput) GoString added in v1.28.1 

func (s CreateAccessPointInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAccessPointInput) SetClientToken added in v1.28.1 

func (s *CreateAccessPointInput) SetClientToken(v string) *CreateAccessPointInput

SetClientToken sets the ClientToken field's value.

func (*CreateAccessPointInput) SetFileSystemId added in v1.28.1 

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

SetFileSystemId sets the FileSystemId field's value.

func (*CreateAccessPointInput) SetPosixUser added in v1.28.1 

func (s *CreateAccessPointInput) SetPosixUser(v *PosixUser) *CreateAccessPointInput

SetPosixUser sets the PosixUser field's value.

func (*CreateAccessPointInput) SetRootDirectory added in v1.28.1 

func (s *CreateAccessPointInput) SetRootDirectory(v *RootDirectory) *CreateAccessPointInput

SetRootDirectory sets the RootDirectory field's value.

func (*CreateAccessPointInput) SetTags added in v1.28.1 

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

SetTags sets the Tags field's value.

func (CreateAccessPointInput) String added in v1.28.1 

func (s CreateAccessPointInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAccessPointInput) Validate added in v1.28.1 

func (s *CreateAccessPointInput) Validate() error

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

type CreateAccessPointOutput added in v1.28.1 

type CreateAccessPointOutput struct {

	// The unique Amazon Resource Name (ARN) associated with the access point.
	AccessPointArn *string `type:"string"`

	// The ID of the access point, assigned by Amazon EFS.
	AccessPointId *string `type:"string"`

	// The opaque string specified in the request to ensure idempotent creation.
	ClientToken *string `min:"1" type:"string"`

	// The ID of the EFS file system that the access point applies to.
	FileSystemId *string `type:"string"`

	// Identifies the lifecycle phase of the access point.
	LifeCycleState *string `type:"string" enum:"LifeCycleState"`

	// The name of the access point. This is the value of the Name tag.
	Name *string `type:"string"`

	// Identifies the Amazon Web Services account that owns the access point resource.
	OwnerId *string `type:"string"`

	// The full POSIX identity, including the user ID, group ID, and secondary group
	// IDs on the access point that is used for all file operations by NFS clients
	// using the access point.
	PosixUser *PosixUser `type:"structure"`

	// The directory on the EFS file system that the access point exposes as the
	// root directory to NFS clients using the access point.
	RootDirectory *RootDirectory `type:"structure"`

	// The tags associated with the access point, presented as an array of Tag objects.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

Provides a description of an EFS file system access point.

func (CreateAccessPointOutput) GoString added in v1.28.1 

func (s CreateAccessPointOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAccessPointOutput) SetAccessPointArn added in v1.28.1 

func (s *CreateAccessPointOutput) SetAccessPointArn(v string) *CreateAccessPointOutput

SetAccessPointArn sets the AccessPointArn field's value.

func (*CreateAccessPointOutput) SetAccessPointId added in v1.28.1 

func (s *CreateAccessPointOutput) SetAccessPointId(v string) *CreateAccessPointOutput

SetAccessPointId sets the AccessPointId field's value.

func (*CreateAccessPointOutput) SetClientToken added in v1.28.1 

func (s *CreateAccessPointOutput) SetClientToken(v string) *CreateAccessPointOutput

SetClientToken sets the ClientToken field's value.

func (*CreateAccessPointOutput) SetFileSystemId added in v1.28.1 

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

SetFileSystemId sets the FileSystemId field's value.

func (*CreateAccessPointOutput) SetLifeCycleState added in v1.28.1 

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

SetLifeCycleState sets the LifeCycleState field's value.

func (*CreateAccessPointOutput) SetName added in v1.28.1 

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

SetName sets the Name field's value.

func (*CreateAccessPointOutput) SetOwnerId added in v1.28.1 

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

SetOwnerId sets the OwnerId field's value.

func (*CreateAccessPointOutput) SetPosixUser added in v1.28.1 

func (s *CreateAccessPointOutput) SetPosixUser(v *PosixUser) *CreateAccessPointOutput

SetPosixUser sets the PosixUser field's value.

func (*CreateAccessPointOutput) SetRootDirectory added in v1.28.1 

func (s *CreateAccessPointOutput) SetRootDirectory(v *RootDirectory) *CreateAccessPointOutput

SetRootDirectory sets the RootDirectory field's value.

func (*CreateAccessPointOutput) SetTags added in v1.28.1 

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

SetTags sets the Tags field's value.

func (CreateAccessPointOutput) String added in v1.28.1 

func (s CreateAccessPointOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateFileSystemInput 

type CreateFileSystemInput struct {

	// Used to create a One Zone file system. It specifies the Amazon Web Services
	// Availability Zone in which to create the file system. Use the format us-east-1a
	// to specify the Availability Zone. For more information about One Zone file
	// systems, see Using EFS storage classes (https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html)
	// in the Amazon EFS User Guide.
	//
	// One Zone file systems are not available in all Availability Zones in Amazon
	// Web Services Regions where Amazon EFS is available.
	AvailabilityZoneName *string `min:"1" type:"string"`

	// Specifies whether automatic backups are enabled on the file system that you
	// are creating. Set the value to true to enable automatic backups. If you are
	// creating a One Zone file system, automatic backups are enabled by default.
	// For more information, see Automatic backups (https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#automatic-backups)
	// in the Amazon EFS User Guide.
	//
	// Default is false. However, if you specify an AvailabilityZoneName, the default
	// is true.
	//
	// Backup is not available in all Amazon Web Services Regions where Amazon EFS
	// is available.
	Backup *bool `type:"boolean"`

	// A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent
	// creation.
	CreationToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// A Boolean value that, if true, creates an encrypted file system. When creating
	// an encrypted file system, you have the option of specifying an existing Key
	// Management Service key (KMS key). If you don't specify a KMS key, then the
	// default KMS key for Amazon EFS, /aws/elasticfilesystem, is used to protect
	// the encrypted file system.
	Encrypted *bool `type:"boolean"`

	// The ID of the KMS key that you want to use to protect the encrypted file
	// system. This parameter is required only if you want to use a non-default
	// KMS key. If this parameter is not specified, the default KMS key for Amazon
	// EFS is used. You can specify a KMS key ID using the following formats:
	//
	//    * Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab.
	//
	//    * ARN - An Amazon Resource Name (ARN) for the key, for example arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
	//
	//    * Key alias - A previously created display name for a key, for example
	//    alias/projectKey1.
	//
	//    * Key alias ARN - An ARN for a key alias, for example arn:aws:kms:us-west-2:444455556666:alias/projectKey1.
	//
	// If you use KmsKeyId, you must set the CreateFileSystemRequest$Encrypted parameter
	// to true.
	//
	// EFS accepts only symmetric KMS keys. You cannot use asymmetric KMS keys with
	// Amazon EFS file systems.
	KmsKeyId *string `type:"string"`

	// The Performance mode of the file system. We recommend generalPurpose performance
	// mode for all 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.
	// The maxIO mode is not supported on One Zone file systems.
	//
	// Due to the higher per-operation latencies with Max I/O, we recommend using
	// General Purpose performance mode for all file systems.
	//
	// Default is generalPurpose.
	PerformanceMode *string `type:"string" enum:"PerformanceMode"`

	// The throughput, measured in mebibytes per second (MiBps), that you want to
	// provision for a file system that you're creating. Required if ThroughputMode
	// is set to provisioned. Valid values are 1-3414 MiBps, with the upper limit
	// depending on Region. To increase this limit, contact Amazon Web Services
	// Support. For more information, see Amazon EFS quotas that you can increase
	// (https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the
	// Amazon EFS User Guide.
	ProvisionedThroughputInMibps *float64 `min:"1" type:"double"`

	// Use to create one or more tags associated with the file system. Each tag
	// is a user-defined key-value pair. Name your file system on creation by including
	// a "Key":"Name","Value":"{value}" key-value pair. Each key must be unique.
	// For more information, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// in the Amazon Web Services General Reference Guide.
	Tags []*Tag `type:"list"`

	// Specifies the throughput mode for the file system. The mode can be bursting,
	// provisioned, or elastic. If you set ThroughputMode to provisioned, you must
	// also set a value for ProvisionedThroughputInMibps. After you create the file
	// system, you can decrease your file system's Provisioned throughput or change
	// between the throughput modes, with certain time restrictions. For more information,
	// see Specifying throughput with provisioned mode (https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput)
	// in the Amazon EFS User Guide.
	//
	// Default is bursting.
	ThroughputMode *string `type:"string" enum:"ThroughputMode"`
	// contains filtered or unexported fields
}

func (CreateFileSystemInput) GoString added in v0.6.5 

func (s CreateFileSystemInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFileSystemInput) SetAvailabilityZoneName added in v1.37.27 

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

SetAvailabilityZoneName sets the AvailabilityZoneName field's value.

func (*CreateFileSystemInput) SetBackup added in v1.37.27 

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

SetBackup sets the Backup field's value.

func (*CreateFileSystemInput) SetCreationToken added in v1.5.0 

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

SetCreationToken sets the CreationToken field's value.

func (*CreateFileSystemInput) SetEncrypted added in v1.10.25 

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

SetEncrypted sets the Encrypted field's value.

func (*CreateFileSystemInput) SetKmsKeyId added in v1.10.25 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateFileSystemInput) SetPerformanceMode added in v1.5.0 

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

SetPerformanceMode sets the PerformanceMode field's value.

func (*CreateFileSystemInput) SetProvisionedThroughputInMibps added in v1.14.26 

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

SetProvisionedThroughputInMibps sets the ProvisionedThroughputInMibps field's value.

func (*CreateFileSystemInput) SetTags added in v1.17.1 

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

SetTags sets the Tags field's value.

func (*CreateFileSystemInput) SetThroughputMode added in v1.14.26 

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

SetThroughputMode sets the ThroughputMode field's value.

func (CreateFileSystemInput) String added in v0.6.5 

func (s CreateFileSystemInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFileSystemInput) Validate added in v1.1.21 

func (s *CreateFileSystemInput) Validate() error

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

type CreateMountTargetInput 

type CreateMountTargetInput struct {

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

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

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

	// The ID of the subnet to add the mount target in. For One Zone file systems,
	// use the subnet that is associated with the file system's Availability Zone.
	//
	// SubnetId is a required field
	SubnetId *string `min:"15" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateMountTargetInput) GoString added in v0.6.5 

func (s CreateMountTargetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMountTargetInput) SetFileSystemId added in v1.5.0 

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

SetFileSystemId sets the FileSystemId field's value.

func (*CreateMountTargetInput) SetIpAddress added in v1.5.0 

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

SetIpAddress sets the IpAddress field's value.

func (*CreateMountTargetInput) SetSecurityGroups added in v1.5.0 

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

SetSecurityGroups sets the SecurityGroups field's value.

func (*CreateMountTargetInput) SetSubnetId added in v1.5.0 

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

SetSubnetId sets the SubnetId field's value.

func (CreateMountTargetInput) String added in v0.6.5 

func (s CreateMountTargetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMountTargetInput) Validate added in v1.1.21 

func (s *CreateMountTargetInput) Validate() error

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

type CreateReplicationConfigurationInput added in v1.42.41 

type CreateReplicationConfigurationInput struct {

	// An array of destination configuration objects. Only one destination configuration
	// object is supported.
	//
	// Destinations is a required field
	Destinations []*DestinationToCreate `type:"list" required:"true"`

	// Specifies the Amazon EFS file system that you want to replicate. This file
	// system cannot already be a source or destination file system in another replication
	// configuration.
	//
	// SourceFileSystemId is a required field
	SourceFileSystemId *string `location:"uri" locationName:"SourceFileSystemId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateReplicationConfigurationInput) GoString added in v1.42.41 

func (s CreateReplicationConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateReplicationConfigurationInput) SetDestinations added in v1.42.41 

func (s *CreateReplicationConfigurationInput) SetDestinations(v []*DestinationToCreate) *CreateReplicationConfigurationInput

SetDestinations sets the Destinations field's value.

func (*CreateReplicationConfigurationInput) SetSourceFileSystemId added in v1.42.41 

func (s *CreateReplicationConfigurationInput) SetSourceFileSystemId(v string) *CreateReplicationConfigurationInput

SetSourceFileSystemId sets the SourceFileSystemId field's value.

func (CreateReplicationConfigurationInput) String added in v1.42.41 

func (s CreateReplicationConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateReplicationConfigurationInput) Validate added in v1.42.41 

func (s *CreateReplicationConfigurationInput) Validate() error

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

type CreateReplicationConfigurationOutput added in v1.42.41 

type CreateReplicationConfigurationOutput struct {

	// Describes when the replication configuration was created.
	//
	// CreationTime is a required field
	CreationTime *time.Time `type:"timestamp" required:"true"`

	// An array of destination objects. Only one destination object is supported.
	//
	// Destinations is a required field
	Destinations []*Destination `type:"list" required:"true"`

	// The Amazon Resource Name (ARN) of the original source EFS file system in
	// the replication configuration.
	//
	// OriginalSourceFileSystemArn is a required field
	OriginalSourceFileSystemArn *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the current source file system in the replication
	// configuration.
	//
	// SourceFileSystemArn is a required field
	SourceFileSystemArn *string `type:"string" required:"true"`

	// The ID of the source Amazon EFS file system that is being replicated.
	//
	// SourceFileSystemId is a required field
	SourceFileSystemId *string `type:"string" required:"true"`

	// The Amazon Web Services Region in which the source EFS file system is located.
	//
	// SourceFileSystemRegion is a required field
	SourceFileSystemRegion *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes the replication configuration for a specific file system.

func (CreateReplicationConfigurationOutput) GoString added in v1.42.41 

func (s CreateReplicationConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateReplicationConfigurationOutput) SetCreationTime added in v1.42.41 

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

SetCreationTime sets the CreationTime field's value.

func (*CreateReplicationConfigurationOutput) SetDestinations added in v1.42.41 

func (s *CreateReplicationConfigurationOutput) SetDestinations(v []*Destination) *CreateReplicationConfigurationOutput

SetDestinations sets the Destinations field's value.

func (*CreateReplicationConfigurationOutput) SetOriginalSourceFileSystemArn added in v1.42.41 

func (s *CreateReplicationConfigurationOutput) SetOriginalSourceFileSystemArn(v string) *CreateReplicationConfigurationOutput

SetOriginalSourceFileSystemArn sets the OriginalSourceFileSystemArn field's value.

func (*CreateReplicationConfigurationOutput) SetSourceFileSystemArn added in v1.42.41 

func (s *CreateReplicationConfigurationOutput) SetSourceFileSystemArn(v string) *CreateReplicationConfigurationOutput

SetSourceFileSystemArn sets the SourceFileSystemArn field's value.

func (*CreateReplicationConfigurationOutput) SetSourceFileSystemId added in v1.42.41 

func (s *CreateReplicationConfigurationOutput) SetSourceFileSystemId(v string) *CreateReplicationConfigurationOutput

SetSourceFileSystemId sets the SourceFileSystemId field's value.

func (*CreateReplicationConfigurationOutput) SetSourceFileSystemRegion added in v1.42.41 

func (s *CreateReplicationConfigurationOutput) SetSourceFileSystemRegion(v string) *CreateReplicationConfigurationOutput

SetSourceFileSystemRegion sets the SourceFileSystemRegion field's value.

func (CreateReplicationConfigurationOutput) String added in v1.42.41 

func (s CreateReplicationConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateTagsInput 

type CreateTagsInput struct {

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

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

func (CreateTagsInput) GoString added in v0.6.5 

func (s CreateTagsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTagsInput) SetFileSystemId added in v1.5.0 

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

SetFileSystemId sets the FileSystemId field's value.

func (*CreateTagsInput) SetTags added in v1.5.0 

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

SetTags sets the Tags field's value.

func (CreateTagsInput) String added in v0.6.5 

func (s CreateTagsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTagsInput) Validate added in v1.1.21 

func (s *CreateTagsInput) Validate() error

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

type CreateTagsOutput 

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

func (CreateTagsOutput) GoString added in v0.6.5 

func (s CreateTagsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CreateTagsOutput) String added in v0.6.5 

func (s CreateTagsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreationInfo added in v1.28.1 

type CreationInfo struct {

	// Specifies the POSIX group ID to apply to the RootDirectory. Accepts values
	// from 0 to 2^32 (4294967295).
	//
	// OwnerGid is a required field
	OwnerGid *int64 `type:"long" required:"true"`

	// Specifies the POSIX user ID to apply to the RootDirectory. Accepts values
	// from 0 to 2^32 (4294967295).
	//
	// OwnerUid is a required field
	OwnerUid *int64 `type:"long" required:"true"`

	// Specifies the POSIX permissions to apply to the RootDirectory, in the format
	// of an octal number representing the file's mode bits.
	//
	// Permissions is a required field
	Permissions *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Required if the RootDirectory > Path specified does not exist. Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory > Path. If the access point root directory does not exist, EFS creates it with these settings when a client connects to the access point. When specifying CreationInfo, you must include values for all properties.

Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount using the access point will fail.

If you do not provide CreationInfo and the specified RootDirectory does not exist, attempts to mount the file system using the access point will fail.

func (CreationInfo) GoString added in v1.28.1 

func (s CreationInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreationInfo) SetOwnerGid added in v1.28.1 

func (s *CreationInfo) SetOwnerGid(v int64) *CreationInfo

SetOwnerGid sets the OwnerGid field's value.

func (*CreationInfo) SetOwnerUid added in v1.28.1 

func (s *CreationInfo) SetOwnerUid(v int64) *CreationInfo

SetOwnerUid sets the OwnerUid field's value.

func (*CreationInfo) SetPermissions added in v1.28.1 

func (s *CreationInfo) SetPermissions(v string) *CreationInfo

SetPermissions sets the Permissions field's value.

func (CreationInfo) String added in v1.28.1 

func (s CreationInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreationInfo) Validate added in v1.28.1 

func (s *CreationInfo) Validate() error

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

type DeleteAccessPointInput added in v1.28.1 

type DeleteAccessPointInput struct {

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

func (DeleteAccessPointInput) GoString added in v1.28.1 

func (s DeleteAccessPointInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAccessPointInput) SetAccessPointId added in v1.28.1 

func (s *DeleteAccessPointInput) SetAccessPointId(v string) *DeleteAccessPointInput

SetAccessPointId sets the AccessPointId field's value.

func (DeleteAccessPointInput) String added in v1.28.1 

func (s DeleteAccessPointInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAccessPointInput) Validate added in v1.28.1 

func (s *DeleteAccessPointInput) Validate() error

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

type DeleteAccessPointOutput added in v1.28.1 

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

func (DeleteAccessPointOutput) GoString added in v1.28.1 

func (s DeleteAccessPointOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAccessPointOutput) String added in v1.28.1 

func (s DeleteAccessPointOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteFileSystemInput 

type DeleteFileSystemInput struct {

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

func (DeleteFileSystemInput) GoString added in v0.6.5 

func (s DeleteFileSystemInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFileSystemInput) SetFileSystemId added in v1.5.0 

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

SetFileSystemId sets the FileSystemId field's value.

func (DeleteFileSystemInput) String added in v0.6.5 

func (s DeleteFileSystemInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFileSystemInput) Validate added in v1.1.21 

func (s *DeleteFileSystemInput) Validate() error

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

type DeleteFileSystemOutput 

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

func (DeleteFileSystemOutput) GoString added in v0.6.5 

func (s DeleteFileSystemOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteFileSystemOutput) String added in v0.6.5 

func (s DeleteFileSystemOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteFileSystemPolicyInput added in v1.28.1 

type DeleteFileSystemPolicyInput struct {

	// Specifies the EFS file system for which to delete the FileSystemPolicy.
	//
	// FileSystemId is a required field
	FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteFileSystemPolicyInput) GoString added in v1.28.1 

func (s DeleteFileSystemPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFileSystemPolicyInput) SetFileSystemId added in v1.28.1 

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

SetFileSystemId sets the FileSystemId field's value.

func (DeleteFileSystemPolicyInput) String added in v1.28.1 

func (s DeleteFileSystemPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFileSystemPolicyInput) Validate added in v1.28.1 

func (s *DeleteFileSystemPolicyInput) Validate() error

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

type DeleteFileSystemPolicyOutput added in v1.28.1 

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

func (DeleteFileSystemPolicyOutput) GoString added in v1.28.1 

func (s DeleteFileSystemPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteFileSystemPolicyOutput) String added in v1.28.1 

func (s DeleteFileSystemPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteMountTargetInput 

type DeleteMountTargetInput struct {

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

func (DeleteMountTargetInput) GoString added in v0.6.5 

func (s DeleteMountTargetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteMountTargetInput) SetMountTargetId added in v1.5.0 

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

SetMountTargetId sets the MountTargetId field's value.

func (DeleteMountTargetInput) String added in v0.6.5 

func (s DeleteMountTargetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteMountTargetInput) Validate added in v1.1.21 

func (s *DeleteMountTargetInput) Validate() error

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

type DeleteMountTargetOutput 

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

func (DeleteMountTargetOutput) GoString added in v0.6.5 

func (s DeleteMountTargetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteMountTargetOutput) String added in v0.6.5 

func (s DeleteMountTargetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteReplicationConfigurationInput added in v1.42.41 

type DeleteReplicationConfigurationInput struct {

	// The ID of the source file system in the replication configuration.
	//
	// SourceFileSystemId is a required field
	SourceFileSystemId *string `location:"uri" locationName:"SourceFileSystemId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteReplicationConfigurationInput) GoString added in v1.42.41 

func (s DeleteReplicationConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteReplicationConfigurationInput) SetSourceFileSystemId added in v1.42.41 

func (s *DeleteReplicationConfigurationInput) SetSourceFileSystemId(v string) *DeleteReplicationConfigurationInput

SetSourceFileSystemId sets the SourceFileSystemId field's value.

func (DeleteReplicationConfigurationInput) String added in v1.42.41 

func (s DeleteReplicationConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteReplicationConfigurationInput) Validate added in v1.42.41 

func (s *DeleteReplicationConfigurationInput) Validate() error

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

type DeleteReplicationConfigurationOutput added in v1.42.41 

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

func (DeleteReplicationConfigurationOutput) GoString added in v1.42.41 

func (s DeleteReplicationConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteReplicationConfigurationOutput) String added in v1.42.41 

func (s DeleteReplicationConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteTagsInput 

type DeleteTagsInput struct {

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

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

func (DeleteTagsInput) GoString added in v0.6.5 

func (s DeleteTagsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTagsInput) SetFileSystemId added in v1.5.0 

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

SetFileSystemId sets the FileSystemId field's value.

func (*DeleteTagsInput) SetTagKeys added in v1.5.0 

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

SetTagKeys sets the TagKeys field's value.

func (DeleteTagsInput) String added in v0.6.5 

func (s DeleteTagsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTagsInput) Validate added in v1.1.21 

func (s *DeleteTagsInput) Validate() error

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

type DeleteTagsOutput 

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

func (DeleteTagsOutput) GoString added in v0.6.5 

func (s DeleteTagsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteTagsOutput) String added in v0.6.5 

func (s DeleteTagsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DependencyTimeout added in v1.28.0 

type DependencyTimeout struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	//
	// ErrorCode is a required field
	ErrorCode *string `min:"1" type:"string" required:"true"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*DependencyTimeout) Code added in v1.28.0 

func (s *DependencyTimeout) Code() string

Code returns the exception type name.

func (*DependencyTimeout) Error added in v1.28.0 

func (s *DependencyTimeout) Error() string

func (DependencyTimeout) GoString added in v1.28.0 

func (s DependencyTimeout) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DependencyTimeout) Message added in v1.28.0 

func (s *DependencyTimeout) Message() string

Message returns the exception's message.

func (*DependencyTimeout) OrigErr added in v1.28.0 

func (s *DependencyTimeout) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DependencyTimeout) RequestID added in v1.28.0 

func (s *DependencyTimeout) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DependencyTimeout) StatusCode added in v1.28.0 

func (s *DependencyTimeout) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DependencyTimeout) String added in v1.28.0 

func (s DependencyTimeout) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAccessPointsInput added in v1.28.1 

type DescribeAccessPointsInput struct {

	// (Optional) Specifies an EFS access point to describe in the response; mutually
	// exclusive with FileSystemId.
	AccessPointId *string `location:"querystring" locationName:"AccessPointId" type:"string"`

	// (Optional) If you provide a FileSystemId, EFS returns all access points for
	// that file system; mutually exclusive with AccessPointId.
	FileSystemId *string `location:"querystring" locationName:"FileSystemId" type:"string"`

	// (Optional) When retrieving all access points for a file system, you can optionally
	// specify the MaxItems parameter to limit the number of objects returned in
	// a response. The default value is 100.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// NextToken is present if the response is paginated. You can use NextMarker
	// in the subsequent request to fetch the next page of access point descriptions.
	NextToken *string `location:"querystring" locationName:"NextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAccessPointsInput) GoString added in v1.28.1 

func (s DescribeAccessPointsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccessPointsInput) SetAccessPointId added in v1.28.1 

func (s *DescribeAccessPointsInput) SetAccessPointId(v string) *DescribeAccessPointsInput

SetAccessPointId sets the AccessPointId field's value.

func (*DescribeAccessPointsInput) SetFileSystemId added in v1.28.1 

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

SetFileSystemId sets the FileSystemId field's value.

func (*DescribeAccessPointsInput) SetMaxResults added in v1.28.1 

func (s *DescribeAccessPointsInput) SetMaxResults(v int64) *DescribeAccessPointsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeAccessPointsInput) SetNextToken added in v1.28.1 

func (s *DescribeAccessPointsInput) SetNextToken(v string) *DescribeAccessPointsInput

SetNextToken sets the NextToken field's value.

func (DescribeAccessPointsInput) String added in v1.28.1 

func (s DescribeAccessPointsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccessPointsInput) Validate added in v1.28.1 

func (s *DescribeAccessPointsInput) Validate() error

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

type DescribeAccessPointsOutput added in v1.28.1 

type DescribeAccessPointsOutput struct {

	// An array of access point descriptions.
	AccessPoints []*AccessPointDescription `type:"list"`

	// Present if there are more access points than returned in the response. You
	// can use the NextMarker in the subsequent request to fetch the additional
	// descriptions.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAccessPointsOutput) GoString added in v1.28.1 

func (s DescribeAccessPointsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccessPointsOutput) SetAccessPoints added in v1.28.1 

func (s *DescribeAccessPointsOutput) SetAccessPoints(v []*AccessPointDescription) *DescribeAccessPointsOutput

SetAccessPoints sets the AccessPoints field's value.

func (*DescribeAccessPointsOutput) SetNextToken added in v1.28.1 

func (s *DescribeAccessPointsOutput) SetNextToken(v string) *DescribeAccessPointsOutput

SetNextToken sets the NextToken field's value.

func (DescribeAccessPointsOutput) String added in v1.28.1 

func (s DescribeAccessPointsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAccountPreferencesInput added in v1.38.45 

type DescribeAccountPreferencesInput struct {

	// (Optional) When retrieving account preferences, you can optionally specify
	// the MaxItems parameter to limit the number of objects returned in a response.
	// The default value is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// (Optional) You can use NextToken in a subsequent request to fetch the next
	// page of Amazon Web Services account preferences if the response payload was
	// paginated.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAccountPreferencesInput) GoString added in v1.38.45 

func (s DescribeAccountPreferencesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccountPreferencesInput) SetMaxResults added in v1.38.45 

func (s *DescribeAccountPreferencesInput) SetMaxResults(v int64) *DescribeAccountPreferencesInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeAccountPreferencesInput) SetNextToken added in v1.38.45 

func (s *DescribeAccountPreferencesInput) SetNextToken(v string) *DescribeAccountPreferencesInput

SetNextToken sets the NextToken field's value.

func (DescribeAccountPreferencesInput) String added in v1.38.45 

func (s DescribeAccountPreferencesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccountPreferencesInput) Validate added in v1.38.45 

func (s *DescribeAccountPreferencesInput) Validate() error

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

type DescribeAccountPreferencesOutput added in v1.38.45 

type DescribeAccountPreferencesOutput struct {

	// Present if there are more records than returned in the response. You can
	// use the NextToken in the subsequent request to fetch the additional descriptions.
	NextToken *string `min:"1" type:"string"`

	// Describes the resource ID preference setting for the Amazon Web Services
	// account associated with the user making the request, in the current Amazon
	// Web Services Region.
	ResourceIdPreference *ResourceIdPreference `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeAccountPreferencesOutput) GoString added in v1.38.45 

func (s DescribeAccountPreferencesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccountPreferencesOutput) SetNextToken added in v1.38.45 

func (s *DescribeAccountPreferencesOutput) SetNextToken(v string) *DescribeAccountPreferencesOutput

SetNextToken sets the NextToken field's value.

func (*DescribeAccountPreferencesOutput) SetResourceIdPreference added in v1.38.45 

func (s *DescribeAccountPreferencesOutput) SetResourceIdPreference(v *ResourceIdPreference) *DescribeAccountPreferencesOutput

SetResourceIdPreference sets the ResourceIdPreference field's value.

func (DescribeAccountPreferencesOutput) String added in v1.38.45 

func (s DescribeAccountPreferencesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeBackupPolicyInput added in v1.33.3 

type DescribeBackupPolicyInput struct {

	// Specifies which EFS file system for which to retrieve the BackupPolicy.
	//
	// FileSystemId is a required field
	FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeBackupPolicyInput) GoString added in v1.33.3 

func (s DescribeBackupPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBackupPolicyInput) SetFileSystemId added in v1.33.3 

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

SetFileSystemId sets the FileSystemId field's value.

func (DescribeBackupPolicyInput) String added in v1.33.3 

func (s DescribeBackupPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBackupPolicyInput) Validate added in v1.33.3 

func (s *DescribeBackupPolicyInput) Validate() error

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

type DescribeBackupPolicyOutput added in v1.33.3 

type DescribeBackupPolicyOutput struct {

	// Describes the file system's backup policy, indicating whether automatic backups
	// are turned on or off.
	BackupPolicy *BackupPolicy `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeBackupPolicyOutput) GoString added in v1.33.3 

func (s DescribeBackupPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBackupPolicyOutput) SetBackupPolicy added in v1.33.3 

func (s *DescribeBackupPolicyOutput) SetBackupPolicy(v *BackupPolicy) *DescribeBackupPolicyOutput

SetBackupPolicy sets the BackupPolicy field's value.

func (DescribeBackupPolicyOutput) String added in v1.33.3 

func (s DescribeBackupPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFileSystemPolicyInput added in v1.28.1 

type DescribeFileSystemPolicyInput struct {

	// Specifies which EFS file system to retrieve the FileSystemPolicy for.
	//
	// FileSystemId is a required field
	FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeFileSystemPolicyInput) GoString added in v1.28.1 

func (s DescribeFileSystemPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFileSystemPolicyInput) SetFileSystemId added in v1.28.1 

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

SetFileSystemId sets the FileSystemId field's value.

func (DescribeFileSystemPolicyInput) String added in v1.28.1 

func (s DescribeFileSystemPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFileSystemPolicyInput) Validate added in v1.28.1 

func (s *DescribeFileSystemPolicyInput) Validate() error

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

type DescribeFileSystemPolicyOutput added in v1.28.1 

type DescribeFileSystemPolicyOutput struct {

	// Specifies the EFS file system to which the FileSystemPolicy applies.
	FileSystemId *string `type:"string"`

	// The JSON formatted FileSystemPolicy for the EFS file system.
	Policy *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeFileSystemPolicyOutput) GoString added in v1.28.1 

func (s DescribeFileSystemPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFileSystemPolicyOutput) SetFileSystemId added in v1.28.1 

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

SetFileSystemId sets the FileSystemId field's value.

func (*DescribeFileSystemPolicyOutput) SetPolicy added in v1.28.1 

func (s *DescribeFileSystemPolicyOutput) SetPolicy(v string) *DescribeFileSystemPolicyOutput

SetPolicy sets the Policy field's value.

func (DescribeFileSystemPolicyOutput) String added in v1.28.1 

func (s DescribeFileSystemPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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" min:"1" type:"string"`

	// (Optional) Specifies the maximum number of file systems to return in the
	// response (integer). This number is automatically set to 100. The response
	// is paginated at 100 per page if you have more than 100 file systems.
	MaxItems *int64 `location:"querystring" locationName:"MaxItems" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeFileSystemsInput) GoString added in v0.6.5 

func (s DescribeFileSystemsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFileSystemsInput) SetCreationToken added in v1.5.0 

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

SetCreationToken sets the CreationToken field's value.

func (*DescribeFileSystemsInput) SetFileSystemId added in v1.5.0 

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

SetFileSystemId sets the FileSystemId field's value.

func (*DescribeFileSystemsInput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (*DescribeFileSystemsInput) SetMaxItems added in v1.5.0 

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

SetMaxItems sets the MaxItems field's value.

func (DescribeFileSystemsInput) String added in v0.6.5 

func (s DescribeFileSystemsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFileSystemsInput) Validate added in v1.1.21 

func (s *DescribeFileSystemsInput) Validate() error

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

type DescribeFileSystemsOutput 

type DescribeFileSystemsOutput struct {

	// An array of file system descriptions.
	FileSystems []*FileSystemDescription `type:"list"`

	// Present if provided by caller in the request (String).
	Marker *string `min:"1" 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeFileSystemsOutput) GoString added in v0.6.5 

func (s DescribeFileSystemsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFileSystemsOutput) SetFileSystems added in v1.5.0 

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

SetFileSystems sets the FileSystems field's value.

func (*DescribeFileSystemsOutput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (*DescribeFileSystemsOutput) SetNextMarker added in v1.5.0 

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

SetNextMarker sets the NextMarker field's value.

func (DescribeFileSystemsOutput) String added in v0.6.5 

func (s DescribeFileSystemsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeLifecycleConfigurationInput added in v1.16.34 

type DescribeLifecycleConfigurationInput struct {

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

func (DescribeLifecycleConfigurationInput) GoString added in v1.16.34 

func (s DescribeLifecycleConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLifecycleConfigurationInput) SetFileSystemId added in v1.16.34 

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

SetFileSystemId sets the FileSystemId field's value.

func (DescribeLifecycleConfigurationInput) String added in v1.16.34 

func (s DescribeLifecycleConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLifecycleConfigurationInput) Validate added in v1.16.34 

func (s *DescribeLifecycleConfigurationInput) Validate() error

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

type DescribeLifecycleConfigurationOutput added in v1.16.34 

type DescribeLifecycleConfigurationOutput struct {

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

func (DescribeLifecycleConfigurationOutput) GoString added in v1.16.34 

func (s DescribeLifecycleConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLifecycleConfigurationOutput) SetLifecyclePolicies added in v1.16.34 

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

SetLifecyclePolicies sets the LifecyclePolicies field's value.

func (DescribeLifecycleConfigurationOutput) String added in v1.16.34 

func (s DescribeLifecycleConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeMountTargetSecurityGroupsInput 

type DescribeMountTargetSecurityGroupsInput struct {

	// The ID of the mount target whose security groups you want to retrieve.
	//
	// MountTargetId is a required field
	MountTargetId *string `location:"uri" locationName:"MountTargetId" min:"13" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeMountTargetSecurityGroupsInput) GoString added in v0.6.5 

func (s DescribeMountTargetSecurityGroupsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMountTargetSecurityGroupsInput) SetMountTargetId added in v1.5.0 

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

SetMountTargetId sets the MountTargetId field's value.

func (DescribeMountTargetSecurityGroupsInput) String added in v0.6.5 

func (s DescribeMountTargetSecurityGroupsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMountTargetSecurityGroupsInput) Validate added in v1.1.21 

func (s *DescribeMountTargetSecurityGroupsInput) Validate() error

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

type DescribeMountTargetSecurityGroupsOutput 

type DescribeMountTargetSecurityGroupsOutput struct {

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

func (DescribeMountTargetSecurityGroupsOutput) GoString added in v0.6.5 

func (s DescribeMountTargetSecurityGroupsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMountTargetSecurityGroupsOutput) SetSecurityGroups added in v1.5.0 

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

SetSecurityGroups sets the SecurityGroups field's value.

func (DescribeMountTargetSecurityGroupsOutput) String added in v0.6.5 

func (s DescribeMountTargetSecurityGroupsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeMountTargetsInput 

type DescribeMountTargetsInput struct {

	// (Optional) The ID of the access point whose mount targets that you want to
	// list. It must be included in your request if a FileSystemId or MountTargetId
	// is not included in your request. Accepts either an access point ID or ARN
	// as input.
	AccessPointId *string `location:"querystring" locationName:"AccessPointId" type:"string"`

	// (Optional) ID of the file system whose mount targets you want to list (String).
	// It must be included in your request if an AccessPointId or MountTargetId
	// is not included. Accepts either a file system ID or ARN as input.
	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" min:"1" type:"string"`

	// (Optional) Maximum number of mount targets to return in the response. Currently,
	// this number is automatically set to 10, and other values are ignored. The
	// response is paginated at 100 per page if you have more than 100 mount targets.
	MaxItems *int64 `location:"querystring" locationName:"MaxItems" min:"1" type:"integer"`

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

func (DescribeMountTargetsInput) GoString added in v0.6.5 

func (s DescribeMountTargetsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMountTargetsInput) SetAccessPointId added in v1.28.1 

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

SetAccessPointId sets the AccessPointId field's value.

func (*DescribeMountTargetsInput) SetFileSystemId added in v1.5.0 

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

SetFileSystemId sets the FileSystemId field's value.

func (*DescribeMountTargetsInput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (*DescribeMountTargetsInput) SetMaxItems added in v1.5.0 

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

SetMaxItems sets the MaxItems field's value.

func (*DescribeMountTargetsInput) SetMountTargetId added in v1.5.0 

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

SetMountTargetId sets the MountTargetId field's value.

func (DescribeMountTargetsInput) String added in v0.6.5 

func (s DescribeMountTargetsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMountTargetsInput) Validate added in v1.1.21 

func (s *DescribeMountTargetsInput) Validate() error

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

type DescribeMountTargetsOutput 

type DescribeMountTargetsOutput struct {

	// If the request included the Marker, the response returns that value in this
	// field.
	Marker *string `min:"1" 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeMountTargetsOutput) GoString added in v0.6.5 

func (s DescribeMountTargetsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMountTargetsOutput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (*DescribeMountTargetsOutput) SetMountTargets added in v1.5.0 

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

SetMountTargets sets the MountTargets field's value.

func (*DescribeMountTargetsOutput) SetNextMarker added in v1.5.0 

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

SetNextMarker sets the NextMarker field's value.

func (DescribeMountTargetsOutput) String added in v0.6.5 

func (s DescribeMountTargetsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeReplicationConfigurationsInput added in v1.42.41 

type DescribeReplicationConfigurationsInput struct {

	// You can retrieve the replication configuration for a specific file system
	// by providing its file system ID.
	FileSystemId *string `location:"querystring" locationName:"FileSystemId" type:"string"`

	// (Optional) To limit the number of objects returned in a response, you can
	// specify the MaxItems parameter. The default value is 100.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// NextToken is present if the response is paginated. You can use NextToken
	// in a subsequent request to fetch the next page of output.
	NextToken *string `location:"querystring" locationName:"NextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeReplicationConfigurationsInput) GoString added in v1.42.41 

func (s DescribeReplicationConfigurationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReplicationConfigurationsInput) SetFileSystemId added in v1.42.41 

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

SetFileSystemId sets the FileSystemId field's value.

func (*DescribeReplicationConfigurationsInput) SetMaxResults added in v1.42.41 

func (s *DescribeReplicationConfigurationsInput) SetMaxResults(v int64) *DescribeReplicationConfigurationsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeReplicationConfigurationsInput) SetNextToken added in v1.42.41 

func (s *DescribeReplicationConfigurationsInput) SetNextToken(v string) *DescribeReplicationConfigurationsInput

SetNextToken sets the NextToken field's value.

func (DescribeReplicationConfigurationsInput) String added in v1.42.41 

func (s DescribeReplicationConfigurationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReplicationConfigurationsInput) Validate added in v1.42.41 

func (s *DescribeReplicationConfigurationsInput) Validate() error

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

type DescribeReplicationConfigurationsOutput added in v1.42.41 

type DescribeReplicationConfigurationsOutput struct {

	// You can use the NextToken from the previous response in a subsequent request
	// to fetch the additional descriptions.
	NextToken *string `min:"1" type:"string"`

	// The collection of replication configurations that is returned.
	Replications []*ReplicationConfigurationDescription `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeReplicationConfigurationsOutput) GoString added in v1.42.41 

func (s DescribeReplicationConfigurationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReplicationConfigurationsOutput) SetNextToken added in v1.42.41 

func (s *DescribeReplicationConfigurationsOutput) SetNextToken(v string) *DescribeReplicationConfigurationsOutput

SetNextToken sets the NextToken field's value.

func (*DescribeReplicationConfigurationsOutput) SetReplications added in v1.42.41 

func (s *DescribeReplicationConfigurationsOutput) SetReplications(v []*ReplicationConfigurationDescription) *DescribeReplicationConfigurationsOutput

SetReplications sets the Replications field's value.

func (DescribeReplicationConfigurationsOutput) String added in v1.42.41 

func (s DescribeReplicationConfigurationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeTagsInput 

type DescribeTagsInput struct {

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

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

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

func (DescribeTagsInput) GoString added in v0.6.5 

func (s DescribeTagsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTagsInput) SetFileSystemId added in v1.5.0 

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

SetFileSystemId sets the FileSystemId field's value.

func (*DescribeTagsInput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (*DescribeTagsInput) SetMaxItems added in v1.5.0 

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

SetMaxItems sets the MaxItems field's value.

func (DescribeTagsInput) String added in v0.6.5 

func (s DescribeTagsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTagsInput) Validate added in v1.1.21 

func (s *DescribeTagsInput) Validate() error

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

type DescribeTagsOutput 

type DescribeTagsOutput struct {

	// If the request included a Marker, the response returns that value in this
	// field.
	Marker *string `min:"1" 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 `min:"1" type:"string"`

	// Returns tags associated with the file system as an array of Tag objects.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeTagsOutput) GoString added in v0.6.5 

func (s DescribeTagsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTagsOutput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (*DescribeTagsOutput) SetNextMarker added in v1.5.0 

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

SetNextMarker sets the NextMarker field's value.

func (*DescribeTagsOutput) SetTags added in v1.5.0 

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

SetTags sets the Tags field's value.

func (DescribeTagsOutput) String added in v0.6.5 

func (s DescribeTagsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Destination added in v1.42.41 

type Destination struct {

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

	// The time when the most recent sync was successfully completed on the destination
	// file system. Any changes to data on the source file system that occurred
	// before this time have been successfully replicated to the destination file
	// system. Any changes that occurred after this time might not be fully replicated.
	LastReplicatedTimestamp *time.Time `type:"timestamp"`

	// The Amazon Web Services Region in which the destination file system is located.
	//
	// Region is a required field
	Region *string `min:"1" type:"string" required:"true"`

	// Describes the status of the destination EFS file system.
	//
	//    * The Paused state occurs as a result of opting out of the source or destination
	//    Region after the replication configuration was created. To resume replication
	//    for the file system, you need to again opt in to the Amazon Web Services
	//    Region. For more information, see Managing Amazon Web Services Regions
	//    (https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable)
	//    in the Amazon Web Services General Reference Guide.
	//
	//    * The Error state occurs when either the source or the destination file
	//    system (or both) is in a failed state and is unrecoverable. For more information,
	//    see Monitoring replication status (https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#restoring-backup-efsmonitoring-replication-status.html)
	//    in the Amazon EFS User Guide. You must delete the replication configuration,
	//    and then restore the most recent backup of the failed file system (either
	//    the source or the destination) to a new file system.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"ReplicationStatus"`
	// contains filtered or unexported fields
}

Describes the destination file system in the replication configuration.

func (Destination) GoString added in v1.42.41 

func (s Destination) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Destination) SetFileSystemId added in v1.42.41 

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

SetFileSystemId sets the FileSystemId field's value.

func (*Destination) SetLastReplicatedTimestamp added in v1.42.41 

func (s *Destination) SetLastReplicatedTimestamp(v time.Time) *Destination

SetLastReplicatedTimestamp sets the LastReplicatedTimestamp field's value.

func (*Destination) SetRegion added in v1.42.41 

func (s *Destination) SetRegion(v string) *Destination

SetRegion sets the Region field's value.

func (*Destination) SetStatus added in v1.42.41 

func (s *Destination) SetStatus(v string) *Destination

SetStatus sets the Status field's value.

func (Destination) String added in v1.42.41 

func (s Destination) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DestinationToCreate added in v1.42.41 

type DestinationToCreate struct {

	// To create a file system that uses One Zone storage, specify the name of the
	// Availability Zone in which to create the destination file system.
	AvailabilityZoneName *string `min:"1" type:"string"`

	// The ID of the file system to use for the destination. The file system's replication
	// overwrite replication must be disabled. If you do not provide an ID, then
	// EFS creates a new file system for the replication destination.
	FileSystemId *string `type:"string"`

	// Specify the Key Management Service (KMS) key that you want to use to encrypt
	// the destination file system. If you do not specify a KMS key, Amazon EFS
	// uses your default KMS key for Amazon EFS, /aws/elasticfilesystem. This ID
	// can be in one of the following formats:
	//
	//    * Key ID - The unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab.
	//
	//    * ARN - The Amazon Resource Name (ARN) for the key, for example arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
	//
	//    * Key alias - A previously created display name for a key, for example
	//    alias/projectKey1.
	//
	//    * Key alias ARN - The ARN for a key alias, for example arn:aws:kms:us-west-2:444455556666:alias/projectKey1.
	KmsKeyId *string `type:"string"`

	// To create a file system that uses Regional storage, specify the Amazon Web
	// Services Region in which to create the destination file system.
	Region *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes the new or existing destination file system for the replication configuration.

func (DestinationToCreate) GoString added in v1.42.41 

func (s DestinationToCreate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DestinationToCreate) SetAvailabilityZoneName added in v1.42.41 

func (s *DestinationToCreate) SetAvailabilityZoneName(v string) *DestinationToCreate

SetAvailabilityZoneName sets the AvailabilityZoneName field's value.

func (*DestinationToCreate) SetFileSystemId added in v1.48.5 

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

SetFileSystemId sets the FileSystemId field's value.

func (*DestinationToCreate) SetKmsKeyId added in v1.42.41 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*DestinationToCreate) SetRegion added in v1.42.41 

func (s *DestinationToCreate) SetRegion(v string) *DestinationToCreate

SetRegion sets the Region field's value.

func (DestinationToCreate) String added in v1.42.41 

func (s DestinationToCreate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DestinationToCreate) Validate added in v1.42.41 

func (s *DestinationToCreate) Validate() error

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

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: 

mySession := session.Must(session.NewSession())

// 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) CreateAccessPoint added in v1.28.1 

func (c *EFS) CreateAccessPoint(input *CreateAccessPointInput) (*CreateAccessPointOutput, error)

CreateAccessPoint API operation for Amazon Elastic File System.

Creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point's root directory. Applications using the access point can only access data in the application's own directory and any subdirectories. To learn more, see Mounting a file system using EFS access points (https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html).

If multiple requests to create access points on the same file system are sent in quick succession, and the file system is near the limit of 1,000 access points, you may experience a throttling response for these requests. This is to ensure that the file system does not exceed the stated access point limit.

This operation requires permissions for the elasticfilesystem:CreateAccessPoint action.

Access points can be tagged on creation. If tags are specified in the creation action, IAM performs additional authorization on the elasticfilesystem:TagResource action to verify if users have permissions to create tags. Therefore, you must grant explicit permissions to use the elasticfilesystem:TagResource action. For more information, see Granting permissions to tag resources during creation (https://docs.aws.amazon.com/efs/latest/ug/using-tags-efs.html#supported-iam-actions-tagging.html).

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

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

Returned Error Types:

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

func (*EFS) CreateAccessPointRequest added in v1.28.1 

func (c *EFS) CreateAccessPointRequest(input *CreateAccessPointInput) (req *request.Request, output *CreateAccessPointOutput)

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

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

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

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

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

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

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

func (*EFS) CreateAccessPointWithContext added in v1.28.1 

func (c *EFS) CreateAccessPointWithContext(ctx aws.Context, input *CreateAccessPointInput, opts ...request.Option) (*CreateAccessPointOutput, error)

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

See CreateAccessPoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*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 Amazon Web Services account with the specified creation token, this operation does the following:

  • Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating.

  • Returns with the description of the created file system.

Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system.

For basic use cases, you can use a randomly generated UUID for the creation token.

The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error.

For more information, see Creating a file system (https://docs.aws.amazon.com/efs/latest/ug/creating-using-create-fs.html#creating-using-create-fs-part1) in the Amazon EFS User Guide.

The CreateFileSystem call returns while the file system's lifecycle state is still creating. You can check the file system creation status by calling the DescribeFileSystems operation, which among other things returns the file system state.

This operation accepts an optional PerformanceMode parameter that you choose for your file system. We recommend generalPurpose performance mode for all file systems. File systems using the maxIO mode is a previous generation performance type that is designed for highly parallelized workloads that can tolerate higher latencies than the General Purpose mode. Max I/O mode is not supported for One Zone file systems or file systems that use Elastic throughput.

Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.

The performance mode can't be changed after the file system has been created. For more information, see Amazon EFS performance modes (https://docs.aws.amazon.com/efs/latest/ug/performance.html#performancemodes.html).

You can set the throughput mode for the file system using the ThroughputMode parameter.

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

This operation requires permissions for the elasticfilesystem:CreateFileSystem action.

File systems can be tagged on creation. If tags are specified in the creation action, IAM performs additional authorization on the elasticfilesystem:TagResource action to verify if users have permissions to create tags. Therefore, you must grant explicit permissions to use the elasticfilesystem:TagResource action. For more information, see Granting permissions to tag resources during creation (https://docs.aws.amazon.com/efs/latest/ug/using-tags-efs.html#supported-iam-actions-tagging.html).

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

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

Returned Error Types:

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

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

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

  • FileSystemLimitExceeded Returned if the Amazon Web Services account has already created the maximum number of file systems allowed per account.

  • InsufficientThroughputCapacity Returned if there's not enough capacity to provision additional throughput. This value might be returned when you try to create a file system in provisioned throughput mode, when you attempt to increase the provisioned throughput of an existing file system, or when you attempt to change an existing file system from Bursting Throughput to Provisioned Throughput mode. Try again later.

  • ThroughputLimitExceeded Returned if the throughput mode or amount of provisioned throughput can't be changed because the throughput limit of 1024 MiB/s has been reached.

  • UnsupportedAvailabilityZone Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.

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

Example (Shared00)

To create a new file system This operation creates a new, encrypted file system with automatic backups enabled, and the default generalpurpose performance mode. 

package main

import (
	"fmt"

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

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

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

	fmt.Println(result)
}

Output:

func (*EFS) CreateFileSystemRequest 

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

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

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

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

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

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

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

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

func (*EFS) CreateFileSystemWithContext added in v1.8.0 

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

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

See CreateFileSystem for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*EFS) CreateMountTarget 

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

CreateMountTarget API operation for Amazon Elastic File System.

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

You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system.

You can create only one mount target for a One Zone file system. You must create that mount target in the same Availability Zone in which the file system is located. Use the AvailabilityZoneName and AvailabiltyZoneId properties in the DescribeFileSystems response object to get this information. Use the subnetId associated with the file system's Availability Zone when creating the mount target.

For more information, see Amazon EFS: How it Works (https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html).

To create a mount target for a file system, the file system's lifecycle state must be available. For more information, see DescribeFileSystems.

In the request, provide the following:

  • The file system ID for which you are creating the mount target.

  • A subnet ID, which determines the following: The VPC in which Amazon EFS creates the mount target The Availability Zone in which Amazon EFS creates the mount target The IP address range from which Amazon EFS selects the IP address of the mount target (if you don't specify an IP address in the request)

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

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

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

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

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

  • Creates a new mount target in the specified subnet.

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

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

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

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

  • elasticfilesystem:CreateMountTarget

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

  • ec2:DescribeSubnets

  • ec2:DescribeNetworkInterfaces

  • ec2:CreateNetworkInterface

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

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

Returned Error Types:

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

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

  • FileSystemNotFound Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

  • IncorrectFileSystemLifeCycleState Returned if the file system's lifecycle state is not "available".

  • MountTargetConflict Returned if the mount target would violate one of the specified restrictions based on the file system's existing mount targets.

  • SubnetNotFound Returned if there is no subnet with ID SubnetId provided in the request.

  • NoFreeAddressesInSubnet Returned if IpAddress was not specified in the request and there are no free IP addresses in the subnet.

  • IpAddressInUse Returned if the request specified an IpAddress that is already in use in the subnet.

  • NetworkInterfaceLimitExceeded The calling account has reached the limit for elastic network interfaces for the specific Amazon Web Services Region. Either delete some network interfaces or request that the account quota be raised. For more information, see Amazon VPC Quotas (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Appendix_Limits.html) in the Amazon VPC User Guide (see the Network interfaces per Region entry in the Network interfaces table).

  • SecurityGroupLimitExceeded Returned if the size of SecurityGroups specified in the request is greater than five.

  • SecurityGroupNotFound Returned if one of the specified security groups doesn't exist in the subnet's virtual private cloud (VPC).

  • UnsupportedAvailabilityZone Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.

  • AvailabilityZonesMismatch Returned if the Availability Zone that was specified for a mount target is different from the Availability Zone that was specified for One Zone storage. For more information, see Regional and One Zone storage redundancy (https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html).

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

Example (Shared00)

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

package main

import (
	"fmt"

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

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

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

	fmt.Println(result)
}

Output:

func (*EFS) CreateMountTargetRequest 

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

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

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

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

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

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

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

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

func (*EFS) CreateMountTargetWithContext added in v1.8.0 

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

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

See CreateMountTarget for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*EFS) CreateReplicationConfiguration added in v1.42.41 

func (c *EFS) CreateReplicationConfiguration(input *CreateReplicationConfigurationInput) (*CreateReplicationConfigurationOutput, error)

CreateReplicationConfiguration API operation for Amazon Elastic File System.

Creates a replication configuration that replicates an existing EFS file system to a new, read-only file system. For more information, see Amazon EFS replication (https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html) in the Amazon EFS User Guide. The replication configuration specifies the following:

  • Source file system – The EFS file system that you want replicated. The source file system cannot be a destination file system in an existing replication configuration.

  • Amazon Web Services Region – The Amazon Web Services Region in which the destination file system is created. Amazon EFS replication is available in all Amazon Web Services Regions in which EFS is available. The Region must be enabled. For more information, see Managing Amazon Web Services Regions (https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable) in the Amazon Web Services General Reference Reference Guide.

  • Destination file system configuration – The configuration of the destination file system to which the source file system will be replicated. There can only be one destination file system in a replication configuration. Parameters for the replication configuration include: File system ID – The ID of the destination file system for the replication. If no ID is provided, then EFS creates a new file system with the default settings. For existing file systems, the file system's replication overwrite protection must be disabled. For more information, see Replicating to an existing file system (https://docs.aws.amazon.com/efs/latest/ug/efs-replication#replicate-existing-destination). Availability Zone – If you want the destination file system to use One Zone storage, you must specify the Availability Zone to create the file system in. For more information, see EFS file system types (https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) in the Amazon EFS User Guide. Encryption – All destination file systems are created with encryption at rest enabled. You can specify the Key Management Service (KMS) key that is used to encrypt the destination file system. If you don't specify a KMS key, your service-managed KMS key for Amazon EFS is used. After the file system is created, you cannot change the KMS key.

After the file system is created, you cannot change the KMS key.

For new destination file systems, the following properties are set by default:

  • Performance mode - The destination file system's performance mode matches that of the source file system, unless the destination file system uses EFS One Zone storage. In that case, the General Purpose performance mode is used. The performance mode cannot be changed.

  • Throughput mode - The destination file system's throughput mode matches that of the source file system. After the file system is created, you can modify the throughput mode.

  • Lifecycle management – Lifecycle management is not enabled on the destination file system. After the destination file system is created, you can enable lifecycle management.

  • Automatic backups – Automatic daily backups are enabled on the destination file system. After the file system is created, you can change this setting.

For more information, see Amazon EFS replication (https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html) in the Amazon EFS User Guide.

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

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

Returned Error Types:

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

  • IncorrectFileSystemLifeCycleState Returned if the file system's lifecycle state is not "available".

  • ValidationException Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.

  • ReplicationNotFound Returned if the specified file system does not have a replication configuration.

  • FileSystemNotFound Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

  • UnsupportedAvailabilityZone Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.

  • FileSystemLimitExceeded Returned if the Amazon Web Services account has already created the maximum number of file systems allowed per account.

  • InsufficientThroughputCapacity Returned if there's not enough capacity to provision additional throughput. This value might be returned when you try to create a file system in provisioned throughput mode, when you attempt to increase the provisioned throughput of an existing file system, or when you attempt to change an existing file system from Bursting Throughput to Provisioned Throughput mode. Try again later.

  • ThroughputLimitExceeded Returned if the throughput mode or amount of provisioned throughput can't be changed because the throughput limit of 1024 MiB/s has been reached.

  • ConflictException Returned if the source file system in a replication is encrypted but the destination file system is unencrypted.

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

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

func (*EFS) CreateReplicationConfigurationRequest added in v1.42.41 

func (c *EFS) CreateReplicationConfigurationRequest(input *CreateReplicationConfigurationInput) (req *request.Request, output *CreateReplicationConfigurationOutput)

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

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

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

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

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

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

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

func (*EFS) CreateReplicationConfigurationWithContext added in v1.42.41 

func (c *EFS) CreateReplicationConfigurationWithContext(ctx aws.Context, input *CreateReplicationConfigurationInput, opts ...request.Option) (*CreateReplicationConfigurationOutput, error)

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

See CreateReplicationConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*EFS) CreateTags deprecated 

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

CreateTags API operation for Amazon Elastic File System.

DEPRECATED - CreateTags is deprecated and not maintained. To create tags for EFS resources, use the API action.

Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If a tag key specified in the request already exists on the file system, this operation overwrites its value with the value provided in the request. If you add the Name tag to your file system, Amazon EFS returns it in the response to the DescribeFileSystems operation.

This operation requires permission for the elasticfilesystem:CreateTags action.

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

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

Returned Error Types:

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

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

  • FileSystemNotFound Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

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

Deprecated: Use TagResource.

Example (Shared00)

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

package main

import (
	"fmt"

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

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

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

	fmt.Println(result)
}

Output:

func (*EFS) CreateTagsRequest deprecated 

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

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

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

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

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

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

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

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

Deprecated: Use TagResource.

func (*EFS) CreateTagsWithContext deprecated added in v1.8.0 

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

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

See CreateTags for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: Use TagResource.

func (*EFS) DeleteAccessPoint added in v1.28.1 

func (c *EFS) DeleteAccessPoint(input *DeleteAccessPointInput) (*DeleteAccessPointOutput, error)

DeleteAccessPoint API operation for Amazon Elastic File System.

Deletes the specified access point. After deletion is complete, new clients can no longer connect to the access points. Clients connected to the access point at the time of deletion will continue to function until they terminate their connection.

This operation requires permissions for the elasticfilesystem:DeleteAccessPoint action.

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

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

Returned Error Types:

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

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

  • AccessPointNotFound Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.

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

func (*EFS) DeleteAccessPointRequest added in v1.28.1 

func (c *EFS) DeleteAccessPointRequest(input *DeleteAccessPointInput) (req *request.Request, output *DeleteAccessPointOutput)

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

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

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

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

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

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

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

func (*EFS) DeleteAccessPointWithContext added in v1.28.1 

func (c *EFS) DeleteAccessPointWithContext(ctx aws.Context, input *DeleteAccessPointInput, opts ...request.Option) (*DeleteAccessPointOutput, error)

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

See DeleteAccessPoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*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 need to manually delete mount targets attached to a file system before you can delete an EFS file system. This step is performed for you when you use the Amazon Web Services console to delete a file system.

You cannot delete a file system that is part of an EFS Replication configuration. You need to delete the replication configuration first.

You can't delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see DescribeMountTargets and DeleteMountTarget.

The DeleteFileSystem call returns while the file system state is still deleting. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the DescribeFileSystems returns a 404 FileSystemNotFound error.

This operation requires permissions for the elasticfilesystem:DeleteFileSystem action.

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

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

Returned Error Types:

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

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

  • FileSystemNotFound Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

  • FileSystemInUse Returned if a file system has mount targets.

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

Example (Shared00)

To delete a file system This operation deletes an EFS file system. 

package main

import (
	"fmt"

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

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

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

	fmt.Println(result)
}

Output:

func (*EFS) DeleteFileSystemPolicy added in v1.28.1 

func (c *EFS) DeleteFileSystemPolicy(input *DeleteFileSystemPolicyInput) (*DeleteFileSystemPolicyOutput, error)

DeleteFileSystemPolicy API operation for Amazon Elastic File System.

Deletes the FileSystemPolicy for the specified file system. The default FileSystemPolicy goes into effect once the existing policy is deleted. For more information about the default file system policy, see Using Resource-based Policies with EFS (https://docs.aws.amazon.com/efs/latest/ug/res-based-policies-efs.html).

This operation requires permissions for the elasticfilesystem:DeleteFileSystemPolicy 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 DeleteFileSystemPolicy for usage and error information.

Returned Error Types:

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

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

  • FileSystemNotFound Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

  • IncorrectFileSystemLifeCycleState Returned if the file system's lifecycle state is not "available".

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

func (*EFS) DeleteFileSystemPolicyRequest added in v1.28.1 

func (c *EFS) DeleteFileSystemPolicyRequest(input *DeleteFileSystemPolicyInput) (req *request.Request, output *DeleteFileSystemPolicyOutput)

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

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

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

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

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

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

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

func (*EFS) DeleteFileSystemPolicyWithContext added in v1.28.1 

func (c *EFS) DeleteFileSystemPolicyWithContext(ctx aws.Context, input *DeleteFileSystemPolicyInput, opts ...request.Option) (*DeleteFileSystemPolicyOutput, error)

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

See DeleteFileSystemPolicy 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) DeleteFileSystemRequest 

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

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

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

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

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

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

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

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

func (*EFS) DeleteFileSystemWithContext added in v1.8.0 

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

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

See DeleteFileSystem for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*EFS) DeleteMountTarget 

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

DeleteMountTarget API operation for Amazon Elastic File System.

Deletes the specified mount target.

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

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

  • elasticfilesystem:DeleteMountTarget

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

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

  • ec2:DeleteNetworkInterface

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

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

Returned Error Types:

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

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

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

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

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

Example (Shared00)

To delete a mount target This operation deletes a mount target. 

package main

import (
	"fmt"

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

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

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

	fmt.Println(result)
}

Output:

func (*EFS) DeleteMountTargetRequest 

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

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

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

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

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

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

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

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

func (*EFS) DeleteMountTargetWithContext added in v1.8.0 

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

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

See DeleteMountTarget for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*EFS) DeleteReplicationConfiguration added in v1.42.41 

func (c *EFS) DeleteReplicationConfiguration(input *DeleteReplicationConfigurationInput) (*DeleteReplicationConfigurationOutput, error)

DeleteReplicationConfiguration API operation for Amazon Elastic File System.

Deletes a replication configuration. Deleting a replication configuration ends the replication process. After a replication configuration is deleted, the destination file system becomes Writeable and its replication overwrite protection is re-enabled. For more information, see Delete a replication configuration (https://docs.aws.amazon.com/efs/latest/ug/delete-replications.html).

This operation requires permissions for the elasticfilesystem:DeleteReplicationConfiguration 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 DeleteReplicationConfiguration for usage and error information.

Returned Error Types:

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

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

  • FileSystemNotFound Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

  • ReplicationNotFound Returned if the specified file system does not have a replication configuration.

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

func (*EFS) DeleteReplicationConfigurationRequest added in v1.42.41 

func (c *EFS) DeleteReplicationConfigurationRequest(input *DeleteReplicationConfigurationInput) (req *request.Request, output *DeleteReplicationConfigurationOutput)

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

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

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

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

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

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

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

func (*EFS) DeleteReplicationConfigurationWithContext added in v1.42.41 

func (c *EFS) DeleteReplicationConfigurationWithContext(ctx aws.Context, input *DeleteReplicationConfigurationInput, opts ...request.Option) (*DeleteReplicationConfigurationOutput, error)

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

See DeleteReplicationConfiguration 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 deprecated 

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

DeleteTags API operation for Amazon Elastic File System.

DEPRECATED - DeleteTags is deprecated and not maintained. To remove tags from EFS resources, use the API action.

Deletes the specified tags from a file system. If the DeleteTags request includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause an error. For more information about tags and related restrictions, see Tag restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the 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 Types:

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

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

  • FileSystemNotFound Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

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

Deprecated: Use UntagResource.

Example (Shared00)

To delete tags for an EFS file system This operation deletes tags for an EFS file system. 

package main

import (
	"fmt"

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

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

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

	fmt.Println(result)
}

Output:

func (*EFS) DeleteTagsRequest deprecated 

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

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

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

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

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

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

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

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

Deprecated: Use UntagResource.

func (*EFS) DeleteTagsWithContext deprecated added in v1.8.0 

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

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

See DeleteTags for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: Use UntagResource.

func (*EFS) DescribeAccessPoints added in v1.28.1 

func (c *EFS) DescribeAccessPoints(input *DescribeAccessPointsInput) (*DescribeAccessPointsOutput, error)

DescribeAccessPoints API operation for Amazon Elastic File System.

Returns the description of a specific Amazon EFS access point if the AccessPointId is provided. If you provide an EFS FileSystemId, it returns descriptions of all access points for that file system. You can provide either an AccessPointId or a FileSystemId in the request, but not both.

This operation requires permissions for the elasticfilesystem:DescribeAccessPoints 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 DescribeAccessPoints for usage and error information.

Returned Error Types:

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

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

  • FileSystemNotFound Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

  • AccessPointNotFound Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.

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

func (*EFS) DescribeAccessPointsPages added in v1.28.1 

func (c *EFS) DescribeAccessPointsPages(input *DescribeAccessPointsInput, fn func(*DescribeAccessPointsOutput, bool) bool) error

DescribeAccessPointsPages iterates over the pages of a DescribeAccessPoints operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeAccessPoints method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeAccessPoints operation.
pageNum := 0
err := client.DescribeAccessPointsPages(params,
    func(page *efs.DescribeAccessPointsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*EFS) DescribeAccessPointsPagesWithContext added in v1.28.1 

func (c *EFS) DescribeAccessPointsPagesWithContext(ctx aws.Context, input *DescribeAccessPointsInput, fn func(*DescribeAccessPointsOutput, bool) bool, opts ...request.Option) error

DescribeAccessPointsPagesWithContext same as DescribeAccessPointsPages except it takes a Context and allows setting request options on the pages.

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) DescribeAccessPointsRequest added in v1.28.1 

func (c *EFS) DescribeAccessPointsRequest(input *DescribeAccessPointsInput) (req *request.Request, output *DescribeAccessPointsOutput)

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

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

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

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

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

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

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

func (*EFS) DescribeAccessPointsWithContext added in v1.28.1 

func (c *EFS) DescribeAccessPointsWithContext(ctx aws.Context, input *DescribeAccessPointsInput, opts ...request.Option) (*DescribeAccessPointsOutput, error)

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

See DescribeAccessPoints 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) DescribeAccountPreferences added in v1.38.45 

func (c *EFS) DescribeAccountPreferences(input *DescribeAccountPreferencesInput) (*DescribeAccountPreferencesOutput, error)

DescribeAccountPreferences API operation for Amazon Elastic File System.

Returns the account preferences settings for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region.

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

Returned Error Types:

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

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

func (*EFS) DescribeAccountPreferencesRequest added in v1.38.45 

func (c *EFS) DescribeAccountPreferencesRequest(input *DescribeAccountPreferencesInput) (req *request.Request, output *DescribeAccountPreferencesOutput)

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

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

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

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

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

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

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

func (*EFS) DescribeAccountPreferencesWithContext added in v1.38.45 

func (c *EFS) DescribeAccountPreferencesWithContext(ctx aws.Context, input *DescribeAccountPreferencesInput, opts ...request.Option) (*DescribeAccountPreferencesOutput, error)

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

See DescribeAccountPreferences 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) DescribeBackupPolicy added in v1.33.3 

func (c *EFS) DescribeBackupPolicy(input *DescribeBackupPolicyInput) (*DescribeBackupPolicyOutput, error)

DescribeBackupPolicy API operation for Amazon Elastic File System.

Returns the backup policy for the specified EFS file system.

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

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

Returned Error Types:

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

  • FileSystemNotFound Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

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

  • PolicyNotFound Returned if the default file system policy is in effect for the EFS file system specified.

  • ValidationException Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.

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

func (*EFS) DescribeBackupPolicyRequest added in v1.33.3 

func (c *EFS) DescribeBackupPolicyRequest(input *DescribeBackupPolicyInput) (req *request.Request, output *DescribeBackupPolicyOutput)

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

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

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

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

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

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

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

func (*EFS) DescribeBackupPolicyWithContext added in v1.33.3 

func (c *EFS) DescribeBackupPolicyWithContext(ctx aws.Context, input *DescribeBackupPolicyInput, opts ...request.Option) (*DescribeBackupPolicyOutput, error)

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

See DescribeBackupPolicy 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) DescribeFileSystemPolicy added in v1.28.1 

func (c *EFS) DescribeFileSystemPolicy(input *DescribeFileSystemPolicyInput) (*DescribeFileSystemPolicyOutput, error)

DescribeFileSystemPolicy API operation for Amazon Elastic File System.

Returns the FileSystemPolicy for the specified EFS file system.

This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy 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 DescribeFileSystemPolicy for usage and error information.

Returned Error Types:

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

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

  • FileSystemNotFound Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

  • PolicyNotFound Returned if the default file system policy is in effect for the EFS file system specified.

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

func (*EFS) DescribeFileSystemPolicyRequest added in v1.28.1 

func (c *EFS) DescribeFileSystemPolicyRequest(input *DescribeFileSystemPolicyInput) (req *request.Request, output *DescribeFileSystemPolicyOutput)

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

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

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

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

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

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

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

func (*EFS) DescribeFileSystemPolicyWithContext added in v1.28.1 

func (c *EFS) DescribeFileSystemPolicyWithContext(ctx aws.Context, input *DescribeFileSystemPolicyInput, opts ...request.Option) (*DescribeFileSystemPolicyOutput, error)

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

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

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

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

This operation requires permissions for the elasticfilesystem:DescribeFileSystems action.

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

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

Returned Error Types:

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

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

  • FileSystemNotFound Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

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

Example (Shared00)

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

package main

import (
	"fmt"

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

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

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

	fmt.Println(result)
}

Output:

func (*EFS) DescribeFileSystemsPages added in v1.28.1 

func (c *EFS) DescribeFileSystemsPages(input *DescribeFileSystemsInput, fn func(*DescribeFileSystemsOutput, bool) bool) error

DescribeFileSystemsPages iterates over the pages of a DescribeFileSystems operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeFileSystems method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeFileSystems operation.
pageNum := 0
err := client.DescribeFileSystemsPages(params,
    func(page *efs.DescribeFileSystemsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*EFS) DescribeFileSystemsPagesWithContext added in v1.28.1 

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

DescribeFileSystemsPagesWithContext same as DescribeFileSystemsPages except it takes a Context and allows setting request options on the pages.

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

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

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

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

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

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

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

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

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

func (*EFS) DescribeFileSystemsWithContext added in v1.8.0 

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

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

See DescribeFileSystems for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*EFS) DescribeLifecycleConfiguration added in v1.16.34 

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

DescribeLifecycleConfiguration API operation for Amazon Elastic File System.

Returns the current LifecycleConfiguration object for the specified Amazon EFS file system. Lifecycle management uses the LifecycleConfiguration object to identify when to move files between storage classes. For a file system without a LifecycleConfiguration object, the call returns an empty array in the response.

This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration operation.

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

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

Returned Error Types:

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

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

  • FileSystemNotFound Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

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

Example (Shared00)

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

package main

import (
	"fmt"

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

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

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

	fmt.Println(result)
}

Output:

func (*EFS) DescribeLifecycleConfigurationRequest added in v1.16.34 

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

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

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

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

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

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

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

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

func (*EFS) DescribeLifecycleConfigurationWithContext added in v1.16.34 

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

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

See DescribeLifecycleConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*EFS) DescribeMountTargetSecurityGroups 

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

DescribeMountTargetSecurityGroups API operation for Amazon Elastic File System.

Returns the security groups currently in effect for a mount target. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted.

This operation requires permissions for the following actions:

  • elasticfilesystem:DescribeMountTargetSecurityGroups action on the mount target's file system.

  • ec2:DescribeNetworkInterfaceAttribute action on the mount target's network interface.

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

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

Returned Error Types:

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

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

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

  • IncorrectMountTargetState Returned if the mount target is not in the correct state for the operation.

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

Example (Shared00)

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

package main

import (
	"fmt"

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

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

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

	fmt.Println(result)
}

Output:

func (*EFS) DescribeMountTargetSecurityGroupsRequest 

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

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

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

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

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

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

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

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

func (*EFS) DescribeMountTargetSecurityGroupsWithContext added in v1.8.0 

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

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

See DescribeMountTargetSecurityGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*EFS) DescribeMountTargets 

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

DescribeMountTargets API operation for Amazon Elastic File System.

Returns the descriptions of all the current mount targets, or a specific mount target, for a file system. When requesting all of the current mount targets, the order of mount targets returned in the response is unspecified.

This operation requires permissions for the elasticfilesystem:DescribeMountTargets action, on either the file system ID that you specify in FileSystemId, or on the file system of the mount target that you specify in MountTargetId.

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

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

Returned Error Types:

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

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

  • FileSystemNotFound Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

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

  • AccessPointNotFound Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.

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

Example (Shared00)

To describe the mount targets for a file system This operation describes all of a file system's mount targets. 

package main

import (
	"fmt"

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

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

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

	fmt.Println(result)
}

Output:

func (*EFS) DescribeMountTargetsPages added in v1.48.4 

func (c *EFS) DescribeMountTargetsPages(input *DescribeMountTargetsInput, fn func(*DescribeMountTargetsOutput, bool) bool) error

DescribeMountTargetsPages iterates over the pages of a DescribeMountTargets operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeMountTargets method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeMountTargets operation.
pageNum := 0
err := client.DescribeMountTargetsPages(params,
    func(page *efs.DescribeMountTargetsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*EFS) DescribeMountTargetsPagesWithContext added in v1.48.4 

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

DescribeMountTargetsPagesWithContext same as DescribeMountTargetsPages except it takes a Context and allows setting request options on the pages.

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

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

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

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

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

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

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

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

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

func (*EFS) DescribeMountTargetsWithContext added in v1.8.0 

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

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

See DescribeMountTargets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*EFS) DescribeReplicationConfigurations added in v1.42.41 

func (c *EFS) DescribeReplicationConfigurations(input *DescribeReplicationConfigurationsInput) (*DescribeReplicationConfigurationsOutput, error)

DescribeReplicationConfigurations API operation for Amazon Elastic File System.

Retrieves the replication configuration for a specific file system. If a file system is not specified, all of the replication configurations for the Amazon Web Services account in an Amazon Web Services Region are retrieved.

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

Returned Error Types:

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

  • FileSystemNotFound Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

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

  • ReplicationNotFound Returned if the specified file system does not have a replication configuration.

  • ValidationException Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.

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

func (*EFS) DescribeReplicationConfigurationsPages added in v1.48.4 

func (c *EFS) DescribeReplicationConfigurationsPages(input *DescribeReplicationConfigurationsInput, fn func(*DescribeReplicationConfigurationsOutput, bool) bool) error

DescribeReplicationConfigurationsPages iterates over the pages of a DescribeReplicationConfigurations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeReplicationConfigurations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeReplicationConfigurations operation.
pageNum := 0
err := client.DescribeReplicationConfigurationsPages(params,
    func(page *efs.DescribeReplicationConfigurationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*EFS) DescribeReplicationConfigurationsPagesWithContext added in v1.48.4 

func (c *EFS) DescribeReplicationConfigurationsPagesWithContext(ctx aws.Context, input *DescribeReplicationConfigurationsInput, fn func(*DescribeReplicationConfigurationsOutput, bool) bool, opts ...request.Option) error

DescribeReplicationConfigurationsPagesWithContext same as DescribeReplicationConfigurationsPages except it takes a Context and allows setting request options on the pages.

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) DescribeReplicationConfigurationsRequest added in v1.42.41 

func (c *EFS) DescribeReplicationConfigurationsRequest(input *DescribeReplicationConfigurationsInput) (req *request.Request, output *DescribeReplicationConfigurationsOutput)

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

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

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

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

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

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

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

func (*EFS) DescribeReplicationConfigurationsWithContext added in v1.42.41 

func (c *EFS) DescribeReplicationConfigurationsWithContext(ctx aws.Context, input *DescribeReplicationConfigurationsInput, opts ...request.Option) (*DescribeReplicationConfigurationsOutput, error)

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

See DescribeReplicationConfigurations 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 deprecated 

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

DescribeTags API operation for Amazon Elastic File System.

DEPRECATED - The DescribeTags action is deprecated and not maintained. To view tags associated with EFS resources, use the ListTagsForResource API action.

Returns the tags associated with a file system. The order of tags returned in the response of one DescribeTags call and the order of tags returned across the responses of a multiple-call iteration (when using pagination) is unspecified.

This operation requires permissions for the elasticfilesystem:DescribeTags action.

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

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

Returned Error Types:

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

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

  • FileSystemNotFound Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

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

Deprecated: Use ListTagsForResource.

Example (Shared00)

To describe the tags for a file system This operation describes all of a file system's tags. 

package main

import (
	"fmt"

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

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

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

	fmt.Println(result)
}

Output:

func (*EFS) DescribeTagsPages deprecated added in v1.28.1 

func (c *EFS) DescribeTagsPages(input *DescribeTagsInput, fn func(*DescribeTagsOutput, bool) bool) error

DescribeTagsPages iterates over the pages of a DescribeTags operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeTags method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeTags operation.
pageNum := 0
err := client.DescribeTagsPages(params,
    func(page *efs.DescribeTagsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

Deprecated: Use ListTagsForResource.

func (*EFS) DescribeTagsPagesWithContext deprecated added in v1.28.1 

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

DescribeTagsPagesWithContext same as DescribeTagsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: Use ListTagsForResource.

func (*EFS) DescribeTagsRequest deprecated 

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

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

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

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

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

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

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

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

Deprecated: Use ListTagsForResource.

func (*EFS) DescribeTagsWithContext deprecated added in v1.8.0 

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

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

See DescribeTags for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: Use ListTagsForResource.

func (*EFS) ListTagsForResource added in v1.28.1 

func (c *EFS) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Elastic File System.

Lists all tags for a top-level EFS resource. You must provide the ID of the resource that you want to retrieve the tags for.

This operation requires permissions for the elasticfilesystem:DescribeAccessPoints 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 ListTagsForResource for usage and error information.

Returned Error Types:

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

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

  • FileSystemNotFound Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

  • AccessPointNotFound Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.

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

func (*EFS) ListTagsForResourcePages added in v1.28.1 

func (c *EFS) ListTagsForResourcePages(input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool) error

ListTagsForResourcePages iterates over the pages of a ListTagsForResource operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTagsForResource method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListTagsForResource operation.
pageNum := 0
err := client.ListTagsForResourcePages(params,
    func(page *efs.ListTagsForResourceOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*EFS) ListTagsForResourcePagesWithContext added in v1.28.1 

func (c *EFS) ListTagsForResourcePagesWithContext(ctx aws.Context, input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool, opts ...request.Option) error

ListTagsForResourcePagesWithContext same as ListTagsForResourcePages except it takes a Context and allows setting request options on the pages.

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) ListTagsForResourceRequest added in v1.28.1 

func (c *EFS) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

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

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

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

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

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

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

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

func (*EFS) ListTagsForResourceWithContext added in v1.28.1 

func (c *EFS) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

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

See ListTagsForResource 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 Types:

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

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

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

  • IncorrectMountTargetState Returned if the mount target is not in the correct state for the operation.

  • SecurityGroupLimitExceeded Returned if the size of SecurityGroups specified in the request is greater than five.

  • SecurityGroupNotFound Returned if one of the specified security groups doesn't exist in the subnet's virtual private cloud (VPC).

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

Example (Shared00)

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

package main

import (
	"fmt"

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

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

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

	fmt.Println(result)
}

Output:

func (*EFS) ModifyMountTargetSecurityGroupsRequest 

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

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

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

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

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

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

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

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

func (*EFS) ModifyMountTargetSecurityGroupsWithContext added in v1.8.0 

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

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

See ModifyMountTargetSecurityGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*EFS) PutAccountPreferences added in v1.38.45 

func (c *EFS) PutAccountPreferences(input *PutAccountPreferencesInput) (*PutAccountPreferencesOutput, error)

PutAccountPreferences API operation for Amazon Elastic File System.

Use this operation to set the account preference in the current Amazon Web Services Region to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for new EFS file system and mount target resources. All existing resource IDs are not affected by any changes you make. You can set the ID preference during the opt-in period as EFS transitions to long resource IDs. For more information, see Managing Amazon EFS resource IDs (https://docs.aws.amazon.com/efs/latest/ug/manage-efs-resource-ids.html).

Starting in October, 2021, you will receive an error if you try to set the account preference to use the short 8 character format resource ID. Contact Amazon Web Services support if you receive an error and must use short IDs for file system and mount target resources.

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

Returned Error Types:

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

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

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

func (*EFS) PutAccountPreferencesRequest added in v1.38.45 

func (c *EFS) PutAccountPreferencesRequest(input *PutAccountPreferencesInput) (req *request.Request, output *PutAccountPreferencesOutput)

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

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

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

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

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

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

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

func (*EFS) PutAccountPreferencesWithContext added in v1.38.45 

func (c *EFS) PutAccountPreferencesWithContext(ctx aws.Context, input *PutAccountPreferencesInput, opts ...request.Option) (*PutAccountPreferencesOutput, error)

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

See PutAccountPreferences 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) PutBackupPolicy added in v1.33.3 

func (c *EFS) PutBackupPolicy(input *PutBackupPolicyInput) (*PutBackupPolicyOutput, error)

PutBackupPolicy API operation for Amazon Elastic File System.

Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system.

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

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

Returned Error Types:

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

  • FileSystemNotFound Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

  • IncorrectFileSystemLifeCycleState Returned if the file system's lifecycle state is not "available".

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

  • ValidationException Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.

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

func (*EFS) PutBackupPolicyRequest added in v1.33.3 

func (c *EFS) PutBackupPolicyRequest(input *PutBackupPolicyInput) (req *request.Request, output *PutBackupPolicyOutput)

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

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

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

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

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

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

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

func (*EFS) PutBackupPolicyWithContext added in v1.33.3 

func (c *EFS) PutBackupPolicyWithContext(ctx aws.Context, input *PutBackupPolicyInput, opts ...request.Option) (*PutBackupPolicyOutput, error)

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

See PutBackupPolicy 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) PutFileSystemPolicy added in v1.28.1 

func (c *EFS) PutFileSystemPolicy(input *PutFileSystemPolicyInput) (*PutFileSystemPolicyOutput, error)

PutFileSystemPolicy API operation for Amazon Elastic File System.

Applies an Amazon EFS FileSystemPolicy to an Amazon EFS file system. A file system policy is an IAM resource-based policy and can contain multiple policy statements. A file system always has exactly one file system policy, which can be the default policy or an explicit policy set or updated using this API operation. EFS file system policies have a 20,000 character limit. When an explicit policy is set, it overrides the default policy. For more information about the default file system policy, see Default EFS File System Policy (https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html#default-filesystempolicy).

EFS file system policies have a 20,000 character limit.

This operation requires permissions for the elasticfilesystem:PutFileSystemPolicy 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 PutFileSystemPolicy for usage and error information.

Returned Error Types:

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

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

  • FileSystemNotFound Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

  • InvalidPolicyException Returned if the FileSystemPolicy is malformed or contains an error such as a parameter value that is not valid or a missing required parameter. Returned in the case of a policy lockout safety check error.

  • IncorrectFileSystemLifeCycleState Returned if the file system's lifecycle state is not "available".

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

func (*EFS) PutFileSystemPolicyRequest added in v1.28.1 

func (c *EFS) PutFileSystemPolicyRequest(input *PutFileSystemPolicyInput) (req *request.Request, output *PutFileSystemPolicyOutput)

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

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

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

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

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

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

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

func (*EFS) PutFileSystemPolicyWithContext added in v1.28.1 

func (c *EFS) PutFileSystemPolicyWithContext(ctx aws.Context, input *PutFileSystemPolicyInput, opts ...request.Option) (*PutFileSystemPolicyOutput, error)

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

See PutFileSystemPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*EFS) PutLifecycleConfiguration added in v1.16.34 

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

PutLifecycleConfiguration API operation for Amazon Elastic File System.

Use this action to manage storage for your file system. A LifecycleConfiguration consists of one or more LifecyclePolicy objects that define the following:

  • TransitionToIA – When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access (IA) storage.

  • TransitionToArchive – When to move files in the file system from their current storage class (either IA or Standard storage) into the Archive storage. File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, TransitionToArchive must either not be set or must be later than TransitionToIA. The Archive storage class is available only for file systems that use the Elastic Throughput mode and the General Purpose Performance mode.

  • TransitionToPrimaryStorageClass – Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA or Archive storage.

For more information, see Managing file system storage (https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html).

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

  • The ID for the file system for which you are enabling, disabling, or modifying Lifecycle management.

  • A LifecyclePolicies array of LifecyclePolicy objects that define when to move files to IA storage, to Archive storage, and back to primary storage. Amazon EFS requires that each LifecyclePolicy object have only have a single transition, so the LifecyclePolicies array needs to be structured with separate LifecyclePolicy objects. See the example requests in the following section for more information.

This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation.

To apply a LifecycleConfiguration object to an encrypted file system, you need the same Key Management Service permissions as when you created the encrypted file system.

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

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

Returned Error Types:

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

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

  • FileSystemNotFound Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

  • IncorrectFileSystemLifeCycleState Returned if the file system's lifecycle state is not "available".

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

Example (Shared00)

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

package main

import (
	"fmt"

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

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

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

	fmt.Println(result)
}

Output:

func (*EFS) PutLifecycleConfigurationRequest added in v1.16.34 

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

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

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

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

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

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

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

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

func (*EFS) PutLifecycleConfigurationWithContext added in v1.16.34 

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

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

See PutLifecycleConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*EFS) TagResource added in v1.28.1 

func (c *EFS) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Elastic File System.

Creates a tag for an EFS resource. You can create tags for EFS file systems and access points using this API operation.

This operation requires permissions for the elasticfilesystem:TagResource 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 TagResource for usage and error information.

Returned Error Types:

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

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

  • FileSystemNotFound Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

  • AccessPointNotFound Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.

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

func (*EFS) TagResourceRequest added in v1.28.1 

func (c *EFS) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

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

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

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

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

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

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

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

func (*EFS) TagResourceWithContext added in v1.28.1 

func (c *EFS) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

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

See TagResource 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) UntagResource added in v1.28.1 

func (c *EFS) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Elastic File System.

Removes tags from an EFS resource. You can remove tags from EFS file systems and access points using this API operation.

This operation requires permissions for the elasticfilesystem:UntagResource 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 UntagResource for usage and error information.

Returned Error Types:

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

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

  • FileSystemNotFound Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

  • AccessPointNotFound Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.

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

func (*EFS) UntagResourceRequest added in v1.28.1 

func (c *EFS) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

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

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

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

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

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

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

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

func (*EFS) UntagResourceWithContext added in v1.28.1 

func (c *EFS) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

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

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*EFS) UpdateFileSystem added in v1.14.26 

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

UpdateFileSystem API operation for Amazon Elastic File System.

Updates the throughput mode or the amount of provisioned throughput of an existing file system.

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

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

Returned Error Types:

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

  • FileSystemNotFound Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

  • IncorrectFileSystemLifeCycleState Returned if the file system's lifecycle state is not "available".

  • InsufficientThroughputCapacity Returned if there's not enough capacity to provision additional throughput. This value might be returned when you try to create a file system in provisioned throughput mode, when you attempt to increase the provisioned throughput of an existing file system, or when you attempt to change an existing file system from Bursting Throughput to Provisioned Throughput mode. Try again later.

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

  • ThroughputLimitExceeded Returned if the throughput mode or amount of provisioned throughput can't be changed because the throughput limit of 1024 MiB/s has been reached.

  • TooManyRequests Returned if you don’t wait at least 24 hours before either changing the throughput mode, or decreasing the Provisioned Throughput value.

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

func (*EFS) UpdateFileSystemProtection added in v1.48.5 

func (c *EFS) UpdateFileSystemProtection(input *UpdateFileSystemProtectionInput) (*UpdateFileSystemProtectionOutput, error)

UpdateFileSystemProtection API operation for Amazon Elastic File System.

Updates protection on the file system.

This operation requires permissions for the elasticfilesystem:UpdateFileSystemProtection 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 UpdateFileSystemProtection for usage and error information.

Returned Error Types:

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

  • FileSystemNotFound Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

  • IncorrectFileSystemLifeCycleState Returned if the file system's lifecycle state is not "available".

  • InsufficientThroughputCapacity Returned if there's not enough capacity to provision additional throughput. This value might be returned when you try to create a file system in provisioned throughput mode, when you attempt to increase the provisioned throughput of an existing file system, or when you attempt to change an existing file system from Bursting Throughput to Provisioned Throughput mode. Try again later.

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

  • ThroughputLimitExceeded Returned if the throughput mode or amount of provisioned throughput can't be changed because the throughput limit of 1024 MiB/s has been reached.

  • ReplicationAlreadyExists Returned if the file system is already included in a replication configuration.>

  • TooManyRequests Returned if you don’t wait at least 24 hours before either changing the throughput mode, or decreasing the Provisioned Throughput value.

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

func (*EFS) UpdateFileSystemProtectionRequest added in v1.48.5 

func (c *EFS) UpdateFileSystemProtectionRequest(input *UpdateFileSystemProtectionInput) (req *request.Request, output *UpdateFileSystemProtectionOutput)

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

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

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

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

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

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

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

func (*EFS) UpdateFileSystemProtectionWithContext added in v1.48.5 

func (c *EFS) UpdateFileSystemProtectionWithContext(ctx aws.Context, input *UpdateFileSystemProtectionInput, opts ...request.Option) (*UpdateFileSystemProtectionOutput, error)

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

See UpdateFileSystemProtection 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) UpdateFileSystemRequest added in v1.14.26 

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

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

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

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

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

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

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

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

func (*EFS) UpdateFileSystemWithContext added in v1.14.26 

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

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

See UpdateFileSystem for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type FileSystemAlreadyExists added in v1.28.0 

type FileSystemAlreadyExists struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	//
	// ErrorCode is a required field
	ErrorCode *string `min:"1" type:"string" required:"true"`

	// FileSystemId is a required field
	FileSystemId *string `type:"string" required:"true"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*FileSystemAlreadyExists) Code added in v1.28.0 

func (s *FileSystemAlreadyExists) Code() string

Code returns the exception type name.

func (*FileSystemAlreadyExists) Error added in v1.28.0 

func (s *FileSystemAlreadyExists) Error() string

func (FileSystemAlreadyExists) GoString added in v1.28.0 

func (s FileSystemAlreadyExists) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FileSystemAlreadyExists) Message added in v1.28.0 

func (s *FileSystemAlreadyExists) Message() string

Message returns the exception's message.

func (*FileSystemAlreadyExists) OrigErr added in v1.28.0 

func (s *FileSystemAlreadyExists) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*FileSystemAlreadyExists) RequestID added in v1.28.0 

func (s *FileSystemAlreadyExists) RequestID() string

RequestID returns the service's response RequestID for request.

func (*FileSystemAlreadyExists) StatusCode added in v1.28.0 

func (s *FileSystemAlreadyExists) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (FileSystemAlreadyExists) String added in v1.28.0 

func (s FileSystemAlreadyExists) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FileSystemDescription 

type FileSystemDescription struct {

	// The unique and consistent identifier of the Availability Zone in which the
	// file system is located, and is valid only for One Zone file systems. For
	// example, use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web
	// Services Region, and it has the same location in every Amazon Web Services
	// account.
	AvailabilityZoneId *string `type:"string"`

	// Describes the Amazon Web Services Availability Zone in which the file system
	// is located, and is valid only for One Zone file systems. For more information,
	// see Using EFS storage classes (https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html)
	// in the Amazon EFS User Guide.
	AvailabilityZoneName *string `min:"1" type:"string"`

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

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

	// A Boolean value that, if true, indicates that the file system is encrypted.
	Encrypted *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) for the EFS file system, in the format arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id
	// . Example with sample data: arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567
	FileSystemArn *string `type:"string"`

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

	// Describes the protection on the file system.
	FileSystemProtection *FileSystemProtectionDescription `type:"structure"`

	// The ID of an KMS key used to protect the encrypted file system.
	KmsKeyId *string `type:"string"`

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

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

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

	// The Amazon Web Services account that created the file system.
	//
	// OwnerId is a required field
	OwnerId *string `type:"string" required:"true"`

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

	// The amount of provisioned throughput, measured in MiBps, for the file system.
	// Valid for file systems using ThroughputMode set to provisioned.
	ProvisionedThroughputInMibps *float64 `min:"1" type:"double"`

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

	// The tags associated with the file system, presented as an array of Tag objects.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`

	// Displays the file system's throughput mode. For more information, see Throughput
	// modes (https://docs.aws.amazon.com/efs/latest/ug/performance.html#throughput-modes)
	// in the Amazon EFS User Guide.
	ThroughputMode *string `type:"string" enum:"ThroughputMode"`
	// contains filtered or unexported fields
}

A description of the file system.

func (FileSystemDescription) GoString added in v0.6.5 

func (s FileSystemDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FileSystemDescription) SetAvailabilityZoneId added in v1.37.27 

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

SetAvailabilityZoneId sets the AvailabilityZoneId field's value.

func (*FileSystemDescription) SetAvailabilityZoneName added in v1.37.27 

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

SetAvailabilityZoneName sets the AvailabilityZoneName field's value.

func (*FileSystemDescription) SetCreationTime added in v1.5.0 

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

SetCreationTime sets the CreationTime field's value.

func (*FileSystemDescription) SetCreationToken added in v1.5.0 

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

SetCreationToken sets the CreationToken field's value.

func (*FileSystemDescription) SetEncrypted added in v1.10.25 

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

SetEncrypted sets the Encrypted field's value.

func (*FileSystemDescription) SetFileSystemArn added in v1.33.3 

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

SetFileSystemArn sets the FileSystemArn field's value.

func (*FileSystemDescription) SetFileSystemId added in v1.5.0 

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

SetFileSystemId sets the FileSystemId field's value.

func (*FileSystemDescription) SetFileSystemProtection added in v1.48.5 

func (s *FileSystemDescription) SetFileSystemProtection(v *FileSystemProtectionDescription) *FileSystemDescription

SetFileSystemProtection sets the FileSystemProtection field's value.

func (*FileSystemDescription) SetKmsKeyId added in v1.10.25 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*FileSystemDescription) SetLifeCycleState added in v1.5.0 

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

SetLifeCycleState sets the LifeCycleState field's value.

func (*FileSystemDescription) SetName added in v1.5.0 

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

SetName sets the Name field's value.

func (*FileSystemDescription) SetNumberOfMountTargets added in v1.5.0 

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

SetNumberOfMountTargets sets the NumberOfMountTargets field's value.

func (*FileSystemDescription) SetOwnerId added in v1.5.0 

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

SetOwnerId sets the OwnerId field's value.

func (*FileSystemDescription) SetPerformanceMode added in v1.5.0 

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

SetPerformanceMode sets the PerformanceMode field's value.

func (*FileSystemDescription) SetProvisionedThroughputInMibps added in v1.15.0 

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

SetProvisionedThroughputInMibps sets the ProvisionedThroughputInMibps field's value.

func (*FileSystemDescription) SetSizeInBytes added in v1.5.0 

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

SetSizeInBytes sets the SizeInBytes field's value.

func (*FileSystemDescription) SetTags added in v1.17.1 

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

SetTags sets the Tags field's value.

func (*FileSystemDescription) SetThroughputMode added in v1.15.0 

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

SetThroughputMode sets the ThroughputMode field's value.

func (FileSystemDescription) String added in v0.6.5 

func (s FileSystemDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FileSystemInUse added in v1.28.0 

type FileSystemInUse struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	//
	// ErrorCode is a required field
	ErrorCode *string `min:"1" type:"string" required:"true"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if a file system has mount targets.

func (*FileSystemInUse) Code added in v1.28.0 

func (s *FileSystemInUse) Code() string

Code returns the exception type name.

func (*FileSystemInUse) Error added in v1.28.0 

func (s *FileSystemInUse) Error() string

func (FileSystemInUse) GoString added in v1.28.0 

func (s FileSystemInUse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FileSystemInUse) Message added in v1.28.0 

func (s *FileSystemInUse) Message() string

Message returns the exception's message.

func (*FileSystemInUse) OrigErr added in v1.28.0 

func (s *FileSystemInUse) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*FileSystemInUse) RequestID added in v1.28.0 

func (s *FileSystemInUse) RequestID() string

RequestID returns the service's response RequestID for request.

func (*FileSystemInUse) StatusCode added in v1.28.0 

func (s *FileSystemInUse) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (FileSystemInUse) String added in v1.28.0 

func (s FileSystemInUse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FileSystemLimitExceeded added in v1.28.0 

type FileSystemLimitExceeded struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	//
	// ErrorCode is a required field
	ErrorCode *string `min:"1" type:"string" required:"true"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if the Amazon Web Services account has already created the maximum number of file systems allowed per account.

func (*FileSystemLimitExceeded) Code added in v1.28.0 

func (s *FileSystemLimitExceeded) Code() string

Code returns the exception type name.

func (*FileSystemLimitExceeded) Error added in v1.28.0 

func (s *FileSystemLimitExceeded) Error() string

func (FileSystemLimitExceeded) GoString added in v1.28.0 

func (s FileSystemLimitExceeded) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FileSystemLimitExceeded) Message added in v1.28.0 

func (s *FileSystemLimitExceeded) Message() string

Message returns the exception's message.

func (*FileSystemLimitExceeded) OrigErr added in v1.28.0 

func (s *FileSystemLimitExceeded) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*FileSystemLimitExceeded) RequestID added in v1.28.0 

func (s *FileSystemLimitExceeded) RequestID() string

RequestID returns the service's response RequestID for request.

func (*FileSystemLimitExceeded) StatusCode added in v1.28.0 

func (s *FileSystemLimitExceeded) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (FileSystemLimitExceeded) String added in v1.28.0 

func (s FileSystemLimitExceeded) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FileSystemNotFound added in v1.28.0 

type FileSystemNotFound struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	//
	// ErrorCode is a required field
	ErrorCode *string `min:"1" type:"string" required:"true"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

func (*FileSystemNotFound) Code added in v1.28.0 

func (s *FileSystemNotFound) Code() string

Code returns the exception type name.

func (*FileSystemNotFound) Error added in v1.28.0 

func (s *FileSystemNotFound) Error() string

func (FileSystemNotFound) GoString added in v1.28.0 

func (s FileSystemNotFound) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FileSystemNotFound) Message added in v1.28.0 

func (s *FileSystemNotFound) Message() string

Message returns the exception's message.

func (*FileSystemNotFound) OrigErr added in v1.28.0 

func (s *FileSystemNotFound) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*FileSystemNotFound) RequestID added in v1.28.0 

func (s *FileSystemNotFound) RequestID() string

RequestID returns the service's response RequestID for request.

func (*FileSystemNotFound) StatusCode added in v1.28.0 

func (s *FileSystemNotFound) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (FileSystemNotFound) String added in v1.28.0 

func (s FileSystemNotFound) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FileSystemProtectionDescription added in v1.48.5 

type FileSystemProtectionDescription struct {

	// The status of the file system's replication overwrite protection.
	//
	//    * ENABLED – The file system cannot be used as the destination file system
	//    in a replication configuration. The file system is writeable. Replication
	//    overwrite protection is ENABLED by default.
	//
	//    * DISABLED – The file system can be used as the destination file system
	//    in a replication configuration. The file system is read-only and can only
	//    be modified by EFS replication.
	//
	//    * REPLICATING – The file system is being used as the destination file
	//    system in a replication configuration. The file system is read-only and
	//    is only modified only by EFS replication.
	//
	// If the replication configuration is deleted, the file system's replication
	// overwrite protection is re-enabled, the file system becomes writeable.
	ReplicationOverwriteProtection *string `type:"string" enum:"ReplicationOverwriteProtection"`
	// contains filtered or unexported fields
}

Describes the protection on a file system.

func (FileSystemProtectionDescription) GoString added in v1.48.5 

func (s FileSystemProtectionDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FileSystemProtectionDescription) SetReplicationOverwriteProtection added in v1.48.5 

func (s *FileSystemProtectionDescription) SetReplicationOverwriteProtection(v string) *FileSystemProtectionDescription

SetReplicationOverwriteProtection sets the ReplicationOverwriteProtection field's value.

func (FileSystemProtectionDescription) String added in v1.48.5 

func (s FileSystemProtectionDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FileSystemSize 

type FileSystemSize struct {

	// The time at which the size of data, returned in the Value field, was determined.
	// The value is the integer number of seconds since 1970-01-01T00:00:00Z.
	Timestamp *time.Time `type:"timestamp"`

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

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

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

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

The latest known metered size (in bytes) of data stored in the file system, in its Value field, and the time at which that size was determined in its Timestamp field. The value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, the value represents the actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not necessarily the exact size the file system was at any instant in time.

func (FileSystemSize) GoString added in v0.6.5 

func (s FileSystemSize) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FileSystemSize) SetTimestamp added in v1.5.0 

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

SetTimestamp sets the Timestamp field's value.

func (*FileSystemSize) SetValue added in v1.5.0 

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

SetValue sets the Value field's value.

func (*FileSystemSize) SetValueInArchive added in v1.48.4 

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

SetValueInArchive sets the ValueInArchive field's value.

func (*FileSystemSize) SetValueInIA added in v1.16.34 

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

SetValueInIA sets the ValueInIA field's value.

func (*FileSystemSize) SetValueInStandard added in v1.16.34 

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

SetValueInStandard sets the ValueInStandard field's value.

func (FileSystemSize) String added in v0.6.5 

func (s FileSystemSize) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IncorrectFileSystemLifeCycleState added in v1.28.0 

type IncorrectFileSystemLifeCycleState struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	//
	// ErrorCode is a required field
	ErrorCode *string `min:"1" type:"string" required:"true"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if the file system's lifecycle state is not "available".

func (*IncorrectFileSystemLifeCycleState) Code added in v1.28.0 

func (s *IncorrectFileSystemLifeCycleState) Code() string

Code returns the exception type name.

func (*IncorrectFileSystemLifeCycleState) Error added in v1.28.0 

func (s *IncorrectFileSystemLifeCycleState) Error() string

func (IncorrectFileSystemLifeCycleState) GoString added in v1.28.0 

func (s IncorrectFileSystemLifeCycleState) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IncorrectFileSystemLifeCycleState) Message added in v1.28.0 

func (s *IncorrectFileSystemLifeCycleState) Message() string

Message returns the exception's message.

func (*IncorrectFileSystemLifeCycleState) OrigErr added in v1.28.0 

func (s *IncorrectFileSystemLifeCycleState) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*IncorrectFileSystemLifeCycleState) RequestID added in v1.28.0 

func (s *IncorrectFileSystemLifeCycleState) RequestID() string

RequestID returns the service's response RequestID for request.

func (*IncorrectFileSystemLifeCycleState) StatusCode added in v1.28.0 

func (s *IncorrectFileSystemLifeCycleState) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (IncorrectFileSystemLifeCycleState) String added in v1.28.0 

func (s IncorrectFileSystemLifeCycleState) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IncorrectMountTargetState added in v1.28.0 

type IncorrectMountTargetState struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	//
	// ErrorCode is a required field
	ErrorCode *string `min:"1" type:"string" required:"true"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if the mount target is not in the correct state for the operation.

func (*IncorrectMountTargetState) Code added in v1.28.0 

func (s *IncorrectMountTargetState) Code() string

Code returns the exception type name.

func (*IncorrectMountTargetState) Error added in v1.28.0 

func (s *IncorrectMountTargetState) Error() string

func (IncorrectMountTargetState) GoString added in v1.28.0 

func (s IncorrectMountTargetState) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IncorrectMountTargetState) Message added in v1.28.0 

func (s *IncorrectMountTargetState) Message() string

Message returns the exception's message.

func (*IncorrectMountTargetState) OrigErr added in v1.28.0 

func (s *IncorrectMountTargetState) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*IncorrectMountTargetState) RequestID added in v1.28.0 

func (s *IncorrectMountTargetState) RequestID() string

RequestID returns the service's response RequestID for request.

func (*IncorrectMountTargetState) StatusCode added in v1.28.0 

func (s *IncorrectMountTargetState) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (IncorrectMountTargetState) String added in v1.28.0 

func (s IncorrectMountTargetState) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InsufficientThroughputCapacity added in v1.28.0 

type InsufficientThroughputCapacity struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	//
	// ErrorCode is a required field
	ErrorCode *string `min:"1" type:"string" required:"true"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if there's not enough capacity to provision additional throughput. This value might be returned when you try to create a file system in provisioned throughput mode, when you attempt to increase the provisioned throughput of an existing file system, or when you attempt to change an existing file system from Bursting Throughput to Provisioned Throughput mode. Try again later.

func (*InsufficientThroughputCapacity) Code added in v1.28.0 

func (s *InsufficientThroughputCapacity) Code() string

Code returns the exception type name.

func (*InsufficientThroughputCapacity) Error added in v1.28.0 

func (s *InsufficientThroughputCapacity) Error() string

func (InsufficientThroughputCapacity) GoString added in v1.28.0 

func (s InsufficientThroughputCapacity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InsufficientThroughputCapacity) Message added in v1.28.0 

func (s *InsufficientThroughputCapacity) Message() string

Message returns the exception's message.

func (*InsufficientThroughputCapacity) OrigErr added in v1.28.0 

func (s *InsufficientThroughputCapacity) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InsufficientThroughputCapacity) RequestID added in v1.28.0 

func (s *InsufficientThroughputCapacity) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InsufficientThroughputCapacity) StatusCode added in v1.28.0 

func (s *InsufficientThroughputCapacity) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InsufficientThroughputCapacity) String added in v1.28.0 

func (s InsufficientThroughputCapacity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerError added in v1.28.0 

type InternalServerError struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	//
	// ErrorCode is a required field
	ErrorCode *string `min:"1" type:"string" required:"true"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if an error occurred on the server side.

func (*InternalServerError) Code added in v1.28.0 

func (s *InternalServerError) Code() string

Code returns the exception type name.

func (*InternalServerError) Error added in v1.28.0 

func (s *InternalServerError) Error() string

func (InternalServerError) GoString added in v1.28.0 

func (s InternalServerError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerError) Message added in v1.28.0 

func (s *InternalServerError) Message() string

Message returns the exception's message.

func (*InternalServerError) OrigErr added in v1.28.0 

func (s *InternalServerError) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerError) RequestID added in v1.28.0 

func (s *InternalServerError) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerError) StatusCode added in v1.28.0 

func (s *InternalServerError) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerError) String added in v1.28.0 

func (s InternalServerError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidPolicyException added in v1.28.1 

type InvalidPolicyException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	ErrorCode *string `min:"1" type:"string"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if the FileSystemPolicy is malformed or contains an error such as a parameter value that is not valid or a missing required parameter. Returned in the case of a policy lockout safety check error.

func (*InvalidPolicyException) Code added in v1.28.1 

func (s *InvalidPolicyException) Code() string

Code returns the exception type name.

func (*InvalidPolicyException) Error added in v1.28.1 

func (s *InvalidPolicyException) Error() string

func (InvalidPolicyException) GoString added in v1.28.1 

func (s InvalidPolicyException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidPolicyException) Message added in v1.28.1 

func (s *InvalidPolicyException) Message() string

Message returns the exception's message.

func (*InvalidPolicyException) OrigErr added in v1.28.1 

func (s *InvalidPolicyException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidPolicyException) RequestID added in v1.28.1 

func (s *InvalidPolicyException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidPolicyException) StatusCode added in v1.28.1 

func (s *InvalidPolicyException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidPolicyException) String added in v1.28.1 

func (s InvalidPolicyException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IpAddressInUse added in v1.28.0 

type IpAddressInUse struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	//
	// ErrorCode is a required field
	ErrorCode *string `min:"1" type:"string" required:"true"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if the request specified an IpAddress that is already in use in the subnet.

func (*IpAddressInUse) Code added in v1.28.0 

func (s *IpAddressInUse) Code() string

Code returns the exception type name.

func (*IpAddressInUse) Error added in v1.28.0 

func (s *IpAddressInUse) Error() string

func (IpAddressInUse) GoString added in v1.28.0 

func (s IpAddressInUse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IpAddressInUse) Message added in v1.28.0 

func (s *IpAddressInUse) Message() string

Message returns the exception's message.

func (*IpAddressInUse) OrigErr added in v1.28.0 

func (s *IpAddressInUse) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*IpAddressInUse) RequestID added in v1.28.0 

func (s *IpAddressInUse) RequestID() string

RequestID returns the service's response RequestID for request.

func (*IpAddressInUse) StatusCode added in v1.28.0 

func (s *IpAddressInUse) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (IpAddressInUse) String added in v1.28.0 

func (s IpAddressInUse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LifecyclePolicy added in v1.16.34 

type LifecyclePolicy struct {

	// The number of days after files were last accessed in primary storage (the
	// Standard storage class) files at which to move them to Archive storage. Metadata
	// operations such as listing the contents of a directory don't count as file
	// access events.
	TransitionToArchive *string `type:"string" enum:"TransitionToArchiveRules"`

	// The number of days after files were last accessed in primary storage (the
	// Standard storage class) at which to move them to Infrequent Access (IA) storage.
	// Metadata operations such as listing the contents of a directory don't count
	// as file access events.
	TransitionToIA *string `type:"string" enum:"TransitionToIARules"`

	// Whether to move files back to primary (Standard) storage after they are accessed
	// in IA or Archive storage. Metadata operations such as listing the contents
	// of a directory don't count as file access events.
	TransitionToPrimaryStorageClass *string `type:"string" enum:"TransitionToPrimaryStorageClassRules"`
	// contains filtered or unexported fields
}

Describes a policy used by Lifecycle management that specifies when to transition files into and out of storage classes. For more information, see Managing file system storage (https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html).

When using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration API action, Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies must be structured as an array of LifecyclePolicy objects, one object for each transition. For more information, see the request examples in PutLifecycleConfiguration.

func (LifecyclePolicy) GoString added in v1.16.34 

func (s LifecyclePolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LifecyclePolicy) SetTransitionToArchive added in v1.48.4 

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

SetTransitionToArchive sets the TransitionToArchive field's value.

func (*LifecyclePolicy) SetTransitionToIA added in v1.16.34 

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

SetTransitionToIA sets the TransitionToIA field's value.

func (*LifecyclePolicy) SetTransitionToPrimaryStorageClass added in v1.40.36 

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

SetTransitionToPrimaryStorageClass sets the TransitionToPrimaryStorageClass field's value.

func (LifecyclePolicy) String added in v1.16.34 

func (s LifecyclePolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput added in v1.28.1 

type ListTagsForResourceInput struct {

	// (Optional) Specifies the maximum number of tag objects to return in the response.
	// The default value is 100.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// (Optional) You can use NextToken in a subsequent request to fetch the next
	// page of access point descriptions if the response payload was paginated.
	NextToken *string `location:"querystring" locationName:"NextToken" min:"1" type:"string"`

	// Specifies the EFS resource you want to retrieve tags for. You can retrieve
	// tags for EFS file systems and access points using this API endpoint.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"ResourceId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.28.1 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetMaxResults added in v1.28.1 

func (s *ListTagsForResourceInput) SetMaxResults(v int64) *ListTagsForResourceInput

SetMaxResults sets the MaxResults field's value.

func (*ListTagsForResourceInput) SetNextToken added in v1.28.1 

func (s *ListTagsForResourceInput) SetNextToken(v string) *ListTagsForResourceInput

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceInput) SetResourceId added in v1.28.1 

func (s *ListTagsForResourceInput) SetResourceId(v string) *ListTagsForResourceInput

SetResourceId sets the ResourceId field's value.

func (ListTagsForResourceInput) String added in v1.28.1 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate added in v1.28.1 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v1.28.1 

type ListTagsForResourceOutput struct {

	// NextToken is present if the response payload is paginated. You can use NextToken
	// in a subsequent request to fetch the next page of access point descriptions.
	NextToken *string `min:"1" type:"string"`

	// An array of the tags for the specified EFS resource.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.28.1 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetNextToken added in v1.28.1 

func (s *ListTagsForResourceOutput) SetNextToken(v string) *ListTagsForResourceOutput

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceOutput) SetTags added in v1.28.1 

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

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.28.1 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyMountTargetSecurityGroupsInput 

type ModifyMountTargetSecurityGroupsInput struct {

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

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

func (ModifyMountTargetSecurityGroupsInput) GoString added in v0.6.5 

func (s ModifyMountTargetSecurityGroupsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyMountTargetSecurityGroupsInput) SetMountTargetId added in v1.5.0 

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

SetMountTargetId sets the MountTargetId field's value.

func (*ModifyMountTargetSecurityGroupsInput) SetSecurityGroups added in v1.5.0 

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

SetSecurityGroups sets the SecurityGroups field's value.

func (ModifyMountTargetSecurityGroupsInput) String added in v0.6.5 

func (s ModifyMountTargetSecurityGroupsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyMountTargetSecurityGroupsInput) Validate added in v1.1.21 

func (s *ModifyMountTargetSecurityGroupsInput) Validate() error

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

type ModifyMountTargetSecurityGroupsOutput 

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

func (ModifyMountTargetSecurityGroupsOutput) GoString added in v0.6.5 

func (s ModifyMountTargetSecurityGroupsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (ModifyMountTargetSecurityGroupsOutput) String added in v0.6.5 

func (s ModifyMountTargetSecurityGroupsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MountTargetConflict added in v1.28.0 

type MountTargetConflict struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	//
	// ErrorCode is a required field
	ErrorCode *string `min:"1" type:"string" required:"true"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if the mount target would violate one of the specified restrictions based on the file system's existing mount targets.

func (*MountTargetConflict) Code added in v1.28.0 

func (s *MountTargetConflict) Code() string

Code returns the exception type name.

func (*MountTargetConflict) Error added in v1.28.0 

func (s *MountTargetConflict) Error() string

func (MountTargetConflict) GoString added in v1.28.0 

func (s MountTargetConflict) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MountTargetConflict) Message added in v1.28.0 

func (s *MountTargetConflict) Message() string

Message returns the exception's message.

func (*MountTargetConflict) OrigErr added in v1.28.0 

func (s *MountTargetConflict) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MountTargetConflict) RequestID added in v1.28.0 

func (s *MountTargetConflict) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MountTargetConflict) StatusCode added in v1.28.0 

func (s *MountTargetConflict) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (MountTargetConflict) String added in v1.28.0 

func (s MountTargetConflict) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MountTargetDescription 

type MountTargetDescription struct {

	// The unique and consistent identifier of the Availability Zone that the mount
	// target resides in. For example, use1-az1 is an AZ ID for the us-east-1 Region
	// and it has the same location in every Amazon Web Services account.
	AvailabilityZoneId *string `type:"string"`

	// The name of the Availability Zone in which the mount target is located. Availability
	// Zones are independently mapped to names for each Amazon Web Services account.
	// For example, the Availability Zone us-east-1a for your Amazon Web Services
	// account might not be the same location as us-east-1a for another Amazon Web
	// Services account.
	AvailabilityZoneName *string `min:"1" type:"string"`

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

	// Address at which the file system can be mounted by using the mount target.
	IpAddress *string `min:"7" 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 `min:"13" type:"string" required:"true"`

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

	// Amazon Web Services account ID that owns the resource.
	OwnerId *string `type:"string"`

	// The ID of the mount target's subnet.
	//
	// SubnetId is a required field
	SubnetId *string `min:"15" type:"string" required:"true"`

	// The virtual private cloud (VPC) ID that the mount target is configured in.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Provides a description of a mount target.

func (MountTargetDescription) GoString added in v0.6.5 

func (s MountTargetDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MountTargetDescription) SetAvailabilityZoneId added in v1.28.1 

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

SetAvailabilityZoneId sets the AvailabilityZoneId field's value.

func (*MountTargetDescription) SetAvailabilityZoneName added in v1.28.1 

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

SetAvailabilityZoneName sets the AvailabilityZoneName field's value.

func (*MountTargetDescription) SetFileSystemId added in v1.5.0 

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

SetFileSystemId sets the FileSystemId field's value.

func (*MountTargetDescription) SetIpAddress added in v1.5.0 

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

SetIpAddress sets the IpAddress field's value.

func (*MountTargetDescription) SetLifeCycleState added in v1.5.0 

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

SetLifeCycleState sets the LifeCycleState field's value.

func (*MountTargetDescription) SetMountTargetId added in v1.5.0 

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

SetMountTargetId sets the MountTargetId field's value.

func (*MountTargetDescription) SetNetworkInterfaceId added in v1.5.0 

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

SetNetworkInterfaceId sets the NetworkInterfaceId field's value.

func (*MountTargetDescription) SetOwnerId added in v1.5.0 

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

SetOwnerId sets the OwnerId field's value.

func (*MountTargetDescription) SetSubnetId added in v1.5.0 

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

SetSubnetId sets the SubnetId field's value.

func (*MountTargetDescription) SetVpcId added in v1.33.3 

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

SetVpcId sets the VpcId field's value.

func (MountTargetDescription) String added in v0.6.5 

func (s MountTargetDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MountTargetNotFound added in v1.28.0 

type MountTargetNotFound struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	//
	// ErrorCode is a required field
	ErrorCode *string `min:"1" type:"string" required:"true"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services account.

func (*MountTargetNotFound) Code added in v1.28.0 

func (s *MountTargetNotFound) Code() string

Code returns the exception type name.

func (*MountTargetNotFound) Error added in v1.28.0 

func (s *MountTargetNotFound) Error() string

func (MountTargetNotFound) GoString added in v1.28.0 

func (s MountTargetNotFound) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MountTargetNotFound) Message added in v1.28.0 

func (s *MountTargetNotFound) Message() string

Message returns the exception's message.

func (*MountTargetNotFound) OrigErr added in v1.28.0 

func (s *MountTargetNotFound) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MountTargetNotFound) RequestID added in v1.28.0 

func (s *MountTargetNotFound) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MountTargetNotFound) StatusCode added in v1.28.0 

func (s *MountTargetNotFound) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (MountTargetNotFound) String added in v1.28.0 

func (s MountTargetNotFound) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NetworkInterfaceLimitExceeded added in v1.28.0 

type NetworkInterfaceLimitExceeded struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	//
	// ErrorCode is a required field
	ErrorCode *string `min:"1" type:"string" required:"true"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The calling account has reached the limit for elastic network interfaces for the specific Amazon Web Services Region. Either delete some network interfaces or request that the account quota be raised. For more information, see Amazon VPC Quotas (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Appendix_Limits.html) in the Amazon VPC User Guide (see the Network interfaces per Region entry in the Network interfaces table).

func (*NetworkInterfaceLimitExceeded) Code added in v1.28.0 

func (s *NetworkInterfaceLimitExceeded) Code() string

Code returns the exception type name.

func (*NetworkInterfaceLimitExceeded) Error added in v1.28.0 

func (s *NetworkInterfaceLimitExceeded) Error() string

func (NetworkInterfaceLimitExceeded) GoString added in v1.28.0 

func (s NetworkInterfaceLimitExceeded) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NetworkInterfaceLimitExceeded) Message added in v1.28.0 

func (s *NetworkInterfaceLimitExceeded) Message() string

Message returns the exception's message.

func (*NetworkInterfaceLimitExceeded) OrigErr added in v1.28.0 

func (s *NetworkInterfaceLimitExceeded) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NetworkInterfaceLimitExceeded) RequestID added in v1.28.0 

func (s *NetworkInterfaceLimitExceeded) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NetworkInterfaceLimitExceeded) StatusCode added in v1.28.0 

func (s *NetworkInterfaceLimitExceeded) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NetworkInterfaceLimitExceeded) String added in v1.28.0 

func (s NetworkInterfaceLimitExceeded) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NoFreeAddressesInSubnet added in v1.28.0 

type NoFreeAddressesInSubnet struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	//
	// ErrorCode is a required field
	ErrorCode *string `min:"1" type:"string" required:"true"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if IpAddress was not specified in the request and there are no free IP addresses in the subnet.

func (*NoFreeAddressesInSubnet) Code added in v1.28.0 

func (s *NoFreeAddressesInSubnet) Code() string

Code returns the exception type name.

func (*NoFreeAddressesInSubnet) Error added in v1.28.0 

func (s *NoFreeAddressesInSubnet) Error() string

func (NoFreeAddressesInSubnet) GoString added in v1.28.0 

func (s NoFreeAddressesInSubnet) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NoFreeAddressesInSubnet) Message added in v1.28.0 

func (s *NoFreeAddressesInSubnet) Message() string

Message returns the exception's message.

func (*NoFreeAddressesInSubnet) OrigErr added in v1.28.0 

func (s *NoFreeAddressesInSubnet) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NoFreeAddressesInSubnet) RequestID added in v1.28.0 

func (s *NoFreeAddressesInSubnet) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NoFreeAddressesInSubnet) StatusCode added in v1.28.0 

func (s *NoFreeAddressesInSubnet) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NoFreeAddressesInSubnet) String added in v1.28.0 

func (s NoFreeAddressesInSubnet) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PolicyNotFound added in v1.28.1 

type PolicyNotFound struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	ErrorCode *string `min:"1" type:"string"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if the default file system policy is in effect for the EFS file system specified.

func (*PolicyNotFound) Code added in v1.28.1 

func (s *PolicyNotFound) Code() string

Code returns the exception type name.

func (*PolicyNotFound) Error added in v1.28.1 

func (s *PolicyNotFound) Error() string

func (PolicyNotFound) GoString added in v1.28.1 

func (s PolicyNotFound) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PolicyNotFound) Message added in v1.28.1 

func (s *PolicyNotFound) Message() string

Message returns the exception's message.

func (*PolicyNotFound) OrigErr added in v1.28.1 

func (s *PolicyNotFound) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*PolicyNotFound) RequestID added in v1.28.1 

func (s *PolicyNotFound) RequestID() string

RequestID returns the service's response RequestID for request.

func (*PolicyNotFound) StatusCode added in v1.28.1 

func (s *PolicyNotFound) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (PolicyNotFound) String added in v1.28.1 

func (s PolicyNotFound) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PosixUser added in v1.28.1 

type PosixUser struct {

	// The POSIX group ID used for all file system operations using this access
	// point.
	//
	// Gid is a required field
	Gid *int64 `type:"long" required:"true"`

	// Secondary POSIX group IDs used for all file system operations using this
	// access point.
	SecondaryGids []*int64 `type:"list"`

	// The POSIX user ID used for all file system operations using this access point.
	//
	// Uid is a required field
	Uid *int64 `type:"long" required:"true"`
	// contains filtered or unexported fields
}

The full POSIX identity, including the user ID, group ID, and any secondary group IDs, on the access point that is used for all file system operations performed by NFS clients using the access point.

func (PosixUser) GoString added in v1.28.1 

func (s PosixUser) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PosixUser) SetGid added in v1.28.1 

func (s *PosixUser) SetGid(v int64) *PosixUser

SetGid sets the Gid field's value.

func (*PosixUser) SetSecondaryGids added in v1.28.1 

func (s *PosixUser) SetSecondaryGids(v []*int64) *PosixUser

SetSecondaryGids sets the SecondaryGids field's value.

func (*PosixUser) SetUid added in v1.28.1 

func (s *PosixUser) SetUid(v int64) *PosixUser

SetUid sets the Uid field's value.

func (PosixUser) String added in v1.28.1 

func (s PosixUser) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PosixUser) Validate added in v1.28.1 

func (s *PosixUser) Validate() error

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

type PutAccountPreferencesInput added in v1.38.45 

type PutAccountPreferencesInput struct {

	// Specifies the EFS resource ID preference to set for the user's Amazon Web
	// Services account, in the current Amazon Web Services Region, either LONG_ID
	// (17 characters), or SHORT_ID (8 characters).
	//
	// Starting in October, 2021, you will receive an error when setting the account
	// preference to SHORT_ID. Contact Amazon Web Services support if you receive
	// an error and must use short IDs for file system and mount target resources.
	//
	// ResourceIdType is a required field
	ResourceIdType *string `type:"string" required:"true" enum:"ResourceIdType"`
	// contains filtered or unexported fields
}

func (PutAccountPreferencesInput) GoString added in v1.38.45 

func (s PutAccountPreferencesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAccountPreferencesInput) SetResourceIdType added in v1.38.45 

func (s *PutAccountPreferencesInput) SetResourceIdType(v string) *PutAccountPreferencesInput

SetResourceIdType sets the ResourceIdType field's value.

func (PutAccountPreferencesInput) String added in v1.38.45 

func (s PutAccountPreferencesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAccountPreferencesInput) Validate added in v1.38.45 

func (s *PutAccountPreferencesInput) Validate() error

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

type PutAccountPreferencesOutput added in v1.38.45 

type PutAccountPreferencesOutput struct {

	// Describes the resource type and its ID preference for the user's Amazon Web
	// Services account, in the current Amazon Web Services Region.
	ResourceIdPreference *ResourceIdPreference `type:"structure"`
	// contains filtered or unexported fields
}

func (PutAccountPreferencesOutput) GoString added in v1.38.45 

func (s PutAccountPreferencesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAccountPreferencesOutput) SetResourceIdPreference added in v1.38.45 

func (s *PutAccountPreferencesOutput) SetResourceIdPreference(v *ResourceIdPreference) *PutAccountPreferencesOutput

SetResourceIdPreference sets the ResourceIdPreference field's value.

func (PutAccountPreferencesOutput) String added in v1.38.45 

func (s PutAccountPreferencesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutBackupPolicyInput added in v1.33.3 

type PutBackupPolicyInput struct {

	// The backup policy included in the PutBackupPolicy request.
	//
	// BackupPolicy is a required field
	BackupPolicy *BackupPolicy `type:"structure" required:"true"`

	// Specifies which EFS file system to update the backup policy for.
	//
	// FileSystemId is a required field
	FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutBackupPolicyInput) GoString added in v1.33.3 

func (s PutBackupPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutBackupPolicyInput) SetBackupPolicy added in v1.33.3 

func (s *PutBackupPolicyInput) SetBackupPolicy(v *BackupPolicy) *PutBackupPolicyInput

SetBackupPolicy sets the BackupPolicy field's value.

func (*PutBackupPolicyInput) SetFileSystemId added in v1.33.3 

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

SetFileSystemId sets the FileSystemId field's value.

func (PutBackupPolicyInput) String added in v1.33.3 

func (s PutBackupPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutBackupPolicyInput) Validate added in v1.33.3 

func (s *PutBackupPolicyInput) Validate() error

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

type PutBackupPolicyOutput added in v1.33.3 

type PutBackupPolicyOutput struct {

	// Describes the file system's backup policy, indicating whether automatic backups
	// are turned on or off.
	BackupPolicy *BackupPolicy `type:"structure"`
	// contains filtered or unexported fields
}

func (PutBackupPolicyOutput) GoString added in v1.33.3 

func (s PutBackupPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutBackupPolicyOutput) SetBackupPolicy added in v1.33.3 

func (s *PutBackupPolicyOutput) SetBackupPolicy(v *BackupPolicy) *PutBackupPolicyOutput

SetBackupPolicy sets the BackupPolicy field's value.

func (PutBackupPolicyOutput) String added in v1.33.3 

func (s PutBackupPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutFileSystemPolicyInput added in v1.28.1 

type PutFileSystemPolicyInput struct {

	// (Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy
	// lockout safety check. The lockout safety check determines whether the policy
	// in the request will lock out, or prevent, the IAM principal that is making
	// the request from making future PutFileSystemPolicy requests on this file
	// system. Set BypassPolicyLockoutSafetyCheck to True only when you intend to
	// prevent the IAM principal that is making the request from making subsequent
	// PutFileSystemPolicy requests on this file system. The default value is False.
	BypassPolicyLockoutSafetyCheck *bool `type:"boolean"`

	// The ID of the EFS file system that you want to create or update the FileSystemPolicy
	// for.
	//
	// FileSystemId is a required field
	FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`

	// The FileSystemPolicy that you're creating. Accepts a JSON formatted policy
	// definition. EFS file system policies have a 20,000 character limit. To find
	// out more about the elements that make up a file system policy, see EFS Resource-based
	// Policies (https://docs.aws.amazon.com/efs/latest/ug/access-control-overview.html#access-control-manage-access-intro-resource-policies).
	//
	// Policy is a required field
	Policy *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutFileSystemPolicyInput) GoString added in v1.28.1 

func (s PutFileSystemPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutFileSystemPolicyInput) SetBypassPolicyLockoutSafetyCheck added in v1.28.1 

func (s *PutFileSystemPolicyInput) SetBypassPolicyLockoutSafetyCheck(v bool) *PutFileSystemPolicyInput

SetBypassPolicyLockoutSafetyCheck sets the BypassPolicyLockoutSafetyCheck field's value.

func (*PutFileSystemPolicyInput) SetFileSystemId added in v1.28.1 

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

SetFileSystemId sets the FileSystemId field's value.

func (*PutFileSystemPolicyInput) SetPolicy added in v1.28.1 

func (s *PutFileSystemPolicyInput) SetPolicy(v string) *PutFileSystemPolicyInput

SetPolicy sets the Policy field's value.

func (PutFileSystemPolicyInput) String added in v1.28.1 

func (s PutFileSystemPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutFileSystemPolicyInput) Validate added in v1.28.1 

func (s *PutFileSystemPolicyInput) Validate() error

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

type PutFileSystemPolicyOutput added in v1.28.1 

type PutFileSystemPolicyOutput struct {

	// Specifies the EFS file system to which the FileSystemPolicy applies.
	FileSystemId *string `type:"string"`

	// The JSON formatted FileSystemPolicy for the EFS file system.
	Policy *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (PutFileSystemPolicyOutput) GoString added in v1.28.1 

func (s PutFileSystemPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutFileSystemPolicyOutput) SetFileSystemId added in v1.28.1 

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

SetFileSystemId sets the FileSystemId field's value.

func (*PutFileSystemPolicyOutput) SetPolicy added in v1.28.1 

func (s *PutFileSystemPolicyOutput) SetPolicy(v string) *PutFileSystemPolicyOutput

SetPolicy sets the Policy field's value.

func (PutFileSystemPolicyOutput) String added in v1.28.1 

func (s PutFileSystemPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutLifecycleConfigurationInput added in v1.16.34 

type PutLifecycleConfigurationInput struct {

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

	// An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration
	// object. A LifecycleConfiguration object informs EFS Lifecycle management
	// of the following:
	//
	//    * TransitionToIA – When to move files in the file system from primary
	//    storage (Standard storage class) into the Infrequent Access (IA) storage.
	//
	//    * TransitionToArchive – When to move files in the file system from their
	//    current storage class (either IA or Standard storage) into the Archive
	//    storage. File systems cannot transition into Archive storage before transitioning
	//    into IA storage. Therefore, TransitionToArchive must either not be set
	//    or must be later than TransitionToIA. The Archive storage class is available
	//    only for file systems that use the Elastic Throughput mode and the General
	//    Purpose Performance mode.
	//
	//    * TransitionToPrimaryStorageClass – Whether to move files in the file
	//    system back to primary storage (Standard storage class) after they are
	//    accessed in IA or Archive storage.
	//
	// When using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration
	// API action, Amazon EFS requires that each LifecyclePolicy object have only
	// a single transition. This means that in a request body, LifecyclePolicies
	// must be structured as an array of LifecyclePolicy objects, one object for
	// each storage transition. See the example requests in the following section
	// for more information.
	//
	// LifecyclePolicies is a required field
	LifecyclePolicies []*LifecyclePolicy `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (PutLifecycleConfigurationInput) GoString added in v1.16.34 

func (s PutLifecycleConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutLifecycleConfigurationInput) SetFileSystemId added in v1.16.34 

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

SetFileSystemId sets the FileSystemId field's value.

func (*PutLifecycleConfigurationInput) SetLifecyclePolicies added in v1.16.34 

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

SetLifecyclePolicies sets the LifecyclePolicies field's value.

func (PutLifecycleConfigurationInput) String added in v1.16.34 

func (s PutLifecycleConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutLifecycleConfigurationInput) Validate added in v1.16.34 

func (s *PutLifecycleConfigurationInput) Validate() error

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

type PutLifecycleConfigurationOutput added in v1.16.34 

type PutLifecycleConfigurationOutput struct {

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

func (PutLifecycleConfigurationOutput) GoString added in v1.16.34 

func (s PutLifecycleConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutLifecycleConfigurationOutput) SetLifecyclePolicies added in v1.16.34 

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

SetLifecyclePolicies sets the LifecyclePolicies field's value.

func (PutLifecycleConfigurationOutput) String added in v1.16.34 

func (s PutLifecycleConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ReplicationAlreadyExists added in v1.48.5 

type ReplicationAlreadyExists struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	ErrorCode *string `min:"1" type:"string"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if the file system is already included in a replication configuration.>

func (*ReplicationAlreadyExists) Code added in v1.48.5 

func (s *ReplicationAlreadyExists) Code() string

Code returns the exception type name.

func (*ReplicationAlreadyExists) Error added in v1.48.5 

func (s *ReplicationAlreadyExists) Error() string

func (ReplicationAlreadyExists) GoString added in v1.48.5 

func (s ReplicationAlreadyExists) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReplicationAlreadyExists) Message added in v1.48.5 

func (s *ReplicationAlreadyExists) Message() string

Message returns the exception's message.

func (*ReplicationAlreadyExists) OrigErr added in v1.48.5 

func (s *ReplicationAlreadyExists) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ReplicationAlreadyExists) RequestID added in v1.48.5 

func (s *ReplicationAlreadyExists) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ReplicationAlreadyExists) StatusCode added in v1.48.5 

func (s *ReplicationAlreadyExists) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ReplicationAlreadyExists) String added in v1.48.5 

func (s ReplicationAlreadyExists) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ReplicationConfigurationDescription added in v1.42.41 

type ReplicationConfigurationDescription struct {

	// Describes when the replication configuration was created.
	//
	// CreationTime is a required field
	CreationTime *time.Time `type:"timestamp" required:"true"`

	// An array of destination objects. Only one destination object is supported.
	//
	// Destinations is a required field
	Destinations []*Destination `type:"list" required:"true"`

	// The Amazon Resource Name (ARN) of the original source EFS file system in
	// the replication configuration.
	//
	// OriginalSourceFileSystemArn is a required field
	OriginalSourceFileSystemArn *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the current source file system in the replication
	// configuration.
	//
	// SourceFileSystemArn is a required field
	SourceFileSystemArn *string `type:"string" required:"true"`

	// The ID of the source Amazon EFS file system that is being replicated.
	//
	// SourceFileSystemId is a required field
	SourceFileSystemId *string `type:"string" required:"true"`

	// The Amazon Web Services Region in which the source EFS file system is located.
	//
	// SourceFileSystemRegion is a required field
	SourceFileSystemRegion *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes the replication configuration for a specific file system.

func (ReplicationConfigurationDescription) GoString added in v1.42.41 

func (s ReplicationConfigurationDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReplicationConfigurationDescription) SetCreationTime added in v1.42.41 

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

SetCreationTime sets the CreationTime field's value.

func (*ReplicationConfigurationDescription) SetDestinations added in v1.42.41 

func (s *ReplicationConfigurationDescription) SetDestinations(v []*Destination) *ReplicationConfigurationDescription

SetDestinations sets the Destinations field's value.

func (*ReplicationConfigurationDescription) SetOriginalSourceFileSystemArn added in v1.42.41 

func (s *ReplicationConfigurationDescription) SetOriginalSourceFileSystemArn(v string) *ReplicationConfigurationDescription

SetOriginalSourceFileSystemArn sets the OriginalSourceFileSystemArn field's value.

func (*ReplicationConfigurationDescription) SetSourceFileSystemArn added in v1.42.41 

func (s *ReplicationConfigurationDescription) SetSourceFileSystemArn(v string) *ReplicationConfigurationDescription

SetSourceFileSystemArn sets the SourceFileSystemArn field's value.

func (*ReplicationConfigurationDescription) SetSourceFileSystemId added in v1.42.41 

func (s *ReplicationConfigurationDescription) SetSourceFileSystemId(v string) *ReplicationConfigurationDescription

SetSourceFileSystemId sets the SourceFileSystemId field's value.

func (*ReplicationConfigurationDescription) SetSourceFileSystemRegion added in v1.42.41 

func (s *ReplicationConfigurationDescription) SetSourceFileSystemRegion(v string) *ReplicationConfigurationDescription

SetSourceFileSystemRegion sets the SourceFileSystemRegion field's value.

func (ReplicationConfigurationDescription) String added in v1.42.41 

func (s ReplicationConfigurationDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ReplicationNotFound added in v1.42.41 

type ReplicationNotFound struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// ReplicationNotFound
	ErrorCode *string `min:"1" type:"string"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if the specified file system does not have a replication configuration.

func (*ReplicationNotFound) Code added in v1.42.41 

func (s *ReplicationNotFound) Code() string

Code returns the exception type name.

func (*ReplicationNotFound) Error added in v1.42.41 

func (s *ReplicationNotFound) Error() string

func (ReplicationNotFound) GoString added in v1.42.41 

func (s ReplicationNotFound) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReplicationNotFound) Message added in v1.42.41 

func (s *ReplicationNotFound) Message() string

Message returns the exception's message.

func (*ReplicationNotFound) OrigErr added in v1.42.41 

func (s *ReplicationNotFound) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ReplicationNotFound) RequestID added in v1.42.41 

func (s *ReplicationNotFound) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ReplicationNotFound) StatusCode added in v1.42.41 

func (s *ReplicationNotFound) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ReplicationNotFound) String added in v1.42.41 

func (s ReplicationNotFound) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceIdPreference added in v1.38.45 

type ResourceIdPreference struct {

	// Identifies the EFS resource ID preference, either LONG_ID (17 characters)
	// or SHORT_ID (8 characters).
	ResourceIdType *string `type:"string" enum:"ResourceIdType"`

	// Identifies the Amazon EFS resources to which the ID preference setting applies,
	// FILE_SYSTEM and MOUNT_TARGET.
	Resources []*string `type:"list" enum:"Resource"`
	// contains filtered or unexported fields
}

Describes the resource type and its ID preference for the user's Amazon Web Services account, in the current Amazon Web Services Region.

func (ResourceIdPreference) GoString added in v1.38.45 

func (s ResourceIdPreference) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceIdPreference) SetResourceIdType added in v1.38.45 

func (s *ResourceIdPreference) SetResourceIdType(v string) *ResourceIdPreference

SetResourceIdType sets the ResourceIdType field's value.

func (*ResourceIdPreference) SetResources added in v1.38.45 

func (s *ResourceIdPreference) SetResources(v []*string) *ResourceIdPreference

SetResources sets the Resources field's value.

func (ResourceIdPreference) String added in v1.38.45 

func (s ResourceIdPreference) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RootDirectory added in v1.28.1 

type RootDirectory struct {

	// (Optional) Specifies the POSIX IDs and permissions to apply to the access
	// point's RootDirectory. If the RootDirectory > Path specified does not exist,
	// EFS creates the root directory using the CreationInfo settings when a client
	// connects to an access point. When specifying the CreationInfo, you must provide
	// values for all properties.
	//
	// If you do not provide CreationInfo and the specified RootDirectory > Path
	// does not exist, attempts to mount the file system using the access point
	// will fail.
	CreationInfo *CreationInfo `type:"structure"`

	// Specifies the path on the EFS file system to expose as the root directory
	// to NFS clients using the access point to access the EFS file system. A path
	// can have up to four subdirectories. If the specified path does not exist,
	// you are required to provide the CreationInfo.
	Path *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Specifies the directory on the Amazon EFS file system that the access point provides access to. The access point exposes the specified file system path as the root directory of your file system to applications using the access point. NFS clients using the access point can only access data in the access point's RootDirectory and it's subdirectories.

func (RootDirectory) GoString added in v1.28.1 

func (s RootDirectory) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RootDirectory) SetCreationInfo added in v1.28.1 

func (s *RootDirectory) SetCreationInfo(v *CreationInfo) *RootDirectory

SetCreationInfo sets the CreationInfo field's value.

func (*RootDirectory) SetPath added in v1.28.1 

func (s *RootDirectory) SetPath(v string) *RootDirectory

SetPath sets the Path field's value.

func (RootDirectory) String added in v1.28.1 

func (s RootDirectory) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RootDirectory) Validate added in v1.28.1 

func (s *RootDirectory) Validate() error

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

type SecurityGroupLimitExceeded added in v1.28.0 

type SecurityGroupLimitExceeded struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	//
	// ErrorCode is a required field
	ErrorCode *string `min:"1" type:"string" required:"true"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if the size of SecurityGroups specified in the request is greater than five.

func (*SecurityGroupLimitExceeded) Code added in v1.28.0 

func (s *SecurityGroupLimitExceeded) Code() string

Code returns the exception type name.

func (*SecurityGroupLimitExceeded) Error added in v1.28.0 

func (s *SecurityGroupLimitExceeded) Error() string

func (SecurityGroupLimitExceeded) GoString added in v1.28.0 

func (s SecurityGroupLimitExceeded) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SecurityGroupLimitExceeded) Message added in v1.28.0 

func (s *SecurityGroupLimitExceeded) Message() string

Message returns the exception's message.

func (*SecurityGroupLimitExceeded) OrigErr added in v1.28.0 

func (s *SecurityGroupLimitExceeded) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*SecurityGroupLimitExceeded) RequestID added in v1.28.0 

func (s *SecurityGroupLimitExceeded) RequestID() string

RequestID returns the service's response RequestID for request.

func (*SecurityGroupLimitExceeded) StatusCode added in v1.28.0 

func (s *SecurityGroupLimitExceeded) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (SecurityGroupLimitExceeded) String added in v1.28.0 

func (s SecurityGroupLimitExceeded) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SecurityGroupNotFound added in v1.28.0 

type SecurityGroupNotFound struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	//
	// ErrorCode is a required field
	ErrorCode *string `min:"1" type:"string" required:"true"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if one of the specified security groups doesn't exist in the subnet's virtual private cloud (VPC).

func (*SecurityGroupNotFound) Code added in v1.28.0 

func (s *SecurityGroupNotFound) Code() string

Code returns the exception type name.

func (*SecurityGroupNotFound) Error added in v1.28.0 

func (s *SecurityGroupNotFound) Error() string

func (SecurityGroupNotFound) GoString added in v1.28.0 

func (s SecurityGroupNotFound) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SecurityGroupNotFound) Message added in v1.28.0 

func (s *SecurityGroupNotFound) Message() string

Message returns the exception's message.

func (*SecurityGroupNotFound) OrigErr added in v1.28.0 

func (s *SecurityGroupNotFound) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*SecurityGroupNotFound) RequestID added in v1.28.0 

func (s *SecurityGroupNotFound) RequestID() string

RequestID returns the service's response RequestID for request.

func (*SecurityGroupNotFound) StatusCode added in v1.28.0 

func (s *SecurityGroupNotFound) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (SecurityGroupNotFound) String added in v1.28.0 

func (s SecurityGroupNotFound) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SubnetNotFound added in v1.28.0 

type SubnetNotFound struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	//
	// ErrorCode is a required field
	ErrorCode *string `min:"1" type:"string" required:"true"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if there is no subnet with ID SubnetId provided in the request.

func (*SubnetNotFound) Code added in v1.28.0 

func (s *SubnetNotFound) Code() string

Code returns the exception type name.

func (*SubnetNotFound) Error added in v1.28.0 

func (s *SubnetNotFound) Error() string

func (SubnetNotFound) GoString added in v1.28.0 

func (s SubnetNotFound) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SubnetNotFound) Message added in v1.28.0 

func (s *SubnetNotFound) Message() string

Message returns the exception's message.

func (*SubnetNotFound) OrigErr added in v1.28.0 

func (s *SubnetNotFound) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*SubnetNotFound) RequestID added in v1.28.0 

func (s *SubnetNotFound) RequestID() string

RequestID returns the service's response RequestID for request.

func (*SubnetNotFound) StatusCode added in v1.28.0 

func (s *SubnetNotFound) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (SubnetNotFound) String added in v1.28.0 

func (s SubnetNotFound) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Tag 

type Tag struct {

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

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

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

func (Tag) GoString added in v0.6.5 

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey added in v1.5.0 

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

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.5.0 

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

SetValue sets the Value field's value.

func (Tag) String added in v0.6.5 

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate added in v1.1.21 

func (s *Tag) Validate() error

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

type TagResourceInput added in v1.28.1 

type TagResourceInput struct {

	// The ID specifying the EFS resource that you want to create a tag for.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"ResourceId" type:"string" required:"true"`

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

func (TagResourceInput) GoString added in v1.28.1 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceId added in v1.28.1 

func (s *TagResourceInput) SetResourceId(v string) *TagResourceInput

SetResourceId sets the ResourceId field's value.

func (*TagResourceInput) SetTags added in v1.28.1 

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

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.28.1 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate added in v1.28.1 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v1.28.1 

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

func (TagResourceOutput) GoString added in v1.28.1 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String added in v1.28.1 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException added in v1.43.38 

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	ErrorCode *string `min:"1" type:"string"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned when the CreateAccessPoint API action is called too quickly and the number of Access Points on the file system is nearing the limit of 120 (https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region).

func (*ThrottlingException) Code added in v1.43.38 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error added in v1.43.38 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString added in v1.43.38 

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message added in v1.43.38 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr added in v1.43.38 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID added in v1.43.38 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode added in v1.43.38 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String added in v1.43.38 

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThroughputLimitExceeded added in v1.28.0 

type ThroughputLimitExceeded struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	//
	// ErrorCode is a required field
	ErrorCode *string `min:"1" type:"string" required:"true"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if the throughput mode or amount of provisioned throughput can't be changed because the throughput limit of 1024 MiB/s has been reached.

func (*ThroughputLimitExceeded) Code added in v1.28.0 

func (s *ThroughputLimitExceeded) Code() string

Code returns the exception type name.

func (*ThroughputLimitExceeded) Error added in v1.28.0 

func (s *ThroughputLimitExceeded) Error() string

func (ThroughputLimitExceeded) GoString added in v1.28.0 

func (s ThroughputLimitExceeded) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThroughputLimitExceeded) Message added in v1.28.0 

func (s *ThroughputLimitExceeded) Message() string

Message returns the exception's message.

func (*ThroughputLimitExceeded) OrigErr added in v1.28.0 

func (s *ThroughputLimitExceeded) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThroughputLimitExceeded) RequestID added in v1.28.0 

func (s *ThroughputLimitExceeded) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThroughputLimitExceeded) StatusCode added in v1.28.0 

func (s *ThroughputLimitExceeded) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThroughputLimitExceeded) String added in v1.28.0 

func (s ThroughputLimitExceeded) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TooManyRequests added in v1.28.0 

type TooManyRequests struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	//
	// ErrorCode is a required field
	ErrorCode *string `min:"1" type:"string" required:"true"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if you don’t wait at least 24 hours before either changing the throughput mode, or decreasing the Provisioned Throughput value.

func (*TooManyRequests) Code added in v1.28.0 

func (s *TooManyRequests) Code() string

Code returns the exception type name.

func (*TooManyRequests) Error added in v1.28.0 

func (s *TooManyRequests) Error() string

func (TooManyRequests) GoString added in v1.28.0 

func (s TooManyRequests) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TooManyRequests) Message added in v1.28.0 

func (s *TooManyRequests) Message() string

Message returns the exception's message.

func (*TooManyRequests) OrigErr added in v1.28.0 

func (s *TooManyRequests) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyRequests) RequestID added in v1.28.0 

func (s *TooManyRequests) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyRequests) StatusCode added in v1.28.0 

func (s *TooManyRequests) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TooManyRequests) String added in v1.28.0 

func (s TooManyRequests) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnsupportedAvailabilityZone added in v1.28.0 

type UnsupportedAvailabilityZone struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	//
	// ErrorCode is a required field
	ErrorCode *string `min:"1" type:"string" required:"true"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.

func (*UnsupportedAvailabilityZone) Code added in v1.28.0 

func (s *UnsupportedAvailabilityZone) Code() string

Code returns the exception type name.

func (*UnsupportedAvailabilityZone) Error added in v1.28.0 

func (s *UnsupportedAvailabilityZone) Error() string

func (UnsupportedAvailabilityZone) GoString added in v1.28.0 

func (s UnsupportedAvailabilityZone) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnsupportedAvailabilityZone) Message added in v1.28.0 

func (s *UnsupportedAvailabilityZone) Message() string

Message returns the exception's message.

func (*UnsupportedAvailabilityZone) OrigErr added in v1.28.0 

func (s *UnsupportedAvailabilityZone) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnsupportedAvailabilityZone) RequestID added in v1.28.0 

func (s *UnsupportedAvailabilityZone) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnsupportedAvailabilityZone) StatusCode added in v1.28.0 

func (s *UnsupportedAvailabilityZone) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnsupportedAvailabilityZone) String added in v1.28.0 

func (s UnsupportedAvailabilityZone) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput added in v1.28.1 

type UntagResourceInput struct {

	// Specifies the EFS resource that you want to remove tags from.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"ResourceId" type:"string" required:"true"`

	// The keys of the key-value tag pairs that you want to remove from the specified
	// EFS resource.
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.28.1 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceId added in v1.28.1 

func (s *UntagResourceInput) SetResourceId(v string) *UntagResourceInput

SetResourceId sets the ResourceId field's value.

func (*UntagResourceInput) SetTagKeys added in v1.28.1 

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

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.28.1 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate added in v1.28.1 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v1.28.1 

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

func (UntagResourceOutput) GoString added in v1.28.1 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String added in v1.28.1 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateFileSystemInput added in v1.14.26 

type UpdateFileSystemInput struct {

	// The ID of the file system that you want to update.
	//
	// FileSystemId is a required field
	FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`

	// (Optional) The throughput, measured in mebibytes per second (MiBps), that
	// you want to provision for a file system that you're creating. Required if
	// ThroughputMode is set to provisioned. Valid values are 1-3414 MiBps, with
	// the upper limit depending on Region. To increase this limit, contact Amazon
	// Web Services Support. For more information, see Amazon EFS quotas that you
	// can increase (https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits)
	// in the Amazon EFS User Guide.
	ProvisionedThroughputInMibps *float64 `min:"1" type:"double"`

	// (Optional) Updates the file system's throughput mode. If you're not updating
	// your throughput mode, you don't need to provide this value in your request.
	// If you are changing the ThroughputMode to provisioned, you must also set
	// a value for ProvisionedThroughputInMibps.
	ThroughputMode *string `type:"string" enum:"ThroughputMode"`
	// contains filtered or unexported fields
}

func (UpdateFileSystemInput) GoString added in v1.14.26 

func (s UpdateFileSystemInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFileSystemInput) SetFileSystemId added in v1.14.26 

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

SetFileSystemId sets the FileSystemId field's value.

func (*UpdateFileSystemInput) SetProvisionedThroughputInMibps added in v1.14.26 

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

SetProvisionedThroughputInMibps sets the ProvisionedThroughputInMibps field's value.

func (*UpdateFileSystemInput) SetThroughputMode added in v1.14.26 

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

SetThroughputMode sets the ThroughputMode field's value.

func (UpdateFileSystemInput) String added in v1.14.26 

func (s UpdateFileSystemInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFileSystemInput) Validate added in v1.14.26 

func (s *UpdateFileSystemInput) Validate() error

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

type UpdateFileSystemOutput added in v1.14.26 

type UpdateFileSystemOutput struct {

	// The unique and consistent identifier of the Availability Zone in which the
	// file system is located, and is valid only for One Zone file systems. For
	// example, use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web
	// Services Region, and it has the same location in every Amazon Web Services
	// account.
	AvailabilityZoneId *string `type:"string"`

	// Describes the Amazon Web Services Availability Zone in which the file system
	// is located, and is valid only for One Zone file systems. For more information,
	// see Using EFS storage classes (https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html)
	// in the Amazon EFS User Guide.
	AvailabilityZoneName *string `min:"1" type:"string"`

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

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

	// A Boolean value that, if true, indicates that the file system is encrypted.
	Encrypted *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) for the EFS file system, in the format arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id
	// . Example with sample data: arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567
	FileSystemArn *string `type:"string"`

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

	// Describes the protection on the file system.
	FileSystemProtection *FileSystemProtectionDescription `type:"structure"`

	// The ID of an KMS key used to protect the encrypted file system.
	KmsKeyId *string `type:"string"`

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

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

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

	// The Amazon Web Services account that created the file system.
	//
	// OwnerId is a required field
	OwnerId *string `type:"string" required:"true"`

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

	// The amount of provisioned throughput, measured in MiBps, for the file system.
	// Valid for file systems using ThroughputMode set to provisioned.
	ProvisionedThroughputInMibps *float64 `min:"1" type:"double"`

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

	// The tags associated with the file system, presented as an array of Tag objects.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`

	// Displays the file system's throughput mode. For more information, see Throughput
	// modes (https://docs.aws.amazon.com/efs/latest/ug/performance.html#throughput-modes)
	// in the Amazon EFS User Guide.
	ThroughputMode *string `type:"string" enum:"ThroughputMode"`
	// contains filtered or unexported fields
}

A description of the file system.

func (UpdateFileSystemOutput) GoString added in v1.14.26 

func (s UpdateFileSystemOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFileSystemOutput) SetAvailabilityZoneId added in v1.37.27 

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

SetAvailabilityZoneId sets the AvailabilityZoneId field's value.

func (*UpdateFileSystemOutput) SetAvailabilityZoneName added in v1.37.27 

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

SetAvailabilityZoneName sets the AvailabilityZoneName field's value.

func (*UpdateFileSystemOutput) SetCreationTime added in v1.14.26 

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

SetCreationTime sets the CreationTime field's value.

func (*UpdateFileSystemOutput) SetCreationToken added in v1.14.26 

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

SetCreationToken sets the CreationToken field's value.

func (*UpdateFileSystemOutput) SetEncrypted added in v1.14.26 

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

SetEncrypted sets the Encrypted field's value.

func (*UpdateFileSystemOutput) SetFileSystemArn added in v1.33.3 

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

SetFileSystemArn sets the FileSystemArn field's value.

func (*UpdateFileSystemOutput) SetFileSystemId added in v1.14.26 

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

SetFileSystemId sets the FileSystemId field's value.

func (*UpdateFileSystemOutput) SetFileSystemProtection added in v1.48.5 

func (s *UpdateFileSystemOutput) SetFileSystemProtection(v *FileSystemProtectionDescription) *UpdateFileSystemOutput

SetFileSystemProtection sets the FileSystemProtection field's value.

func (*UpdateFileSystemOutput) SetKmsKeyId added in v1.14.26 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*UpdateFileSystemOutput) SetLifeCycleState added in v1.14.26 

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

SetLifeCycleState sets the LifeCycleState field's value.

func (*UpdateFileSystemOutput) SetName added in v1.14.26 

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

SetName sets the Name field's value.

func (*UpdateFileSystemOutput) SetNumberOfMountTargets added in v1.14.26 

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

SetNumberOfMountTargets sets the NumberOfMountTargets field's value.

func (*UpdateFileSystemOutput) SetOwnerId added in v1.14.26 

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

SetOwnerId sets the OwnerId field's value.

func (*UpdateFileSystemOutput) SetPerformanceMode added in v1.14.26 

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

SetPerformanceMode sets the PerformanceMode field's value.

func (*UpdateFileSystemOutput) SetProvisionedThroughputInMibps added in v1.14.26 

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

SetProvisionedThroughputInMibps sets the ProvisionedThroughputInMibps field's value.

func (*UpdateFileSystemOutput) SetSizeInBytes added in v1.14.26 

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

SetSizeInBytes sets the SizeInBytes field's value.

func (*UpdateFileSystemOutput) SetTags added in v1.17.1 

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

SetTags sets the Tags field's value.

func (*UpdateFileSystemOutput) SetThroughputMode added in v1.14.26 

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

SetThroughputMode sets the ThroughputMode field's value.

func (UpdateFileSystemOutput) String added in v1.14.26 

func (s UpdateFileSystemOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateFileSystemProtectionInput added in v1.48.5 

type UpdateFileSystemProtectionInput struct {

	// The ID of the file system to update.
	//
	// FileSystemId is a required field
	FileSystemId *string `location:"uri" locationName:"FileSystemId" type:"string" required:"true"`

	// The status of the file system's replication overwrite protection.
	//
	//    * ENABLED – The file system cannot be used as the destination file system
	//    in a replication configuration. The file system is writeable. Replication
	//    overwrite protection is ENABLED by default.
	//
	//    * DISABLED – The file system can be used as the destination file system
	//    in a replication configuration. The file system is read-only and can only
	//    be modified by EFS replication.
	//
	//    * REPLICATING – The file system is being used as the destination file
	//    system in a replication configuration. The file system is read-only and
	//    is only modified only by EFS replication.
	//
	// If the replication configuration is deleted, the file system's replication
	// overwrite protection is re-enabled, the file system becomes writeable.
	ReplicationOverwriteProtection *string `type:"string" enum:"ReplicationOverwriteProtection"`
	// contains filtered or unexported fields
}

func (UpdateFileSystemProtectionInput) GoString added in v1.48.5 

func (s UpdateFileSystemProtectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFileSystemProtectionInput) SetFileSystemId added in v1.48.5 

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

SetFileSystemId sets the FileSystemId field's value.

func (*UpdateFileSystemProtectionInput) SetReplicationOverwriteProtection added in v1.48.5 

func (s *UpdateFileSystemProtectionInput) SetReplicationOverwriteProtection(v string) *UpdateFileSystemProtectionInput

SetReplicationOverwriteProtection sets the ReplicationOverwriteProtection field's value.

func (UpdateFileSystemProtectionInput) String added in v1.48.5 

func (s UpdateFileSystemProtectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFileSystemProtectionInput) Validate added in v1.48.5 

func (s *UpdateFileSystemProtectionInput) Validate() error

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

type UpdateFileSystemProtectionOutput added in v1.48.5 

type UpdateFileSystemProtectionOutput struct {

	// The status of the file system's replication overwrite protection.
	//
	//    * ENABLED – The file system cannot be used as the destination file system
	//    in a replication configuration. The file system is writeable. Replication
	//    overwrite protection is ENABLED by default.
	//
	//    * DISABLED – The file system can be used as the destination file system
	//    in a replication configuration. The file system is read-only and can only
	//    be modified by EFS replication.
	//
	//    * REPLICATING – The file system is being used as the destination file
	//    system in a replication configuration. The file system is read-only and
	//    is only modified only by EFS replication.
	//
	// If the replication configuration is deleted, the file system's replication
	// overwrite protection is re-enabled, the file system becomes writeable.
	ReplicationOverwriteProtection *string `type:"string" enum:"ReplicationOverwriteProtection"`
	// contains filtered or unexported fields
}

Describes the protection on a file system.

func (UpdateFileSystemProtectionOutput) GoString added in v1.48.5 

func (s UpdateFileSystemProtectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFileSystemProtectionOutput) SetReplicationOverwriteProtection added in v1.48.5 

func (s *UpdateFileSystemProtectionOutput) SetReplicationOverwriteProtection(v string) *UpdateFileSystemProtectionOutput

SetReplicationOverwriteProtection sets the ReplicationOverwriteProtection field's value.

func (UpdateFileSystemProtectionOutput) String added in v1.48.5 

func (s UpdateFileSystemProtectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException added in v1.33.3 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code is a string that uniquely identifies an error condition. It
	// is meant to be read and understood by programs that detect and handle errors
	// by type.
	//
	// ErrorCode is a required field
	ErrorCode *string `min:"1" type:"string" required:"true"`

	// The error message contains a generic description of the error condition in
	// English. It is intended for a human audience. Simple programs display the
	// message directly to the end user if they encounter an error condition they
	// don't know how or don't care to handle. Sophisticated programs with more
	// exhaustive error handling and proper internationalization are more likely
	// to ignore the error message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.

func (*ValidationException) Code added in v1.33.3 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error added in v1.33.3 

func (s *ValidationException) Error() string

func (ValidationException) GoString added in v1.33.3 

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message added in v1.33.3 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr added in v1.33.3 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID added in v1.33.3 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode added in v1.33.3 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String added in v1.33.3 

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.