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.
efs_describe_access_points(MaxResults, NextToken, AccessPointId,
FileSystemId)
A list with the following syntax:
list(
AccessPoints = list(
list(
ClientToken = "string",
Name = "string",
Tags = list(
list(
Key = "string",
Value = "string"
)
),
AccessPointId = "string",
AccessPointArn = "string",
FileSystemId = "string",
PosixUser = list(
Uid = 123,
Gid = 123,
SecondaryGids = list(
123
)
),
RootDirectory = list(
Path = "string",
CreationInfo = list(
OwnerUid = 123,
OwnerGid = 123,
Permissions = "string"
)
),
OwnerId = "string",
LifeCycleState = "creating"|"available"|"updating"|"deleting"|"deleted"
)
),
NextToken = "string"
)
(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
is present if the response is paginated. You can use
NextMarker
in the subsequent request to fetch the next page of access
point descriptions.
(Optional) Specifies an EFS access point to describe in the response;
mutually exclusive with FileSystemId
.
(Optional) If you provide a FileSystemId
, EFS returns all access
points for that file system; mutually exclusive with AccessPointId
.
svc$describe_access_points(
MaxResults = 123,
NextToken = "string",
AccessPointId = "string",
FileSystemId = "string"
)