| 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.DescribeAccessPoints
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
- data DescribeAccessPoints = DescribeAccessPoints' {}
- newDescribeAccessPoints :: DescribeAccessPoints
- describeAccessPoints_accessPointId :: Lens' DescribeAccessPoints (Maybe Text)
- describeAccessPoints_fileSystemId :: Lens' DescribeAccessPoints (Maybe Text)
- describeAccessPoints_nextToken :: Lens' DescribeAccessPoints (Maybe Text)
- describeAccessPoints_maxResults :: Lens' DescribeAccessPoints (Maybe Natural)
- data DescribeAccessPointsResponse = DescribeAccessPointsResponse' {}
- newDescribeAccessPointsResponse :: Int -> DescribeAccessPointsResponse
- describeAccessPointsResponse_accessPoints :: Lens' DescribeAccessPointsResponse (Maybe [AccessPointDescription])
- describeAccessPointsResponse_nextToken :: Lens' DescribeAccessPointsResponse (Maybe Text)
- describeAccessPointsResponse_httpStatus :: Lens' DescribeAccessPointsResponse Int
Creating a Request
data DescribeAccessPoints Source #
See: newDescribeAccessPoints smart constructor.
Constructors
| DescribeAccessPoints' | |
Fields
| |
Instances
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:
$sel:accessPointId:DescribeAccessPoints', describeAccessPoints_accessPointId - (Optional) Specifies an EFS access point to describe in the response;
mutually exclusive with FileSystemId.
$sel:fileSystemId:DescribeAccessPoints', describeAccessPoints_fileSystemId - (Optional) If you provide a FileSystemId, EFS returns all access
points for that file system; mutually exclusive with AccessPointId.
$sel:nextToken: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.
$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.
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_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.
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.
Destructuring the Response
data DescribeAccessPointsResponse Source #
See: newDescribeAccessPointsResponse smart constructor.
Constructors
| DescribeAccessPointsResponse' | |
Fields
| |
Instances
newDescribeAccessPointsResponse Source #
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.
$sel:nextToken: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.