Network.AWS.EFS.DescribeFileSystems

Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided. Otherwise, it returns descriptions of all file systems owned by the caller's AWS account in the AWS Region of the endpoint that you're calling.

When retrieving all file system descriptions, you can optionally specify the MaxItems parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon EFS returns a NextMarker , an opaque token, in the response. In this case, you should send a subsequent request with the Marker request parameter set to the value of NextMarker .

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

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

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

This operation requires permissions for the elasticfilesystem:DescribeFileSystems action.

This operation returns paginated results.

Creating a Request

describeFileSystems :: DescribeFileSystems

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

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

• dfsFileSystemId - (Optional) ID of the file system whose description you want to retrieve (String).
• dfsCreationToken - (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.
• dfsMarker - (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.
• dfsMaxItems - (Optional) Specifies the maximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon EFS returns is the minimum of the MaxItems parameter specified in the request and the service's internal maximum number of items per page.

data DescribeFileSystems

See: describeFileSystems smart constructor.

Instances

Eq DescribeFileSystems

Methods

(==) :: DescribeFileSystems -> DescribeFileSystems -> Bool

(/=) :: DescribeFileSystems -> DescribeFileSystems -> Bool

Data DescribeFileSystems

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeFileSystems -> c DescribeFileSystems

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeFileSystems

toConstr :: DescribeFileSystems -> Constr

dataTypeOf :: DescribeFileSystems -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeFileSystems)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeFileSystems)

gmapT :: (forall b. Data b => b -> b) -> DescribeFileSystems -> DescribeFileSystems

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeFileSystems -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeFileSystems -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeFileSystems -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeFileSystems -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeFileSystems -> m DescribeFileSystems

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeFileSystems -> m DescribeFileSystems

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeFileSystems -> m DescribeFileSystems

Read DescribeFileSystems

Methods

readsPrec :: Int -> ReadS DescribeFileSystems

readList :: ReadS [DescribeFileSystems]

readPrec :: ReadPrec DescribeFileSystems

readListPrec :: ReadPrec [DescribeFileSystems]

Show DescribeFileSystems

Methods

showsPrec :: Int -> DescribeFileSystems -> ShowS

show :: DescribeFileSystems -> String

showList :: [DescribeFileSystems] -> ShowS

Generic DescribeFileSystems

Associated Types

type Rep DescribeFileSystems :: * -> *

Methods

from :: DescribeFileSystems -> Rep DescribeFileSystems x

to :: Rep DescribeFileSystems x -> DescribeFileSystems

Hashable DescribeFileSystems

Methods

hashWithSalt :: Int -> DescribeFileSystems -> Int

hash :: DescribeFileSystems -> Int

NFData DescribeFileSystems

Methods

rnf :: DescribeFileSystems -> ()

AWSPager DescribeFileSystems

Methods

page :: DescribeFileSystems -> Rs DescribeFileSystems -> Maybe DescribeFileSystems

AWSRequest DescribeFileSystems

Associated Types

type Rs DescribeFileSystems :: *

Methods

request :: DescribeFileSystems -> Request DescribeFileSystems

response :: MonadResource m => Logger -> Service -> Proxy * DescribeFileSystems -> ClientResponse -> m (Response DescribeFileSystems)

ToQuery DescribeFileSystems

Methods

toQuery :: DescribeFileSystems -> QueryString

ToPath DescribeFileSystems

Methods

toPath :: DescribeFileSystems -> ByteString

ToHeaders DescribeFileSystems

Methods

toHeaders :: DescribeFileSystems -> [Header]

type Rep DescribeFileSystems

type Rep DescribeFileSystems = D1 (MetaData "DescribeFileSystems" "Network.AWS.EFS.DescribeFileSystems" "amazonka-efs-1.5.0-AGdA5NiO2mlIVVmSCQcc4J" False) (C1 (MetaCons "DescribeFileSystems'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dfsFileSystemId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dfsCreationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_dfsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dfsMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))))))

type Rs DescribeFileSystems

type Rs DescribeFileSystems = DescribeFileSystemsResponse

Request Lenses

dfsFileSystemId :: Lens' DescribeFileSystems (Maybe Text)

(Optional) ID of the file system whose description you want to retrieve (String).

dfsCreationToken :: Lens' DescribeFileSystems (Maybe Text)

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

dfsMarker :: Lens' DescribeFileSystems (Maybe Text)

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

dfsMaxItems :: Lens' DescribeFileSystems (Maybe Natural)

(Optional) Specifies the maximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon EFS returns is the minimum of the MaxItems parameter specified in the request and the service's internal maximum number of items per page.

Destructuring the Response

describeFileSystemsResponse

Arguments

:: Int

dfsrsResponseStatus

-> DescribeFileSystemsResponse

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

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

• dfsrsFileSystems - Array of file system descriptions.
• dfsrsMarker - Present if provided by caller in the request (String).
• dfsrsNextMarker - 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.
• dfsrsResponseStatus - -- | The response status code.

data DescribeFileSystemsResponse

See: describeFileSystemsResponse smart constructor.

Instances

Eq DescribeFileSystemsResponse

Methods

(==) :: DescribeFileSystemsResponse -> DescribeFileSystemsResponse -> Bool

(/=) :: DescribeFileSystemsResponse -> DescribeFileSystemsResponse -> Bool

Data DescribeFileSystemsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeFileSystemsResponse -> c DescribeFileSystemsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeFileSystemsResponse

toConstr :: DescribeFileSystemsResponse -> Constr

dataTypeOf :: DescribeFileSystemsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeFileSystemsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeFileSystemsResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeFileSystemsResponse -> DescribeFileSystemsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeFileSystemsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeFileSystemsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeFileSystemsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeFileSystemsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeFileSystemsResponse -> m DescribeFileSystemsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeFileSystemsResponse -> m DescribeFileSystemsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeFileSystemsResponse -> m DescribeFileSystemsResponse

Read DescribeFileSystemsResponse

Methods

readsPrec :: Int -> ReadS DescribeFileSystemsResponse

readList :: ReadS [DescribeFileSystemsResponse]

readPrec :: ReadPrec DescribeFileSystemsResponse

readListPrec :: ReadPrec [DescribeFileSystemsResponse]

Show DescribeFileSystemsResponse

Methods

showsPrec :: Int -> DescribeFileSystemsResponse -> ShowS

show :: DescribeFileSystemsResponse -> String

showList :: [DescribeFileSystemsResponse] -> ShowS

Generic DescribeFileSystemsResponse

Associated Types

type Rep DescribeFileSystemsResponse :: * -> *

Methods

from :: DescribeFileSystemsResponse -> Rep DescribeFileSystemsResponse x

to :: Rep DescribeFileSystemsResponse x -> DescribeFileSystemsResponse

NFData DescribeFileSystemsResponse

Methods

rnf :: DescribeFileSystemsResponse -> ()

type Rep DescribeFileSystemsResponse

type Rep DescribeFileSystemsResponse = D1 (MetaData "DescribeFileSystemsResponse" "Network.AWS.EFS.DescribeFileSystems" "amazonka-efs-1.5.0-AGdA5NiO2mlIVVmSCQcc4J" False) (C1 (MetaCons "DescribeFileSystemsResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dfsrsFileSystems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [FileSystemDescription]))) (S1 (MetaSel (Just Symbol "_dfsrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_dfsrsNextMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dfsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

dfsrsFileSystems :: Lens' DescribeFileSystemsResponse [FileSystemDescription]

Array of file system descriptions.

dfsrsMarker :: Lens' DescribeFileSystemsResponse (Maybe Text)

Present if provided by caller in the request (String).

dfsrsNextMarker :: Lens' DescribeFileSystemsResponse (Maybe Text)

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.

dfsrsResponseStatus :: Lens' DescribeFileSystemsResponse Int

• - | The response status code.