Struct aws_sdk_transfer::operation::start_file_transfer::builders::StartFileTransferFluentBuilder

pub struct StartFileTransferFluentBuilder { /* private fields */ }

Fluent builder constructing a request to StartFileTransfer.

Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.

• For an AS2 connector, you specify the ConnectorId and one or more SendFilePaths to identify the files you want to transfer.

• For an SFTP connector, the file transfer can be either outbound or inbound. In both cases, you specify the ConnectorId. Depending on the direction of the transfer, you also specify the following items:

  • If you are transferring file from a partner's SFTP server to Amazon Web Services storage, you specify one or more RetreiveFilePaths to identify the files you want to transfer, and a LocalDirectoryPath to specify the destination folder.

  • If you are transferring file to a partner's SFTP server from Amazon Web Services storage, you specify one or more SendFilePaths to identify the files you want to transfer, and a RemoteDirectoryPath to specify the destination folder.

Implementations

impl StartFileTransferFluentBuilder

pub fn as_input(&self) -> &StartFileTransferInputBuilder

Access the StartFileTransfer as a reference.

pub async fn send( self ) -> Result<StartFileTransferOutput, SdkError<StartFileTransferError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<StartFileTransferOutput, StartFileTransferError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn connector_id(self, input: impl Into<String>) -> Self

The unique identifier for the connector.

pub fn set_connector_id(self, input: Option<String>) -> Self

The unique identifier for the connector.

pub fn get_connector_id(&self) -> &Option<String>

The unique identifier for the connector.

pub fn send_file_paths(self, input: impl Into<String>) -> Self

Appends an item to SendFilePaths.

To override the contents of this collection use set_send_file_paths.

One or more source paths for the Amazon S3 storage. Each string represents a source file path for one outbound file transfer. For example, DOC-EXAMPLE-BUCKET/myfile.txt .

Replace DOC-EXAMPLE-BUCKET with one of your actual buckets.

pub fn set_send_file_paths(self, input: Option<Vec<String>>) -> Self

One or more source paths for the Amazon S3 storage. Each string represents a source file path for one outbound file transfer. For example, DOC-EXAMPLE-BUCKET/myfile.txt .

Replace DOC-EXAMPLE-BUCKET with one of your actual buckets.

pub fn get_send_file_paths(&self) -> &Option<Vec<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, DOC-EXAMPLE-BUCKET/myfile.txt .

Replace DOC-EXAMPLE-BUCKET with one of your actual buckets.

pub fn retrieve_file_paths(self, input: impl Into<String>) -> Self

Appends an item to RetrieveFilePaths.

To override the contents of this collection use set_retrieve_file_paths.

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

pub fn set_retrieve_file_paths(self, input: Option<Vec<String>>) -> Self

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

pub fn get_retrieve_file_paths(&self) -> &Option<Vec<String>>

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

pub fn local_directory_path(self, input: impl Into<String>) -> Self

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

pub fn set_local_directory_path(self, input: Option<String>) -> Self

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

pub fn get_local_directory_path(&self) -> &Option<String>

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

pub fn remote_directory_path(self, input: impl Into<String>) -> Self

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.

pub fn set_remote_directory_path(self, input: Option<String>) -> Self

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.

pub fn get_remote_directory_path(&self) -> &Option<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.

Trait Implementations

impl Clone for StartFileTransferFluentBuilder

fn clone(&self) -> StartFileTransferFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartFileTransferFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.