describeAccessPoints method

Future<DescribeAccessPointsResponse> describeAccessPoints({ String? accessPointId, String? fileSystemId, int? maxResults, String? nextToken, })

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.

May throw BadRequest. May throw InternalServerError. May throw FileSystemNotFound. May throw AccessPointNotFound.

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

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

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

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

Implementation

Future<DescribeAccessPointsResponse> describeAccessPoints({
  String? accessPointId,
  String? fileSystemId,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateStringLength(
    'fileSystemId',
    fileSystemId,
    0,
    128,
  );
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    1152921504606846976,
  );
  final $query = <String, List<String>>{
    if (accessPointId != null) 'AccessPointId': [accessPointId],
    if (fileSystemId != null) 'FileSystemId': [fileSystemId],
    if (maxResults != null) 'MaxResults': [maxResults.toString()],
    if (nextToken != null) 'NextToken': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/2015-02-01/access-points',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return DescribeAccessPointsResponse.fromJson(response);
}