Struct aws_sdk_transfer::operation::start_file_transfer::StartFileTransferInput

#[non_exhaustive]
pub struct StartFileTransferInput {
    pub connector_id: Option<String>,
    pub send_file_paths: Option<Vec<String>>,
    pub retrieve_file_paths: Option<Vec<String>>,
    pub local_directory_path: Option<String>,
    pub remote_directory_path: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

connector_id: Option<String>

The unique identifier for the connector.

send_file_paths: 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.

retrieve_file_paths: 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.

local_directory_path: 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.

remote_directory_path: 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.

Implementations

impl StartFileTransferInput

pub fn connector_id(&self) -> Option<&str>

The unique identifier for the connector.

pub fn send_file_paths(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .send_file_paths.is_none().

pub fn retrieve_file_paths(&self) -> &[String]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .retrieve_file_paths.is_none().

pub fn local_directory_path(&self) -> Option<&str>

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) -> Option<&str>

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.

impl StartFileTransferInput

pub fn builder() -> StartFileTransferInputBuilder

Creates a new builder-style object to manufacture StartFileTransferInput.

Trait Implementations

impl Clone for StartFileTransferInput

fn clone(&self) -> StartFileTransferInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartFileTransferInput

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

Formats the value using the given formatter.

impl PartialEq for StartFileTransferInput

fn eq(&self, other: &StartFileTransferInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StartFileTransferInput