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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-fsx/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#file_system_idsArray<String>

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

Returns:

  • (Array<String>)


4773
4774
4775
4776
4777
4778
4779
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 4773

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

#max_resultsInteger

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)


4773
4774
4775
4776
4777
4778
4779
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 4773

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

#next_tokenString

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

Returns:

  • (String)


4773
4774
4775
4776
4777
4778
4779
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 4773

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