Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.EFS.DescribeFileSystems

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 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. Currently, this number is automatically set to 10. 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.

This operation returns paginated results.

Synopsis

data DescribeFileSystems = DescribeFileSystems' {
- fileSystemId :: Maybe Text
- creationToken :: Maybe Text
- marker :: Maybe Text
- maxItems :: Maybe Natural
}
newDescribeFileSystems :: DescribeFileSystems
describeFileSystems_fileSystemId :: Lens' DescribeFileSystems (Maybe Text)
describeFileSystems_creationToken :: Lens' DescribeFileSystems (Maybe Text)
describeFileSystems_marker :: Lens' DescribeFileSystems (Maybe Text)
describeFileSystems_maxItems :: Lens' DescribeFileSystems (Maybe Natural)
data DescribeFileSystemsResponse = DescribeFileSystemsResponse' {
- fileSystems :: Maybe [FileSystemDescription]
- marker :: Maybe Text
- nextMarker :: Maybe Text
- httpStatus :: Int
}
newDescribeFileSystemsResponse :: Int -> DescribeFileSystemsResponse
describeFileSystemsResponse_fileSystems :: Lens' DescribeFileSystemsResponse (Maybe [FileSystemDescription])
describeFileSystemsResponse_marker :: Lens' DescribeFileSystemsResponse (Maybe Text)
describeFileSystemsResponse_nextMarker :: Lens' DescribeFileSystemsResponse (Maybe Text)
describeFileSystemsResponse_httpStatus :: Lens' DescribeFileSystemsResponse Int

Creating a Request

data DescribeFileSystems Source #

See: newDescribeFileSystems smart constructor.

Constructors

DescribeFileSystems'

Fields

fileSystemId :: Maybe Text
(Optional) ID of the file system whose description you want to retrieve (String).
creationToken :: 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.
marker :: 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.
maxItems :: Maybe Natural
(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.

Instances

Instances details

Eq DescribeFileSystems Source #
Instance details Defined in Amazonka.EFS.DescribeFileSystems Methods (==) :: DescribeFileSystems -> DescribeFileSystems -> Bool # (/=) :: DescribeFileSystems -> DescribeFileSystems -> Bool #
Read DescribeFileSystems Source #
Instance details Defined in Amazonka.EFS.DescribeFileSystems Methods readsPrec :: Int -> ReadS DescribeFileSystems # readList :: ReadS [DescribeFileSystems] # readPrec :: ReadPrec DescribeFileSystems # readListPrec :: ReadPrec [DescribeFileSystems] #
Show DescribeFileSystems Source #
Instance details Defined in Amazonka.EFS.DescribeFileSystems Methods showsPrec :: Int -> DescribeFileSystems -> ShowS # show :: DescribeFileSystems -> String # showList :: [DescribeFileSystems] -> ShowS #
Generic DescribeFileSystems Source #
Instance details Defined in Amazonka.EFS.DescribeFileSystems Associated Types type Rep DescribeFileSystems :: Type -> Type # Methods from :: DescribeFileSystems -> Rep DescribeFileSystems x # to :: Rep DescribeFileSystems x -> DescribeFileSystems #
NFData DescribeFileSystems Source #
Instance details Defined in Amazonka.EFS.DescribeFileSystems Methods rnf :: DescribeFileSystems -> () #
Hashable DescribeFileSystems Source #
Instance details Defined in Amazonka.EFS.DescribeFileSystems Methods hashWithSalt :: Int -> DescribeFileSystems -> Int # hash :: DescribeFileSystems -> Int #
AWSPager DescribeFileSystems Source #
Instance details Defined in Amazonka.EFS.DescribeFileSystems Methods page :: DescribeFileSystems -> AWSResponse DescribeFileSystems -> Maybe DescribeFileSystems #
AWSRequest DescribeFileSystems Source #
Instance details Defined in Amazonka.EFS.DescribeFileSystems Associated Types type AWSResponse DescribeFileSystems # Methods request :: DescribeFileSystems -> Request DescribeFileSystems # response :: MonadResource m => Logger -> Service -> Proxy DescribeFileSystems -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeFileSystems))) #
ToHeaders DescribeFileSystems Source #
Instance details Defined in Amazonka.EFS.DescribeFileSystems Methods toHeaders :: DescribeFileSystems -> [Header] #
ToPath DescribeFileSystems Source #
Instance details Defined in Amazonka.EFS.DescribeFileSystems Methods toPath :: DescribeFileSystems -> ByteString #
ToQuery DescribeFileSystems Source #
Instance details Defined in Amazonka.EFS.DescribeFileSystems Methods toQuery :: DescribeFileSystems -> QueryString #
type Rep DescribeFileSystems Source #
Instance details Defined in Amazonka.EFS.DescribeFileSystems type Rep DescribeFileSystems = D1 ('MetaData "DescribeFileSystems" "Amazonka.EFS.DescribeFileSystems" "libZSservicesZSamazonka-efsZSamazonka-efs" 'False) (C1 ('MetaCons "DescribeFileSystems'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "fileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "creationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse DescribeFileSystems Source #
Instance details Defined in Amazonka.EFS.DescribeFileSystems type AWSResponse DescribeFileSystems = DescribeFileSystemsResponse

newDescribeFileSystems :: DescribeFileSystems Source #

Create a value of DescribeFileSystems with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:fileSystemId:DescribeFileSystems', describeFileSystems_fileSystemId - (Optional) ID of the file system whose description you want to retrieve (String).

$sel:creationToken:DescribeFileSystems', describeFileSystems_creationToken - (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.

$sel:marker:DescribeFileSystems', describeFileSystems_marker - (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.

$sel:maxItems:DescribeFileSystems', describeFileSystems_maxItems - (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.

Request Lenses

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

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

describeFileSystems_creationToken :: 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.

describeFileSystems_marker :: 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.

describeFileSystems_maxItems :: Lens' DescribeFileSystems (Maybe Natural) Source #

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

Destructuring the Response

data DescribeFileSystemsResponse Source #

See: newDescribeFileSystemsResponse smart constructor.

Constructors

DescribeFileSystemsResponse'

Fields

fileSystems :: Maybe [FileSystemDescription]
An array of file system descriptions.
marker :: Maybe Text
Present if provided by caller in the request (String).
nextMarker :: 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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeFileSystemsResponse Source #
Instance details Defined in Amazonka.EFS.DescribeFileSystems Methods (==) :: DescribeFileSystemsResponse -> DescribeFileSystemsResponse -> Bool # (/=) :: DescribeFileSystemsResponse -> DescribeFileSystemsResponse -> Bool #
Read DescribeFileSystemsResponse Source #
Instance details Defined in Amazonka.EFS.DescribeFileSystems Methods readsPrec :: Int -> ReadS DescribeFileSystemsResponse # readList :: ReadS [DescribeFileSystemsResponse] # readPrec :: ReadPrec DescribeFileSystemsResponse # readListPrec :: ReadPrec [DescribeFileSystemsResponse] #
Show DescribeFileSystemsResponse Source #
Instance details Defined in Amazonka.EFS.DescribeFileSystems Methods showsPrec :: Int -> DescribeFileSystemsResponse -> ShowS # show :: DescribeFileSystemsResponse -> String # showList :: [DescribeFileSystemsResponse] -> ShowS #
Generic DescribeFileSystemsResponse Source #
Instance details Defined in Amazonka.EFS.DescribeFileSystems Associated Types type Rep DescribeFileSystemsResponse :: Type -> Type # Methods from :: DescribeFileSystemsResponse -> Rep DescribeFileSystemsResponse x # to :: Rep DescribeFileSystemsResponse x -> DescribeFileSystemsResponse #
NFData DescribeFileSystemsResponse Source #
Instance details Defined in Amazonka.EFS.DescribeFileSystems Methods rnf :: DescribeFileSystemsResponse -> () #
type Rep DescribeFileSystemsResponse Source #
Instance details Defined in Amazonka.EFS.DescribeFileSystems type Rep DescribeFileSystemsResponse = D1 ('MetaData "DescribeFileSystemsResponse" "Amazonka.EFS.DescribeFileSystems" "libZSservicesZSamazonka-efsZSamazonka-efs" 'False) (C1 ('MetaCons "DescribeFileSystemsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "fileSystems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FileSystemDescription])) :: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "nextMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeFileSystemsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeFileSystemsResponse'`
-> DescribeFileSystemsResponse

Create a value of DescribeFileSystemsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:fileSystems:DescribeFileSystemsResponse', describeFileSystemsResponse_fileSystems - An array of file system descriptions.

$sel:marker:DescribeFileSystems', describeFileSystemsResponse_marker - Present if provided by caller in the request (String).

$sel:nextMarker:DescribeFileSystemsResponse', describeFileSystemsResponse_nextMarker - 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.

$sel:httpStatus:DescribeFileSystemsResponse', describeFileSystemsResponse_httpStatus - The response's http status code.

Response Lenses

describeFileSystemsResponse_fileSystems :: Lens' DescribeFileSystemsResponse (Maybe [FileSystemDescription]) Source #

An array of file system descriptions.

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

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

describeFileSystemsResponse_nextMarker :: 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.

describeFileSystemsResponse_httpStatus :: Lens' DescribeFileSystemsResponse Int Source #

The response's http status code.