Skip to content

aws.efs.describe_access_points

Example SQL Queries

SELECT * FROM
aws.efs.describe_access_points;

Description

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.

Table Definition

Column NameColumn Data Type
access_point_id Input Column

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

VARCHAR
file_system_id Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

access_point_arn

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

VARCHAR
client_token

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

VARCHAR
life_cycle_state

Identifies the lifecycle phase of the access point.

VARCHAR
name

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

VARCHAR
owner_id

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

VARCHAR
posix_user

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.

STRUCT(
"uid" BIGINT,
"gid" BIGINT,
"secondary_gids" BIGINT[]
)
Show child fields
posix_user.gid

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

posix_user.secondary_gids[]
posix_user.uid

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

root_directory

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

STRUCT(
"path" VARCHAR,
"creation_info" STRUCT(
"owner_uid" BIGINT,
"owner_gid" BIGINT,
"permissions" VARCHAR
)
)
Show child fields
root_directory.creation_info

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

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.

Show child fields
root_directory.creation_info.owner_gid

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

root_directory.creation_info.owner_uid

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

root_directory.creation_info.permissions

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

root_directory.path

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.

tags

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

STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
Show child fields
tags[]
Show child fields
tags[].key

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

tags[].value

The value of the tag key.