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.
Parameters:
-
max_results
(Optional[MaxResults], default:
None
)
–
(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.
-
next_token
(Optional[Token], default:
None
)
–
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.
-
access_point_id
(Optional[AccessPointId], default:
None
)
–
(Optional) Specifies an EFS access point to describe in the response; mutually exclusive with FileSystemId.
-
file_system_id
(Optional[FileSystemId], default:
None
)
–
(Optional) If you provide a FileSystemId, EFS returns all access points for that file system; mutually exclusive with AccessPointId.
Raises:
-
AccessPointNotFound
–
Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.
-
BadRequest
–
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
-
FileSystemNotFound
–
Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
-
InternalServerError
–
Returned if an error occurred on the server side.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_efs/_services/efs.py
| def describe_access_points(
self,
*,
config_overrides: Optional[EFSClientConfig] = None,
max_results: Optional["capo_efs.types.max_results.MaxResults"] = None,
next_token: Optional["capo_efs.types.token.Token"] = None,
access_point_id: Optional[
"capo_efs.types.access_point_id.AccessPointId"
] = None,
file_system_id: Optional["capo_efs.types.file_system_id.FileSystemId"] = None,
) -> "capo_efs.types.describe_access_points_response.DescribeAccessPointsResponse":
"""<p>Returns the description of a specific Amazon EFS access point if the <code>AccessPointId</code> is provided. If you provide an EFS <code>FileSystemId</code>, it returns descriptions of all access points for that file system. You can provide either an <code>AccessPointId</code> or a <code>FileSystemId</code> in the request, but not both. </p> <p>This operation requires permissions for the <code>elasticfilesystem:DescribeAccessPoints</code> action.</p>
Args:
max_results: <p>(Optional) When retrieving all access points for a file system, you can optionally specify the <code>MaxItems</code> parameter to limit the number of objects returned in a response. The default value is 100. </p>
next_token: <p> <code>NextToken</code> is present if the response is paginated. You can use <code>NextMarker</code> in the subsequent request to fetch the next page of access point descriptions.</p>
access_point_id: <p>(Optional) Specifies an EFS access point to describe in the response; mutually exclusive with <code>FileSystemId</code>.</p>
file_system_id: <p>(Optional) If you provide a <code>FileSystemId</code>, EFS returns all access points for that file system; mutually exclusive with <code>AccessPointId</code>.</p>
Raises:
capo_efs.errors.access_point_not_found.AccessPointNotFound: <p>Returned if the specified <code>AccessPointId</code> value doesn't exist in the requester's Amazon Web Services account.</p>
capo_efs.errors.bad_request.BadRequest: <p>Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.</p>
capo_efs.errors.file_system_not_found.FileSystemNotFound: <p>Returned if the specified <code>FileSystemId</code> value doesn't exist in the requester's Amazon Web Services account.</p>
capo_efs.errors.internal_server_error.InternalServerError: <p>Returned if an error occurred on the server side.</p>
capo_efs.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_efs.types.describe_access_points_request.DescribeAccessPointsRequest]",
) -> OperationResponse[
"capo_efs.types.describe_access_points_response.DescribeAccessPointsResponse"
]:
import capo_efs._operations.magnolio_api_service_v20150201.describe_access_points
output, http_response = (
capo_efs._operations.magnolio_api_service_v20150201.describe_access_points.describe_access_points(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeAccessPoints")
)
input_: capo_efs.types.describe_access_points_request.DescribeAccessPointsRequest = {}
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
if access_point_id is not None:
input_["access_point_id"] = access_point_id
if file_system_id is not None:
input_["file_system_id"] = file_system_id
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|