Class: Aws::Transfer::Types::StartDirectoryListingRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#connector_idString

The unique identifier for the connector.

Returns:

  • (String)


5121
5122
5123
5124
5125
5126
5127
5128
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 5121

class StartDirectoryListingRequest < Struct.new(
  :connector_id,
  :remote_directory_path,
  :max_items,
  :output_directory_path)
  SENSITIVE = []
  include Aws::Structure
end

#max_itemsInteger

An optional parameter where you can specify the maximum number of file/directory names to retrieve. The default value is 1,000.

Returns:

  • (Integer)


5121
5122
5123
5124
5125
5126
5127
5128
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 5121

class StartDirectoryListingRequest < Struct.new(
  :connector_id,
  :remote_directory_path,
  :max_items,
  :output_directory_path)
  SENSITIVE = []
  include Aws::Structure
end

#output_directory_pathString

Specifies the path (bucket and prefix) in Amazon S3 storage to store the results of the directory listing.

Returns:

  • (String)


5121
5122
5123
5124
5125
5126
5127
5128
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 5121

class StartDirectoryListingRequest < Struct.new(
  :connector_id,
  :remote_directory_path,
  :max_items,
  :output_directory_path)
  SENSITIVE = []
  include Aws::Structure
end

#remote_directory_pathString

Specifies the directory on the remote SFTP server for which you want to list its contents.

Returns:

  • (String)


5121
5122
5123
5124
5125
5126
5127
5128
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 5121

class StartDirectoryListingRequest < Struct.new(
  :connector_id,
  :remote_directory_path,
  :max_items,
  :output_directory_path)
  SENSITIVE = []
  include Aws::Structure
end