You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EFS::Types::DescribeAccessPointsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeAccessPointsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  max_results: 1,
  next_token: "Token",
  access_point_id: "AccessPointId",
  file_system_id: "FileSystemId",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#access_point_id ⇒ String

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

Returns:

  • (String) —

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

#file_system_id ⇒ String

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

Returns:

  • (String) —

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

#max_results ⇒ 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.

Returns:

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

#next_token ⇒ 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.

Returns:

  • (String) —

    NextToken is present if the response is paginated.