Class: Aws::FSx::Types::DescribeFileSystemsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-fsx/types.rb

Overview

Note:

When making an API call, you may pass DescribeFileSystemsRequest data as a hash:

{
  file_system_ids: ["FileSystemId"],
  max_results: 1,
  next_token: "NextToken",
}

The request object for ‘DescribeFileSystems` operation.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#file_system_ids ⇒ Array<String>

(Optional) IDs of the file systems whose descriptions you want to retrieve (String).

Returns:

  • (Array<String>) 


807
808
809
810
811
812
 
# File 'lib/aws-sdk-fsx/types.rb', line 807

class DescribeFileSystemsRequest < Struct.new(
  :file_system_ids,
  :max_results,
  :next_token)
  include Aws::Structure
end

#max_results ⇒ Integer

(Optional) 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 FSx returns is the minimum of the ‘MaxResults` parameter specified in the request and the service’s internal maximum number of items per page.

Returns:

  • (Integer) 


807
808
809
810
811
812
 
# File 'lib/aws-sdk-fsx/types.rb', line 807

class DescribeFileSystemsRequest < Struct.new(
  :file_system_ids,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_token ⇒ String

(Optional) Opaque pagination token returned from a previous ‘DescribeFileSystems` operation (String). If a token present, the action continues the list from where the returning call left off.

Returns:

  • (String) 


807
808
809
810
811
812
 
# File 'lib/aws-sdk-fsx/types.rb', line 807

class DescribeFileSystemsRequest < Struct.new(
  :file_system_ids,
  :max_results,
  :next_token)
  include Aws::Structure
end