Class: Aws::EFS::Types::DescribeAccessPointsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::EFS::Types::DescribeAccessPointsRequest
- Defined in:
- gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb
Overview
When making an API call, you may pass DescribeAccessPointsRequest data as a hash:
{
max_results: 1,
next_token: "Token",
access_point_id: "AccessPointId",
file_system_id: "FileSystemId",
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#access_point_id ⇒ 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 withAccessPointId
. -
#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. -
#next_token ⇒ String
NextToken
is present if the response is paginated.
Instance Attribute Details
#access_point_id ⇒ String
(Optional) Specifies an EFS access point to describe in the
response; mutually exclusive with FileSystemId
.
891 892 893 894 895 896 897 898 |
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 891 class DescribeAccessPointsRequest < Struct.new( :max_results, :next_token, :access_point_id, :file_system_id) SENSITIVE = [] include Aws::Structure end |
#file_system_id ⇒ String
(Optional) If you provide a FileSystemId
, EFS returns all access
points for that file system; mutually exclusive with
AccessPointId
.
891 892 893 894 895 896 897 898 |
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 891 class DescribeAccessPointsRequest < Struct.new( :max_results, :next_token, :access_point_id, :file_system_id) SENSITIVE = [] include Aws::Structure end |
#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.
891 892 893 894 895 896 897 898 |
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 891 class DescribeAccessPointsRequest < Struct.new( :max_results, :next_token, :access_point_id, :file_system_id) SENSITIVE = [] include Aws::Structure end |
#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.
891 892 893 894 895 896 897 898 |
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 891 class DescribeAccessPointsRequest < Struct.new( :max_results, :next_token, :access_point_id, :file_system_id) SENSITIVE = [] include Aws::Structure end |