Network.AWS.EFS

Amazon Elastic File System

See: AWS API Reference

Service Configuration

eFS :: Service

API version '2015-02-01' of the Amazon Elastic File System SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by EFS.

MountTargetNotFound

_MountTargetNotFound :: AsError a => Getting (First ServiceError) a ServiceError

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

SecurityGroupLimitExceeded

_SecurityGroupLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError

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

SecurityGroupNotFound

_SecurityGroupNotFound :: AsError a => Getting (First ServiceError) a ServiceError

Returned if one of the specified security groups does not exist in the subnet's VPC.

MountTargetConflict

_MountTargetConflict :: AsError a => Getting (First ServiceError) a ServiceError

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

UnsupportedAvailabilityZone

_UnsupportedAvailabilityZone :: AsError a => Getting (First ServiceError) a ServiceError

Prism for UnsupportedAvailabilityZone' errors.

FileSystemLimitExceeded

_FileSystemLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError

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

NetworkInterfaceLimitExceeded

_NetworkInterfaceLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError

The calling account has reached the ENI limit for the specific AWS region. Client should try to delete some ENIs or get its account limit raised. For more information, go to Amazon VPC Limits in the Amazon Virtual Private Cloud User Guide (see the Network interfaces per VPC entry in the table).

FileSystemAlreadyExists

_FileSystemAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError

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

SubnetNotFound

_SubnetNotFound :: AsError a => Getting (First ServiceError) a ServiceError

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

FileSystemNotFound

_FileSystemNotFound :: AsError a => Getting (First ServiceError) a ServiceError

Returned if the specified FileSystemId does not exist in the requester's AWS account.

IncorrectFileSystemLifeCycleState

_IncorrectFileSystemLifeCycleState :: AsError a => Getting (First ServiceError) a ServiceError

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

BadRequest

_BadRequest :: AsError a => Getting (First ServiceError) a ServiceError

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

NoFreeAddressesInSubnet

_NoFreeAddressesInSubnet :: AsError a => Getting (First ServiceError) a ServiceError

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

DependencyTimeout

_DependencyTimeout :: AsError a => Getting (First ServiceError) a ServiceError

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

FileSystemInUse

_FileSystemInUse :: AsError a => Getting (First ServiceError) a ServiceError

Returned if a file system has mount targets.

IncorrectMountTargetState

_IncorrectMountTargetState :: AsError a => Getting (First ServiceError) a ServiceError

Returned if the mount target is not in the correct state for the operation.

InternalServerError

_InternalServerError :: AsError a => Getting (First ServiceError) a ServiceError

Returned if an error occurred on the server side.

IPAddressInUse

_IPAddressInUse :: AsError a => Getting (First ServiceError) a ServiceError

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

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

DescribeTags

module Network.AWS.EFS.DescribeTags

DescribeMountTargets

module Network.AWS.EFS.DescribeMountTargets

DescribeFileSystems

module Network.AWS.EFS.DescribeFileSystems

DeleteMountTarget

module Network.AWS.EFS.DeleteMountTarget

CreateTags

module Network.AWS.EFS.CreateTags

DeleteTags

module Network.AWS.EFS.DeleteTags

DescribeMountTargetSecurityGroups

module Network.AWS.EFS.DescribeMountTargetSecurityGroups

ModifyMountTargetSecurityGroups

module Network.AWS.EFS.ModifyMountTargetSecurityGroups

CreateFileSystem

module Network.AWS.EFS.CreateFileSystem

DeleteFileSystem

module Network.AWS.EFS.DeleteFileSystem

CreateMountTarget

module Network.AWS.EFS.CreateMountTarget

Types

LifeCycleState

data LifeCycleState

Constructors

Available

Creating

Deleted

Deleting

Instances

Enum LifeCycleState

Eq LifeCycleState

Data LifeCycleState

Ord LifeCycleState

Read LifeCycleState

Show LifeCycleState

Generic LifeCycleState

FromJSON LifeCycleState

Hashable LifeCycleState

ToHeader LifeCycleState

ToQuery LifeCycleState

ToByteString LifeCycleState

FromText LifeCycleState

ToText LifeCycleState

type Rep LifeCycleState

FileSystemDescription

data FileSystemDescription

This object provides description of a file system.

See: fileSystemDescription smart constructor.

Instances

Eq FileSystemDescription

Data FileSystemDescription

Read FileSystemDescription

Show FileSystemDescription

Generic FileSystemDescription

FromJSON FileSystemDescription

type Rep FileSystemDescription

fileSystemDescription

Arguments

:: Text

fsdOwnerId

-> Text

fsdCreationToken

-> Text

fsdFileSystemId

-> UTCTime

fsdCreationTime

-> LifeCycleState

fsdLifeCycleState

-> Natural

fsdNumberOfMountTargets

-> FileSystemSize

fsdSizeInBytes

-> FileSystemDescription

Creates a value of FileSystemDescription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• fsdName
• fsdOwnerId
• fsdCreationToken
• fsdFileSystemId
• fsdCreationTime
• fsdLifeCycleState
• fsdNumberOfMountTargets
• fsdSizeInBytes

fsdName :: Lens' FileSystemDescription (Maybe Text)

You can add tags to a file system (see CreateTags) including a "Name" tag. If the file system has a "Name" tag, Amazon EFS returns the value in this field.

fsdOwnerId :: Lens' FileSystemDescription Text

The AWS account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.

fsdCreationToken :: Lens' FileSystemDescription Text

Opaque string specified in the request.

fsdFileSystemId :: Lens' FileSystemDescription Text

The file system ID assigned by Amazon EFS.

fsdCreationTime :: Lens' FileSystemDescription UTCTime

The time at which the file system was created, in seconds, since 1970-01-01T00:00:00Z.

fsdLifeCycleState :: Lens' FileSystemDescription LifeCycleState

A predefined string value that indicates the lifecycle phase of the file system.

fsdNumberOfMountTargets :: Lens' FileSystemDescription Natural

The current number of mount targets (see CreateMountTarget) the file system has.

fsdSizeInBytes :: Lens' FileSystemDescription FileSystemSize

This object provides the latest known metered size of data stored in the file system, in bytes, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. Note that the value does not represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, the value will represent actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size the file system was at any instant in time.

FileSystemSize

data FileSystemSize

This object provides 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. Note that the value does not represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, the value will represent the actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not necessarily the exact size the file system was at any instant in time.

See: fileSystemSize smart constructor.

Instances

Eq FileSystemSize

Data FileSystemSize

Read FileSystemSize

Show FileSystemSize

Generic FileSystemSize

FromJSON FileSystemSize

type Rep FileSystemSize

fileSystemSize

Arguments

:: Natural

fssValue

-> FileSystemSize

Creates a value of FileSystemSize with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• fssTimestamp
• fssValue

fssTimestamp :: Lens' FileSystemSize (Maybe UTCTime)

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.

fssValue :: Lens' FileSystemSize Natural

The latest known metered size, in bytes, of data stored in the file system.

MountTargetDescription

data MountTargetDescription

This object provides description of a mount target.

See: mountTargetDescription smart constructor.

Instances

Eq MountTargetDescription

Data MountTargetDescription

Read MountTargetDescription

Show MountTargetDescription

Generic MountTargetDescription

FromJSON MountTargetDescription

type Rep MountTargetDescription

mountTargetDescription

Arguments

:: Text

mtdMountTargetId

-> Text

mtdFileSystemId

-> Text

mtdSubnetId

-> LifeCycleState

mtdLifeCycleState

-> MountTargetDescription

Creates a value of MountTargetDescription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• mtdIPAddress
• mtdNetworkInterfaceId
• mtdOwnerId
• mtdMountTargetId
• mtdFileSystemId
• mtdSubnetId
• mtdLifeCycleState

mtdIPAddress :: Lens' MountTargetDescription (Maybe Text)

The address at which the file system may be mounted via the mount target.

mtdNetworkInterfaceId :: Lens' MountTargetDescription (Maybe Text)

The ID of the network interface that Amazon EFS created when it created the mount target.

mtdOwnerId :: Lens' MountTargetDescription (Maybe Text)

The AWS account ID that owns the resource.

mtdMountTargetId :: Lens' MountTargetDescription Text

The system-assigned mount target ID.

mtdFileSystemId :: Lens' MountTargetDescription Text

The ID of the file system for which the mount target is intended.

mtdSubnetId :: Lens' MountTargetDescription Text

The ID of the subnet that the mount target is in.

mtdLifeCycleState :: Lens' MountTargetDescription LifeCycleState

The lifecycle state the mount target is in.

Tag

data Tag

A tag is a pair of key and value. The allowed characters in keys and values are letters, whitespace, and numbers, representable in UTF-8, and the characters '+', '-', '=', '.', '_', ':', and '/'.

See: tag smart constructor.

Instances

Eq Tag

Data Tag

Read Tag

Show Tag

Generic Tag

ToJSON Tag

FromJSON Tag

type Rep Tag

tag

Arguments

:: Text

tagKey

-> Text

tagValue

-> Tag

Creates a value of Tag with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• tagKey
• tagValue

tagKey :: Lens' Tag Text

Tag key, a string. The key must not start with "aws:".

tagValue :: Lens' Tag Text

Value of the tag key.