EFS / Client / describe_access_points

describe_access_points

EFS.Client.describe_access_points(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_access_points(
    MaxResults=123,
    NextToken='string',
    AccessPointId='string',
    FileSystemId='string'
)

Parameters:

• MaxResults (integer) – (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 (string) – 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.

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

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

Return type:

dict

Returns:

Response Syntax

{
    'AccessPoints': [
        {
            'ClientToken': 'string',
            'Name': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'AccessPointId': 'string',
            'AccessPointArn': 'string',
            'FileSystemId': 'string',
            'PosixUser': {
                'Uid': 123,
                'Gid': 123,
                'SecondaryGids': [
                    123,
                ]
            },
            'RootDirectory': {
                'Path': 'string',
                'CreationInfo': {
                    'OwnerUid': 123,
                    'OwnerGid': 123,
                    'Permissions': 'string'
                }
            },
            'OwnerId': 'string',
            'LifeCycleState': 'creating'|'available'|'updating'|'deleting'|'deleted'|'error'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • AccessPoints (list) –

    An array of access point descriptions.

    • (dict) –

      Provides a description of an EFS file system access point.

      • ClientToken (string) –

        The opaque string specified in the request to ensure idempotent creation.

      • Name (string) –

        The name of the access point. This is the value of the Name tag.

      • Tags (list) –

        The tags associated with the access point, presented as an array of Tag objects.

        • (dict) –

          A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters: `` + - = . _ : /``.

          • Key (string) –

            The tag key (String). The key can’t start with aws:.

          • Value (string) –

            The value of the tag key.

      • AccessPointId (string) –

        The ID of the access point, assigned by Amazon EFS.

      • AccessPointArn (string) –

        The unique Amazon Resource Name (ARN) associated with the access point.

      • FileSystemId (string) –

        The ID of the EFS file system that the access point applies to.

      • PosixUser (dict) –

        The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.

        • Uid (integer) –

          The POSIX user ID used for all file system operations using this access point.

        • Gid (integer) –

          The POSIX group ID used for all file system operations using this access point.

        • SecondaryGids (list) –

          Secondary POSIX group IDs used for all file system operations using this access point.

          • (integer) –

      • RootDirectory (dict) –

        The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.

        • Path (string) –

          Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the CreationInfo.

        • CreationInfo (dict) –

          (Optional) Specifies the POSIX IDs and permissions to apply to the access point’s RootDirectory. If the RootDirectory > Path specified does not exist, EFS creates the root directory using the CreationInfo settings when a client connects to an access point. When specifying the CreationInfo, you must provide values for all properties.

          Warning

          If you do not provide CreationInfo and the specified RootDirectory > Path does not exist, attempts to mount the file system using the access point will fail.

          • OwnerUid (integer) –

            Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).

          • OwnerGid (integer) –

            Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).

          • Permissions (string) –

            Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file’s mode bits.

      • OwnerId (string) –

        Identifies the Amazon Web Services account that owns the access point resource.

      • LifeCycleState (string) –

        Identifies the lifecycle phase of the access point.

  • NextToken (string) –

    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.

Exceptions

• EFS.Client.exceptions.BadRequest

• EFS.Client.exceptions.InternalServerError

• EFS.Client.exceptions.FileSystemNotFound

• EFS.Client.exceptions.AccessPointNotFound