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

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",
}

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)


243
244
245
246
247
248
249
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 243

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

#file_system_idString

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

Returns:

  • (String)


243
244
245
246
247
248
249
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 243

class DescribeFileSystemsRequest < Struct.new(
  :max_items,
  :marker,
  :creation_token,
  :file_system_id)
  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)


243
244
245
246
247
248
249
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 243

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

#max_itemsInteger

(Optional) Specifies the maximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon EFS returns is the minimum of the MaxItems parameter specified in the request and the service's internal maximum number of items per page.

Returns:

  • (Integer)


243
244
245
246
247
248
249
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 243

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