Class: Aws::Transfer::Types::StartFileTransferRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#connector_id ⇒ String

The unique identifier for the connector.

Returns:

  • (String) 


5735
5736
5737
5738
5739
5740
5741
5742
5743
 
# File 'lib/aws-sdk-transfer/types.rb', line 5735

class StartFileTransferRequest < Struct.new(
  :connector_id,
  :send_file_paths,
  :retrieve_file_paths,
  :local_directory_path,
  :remote_directory_path)
  SENSITIVE = []
  include Aws::Structure
end

#local_directory_path ⇒ String

For an inbound transfer, the ‘LocaDirectoryPath` specifies the destination for one or more files that are transferred from the partner’s SFTP server.

Returns:

  • (String) 


5735
5736
5737
5738
5739
5740
5741
5742
5743
 
# File 'lib/aws-sdk-transfer/types.rb', line 5735

class StartFileTransferRequest < Struct.new(
  :connector_id,
  :send_file_paths,
  :retrieve_file_paths,
  :local_directory_path,
  :remote_directory_path)
  SENSITIVE = []
  include Aws::Structure
end

#remote_directory_path ⇒ String

For an outbound transfer, the ‘RemoteDirectoryPath` specifies the destination for one or more files that are transferred to the partner’s SFTP server. If you don’t specify a ‘RemoteDirectoryPath`, the destination for transferred files is the SFTP user’s home directory.

Returns:

  • (String) 


5735
5736
5737
5738
5739
5740
5741
5742
5743
 
# File 'lib/aws-sdk-transfer/types.rb', line 5735

class StartFileTransferRequest < Struct.new(
  :connector_id,
  :send_file_paths,
  :retrieve_file_paths,
  :local_directory_path,
  :remote_directory_path)
  SENSITIVE = []
  include Aws::Structure
end

#retrieve_file_paths ⇒ Array<String>

One or more source paths for the partner’s SFTP server. Each string represents a source file path for one inbound file transfer.

Returns:

  • (Array<String>) 


5735
5736
5737
5738
5739
5740
5741
5742
5743
 
# File 'lib/aws-sdk-transfer/types.rb', line 5735

class StartFileTransferRequest < Struct.new(
  :connector_id,
  :send_file_paths,
  :retrieve_file_paths,
  :local_directory_path,
  :remote_directory_path)
  SENSITIVE = []
  include Aws::Structure
end

#send_file_paths ⇒ Array<String>

One or more source paths for the Amazon S3 storage. Each string represents a source file path for one outbound file transfer. For example, ‘ amzn-s3-demo-bucket/myfile.txt `.

<note markdown=“1”> Replace ‘ amzn-s3-demo-bucket ` with one of your actual buckets.

</note>

Returns:

  • (Array<String>) 


5735
5736
5737
5738
5739
5740
5741
5742
5743
 
# File 'lib/aws-sdk-transfer/types.rb', line 5735

class StartFileTransferRequest < Struct.new(
  :connector_id,
  :send_file_paths,
  :retrieve_file_paths,
  :local_directory_path,
  :remote_directory_path)
  SENSITIVE = []
  include Aws::Structure
end