Class: Aws::FSx::Types::DescribeFileSystemAliasesRequest

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

{
  client_request_token: "ClientRequestToken",
  file_system_id: "FileSystemId", # required
  max_results: 1,
  next_token: "NextToken",
}

The request object for DescribeFileSystemAliases operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

(Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


4710
4711
4712
4713
4714
4715
4716
4717
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 4710

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

#file_system_idString

The ID of the file system to return the associated DNS aliases for (String).

Returns:

  • (String)


4710
4711
4712
4713
4714
4715
4716
4717
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 4710

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

#max_resultsInteger

Maximum number of DNS aliases 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)


4710
4711
4712
4713
4714
4715
4716
4717
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 4710

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

#next_tokenString

Opaque pagination token returned from a previous DescribeFileSystemAliases operation (String). If a token is included in the request, the action continues the list from where the previous returning call left off.

Returns:

  • (String)


4710
4711
4712
4713
4714
4715
4716
4717
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 4710

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