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
See also: AWS API Documentation
describe-access-points [--max-results <value>] [--next-token <value>] [--access-point-id <value>] [--file-system-id <value>] [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton <value>] [--debug] [--endpoint-url <value>] [--no-verify-ssl] [--no-paginate] [--output <value>] [--query <value>] [--profile <value>] [--region <value>] [--version <value>] [--color <value>] [--no-sign-request] [--ca-bundle <value>] [--cli-read-timeout <value>] [--cli-connect-timeout <value>] [--cli-binary-format <value>] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt]
(Optional) When retrieving all access points for a file system, you can optionally specify the
MaxItemsparameter to limit the number of objects returned in a response. The default value is 100.
NextTokenis present if the response is paginated. You can use
NextMarkerin 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
(Optional) If you provide a
FileSystemId, EFS returns all access points for that file system; mutually exclusive with
Reads arguments from the JSON string provided. The JSON string follows the format provided by
--generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value
input, prints a sample input JSON that can be used as an argument for
--cli-input-json. Similarly, if provided
yaml-input it will print a sample input YAML that can be used with
--cli-input-yaml. If provided with the value
output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Turn on debug logging.
Override command’s default URL with the given URL.
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
Disable automatic pagination.
The formatting style for command output.
A JMESPath query to use in filtering the response data.
Use a specific profile from your credential file.
The region to use. Overrides config/env settings.
Display the version of this tool.
Turn on/off color output.
Do not sign requests. Credentials will not be loaded if this argument is provided.
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob
fileb:// will always be treated as binary and use the file contents directly regardless of the
cli-binary-format setting. When using
file:// the file contents will need to properly formatted for the configured
Disable cli pager for output.
Automatically prompt for CLI input parameters.
Disable automatically prompt for CLI input parameters.
AccessPoints -> (list)
An array of access point descriptions.
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
Tags -> (list)
The tags associated with the access point, presented as an array of Tag objects.
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
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 -> (structure)
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 -> (long)The POSIX user ID used for all file system operations using this access point.
Gid -> (long)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.
RootDirectory -> (structure)
The directory on the Amazon 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 -> (structure)
(Optional) Specifies the POSIX IDs and permissions to apply to the access point’s
RootDirectory. If the
Pathspecified does not exist, EFS creates the root directory using the
CreationInfosettings when a client connects to an access point. When specifying the
CreationInfo, you must provide values for all properties.
WarningIf you do not provide
CreationInfoand the specified
Pathdoes not exist, attempts to mount the file system using the access point will fail.
OwnerUid -> (long)Specifies the POSIX user ID to apply to the
RootDirectory. Accepts values from 0 to 2^32 (4294967295).
OwnerGid -> (long)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.