Class: Aws::EFS::Types::DescribeFileSystemsRequest

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 DescribeFileSystemsRequest data as a hash:

{
  max_items: 1,
  marker: "Marker",
  creation_token: "CreationToken",
  file_system_id: "FileSystemId",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_tokenString

(Optional) Restricts the list to the file system with this creation token (String). You specify a creation token when you create an Amazon EFS file system.

Returns:

  • (String)


1038
1039
1040
1041
1042
1043
1044
1045
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 1038

class DescribeFileSystemsRequest < Struct.new(
  :max_items,
  :marker,
  :creation_token,
  :file_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_idString

(Optional) ID of the file system whose description you want to retrieve (String).

Returns:

  • (String)


1038
1039
1040
1041
1042
1043
1044
1045
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 1038

class DescribeFileSystemsRequest < Struct.new(
  :max_items,
  :marker,
  :creation_token,
  :file_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#markerString

(Optional) Opaque pagination token returned from a previous DescribeFileSystems operation (String). If present, specifies to continue the list from where the returning call had left off.

Returns:

  • (String)


1038
1039
1040
1041
1042
1043
1044
1045
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 1038

class DescribeFileSystemsRequest < Struct.new(
  :max_items,
  :marker,
  :creation_token,
  :file_system_id)
  SENSITIVE = []
  include Aws::Structure
end

#max_itemsInteger

(Optional) Specifies the maximum number of file systems to return in the response (integer). This number is automatically set to 100. The response is paginated at 100 per page if you have more than 100 file systems.

Returns:

  • (Integer)


1038
1039
1040
1041
1042
1043
1044
1045
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 1038

class DescribeFileSystemsRequest < Struct.new(
  :max_items,
  :marker,
  :creation_token,
  :file_system_id)
  SENSITIVE = []
  include Aws::Structure
end