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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb

Overview

Note:

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

Instance Attribute Details

#access_point_idString

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

Returns:

  • (String)


773
774
775
776
777
778
779
780
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 773

class DescribeAccessPointsRequest < Struct.new(
  :max_results,
  :next_token,
  :access_point_id,
  :file_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_idString

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

Returns:

  • (String)


773
774
775
776
777
778
779
780
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 773

class DescribeAccessPointsRequest < Struct.new(
  :max_results,
  :next_token,
  :access_point_id,
  :file_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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


773
774
775
776
777
778
779
780
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 773

class DescribeAccessPointsRequest < Struct.new(
  :max_results,
  :next_token,
  :access_point_id,
  :file_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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)


773
774
775
776
777
778
779
780
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 773

class DescribeAccessPointsRequest < Struct.new(
  :max_results,
  :next_token,
  :access_point_id,
  :file_system_id)
  SENSITIVE = []
  include Aws::Structure
end