amazonka-efs-1.6.1: Amazon Elastic File System SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.EFS.DescribeFileSystems

Contents

Description

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.

Synopsis

Creating a Request

describeFileSystems :: DescribeFileSystems Source #

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 Source #

See: describeFileSystems smart constructor.

Instances
Eq DescribeFileSystems Source # 
Instance details

Defined in Network.AWS.EFS.DescribeFileSystems

Data DescribeFileSystems Source # 
Instance details

Defined in Network.AWS.EFS.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 Source # 
Instance details

Defined in Network.AWS.EFS.DescribeFileSystems

Show DescribeFileSystems Source # 
Instance details

Defined in Network.AWS.EFS.DescribeFileSystems

Generic DescribeFileSystems Source # 
Instance details

Defined in Network.AWS.EFS.DescribeFileSystems

Associated Types

type Rep DescribeFileSystems :: Type -> Type #

Hashable DescribeFileSystems Source # 
Instance details

Defined in Network.AWS.EFS.DescribeFileSystems

AWSPager DescribeFileSystems Source # 
Instance details

Defined in Network.AWS.EFS.DescribeFileSystems

AWSRequest DescribeFileSystems Source # 
Instance details

Defined in Network.AWS.EFS.DescribeFileSystems

Associated Types

type Rs DescribeFileSystems :: Type #

ToHeaders DescribeFileSystems Source # 
Instance details

Defined in Network.AWS.EFS.DescribeFileSystems

ToPath DescribeFileSystems Source # 
Instance details

Defined in Network.AWS.EFS.DescribeFileSystems

ToQuery DescribeFileSystems Source # 
Instance details

Defined in Network.AWS.EFS.DescribeFileSystems

NFData DescribeFileSystems Source # 
Instance details

Defined in Network.AWS.EFS.DescribeFileSystems

Methods

rnf :: DescribeFileSystems -> () #

type Rep DescribeFileSystems Source # 
Instance details

Defined in Network.AWS.EFS.DescribeFileSystems

type Rep DescribeFileSystems = D1 (MetaData "DescribeFileSystems" "Network.AWS.EFS.DescribeFileSystems" "amazonka-efs-1.6.1-Id3YwDdTidaJIkjyChst47" False) (C1 (MetaCons "DescribeFileSystems'" PrefixI True) ((S1 (MetaSel (Just "_dfsFileSystemId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dfsCreationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_dfsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dfsMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))))
type Rs DescribeFileSystems Source # 
Instance details

Defined in Network.AWS.EFS.DescribeFileSystems

Request Lenses

dfsFileSystemId :: Lens' DescribeFileSystems (Maybe Text) Source #

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

dfsCreationToken :: Lens' DescribeFileSystems (Maybe Text) Source #

(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) Source #

(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) Source #

(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 Source #

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 Source #

See: describeFileSystemsResponse smart constructor.

Instances
Eq DescribeFileSystemsResponse Source # 
Instance details

Defined in Network.AWS.EFS.DescribeFileSystems

Data DescribeFileSystemsResponse Source # 
Instance details

Defined in Network.AWS.EFS.DescribeFileSystems

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 Source # 
Instance details

Defined in Network.AWS.EFS.DescribeFileSystems

Show DescribeFileSystemsResponse Source # 
Instance details

Defined in Network.AWS.EFS.DescribeFileSystems

Generic DescribeFileSystemsResponse Source # 
Instance details

Defined in Network.AWS.EFS.DescribeFileSystems

Associated Types

type Rep DescribeFileSystemsResponse :: Type -> Type #

NFData DescribeFileSystemsResponse Source # 
Instance details

Defined in Network.AWS.EFS.DescribeFileSystems

type Rep DescribeFileSystemsResponse Source # 
Instance details

Defined in Network.AWS.EFS.DescribeFileSystems

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

Response Lenses

dfsrsMarker :: Lens' DescribeFileSystemsResponse (Maybe Text) Source #

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

dfsrsNextMarker :: Lens' DescribeFileSystemsResponse (Maybe Text) Source #

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.