Skip to content

DescribeAccessPointsRequest

Source code in docs_src/capo_efs/types/describe_access_points_request.py 
14
15
16
17
18
19
20
21
22
class DescribeAccessPointsRequest(TypedDict, closed=True):
    max_results: NotRequired["capo_efs.types.max_results.MaxResults"]
    """<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: NotRequired["capo_efs.types.token.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: NotRequired["capo_efs.types.access_point_id.AccessPointId"]
    """<p>(Optional) Specifies an EFS access point to describe in the response; mutually exclusive with <code>FileSystemId</code>.</p>"""
    file_system_id: NotRequired["capo_efs.types.file_system_id.FileSystemId"]
    """<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>"""

access_point_id instance-attribute 

access_point_id: NotRequired[AccessPointId]

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

file_system_id instance-attribute 

file_system_id: NotRequired[FileSystemId]

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

max_results instance-attribute 

max_results: NotRequired[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.

next_token instance-attribute 

next_token: NotRequired[Token]

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.