Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EFS.DescribeAccessPoints

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

Creating a Request

data DescribeAccessPoints Source #

See: newDescribeAccessPoints smart constructor.

Constructors

DescribeAccessPoints'

Fields

accessPointId :: Maybe Text
(Optional) Specifies an EFS access point to describe in the response; mutually exclusive with FileSystemId.
fileSystemId :: Maybe Text
(Optional) If you provide a FileSystemId, EFS returns all access points for that file system; mutually exclusive with AccessPointId.
maxResults :: Maybe Natural
(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.
nextToken :: Maybe Text
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.

Instances

Instances details

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

newDescribeAccessPoints :: DescribeAccessPoints Source #

Create a value of DescribeAccessPoints 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:

DescribeAccessPoints, describeAccessPoints_accessPointId - (Optional) Specifies an EFS access point to describe in the response; mutually exclusive with FileSystemId.

DescribeAccessPoints, describeAccessPoints_fileSystemId - (Optional) If you provide a FileSystemId, EFS returns all access points for that file system; mutually exclusive with AccessPointId.

$sel:maxResults:DescribeAccessPoints', describeAccessPoints_maxResults - (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.

DescribeAccessPoints, describeAccessPoints_nextToken - 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.

Request Lenses

describeAccessPoints_accessPointId :: Lens' DescribeAccessPoints (Maybe Text) Source #

(Optional) Specifies an EFS access point to describe in the response; mutually exclusive with FileSystemId.

describeAccessPoints_fileSystemId :: Lens' DescribeAccessPoints (Maybe Text) Source #

(Optional) If you provide a FileSystemId, EFS returns all access points for that file system; mutually exclusive with AccessPointId.

describeAccessPoints_maxResults :: Lens' DescribeAccessPoints (Maybe Natural) Source #

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

describeAccessPoints_nextToken :: Lens' DescribeAccessPoints (Maybe Text) Source #

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.

Destructuring the Response

data DescribeAccessPointsResponse Source #

See: newDescribeAccessPointsResponse smart constructor.

Constructors

DescribeAccessPointsResponse'
Fields accessPoints :: Maybe [AccessPointDescription] An array of access point descriptions. nextToken :: Maybe Text 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. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeAccessPointsResponse Source #
Instance details Defined in Amazonka.EFS.DescribeAccessPoints Associated Types type Rep DescribeAccessPointsResponse :: Type -> Type # Methods from :: DescribeAccessPointsResponse -> Rep DescribeAccessPointsResponse x # to :: Rep DescribeAccessPointsResponse x -> DescribeAccessPointsResponse #
Read DescribeAccessPointsResponse Source #
Instance details Defined in Amazonka.EFS.DescribeAccessPoints Methods readsPrec :: Int -> ReadS DescribeAccessPointsResponse # readList :: ReadS [DescribeAccessPointsResponse] # readPrec :: ReadPrec DescribeAccessPointsResponse # readListPrec :: ReadPrec [DescribeAccessPointsResponse] #
Show DescribeAccessPointsResponse Source #
Instance details Defined in Amazonka.EFS.DescribeAccessPoints Methods showsPrec :: Int -> DescribeAccessPointsResponse -> ShowS # show :: DescribeAccessPointsResponse -> String # showList :: [DescribeAccessPointsResponse] -> ShowS #
NFData DescribeAccessPointsResponse Source #
Instance details Defined in Amazonka.EFS.DescribeAccessPoints Methods rnf :: DescribeAccessPointsResponse -> () #
Eq DescribeAccessPointsResponse Source #
Instance details Defined in Amazonka.EFS.DescribeAccessPoints Methods (==) :: DescribeAccessPointsResponse -> DescribeAccessPointsResponse -> Bool # (/=) :: DescribeAccessPointsResponse -> DescribeAccessPointsResponse -> Bool #
type Rep DescribeAccessPointsResponse Source #
Instance details Defined in Amazonka.EFS.DescribeAccessPoints type Rep DescribeAccessPointsResponse = D1 ('MetaData "DescribeAccessPointsResponse" "Amazonka.EFS.DescribeAccessPoints" "amazonka-efs-2.0-EHRjUBbcNxzHWDmYi0HAD5" 'False) (C1 ('MetaCons "DescribeAccessPointsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accessPoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AccessPointDescription])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeAccessPointsResponse Source #

Arguments

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

Create a value of DescribeAccessPointsResponse 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:accessPoints:DescribeAccessPointsResponse', describeAccessPointsResponse_accessPoints - An array of access point descriptions.

DescribeAccessPoints, describeAccessPointsResponse_nextToken - 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.

$sel:httpStatus:DescribeAccessPointsResponse', describeAccessPointsResponse_httpStatus - The response's http status code.

Response Lenses

describeAccessPointsResponse_accessPoints :: Lens' DescribeAccessPointsResponse (Maybe [AccessPointDescription]) Source #

An array of access point descriptions.

describeAccessPointsResponse_nextToken :: Lens' DescribeAccessPointsResponse (Maybe Text) Source #

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.

describeAccessPointsResponse_httpStatus :: Lens' DescribeAccessPointsResponse Int Source #

The response's http status code.