Struct Client 

pub struct Client { /* private fields */ }

Client for AWS Transfer Family

Client for invoking operations on AWS Transfer Family. Each operation on AWS Transfer Family is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_transfer::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_transfer::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CreateAccess operation has a Client::create_access, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.create_access()
    .home_directory("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Implementations

impl Client

pub fn create_access(&self) -> CreateAccessFluentBuilder

Constructs a fluent builder for the CreateAccess operation.

• The fluent builder is configurable:
  • home_directory(impl Into<String>) / set_home_directory(Option<String>):
    required: false
    

    The landing directory (folder) for a user when they log in to the server using the client.

    A HomeDirectory example is /bucket_name/home/mydirectory.

    You can use the HomeDirectory parameter for HomeDirectoryType when it is set to either PATH or LOGICAL.

    
    
  • home_directory_type(HomeDirectoryType) / set_home_directory_type(Option<HomeDirectoryType>):
    required: false
    

    The type of landing directory (folder) that you want your users’ home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your users.

    If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your template.

    
    
  • home_directory_mappings(HomeDirectoryMapEntry) / set_home_directory_mappings(Option<Vec::<HomeDirectoryMapEntry>>):
    required: false
    

    Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL.

    The following is an Entry and Target pair example.

    [ { “Entry”: “/directory1”, “Target”: “/bucket_name/home/mydirectory” } ]

    In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory (“chroot”). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.

    The following is an Entry and Target pair example for chroot.

    [ { “Entry”: “/”, “Target”: “/bucket_name/home/mydirectory” } ]

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: false
    

    A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user’s access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

    This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies.

    For session policies, Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

    For an example of a session policy, see Example session policy.

    For more information, see AssumeRole in the Security Token Service API Reference.

    
    
  • posix_profile(PosixProfile) / set_posix_profile(Option<PosixProfile>):
    required: false
    

    The full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users’ access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

    
    
  • role(impl Into<String>) / set_role(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users’ access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users’ transfer requests.

    
    
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.

    
    
  • external_id(impl Into<String>) / set_external_id(Option<String>):
    required: true
    

    A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

    Get-ADGroup -Filter {samAccountName -like “YourGroupName*”} -Properties * | Select SamAccountName,ObjectSid

    In that command, replace YourGroupName with the name of your Active Directory group.

    The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

    
    
• On success, responds with CreateAccessOutput with field(s):
  • server_id(String):

    The identifier of the server that the user is attached to.

  • external_id(String):

    The external identifier of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family.

• On failure, responds with SdkError<CreateAccessError>

impl Client

pub fn create_agreement(&self) -> CreateAgreementFluentBuilder

Constructs a fluent builder for the CreateAgreement operation.

• The fluent builder is configurable:
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A name or short description to identify the agreement.

    
    
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.

    
    
  • local_profile_id(impl Into<String>) / set_local_profile_id(Option<String>):
    required: true
    

    A unique identifier for the AS2 local profile.

    
    
  • partner_profile_id(impl Into<String>) / set_partner_profile_id(Option<String>):
    required: true
    

    A unique identifier for the partner profile used in the agreement.

    
    
  • base_directory(impl Into<String>) / set_base_directory(Option<String>):
    required: false
    

    The landing directory (folder) for files transferred by using the AS2 protocol.

    A BaseDirectory example is /amzn-s3-demo-bucket/home/mydirectory.

    
    
  • access_role(impl Into<String>) / set_access_role(Option<String>):
    required: true
    

    Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

    For AS2 connectors

    With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for –send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

    If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

    For SFTP connectors

    Make sure that the access role provides read and write access to the parent directory of the file location that’s used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.

    
    
  • status(AgreementStatusType) / set_status(Option<AgreementStatusType>):
    required: false
    

    The status of the agreement. The agreement can be either ACTIVE or INACTIVE.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Key-value pairs that can be used to group and search for agreements.

    
    
  • preserve_filename(PreserveFilenameType) / set_preserve_filename(Option<PreserveFilenameType>):
    required: false
    

    Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.

    • ENABLED: the filename provided by your trading parter is preserved when the file is saved.

    • DISABLED (default value): when Transfer Family saves the file, the filename is adjusted, as described in File names and locations.

    
    
  • enforce_message_signing(EnforceMessageSigningType) / set_enforce_message_signing(Option<EnforceMessageSigningType>):
    required: false
    

    Determines whether or not unsigned messages from your trading partners will be accepted.

    • ENABLED: Transfer Family rejects unsigned messages from your trading partner.

    • DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner.

    
    
  • custom_directories(CustomDirectoriesType) / set_custom_directories(Option<CustomDirectoriesType>):
    required: false
    

    A CustomDirectoriesType structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.

    • Failed files

    • MDN files

    • Payload files

    • Status files

    • Temporary files

    
    
• On success, responds with CreateAgreementOutput with field(s):
  • agreement_id(String):

    The unique identifier for the agreement. Use this ID for deleting, or updating an agreement, as well as in any other API calls that require that you specify the agreement ID.

• On failure, responds with SdkError<CreateAgreementError>

impl Client

pub fn create_connector(&self) -> CreateConnectorFluentBuilder

Constructs a fluent builder for the CreateConnector operation.

• The fluent builder is configurable:
  • url(impl Into<String>) / set_url(Option<String>):
    required: false
    

    The URL of the partner’s AS2 or SFTP endpoint.

    When creating AS2 connectors or service-managed SFTP connectors (connectors without egress configuration), you must provide a URL to specify the remote server endpoint. For VPC Lattice type connectors, the URL must be null.

    
    
  • as2_config(As2ConnectorConfig) / set_as2_config(Option<As2ConnectorConfig>):
    required: false
    

    A structure that contains the parameters for an AS2 connector object.

    
    
  • access_role(impl Into<String>) / set_access_role(Option<String>):
    required: true
    

    Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

    For AS2 connectors

    With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for –send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

    If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

    For SFTP connectors

    Make sure that the access role provides read and write access to the parent directory of the file location that’s used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.

    
    
  • logging_role(impl Into<String>) / set_logging_role(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.

    
    
  • sftp_config(SftpConnectorConfig) / set_sftp_config(Option<SftpConnectorConfig>):
    required: false
    

    A structure that contains the parameters for an SFTP connector object.

    
    
  • security_policy_name(impl Into<String>) / set_security_policy_name(Option<String>):
    required: false
    

    Specifies the name of the security policy for the connector.

    
    
  • egress_config(ConnectorEgressConfig) / set_egress_config(Option<ConnectorEgressConfig>):
    required: false
    

    Specifies the egress configuration for the connector, which determines how traffic is routed from the connector to the SFTP server. When set to VPC, enables routing through customer VPCs using VPC_LATTICE for private connectivity.

    
    
• On success, responds with CreateConnectorOutput with field(s):
  • connector_id(String):

    The unique identifier for the connector, returned after the API call succeeds.

• On failure, responds with SdkError<CreateConnectorError>

impl Client

pub fn create_profile(&self) -> CreateProfileFluentBuilder

Constructs a fluent builder for the CreateProfile operation.

• The fluent builder is configurable:
  • as2_id(impl Into<String>) / set_as2_id(Option<String>):
    required: true
    

    The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is the AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.

    
    
  • profile_type(ProfileType) / set_profile_type(Option<ProfileType>):
    required: true
    

    Determines the type of profile to create:

    • Specify LOCAL to create a local profile. A local profile represents the AS2-enabled Transfer Family server organization or party.

    • Specify PARTNER to create a partner profile. A partner profile represents a remote organization, external to Transfer Family.

    
    
  • certificate_ids(impl Into<String>) / set_certificate_ids(Option<Vec::<String>>):
    required: false
    

    An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Key-value pairs that can be used to group and search for AS2 profiles.

    
    
• On success, responds with CreateProfileOutput with field(s):
  • profile_id(String):

    The unique identifier for the AS2 profile, returned after the API call succeeds.

• On failure, responds with SdkError<CreateProfileError>

impl Client

pub fn create_server(&self) -> CreateServerFluentBuilder

Constructs a fluent builder for the CreateServer operation.

• The fluent builder is configurable:
  • certificate(impl Into<String>) / set_certificate(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

    To request a new public certificate, see Request a public certificate in the Certificate Manager User Guide.

    To import an existing certificate into ACM, see Importing certificates into ACM in the Certificate Manager User Guide.

    To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Certificate Manager User Guide.

    Certificates with the following cryptographic algorithms and key sizes are supported:

    • 2048-bit RSA (RSA_2048)

    • 4096-bit RSA (RSA_4096)

    • Elliptic Prime Curve 256 bit (EC_prime256v1)

    • Elliptic Prime Curve 384 bit (EC_secp384r1)

    • Elliptic Prime Curve 521 bit (EC_secp521r1)

    The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.

    
    
  • domain(Domain) / set_domain(Option<Domain>):
    required: false
    

    The domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.

    After the server is created, the domain cannot be changed.

    
    
  • endpoint_details(EndpointDetails) / set_endpoint_details(Option<EndpointDetails>):
    required: false
    

    The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC’s default security groups are automatically assigned to your endpoint.

    
    
  • endpoint_type(EndpointType) / set_endpoint_type(Option<EndpointType>):
    required: false
    

    The type of endpoint that you want your server to use. You can choose to make your server’s endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.

    After May 19, 2021, you won’t be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn’t already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.

    For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

    It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server’s endpoint and use VPC security groups to restrict traffic by the client’s public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.

    
    
  • host_key(impl Into<String>) / set_host_key(Option<String>):
    required: false
    

    The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want to rotate keys, or have a set of active keys that use different algorithms.

    Use the following command to generate an RSA 2048 bit key with no passphrase:

    ssh-keygen -t rsa -b 2048 -N “” -m PEM -f my-new-server-key.

    Use a minimum value of 2048 for the -b option. You can create a stronger key by using 3072 or 4096.

    Use the following command to generate an ECDSA 256 bit key with no passphrase:

    ssh-keygen -t ecdsa -b 256 -N “” -m PEM -f my-new-server-key.

    Valid values for the -b option for ECDSA are 256, 384, and 521.

    Use the following command to generate an ED25519 key with no passphrase:

    ssh-keygen -t ed25519 -N “” -f my-new-server-key.

    For all of these commands, you can replace my-new-server-key with a string of your choice.

    If you aren’t planning to migrate existing users from an existing SFTP-enabled server to a new server, don’t update the host key. Accidentally changing a server’s host key can be disruptive.

    For more information, see Manage host keys for your SFTP-enabled server in the Transfer Family User Guide.

    
    
  • identity_provider_details(IdentityProviderDetails) / set_identity_provider_details(Option<IdentityProviderDetails>):
    required: false
    

    Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE, Amazon Web Services_LAMBDA or API_GATEWAY. Accepts an array containing all of the information required to use a directory in AWS_DIRECTORY_SERVICE or invoke a customer-supplied authentication API, including the API Gateway URL. Cannot be specified when IdentityProviderType is set to SERVICE_MANAGED.

    
    
  • identity_provider_type(IdentityProviderType) / set_identity_provider_type(Option<IdentityProviderType>):
    required: false
    

    The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service.

    Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails parameter.

    Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter.

    Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter for the IdentityProviderDetails data type.

    
    
  • logging_role(impl Into<String>) / set_logging_role(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, you can view user activity in your CloudWatch logs.

    
    
  • post_authentication_login_banner(impl Into<String>) / set_post_authentication_login_banner(Option<String>):
    required: false
    

    Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.

    The SFTP protocol does not support post-authentication display banners.

    
    
  • pre_authentication_login_banner(impl Into<String>) / set_pre_authentication_login_banner(Option<String>):
    required: false
    

    Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:

    This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.

    
    
  • protocols(Protocol) / set_protocols(Option<Vec::<Protocol>>):
    required: false
    

    Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server’s endpoint. The available protocols are:

    • SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH

    • FTPS (File Transfer Protocol Secure): File transfer with TLS encryption

    • FTP (File Transfer Protocol): Unencrypted file transfer

    • AS2 (Applicability Statement 2): used for transporting structured business-to-business data

    • If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.

    • If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

    • If Protocol includes FTP, then AddressAllocationIds cannot be associated.

    • If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set any of the supported identity types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

    • If Protocol includes AS2, then the EndpointType must be VPC, and domain must be Amazon S3.

    
    
  • protocol_details(ProtocolDetails) / set_protocol_details(Option<ProtocolDetails>):
    required: false
    

    The protocol settings that are configured for your server.

    Avoid placing Network Load Balancers (NLBs) or NAT gateways in front of Transfer Family servers, as this increases costs and can cause performance issues, including reduced connection limits for FTPS. For more details, see Avoid placing NLBs and NATs in front of Transfer Family.

    • To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.

    • To ignore the error that is generated when the client attempts to use the SETSTAT command on a file that you are uploading to an Amazon S3 bucket, use the SetStatOption parameter. To have the Transfer Family server ignore the SETSTAT command and upload files without needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT call.

    • To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the TlsSessionResumptionMode parameter.

    • As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

    
    
  • security_policy_name(impl Into<String>) / set_security_policy_name(Option<String>):
    required: false
    

    Specifies the name of the security policy for the server.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Key-value pairs that can be used to group and search for servers.

    
    
  • workflow_details(WorkflowDetails) / set_workflow_details(Option<WorkflowDetails>):
    required: false
    

    Specifies the workflow ID for the workflow to assign and the execution role that’s used for executing the workflow.

    In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects while the file is still being uploaded.

    
    
  • structured_log_destinations(impl Into<String>) / set_structured_log_destinations(Option<Vec::<String>>):
    required: false
    

    Specifies the log groups to which your server logs are sent.

    To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:

    arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:

    For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:

    If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an update-server call. For example:

    update-server –server-id s-1234567890abcdef0 –structured-log-destinations

    
    
  • s3_storage_options(S3StorageOptions) / set_s3_storage_options(Option<S3StorageOptions>):
    required: false
    

    Specifies whether or not performance for your Amazon S3 directories is optimized.

    • If using the console, this is enabled by default.

    • If using the API or CLI, this is disabled by default.

    By default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.

    
    
  • ip_address_type(IpAddressType) / set_ip_address_type(Option<IpAddressType>):
    required: false
    

    Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and IPv6) for your Transfer Family endpoint. The default value is IPV4.

    The IpAddressType parameter has the following limitations:

    • It cannot be changed while the server is online. You must stop the server before modifying this parameter.

    • It cannot be updated to DUALSTACK if the server has AddressAllocationIds specified.

    When using DUALSTACK as the IpAddressType, you cannot set the AddressAllocationIds parameter for the EndpointDetails for the server.

    
    
• On success, responds with CreateServerOutput with field(s):
  • server_id(String):

    The service-assigned identifier of the server that is created.

• On failure, responds with SdkError<CreateServerError>

impl Client

pub fn create_user(&self) -> CreateUserFluentBuilder

Constructs a fluent builder for the CreateUser operation.

• The fluent builder is configurable:
  • home_directory(impl Into<String>) / set_home_directory(Option<String>):
    required: false
    

    The landing directory (folder) for a user when they log in to the server using the client.

    A HomeDirectory example is /bucket_name/home/mydirectory.

    You can use the HomeDirectory parameter for HomeDirectoryType when it is set to either PATH or LOGICAL.

    
    
  • home_directory_type(HomeDirectoryType) / set_home_directory_type(Option<HomeDirectoryType>):
    required: false
    

    The type of landing directory (folder) that you want your users’ home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your users.

    If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your template.

    
    
  • home_directory_mappings(HomeDirectoryMapEntry) / set_home_directory_mappings(Option<Vec::<HomeDirectoryMapEntry>>):
    required: false
    

    Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL.

    The following is an Entry and Target pair example.

    [ { “Entry”: “/directory1”, “Target”: “/bucket_name/home/mydirectory” } ]

    In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory (“chroot”). To do this, you can set Entry to / and set Target to the value the user should see for their home directory when they log in.

    The following is an Entry and Target pair example for chroot.

    [ { “Entry”: “/”, “Target”: “/bucket_name/home/mydirectory” } ]

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: false
    

    A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user’s access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

    This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies.

    For session policies, Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

    For an example of a session policy, see Example session policy.

    For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.

    
    
  • posix_profile(PosixProfile) / set_posix_profile(Option<PosixProfile>):
    required: false
    

    Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users’ access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in Amazon EFS determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

    
    
  • role(impl Into<String>) / set_role(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users’ access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users’ transfer requests.

    
    
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.

    
    
  • ssh_public_key_body(impl Into<String>) / set_ssh_public_key_body(Option<String>):
    required: false
    

    The public portion of the Secure Shell (SSH) key used to authenticate the user to the server.

    The three standard SSH public key format elements are <key type>, <body base64>, and an optional <comment>, with spaces between each element.

    Transfer Family accepts RSA, ECDSA, and ED25519 keys.

    • For RSA keys, the key type is ssh-rsa.

    • For ED25519 keys, the key type is ssh-ed25519.

    • For ECDSA keys, the key type is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the size of the key you generated.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.

    
    
  • user_name(impl Into<String>) / set_user_name(Option<String>):
    required: true
    

    A unique string that identifies a user and is associated with a ServerId. This user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore ‘_’, hyphen ‘-’, period ‘.’, and at sign ‘@’. The user name can’t start with a hyphen, period, or at sign.

    
    
• On success, responds with CreateUserOutput with field(s):
  • server_id(String):

    The identifier of the server that the user is attached to.

  • user_name(String):

    A unique string that identifies a Transfer Family user.

• On failure, responds with SdkError<CreateUserError>

impl Client

pub fn create_web_app(&self) -> CreateWebAppFluentBuilder

Constructs a fluent builder for the CreateWebApp operation.

• The fluent builder is configurable:
  • identity_provider_details(WebAppIdentityProviderDetails) / set_identity_provider_details(Option<WebAppIdentityProviderDetails>):
    required: true
    

    You can provide a structure that contains the details for the identity provider to use with your web app.

    For more details about this parameter, see Configure your identity provider for Transfer Family web apps.

    
    
  • access_endpoint(impl Into<String>) / set_access_endpoint(Option<String>):
    required: false
    

    The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.

    Before you enter a custom URL for this parameter, follow the steps described in Update your access endpoint with a custom URL.

    
    
  • web_app_units(WebAppUnits) / set_web_app_units(Option<WebAppUnits>):
    required: false
    

    A union that contains the value for number of concurrent connections or the user sessions on your web app.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Key-value pairs that can be used to group and search for web apps.

    
    
  • web_app_endpoint_policy(WebAppEndpointPolicy) / set_web_app_endpoint_policy(Option<WebAppEndpointPolicy>):
    required: false
    

    Setting for the type of endpoint policy for the web app. The default value is STANDARD.

    If you are creating the web app in an Amazon Web Services GovCloud (US) Region, you can set this parameter to FIPS.

    
    
• On success, responds with CreateWebAppOutput with field(s):
  • web_app_id(String):

    Returns a unique identifier for the web app.

• On failure, responds with SdkError<CreateWebAppError>

impl Client

pub fn create_workflow(&self) -> CreateWorkflowFluentBuilder

Constructs a fluent builder for the CreateWorkflow operation.

• The fluent builder is configurable:
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A textual description for the workflow.

    
    
  • steps(WorkflowStep) / set_steps(Option<Vec::<WorkflowStep>>):
    required: true
    

    Specifies the details for the steps that are in the specified workflow.

    The TYPE specifies which of the following actions is being taken for this step.

    • COPY - Copy the file to another location.

    • CUSTOM - Perform a custom step with an Lambda function target.

    • DECRYPT - Decrypt a file that was encrypted before it was uploaded.

    • DELETE - Delete the file.

    • TAG - Add a tag to the file.

    Currently, copying and tagging are supported only on S3.

    For file location, you specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID and path.

    
    
  • on_exception_steps(WorkflowStep) / set_on_exception_steps(Option<Vec::<WorkflowStep>>):
    required: false
    

    Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

    For custom steps, the Lambda function needs to send FAILURE to the call back API to kick off the exception steps. Additionally, if the Lambda does not send SUCCESS before it times out, the exception steps are executed.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

    
    
• On success, responds with CreateWorkflowOutput with field(s):
  • workflow_id(String):

    A unique identifier for the workflow.

• On failure, responds with SdkError<CreateWorkflowError>

impl Client

pub fn delete_access(&self) -> DeleteAccessFluentBuilder

Constructs a fluent builder for the DeleteAccess operation.

• The fluent builder is configurable:
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    A system-assigned unique identifier for a server that has this user assigned.

    
    
  • external_id(impl Into<String>) / set_external_id(Option<String>):
    required: true
    

    A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

    Get-ADGroup -Filter {samAccountName -like “YourGroupName*”} -Properties * | Select SamAccountName,ObjectSid

    In that command, replace YourGroupName with the name of your Active Directory group.

    The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

    
    
• On success, responds with DeleteAccessOutput
• On failure, responds with SdkError<DeleteAccessError>

impl Client

pub fn delete_agreement(&self) -> DeleteAgreementFluentBuilder

Constructs a fluent builder for the DeleteAgreement operation.

• The fluent builder is configurable:
  • agreement_id(impl Into<String>) / set_agreement_id(Option<String>):
    required: true
    

    A unique identifier for the agreement. This identifier is returned when you create an agreement.

    
    
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    The server identifier associated with the agreement that you are deleting.

    
    
• On success, responds with DeleteAgreementOutput
• On failure, responds with SdkError<DeleteAgreementError>

impl Client

pub fn delete_certificate(&self) -> DeleteCertificateFluentBuilder

Constructs a fluent builder for the DeleteCertificate operation.

• The fluent builder is configurable:
  • certificate_id(impl Into<String>) / set_certificate_id(Option<String>):
    required: true
    

    The identifier of the certificate object that you are deleting.

    
    
• On success, responds with DeleteCertificateOutput
• On failure, responds with SdkError<DeleteCertificateError>

impl Client

pub fn delete_connector(&self) -> DeleteConnectorFluentBuilder

Constructs a fluent builder for the DeleteConnector operation.

• The fluent builder is configurable:
  • connector_id(impl Into<String>) / set_connector_id(Option<String>):
    required: true
    

    The unique identifier for the connector.

    
    
• On success, responds with DeleteConnectorOutput
• On failure, responds with SdkError<DeleteConnectorError>

impl Client

pub fn delete_host_key(&self) -> DeleteHostKeyFluentBuilder

Constructs a fluent builder for the DeleteHostKey operation.

• The fluent builder is configurable:
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    The identifier of the server that contains the host key that you are deleting.

    
    
  • host_key_id(impl Into<String>) / set_host_key_id(Option<String>):
    required: true
    

    The identifier of the host key that you are deleting.

    
    
• On success, responds with DeleteHostKeyOutput
• On failure, responds with SdkError<DeleteHostKeyError>

impl Client

pub fn delete_profile(&self) -> DeleteProfileFluentBuilder

Constructs a fluent builder for the DeleteProfile operation.

• The fluent builder is configurable:
  • profile_id(impl Into<String>) / set_profile_id(Option<String>):
    required: true
    

    The identifier of the profile that you are deleting.

    
    
• On success, responds with DeleteProfileOutput
• On failure, responds with SdkError<DeleteProfileError>

impl Client

pub fn delete_server(&self) -> DeleteServerFluentBuilder

Constructs a fluent builder for the DeleteServer operation.

• The fluent builder is configurable:
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    A unique system-assigned identifier for a server instance.

    
    
• On success, responds with DeleteServerOutput
• On failure, responds with SdkError<DeleteServerError>

impl Client

pub fn delete_ssh_public_key(&self) -> DeleteSshPublicKeyFluentBuilder

Constructs a fluent builder for the DeleteSshPublicKey operation.

• The fluent builder is configurable:
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    A system-assigned unique identifier for a file transfer protocol-enabled server instance that has the user assigned to it.

    
    
  • ssh_public_key_id(impl Into<String>) / set_ssh_public_key_id(Option<String>):
    required: true
    

    A unique identifier used to reference your user’s specific SSH key.

    
    
  • user_name(impl Into<String>) / set_user_name(Option<String>):
    required: true
    

    A unique string that identifies a user whose public key is being deleted.

    
    
• On success, responds with DeleteSshPublicKeyOutput
• On failure, responds with SdkError<DeleteSshPublicKeyError>

impl Client

pub fn delete_user(&self) -> DeleteUserFluentBuilder

Constructs a fluent builder for the DeleteUser operation.

• The fluent builder is configurable:
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    A system-assigned unique identifier for a server instance that has the user assigned to it.

    
    
  • user_name(impl Into<String>) / set_user_name(Option<String>):
    required: true
    

    A unique string that identifies a user that is being deleted from a server.

    
    
• On success, responds with DeleteUserOutput
• On failure, responds with SdkError<DeleteUserError>

impl Client

pub fn delete_web_app(&self) -> DeleteWebAppFluentBuilder

Constructs a fluent builder for the DeleteWebApp operation.

• The fluent builder is configurable:
  • web_app_id(impl Into<String>) / set_web_app_id(Option<String>):
    required: true
    

    Provide the unique identifier for the web app that you are deleting.

    
    
• On success, responds with DeleteWebAppOutput
• On failure, responds with SdkError<DeleteWebAppError>

impl Client

pub fn delete_web_app_customization( &self, ) -> DeleteWebAppCustomizationFluentBuilder

Constructs a fluent builder for the DeleteWebAppCustomization operation.

• The fluent builder is configurable:
  • web_app_id(impl Into<String>) / set_web_app_id(Option<String>):
    required: true
    

    Provide the unique identifier for the web app that contains the customizations that you are deleting.

    
    
• On success, responds with DeleteWebAppCustomizationOutput
• On failure, responds with SdkError<DeleteWebAppCustomizationError>

impl Client

pub fn delete_workflow(&self) -> DeleteWorkflowFluentBuilder

Constructs a fluent builder for the DeleteWorkflow operation.

• The fluent builder is configurable:
  • workflow_id(impl Into<String>) / set_workflow_id(Option<String>):
    required: true
    

    A unique identifier for the workflow.

    
    
• On success, responds with DeleteWorkflowOutput
• On failure, responds with SdkError<DeleteWorkflowError>

impl Client

pub fn describe_access(&self) -> DescribeAccessFluentBuilder

Constructs a fluent builder for the DescribeAccess operation.

• The fluent builder is configurable:
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    A system-assigned unique identifier for a server that has this access assigned.

    
    
  • external_id(impl Into<String>) / set_external_id(Option<String>):
    required: true
    

    A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

    Get-ADGroup -Filter {samAccountName -like “YourGroupName*”} -Properties * | Select SamAccountName,ObjectSid

    In that command, replace YourGroupName with the name of your Active Directory group.

    The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

    
    
• On success, responds with DescribeAccessOutput with field(s):
  • server_id(String):

    A system-assigned unique identifier for a server that has this access assigned.

  • access(Option<DescribedAccess>):

    The external identifier of the server that the access is attached to.

• On failure, responds with SdkError<DescribeAccessError>

impl Client

pub fn describe_agreement(&self) -> DescribeAgreementFluentBuilder

Constructs a fluent builder for the DescribeAgreement operation.

• The fluent builder is configurable:
  • agreement_id(impl Into<String>) / set_agreement_id(Option<String>):
    required: true
    

    A unique identifier for the agreement. This identifier is returned when you create an agreement.

    
    
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    The server identifier that’s associated with the agreement.

    
    
• On success, responds with DescribeAgreementOutput with field(s):
  • agreement(Option<DescribedAgreement>):

    The details for the specified agreement, returned as a DescribedAgreement object.

• On failure, responds with SdkError<DescribeAgreementError>

impl Client

pub fn describe_certificate(&self) -> DescribeCertificateFluentBuilder

Constructs a fluent builder for the DescribeCertificate operation.

• The fluent builder is configurable:
  • certificate_id(impl Into<String>) / set_certificate_id(Option<String>):
    required: true
    

    An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

    
    
• On success, responds with DescribeCertificateOutput with field(s):
  • certificate(Option<DescribedCertificate>):

    The details for the specified certificate, returned as an object.

• On failure, responds with SdkError<DescribeCertificateError>

impl Client

pub fn describe_connector(&self) -> DescribeConnectorFluentBuilder

Constructs a fluent builder for the DescribeConnector operation.

• The fluent builder is configurable:
  • connector_id(impl Into<String>) / set_connector_id(Option<String>):
    required: true
    

    The unique identifier for the connector.

    
    
• On success, responds with DescribeConnectorOutput with field(s):
  • connector(Option<DescribedConnector>):

    The structure that contains the details of the connector.

• On failure, responds with SdkError<DescribeConnectorError>

impl Client

pub fn describe_execution(&self) -> DescribeExecutionFluentBuilder

Constructs a fluent builder for the DescribeExecution operation.

• The fluent builder is configurable:
  • execution_id(impl Into<String>) / set_execution_id(Option<String>):
    required: true
    

    A unique identifier for the execution of a workflow.

    
    
  • workflow_id(impl Into<String>) / set_workflow_id(Option<String>):
    required: true
    

    A unique identifier for the workflow.

    
    
• On success, responds with DescribeExecutionOutput with field(s):
  • workflow_id(String):

    A unique identifier for the workflow.

  • execution(Option<DescribedExecution>):

    The structure that contains the details of the workflow’ execution.

• On failure, responds with SdkError<DescribeExecutionError>

impl Client

pub fn describe_host_key(&self) -> DescribeHostKeyFluentBuilder

Constructs a fluent builder for the DescribeHostKey operation.

• The fluent builder is configurable:
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    The identifier of the server that contains the host key that you want described.

    
    
  • host_key_id(impl Into<String>) / set_host_key_id(Option<String>):
    required: true
    

    The identifier of the host key that you want described.

    
    
• On success, responds with DescribeHostKeyOutput with field(s):
  • host_key(Option<DescribedHostKey>):

    Returns the details for the specified host key.

• On failure, responds with SdkError<DescribeHostKeyError>

impl Client

pub fn describe_profile(&self) -> DescribeProfileFluentBuilder

Constructs a fluent builder for the DescribeProfile operation.

• The fluent builder is configurable:
  • profile_id(impl Into<String>) / set_profile_id(Option<String>):
    required: true
    

    The identifier of the profile that you want described.

    
    
• On success, responds with DescribeProfileOutput with field(s):
  • profile(Option<DescribedProfile>):

    The details of the specified profile, returned as an object.

• On failure, responds with SdkError<DescribeProfileError>

impl Client

pub fn describe_security_policy(&self) -> DescribeSecurityPolicyFluentBuilder

Constructs a fluent builder for the DescribeSecurityPolicy operation.

• The fluent builder is configurable:
  • security_policy_name(impl Into<String>) / set_security_policy_name(Option<String>):
    required: true
    

    Specify the text name of the security policy for which you want the details.

    
    
• On success, responds with DescribeSecurityPolicyOutput with field(s):
  • security_policy(Option<DescribedSecurityPolicy>):

    An array containing the properties of the security policy.

• On failure, responds with SdkError<DescribeSecurityPolicyError>

impl Client

pub fn describe_server(&self) -> DescribeServerFluentBuilder

Constructs a fluent builder for the DescribeServer operation.

• The fluent builder is configurable:
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    A system-assigned unique identifier for a server.

    
    
• On success, responds with DescribeServerOutput with field(s):
  • server(Option<DescribedServer>):

    An array containing the properties of a server with the ServerID you specified.

• On failure, responds with SdkError<DescribeServerError>

impl Client

pub fn describe_user(&self) -> DescribeUserFluentBuilder

Constructs a fluent builder for the DescribeUser operation.

• The fluent builder is configurable:
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    A system-assigned unique identifier for a server that has this user assigned.

    
    
  • user_name(impl Into<String>) / set_user_name(Option<String>):
    required: true
    

    The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the Transfer Family service and perform file transfer tasks.

    
    
• On success, responds with DescribeUserOutput with field(s):
  • server_id(String):

    A system-assigned unique identifier for a server that has this user assigned.

  • user(Option<DescribedUser>):

    An array containing the properties of the Transfer Family user for the ServerID value that you specified.

• On failure, responds with SdkError<DescribeUserError>

impl Client

pub fn describe_web_app(&self) -> DescribeWebAppFluentBuilder

Constructs a fluent builder for the DescribeWebApp operation.

• The fluent builder is configurable:
  • web_app_id(impl Into<String>) / set_web_app_id(Option<String>):
    required: true
    

    Provide the unique identifier for the web app.

    
    
• On success, responds with DescribeWebAppOutput with field(s):
  • web_app(Option<DescribedWebApp>):

    Returns a structure that contains the details of the web app.

• On failure, responds with SdkError<DescribeWebAppError>

impl Client

pub fn describe_web_app_customization( &self, ) -> DescribeWebAppCustomizationFluentBuilder

Constructs a fluent builder for the DescribeWebAppCustomization operation.

• The fluent builder is configurable:
  • web_app_id(impl Into<String>) / set_web_app_id(Option<String>):
    required: true
    

    Provide the unique identifier for the web app.

    
    
• On success, responds with DescribeWebAppCustomizationOutput with field(s):
  • web_app_customization(Option<DescribedWebAppCustomization>):

    Returns a structure that contains the details of the web app customizations.

• On failure, responds with SdkError<DescribeWebAppCustomizationError>

impl Client

pub fn describe_workflow(&self) -> DescribeWorkflowFluentBuilder

Constructs a fluent builder for the DescribeWorkflow operation.

• The fluent builder is configurable:
  • workflow_id(impl Into<String>) / set_workflow_id(Option<String>):
    required: true
    

    A unique identifier for the workflow.

    
    
• On success, responds with DescribeWorkflowOutput with field(s):
  • workflow(Option<DescribedWorkflow>):

    The structure that contains the details of the workflow.

• On failure, responds with SdkError<DescribeWorkflowError>

impl Client

pub fn import_certificate(&self) -> ImportCertificateFluentBuilder

Constructs a fluent builder for the ImportCertificate operation.

• The fluent builder is configurable:
  • usage(CertificateUsageType) / set_usage(Option<CertificateUsageType>):
    required: true
    

    Specifies how this certificate is used. It can be used in the following ways:

    • SIGNING: For signing AS2 messages

    • ENCRYPTION: For encrypting AS2 messages

    • TLS: For securing AS2 communications sent over HTTPS

    
    
  • certificate(impl Into<String>) / set_certificate(Option<String>):
    required: true
    

    • For the CLI, provide a file path for a certificate in URI format. For example, –certificate file://encryption-cert.pem. Alternatively, you can provide the raw content.

    • For the SDK, specify the raw content of a certificate file. For example, –certificate “cat encryption-cert.pem”.

    You can provide both the certificate and its chain in this parameter, without needing to use the CertificateChain parameter. If you use this parameter for both the certificate and its chain, do not use the CertificateChain parameter.

    
    
  • certificate_chain(impl Into<String>) / set_certificate_chain(Option<String>):
    required: false
    

    An optional list of certificates that make up the chain for the certificate that’s being imported.

    
    
  • private_key(impl Into<String>) / set_private_key(Option<String>):
    required: false
    

    • For the CLI, provide a file path for a private key in URI format. For example, –private-key file://encryption-key.pem. Alternatively, you can provide the raw content of the private key file.

    • For the SDK, specify the raw content of a private key file. For example, –private-key “cat encryption-key.pem”

    
    
  • active_date(DateTime) / set_active_date(Option<DateTime>):
    required: false
    

    An optional date that specifies when the certificate becomes active. If you do not specify a value, ActiveDate takes the same value as NotBeforeDate, which is specified by the CA.

    
    
  • inactive_date(DateTime) / set_inactive_date(Option<DateTime>):
    required: false
    

    An optional date that specifies when the certificate becomes inactive. If you do not specify a value, InactiveDate takes the same value as NotAfterDate, which is specified by the CA.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A short description that helps identify the certificate.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Key-value pairs that can be used to group and search for certificates.

    
    
• On success, responds with ImportCertificateOutput with field(s):
  • certificate_id(String):

    An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

• On failure, responds with SdkError<ImportCertificateError>

impl Client

pub fn import_host_key(&self) -> ImportHostKeyFluentBuilder

Constructs a fluent builder for the ImportHostKey operation.

• The fluent builder is configurable:
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    The identifier of the server that contains the host key that you are importing.

    
    
  • host_key_body(impl Into<String>) / set_host_key_body(Option<String>):
    required: true
    

    The private key portion of an SSH key pair.

    Transfer Family accepts RSA, ECDSA, and ED25519 keys.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The text description that identifies this host key.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Key-value pairs that can be used to group and search for host keys.

    
    
• On success, responds with ImportHostKeyOutput with field(s):
  • server_id(String):

    Returns the server identifier that contains the imported key.

  • host_key_id(String):

    Returns the host key identifier for the imported key.

• On failure, responds with SdkError<ImportHostKeyError>

impl Client

pub fn import_ssh_public_key(&self) -> ImportSshPublicKeyFluentBuilder

Constructs a fluent builder for the ImportSshPublicKey operation.

• The fluent builder is configurable:
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    A system-assigned unique identifier for a server.

    
    
  • ssh_public_key_body(impl Into<String>) / set_ssh_public_key_body(Option<String>):
    required: true
    

    The public key portion of an SSH key pair.

    Transfer Family accepts RSA, ECDSA, and ED25519 keys.

    
    
  • user_name(impl Into<String>) / set_user_name(Option<String>):
    required: true
    

    The name of the Transfer Family user that is assigned to one or more servers.

    
    
• On success, responds with ImportSshPublicKeyOutput with field(s):
  • server_id(String):

    A system-assigned unique identifier for a server.

  • ssh_public_key_id(String):

    The name given to a public key by the system that was imported.

  • user_name(String):

    A user name assigned to the ServerID value that you specified.

• On failure, responds with SdkError<ImportSshPublicKeyError>

impl Client

pub fn list_accesses(&self) -> ListAccessesFluentBuilder

Constructs a fluent builder for the ListAccesses operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    When you can get additional results from the ListAccesses call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional accesses.

    
    
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    A system-assigned unique identifier for a server that has users assigned to it.

    
    
• On success, responds with ListAccessesOutput with field(s):
  • next_token(Option<String>):

    When you can get additional results from the ListAccesses call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional accesses.

  • server_id(String):

    A system-assigned unique identifier for a server that has users assigned to it.

  • accesses(Vec::<ListedAccess>):

    Returns the accesses and their properties for the ServerId value that you specify.

• On failure, responds with SdkError<ListAccessesError>

impl Client

pub fn list_agreements(&self) -> ListAgreementsFluentBuilder

Constructs a fluent builder for the ListAgreements operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    When you can get additional results from the ListAgreements call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional agreements.

    
    
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    The identifier of the server for which you want a list of agreements.

    
    
• On success, responds with ListAgreementsOutput with field(s):
  • next_token(Option<String>):

    Returns a token that you can use to call ListAgreements again and receive additional results, if there are any.

  • agreements(Vec::<ListedAgreement>):

    Returns an array, where each item contains the details of an agreement.

• On failure, responds with SdkError<ListAgreementsError>

impl Client

pub fn list_certificates(&self) -> ListCertificatesFluentBuilder

Constructs a fluent builder for the ListCertificates operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    When you can get additional results from the ListCertificates call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional certificates.

    
    
• On success, responds with ListCertificatesOutput with field(s):
  • next_token(Option<String>):

    Returns the next token, which you can use to list the next certificate.

  • certificates(Vec::<ListedCertificate>):

    Returns an array of the certificates that are specified in the ListCertificates call.

• On failure, responds with SdkError<ListCertificatesError>

impl Client

pub fn list_connectors(&self) -> ListConnectorsFluentBuilder

Constructs a fluent builder for the ListConnectors operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    When you can get additional results from the ListConnectors call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional connectors.

    
    
• On success, responds with ListConnectorsOutput with field(s):
  • next_token(Option<String>):

    Returns a token that you can use to call ListConnectors again and receive additional results, if there are any.

  • connectors(Vec::<ListedConnector>):

    Returns an array, where each item contains the details of a connector.

• On failure, responds with SdkError<ListConnectorsError>

impl Client

pub fn list_executions(&self) -> ListExecutionsFluentBuilder

Constructs a fluent builder for the ListExecutions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

    This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to list first 10. If so, call the API by specifying the max-results:

    aws transfer list-executions –max-results 10

    This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh execution. You can now call the API again, supplying the NextToken value you received:

    aws transfer list-executions –max-results 10 –next-token $somePointerReturnedFromPreviousListResult

    This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned.

    
    
  • workflow_id(impl Into<String>) / set_workflow_id(Option<String>):
    required: true
    

    A unique identifier for the workflow.

    
    
• On success, responds with ListExecutionsOutput with field(s):
  • next_token(Option<String>):

    ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

  • workflow_id(String):

    A unique identifier for the workflow.

  • executions(Vec::<ListedExecution>):

    Returns the details for each execution, in a ListedExecution array.

• On failure, responds with SdkError<ListExecutionsError>

impl Client

pub fn list_file_transfer_results(&self) -> ListFileTransferResultsFluentBuilder

Constructs a fluent builder for the ListFileTransferResults operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • connector_id(impl Into<String>) / set_connector_id(Option<String>):
    required: true
    

    A unique identifier for a connector. This value should match the value supplied to the corresponding StartFileTransfer call.

    
    
  • transfer_id(impl Into<String>) / set_transfer_id(Option<String>):
    required: true
    

    A unique identifier for a file transfer. This value should match the value supplied to the corresponding StartFileTransfer call.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If there are more file details than returned in this call, use this value for a subsequent call to ListFileTransferResults to retrieve them.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of files to return in a single page. Note that currently you can specify a maximum of 10 file paths in a single StartFileTransfer operation. Thus, the maximum number of file transfer results that can be returned in a single page is 10.

    
    
• On success, responds with ListFileTransferResultsOutput with field(s):
  • file_transfer_results(Vec::<ConnectorFileTransferResult>):

    Returns the details for the files transferred in the transfer identified by the TransferId and ConnectorId specified.

    • FilePath: the filename and path to where the file was sent to or retrieved from.

    • StatusCode: current status for the transfer. The status returned is one of the following values:QUEUED, IN_PROGRESS, COMPLETED, or FAILED

    • FailureCode: for transfers that fail, this parameter contains a code indicating the reason. For example, RETRIEVE_FILE_NOT_FOUND

    • FailureMessage: for transfers that fail, this parameter describes the reason for the failure.

  • next_token(Option<String>):

    Returns a token that you can use to call ListFileTransferResults again and receive additional results, if there are any (against the same TransferId.

• On failure, responds with SdkError<ListFileTransferResultsError>

impl Client

pub fn list_host_keys(&self) -> ListHostKeysFluentBuilder

Constructs a fluent builder for the ListHostKeys operation.

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    When there are additional results that were not returned, a NextToken parameter is returned. You can use that value for a subsequent call to ListHostKeys to continue listing results.

    
    
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    The identifier of the server that contains the host keys that you want to view.

    
    
• On success, responds with ListHostKeysOutput with field(s):
  • next_token(Option<String>):

    Returns a token that you can use to call ListHostKeys again and receive additional results, if there are any.

  • server_id(String):

    Returns the server identifier that contains the listed host keys.

  • host_keys(Vec::<ListedHostKey>):

    Returns an array, where each item contains the details of a host key.

• On failure, responds with SdkError<ListHostKeysError>

impl Client

pub fn list_profiles(&self) -> ListProfilesFluentBuilder

Constructs a fluent builder for the ListProfiles operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    When there are additional results that were not returned, a NextToken parameter is returned. You can use that value for a subsequent call to ListProfiles to continue listing results.

    
    
  • profile_type(ProfileType) / set_profile_type(Option<ProfileType>):
    required: false
    

    Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

    
    
• On success, responds with ListProfilesOutput with field(s):
  • next_token(Option<String>):

    Returns a token that you can use to call ListProfiles again and receive additional results, if there are any.

  • profiles(Vec::<ListedProfile>):

    Returns an array, where each item contains the details of a profile.

• On failure, responds with SdkError<ListProfilesError>

impl Client

pub fn list_security_policies(&self) -> ListSecurityPoliciesFluentBuilder

Constructs a fluent builder for the ListSecurityPolicies operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Specifies the number of security policies to return as a response to the ListSecurityPolicies query.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    When additional results are obtained from the ListSecurityPolicies command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional security policies.

    
    
• On success, responds with ListSecurityPoliciesOutput with field(s):
  • next_token(Option<String>):

    When you can get additional results from the ListSecurityPolicies operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing security policies.

  • security_policy_names(Vec::<String>):

    An array of security policies that were listed.

• On failure, responds with SdkError<ListSecurityPoliciesError>

impl Client

pub fn list_servers(&self) -> ListServersFluentBuilder

Constructs a fluent builder for the ListServers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Specifies the number of servers to return as a response to the ListServers query.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    When additional results are obtained from the ListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional servers.

    
    
• On success, responds with ListServersOutput with field(s):
  • next_token(Option<String>):

    When you can get additional results from the ListServers operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing additional servers.

  • servers(Vec::<ListedServer>):

    An array of servers that were listed.

• On failure, responds with SdkError<ListServersError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific Amazon Web Services resource, such as a server, user, or role.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Specifies the number of tags to return as a response to the ListTagsForResource request.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    When you request additional results from the ListTagsForResource operation, a NextToken parameter is returned in the input. You can then pass in a subsequent command to the NextToken parameter to continue listing additional tags.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • arn(Option<String>):

    The ARN you specified to list the tags of.

  • next_token(Option<String>):

    When you can get additional results from the ListTagsForResource call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional tags.

  • tags(Option<Vec::<Tag>>):

    Key-value pairs that are assigned to a resource, usually for the purpose of grouping and searching for items. Tags are metadata that you define.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_users(&self) -> ListUsersFluentBuilder

Constructs a fluent builder for the ListUsers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Specifies the number of users to return as a response to the ListUsers request.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If there are additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass the NextToken to a subsequent ListUsers command, to continue listing additional users.

    
    
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    A system-assigned unique identifier for a server that has users assigned to it.

    
    
• On success, responds with ListUsersOutput with field(s):
  • next_token(Option<String>):

    When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional users.

  • server_id(String):

    A system-assigned unique identifier for a server that the users are assigned to.

  • users(Vec::<ListedUser>):

    Returns the Transfer Family users and their properties for the ServerId value that you specify.

• On failure, responds with SdkError<ListUsersError>

impl Client

pub fn list_web_apps(&self) -> ListWebAppsFluentBuilder

Constructs a fluent builder for the ListWebApps operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional web apps.

    
    
• On success, responds with ListWebAppsOutput with field(s):
  • next_token(Option<String>):

    Provide this value for the NextToken parameter in a subsequent command to continue listing additional web apps.

  • web_apps(Vec::<ListedWebApp>):

    Returns, for each listed web app, a structure that contains details for the web app.

• On failure, responds with SdkError<ListWebAppsError>

impl Client

pub fn list_workflows(&self) -> ListWorkflowsFluentBuilder

Constructs a fluent builder for the ListWorkflows operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    ListWorkflows returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional workflows.

    
    
• On success, responds with ListWorkflowsOutput with field(s):
  • next_token(Option<String>):

    ListWorkflows returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional workflows.

  • workflows(Vec::<ListedWorkflow>):

    Returns the Arn, WorkflowId, and Description for each workflow.

• On failure, responds with SdkError<ListWorkflowsError>

impl Client

pub fn send_workflow_step_state(&self) -> SendWorkflowStepStateFluentBuilder

Constructs a fluent builder for the SendWorkflowStepState operation.

• The fluent builder is configurable:
  • workflow_id(impl Into<String>) / set_workflow_id(Option<String>):
    required: true
    

    A unique identifier for the workflow.

    
    
  • execution_id(impl Into<String>) / set_execution_id(Option<String>):
    required: true
    

    A unique identifier for the execution of a workflow.

    
    
  • token(impl Into<String>) / set_token(Option<String>):
    required: true
    

    Used to distinguish between multiple callbacks for multiple Lambda steps within the same execution.

    
    
  • status(CustomStepStatus) / set_status(Option<CustomStepStatus>):
    required: true
    

    Indicates whether the specified step succeeded or failed.

    
    
• On success, responds with SendWorkflowStepStateOutput
• On failure, responds with SdkError<SendWorkflowStepStateError>

impl Client

pub fn start_directory_listing(&self) -> StartDirectoryListingFluentBuilder

Constructs a fluent builder for the StartDirectoryListing operation.

• The fluent builder is configurable:
  • connector_id(impl Into<String>) / set_connector_id(Option<String>):
    required: true
    

    The unique identifier for the connector.

    
    
  • remote_directory_path(impl Into<String>) / set_remote_directory_path(Option<String>):
    required: true
    

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

    
    
  • max_items(i32) / set_max_items(Option<i32>):
    required: false
    

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

    
    
  • output_directory_path(impl Into<String>) / set_output_directory_path(Option<String>):
    required: true
    

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

    
    
• On success, responds with StartDirectoryListingOutput with field(s):
  • listing_id(String):

    Returns a unique identifier for the directory listing call.

  • output_file_name(String):

    Returns the file name where the results are stored. This is a combination of the connector ID and the listing ID: <connector-id>-<listing-id>.json.

• On failure, responds with SdkError<StartDirectoryListingError>

impl Client

pub fn start_file_transfer(&self) -> StartFileTransferFluentBuilder

Constructs a fluent builder for the StartFileTransfer operation.

• The fluent builder is configurable:
  • connector_id(impl Into<String>) / set_connector_id(Option<String>):
    required: true
    

    The unique identifier for the connector.

    
    
  • send_file_paths(impl Into<String>) / set_send_file_paths(Option<Vec::<String>>):
    required: false
    

    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 .

    Replace amzn-s3-demo-bucket with one of your actual buckets.

    
    
  • retrieve_file_paths(impl Into<String>) / set_retrieve_file_paths(Option<Vec::<String>>):
    required: false
    

    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(impl Into<String>) / set_local_directory_path(Option<String>):
    required: false
    

    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(impl Into<String>) / set_remote_directory_path(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with StartFileTransferOutput with field(s):
  • transfer_id(String):

    Returns the unique identifier for the file transfer.

• On failure, responds with SdkError<StartFileTransferError>

impl Client

pub fn start_remote_delete(&self) -> StartRemoteDeleteFluentBuilder

Constructs a fluent builder for the StartRemoteDelete operation.

• The fluent builder is configurable:
  • connector_id(impl Into<String>) / set_connector_id(Option<String>):
    required: true
    

    The unique identifier for the connector.

    
    
  • delete_path(impl Into<String>) / set_delete_path(Option<String>):
    required: true
    

    The absolute path of the file or directory to delete. You can only specify one path per call to this operation.

    
    
• On success, responds with StartRemoteDeleteOutput with field(s):
  • delete_id(String):

    Returns a unique identifier for the delete operation.

• On failure, responds with SdkError<StartRemoteDeleteError>

impl Client

pub fn start_remote_move(&self) -> StartRemoteMoveFluentBuilder

Constructs a fluent builder for the StartRemoteMove operation.

• The fluent builder is configurable:
  • connector_id(impl Into<String>) / set_connector_id(Option<String>):
    required: true
    

    The unique identifier for the connector.

    
    
  • source_path(impl Into<String>) / set_source_path(Option<String>):
    required: true
    

    The absolute path of the file or directory to move or rename. You can only specify one path per call to this operation.

    
    
  • target_path(impl Into<String>) / set_target_path(Option<String>):
    required: true
    

    The absolute path for the target of the move/rename operation.

    
    
• On success, responds with StartRemoteMoveOutput with field(s):
  • move_id(String):

    Returns a unique identifier for the move/rename operation.

• On failure, responds with SdkError<StartRemoteMoveError>

impl Client

pub fn start_server(&self) -> StartServerFluentBuilder

Constructs a fluent builder for the StartServer operation.

• The fluent builder is configurable:
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    A system-assigned unique identifier for a server that you start.

    
    
• On success, responds with StartServerOutput
• On failure, responds with SdkError<StartServerError>

impl Client

pub fn stop_server(&self) -> StopServerFluentBuilder

Constructs a fluent builder for the StopServer operation.

• The fluent builder is configurable:
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    A system-assigned unique identifier for a server that you stopped.

    
    
• On success, responds with StopServerOutput
• On failure, responds with SdkError<StopServerError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    An Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a server, user, or role.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    Key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (servers, users, workflows, and so on) for any purpose.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn test_connection(&self) -> TestConnectionFluentBuilder

Constructs a fluent builder for the TestConnection operation.

• The fluent builder is configurable:
  • connector_id(impl Into<String>) / set_connector_id(Option<String>):
    required: true
    

    The unique identifier for the connector.

    
    
• On success, responds with TestConnectionOutput with field(s):
  • connector_id(Option<String>):

    Returns the identifier of the connector object that you are testing.

  • status(Option<String>):

    Returns OK for successful test, or ERROR if the test fails.

  • status_message(Option<String>):

    Returns Connection succeeded if the test is successful. Or, returns a descriptive error message if the test fails. The following list provides troubleshooting details, depending on the error message that you receive.

    • Verify that your secret name aligns with the one in Transfer Role permissions.

    • Verify the server URL in the connector configuration , and verify that the login credentials work successfully outside of the connector.

    • Verify that the secret exists and is formatted correctly.

    • Verify that the trusted host key in the connector configuration matches the ssh-keyscan output.

  • sftp_connection_details(Option<SftpConnectorConnectionDetails>):

    Structure that contains the SFTP connector host key.

• On failure, responds with SdkError<TestConnectionError>

impl Client

pub fn test_identity_provider(&self) -> TestIdentityProviderFluentBuilder

Constructs a fluent builder for the TestIdentityProvider operation.

• The fluent builder is configurable:
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    A system-assigned identifier for a specific server. That server’s user authentication method is tested with a user name and password.

    
    
  • server_protocol(Protocol) / set_server_protocol(Option<Protocol>):
    required: false
    

    The type of file transfer protocol to be tested.

    The available protocols are:

    • Secure Shell (SSH) File Transfer Protocol (SFTP)

    • File Transfer Protocol Secure (FTPS)

    • File Transfer Protocol (FTP)

    • Applicability Statement 2 (AS2)

    
    
  • source_ip(impl Into<String>) / set_source_ip(Option<String>):
    required: false
    

    The source IP address of the account to be tested.

    
    
  • user_name(impl Into<String>) / set_user_name(Option<String>):
    required: true
    

    The name of the account to be tested.

    
    
  • user_password(impl Into<String>) / set_user_password(Option<String>):
    required: false
    

    The password of the account to be tested.

    
    
• On success, responds with TestIdentityProviderOutput with field(s):
  • response(Option<String>):

    The response that is returned from your API Gateway or your Lambda function.

  • status_code(i32):

    The HTTP status code that is the response from your API Gateway or your Lambda function.

  • message(Option<String>):

    A message that indicates whether the test was successful or not.

    If an empty string is returned, the most likely cause is that the authentication failed due to an incorrect username or password.

  • url(String):

    The endpoint of the service used to authenticate a user.

• On failure, responds with SdkError<TestIdentityProviderError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific Amazon Web Services resource, such as a server, user, or role.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    TagKeys are key-value pairs assigned to ARNs that can be used to group and search for resources by type. This metadata can be attached to resources for any purpose.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_access(&self) -> UpdateAccessFluentBuilder

Constructs a fluent builder for the UpdateAccess operation.

• The fluent builder is configurable:
  • home_directory(impl Into<String>) / set_home_directory(Option<String>):
    required: false
    

    The landing directory (folder) for a user when they log in to the server using the client.

    A HomeDirectory example is /bucket_name/home/mydirectory.

    You can use the HomeDirectory parameter for HomeDirectoryType when it is set to either PATH or LOGICAL.

    
    
  • home_directory_type(HomeDirectoryType) / set_home_directory_type(Option<HomeDirectoryType>):
    required: false
    

    The type of landing directory (folder) that you want your users’ home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your users.

    If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your template.

    
    
  • home_directory_mappings(HomeDirectoryMapEntry) / set_home_directory_mappings(Option<Vec::<HomeDirectoryMapEntry>>):
    required: false
    

    Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL.

    The following is an Entry and Target pair example.

    [ { “Entry”: “/directory1”, “Target”: “/bucket_name/home/mydirectory” } ]

    In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory (“chroot”). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.

    The following is an Entry and Target pair example for chroot.

    [ { “Entry”: “/”, “Target”: “/bucket_name/home/mydirectory” } ]

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: false
    

    A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user’s access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

    This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies.

    For session policies, Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

    For an example of a session policy, see Example session policy.

    For more information, see AssumeRole in the Amazon Web ServicesSecurity Token Service API Reference.

    
    
  • posix_profile(PosixProfile) / set_posix_profile(Option<PosixProfile>):
    required: false
    

    The full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users’ access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

    
    
  • role(impl Into<String>) / set_role(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users’ access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users’ transfer requests.

    
    
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.

    
    
  • external_id(impl Into<String>) / set_external_id(Option<String>):
    required: true
    

    A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

    Get-ADGroup -Filter {samAccountName -like “YourGroupName*”} -Properties * | Select SamAccountName,ObjectSid

    In that command, replace YourGroupName with the name of your Active Directory group.

    The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

    
    
• On success, responds with UpdateAccessOutput with field(s):
  • server_id(String):

    The identifier of the server that the user is attached to.

  • external_id(String):

    The external identifier of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web ServicesTransfer Family.

• On failure, responds with SdkError<UpdateAccessError>

impl Client

pub fn update_agreement(&self) -> UpdateAgreementFluentBuilder

Constructs a fluent builder for the UpdateAgreement operation.

• The fluent builder is configurable:
  • agreement_id(impl Into<String>) / set_agreement_id(Option<String>):
    required: true
    

    A unique identifier for the agreement. This identifier is returned when you create an agreement.

    
    
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    To replace the existing description, provide a short description for the agreement.

    
    
  • status(AgreementStatusType) / set_status(Option<AgreementStatusType>):
    required: false
    

    You can update the status for the agreement, either activating an inactive agreement or the reverse.

    
    
  • local_profile_id(impl Into<String>) / set_local_profile_id(Option<String>):
    required: false
    

    A unique identifier for the AS2 local profile.

    To change the local profile identifier, provide a new value here.

    
    
  • partner_profile_id(impl Into<String>) / set_partner_profile_id(Option<String>):
    required: false
    

    A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here.

    
    
  • base_directory(impl Into<String>) / set_base_directory(Option<String>):
    required: false
    

    To change the landing directory (folder) for files that are transferred, provide the bucket folder that you want to use; for example, /amzn-s3-demo-bucket/home/mydirectory .

    
    
  • access_role(impl Into<String>) / set_access_role(Option<String>):
    required: false
    

    Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

    For AS2 connectors

    With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for –send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

    If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

    For SFTP connectors

    Make sure that the access role provides read and write access to the parent directory of the file location that’s used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.

    
    
  • preserve_filename(PreserveFilenameType) / set_preserve_filename(Option<PreserveFilenameType>):
    required: false
    

    Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.

    • ENABLED: the filename provided by your trading parter is preserved when the file is saved.

    • DISABLED (default value): when Transfer Family saves the file, the filename is adjusted, as described in File names and locations.

    
    
  • enforce_message_signing(EnforceMessageSigningType) / set_enforce_message_signing(Option<EnforceMessageSigningType>):
    required: false
    

    Determines whether or not unsigned messages from your trading partners will be accepted.

    • ENABLED: Transfer Family rejects unsigned messages from your trading partner.

    • DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner.

    
    
  • custom_directories(CustomDirectoriesType) / set_custom_directories(Option<CustomDirectoriesType>):
    required: false
    

    A CustomDirectoriesType structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.

    • Failed files

    • MDN files

    • Payload files

    • Status files

    • Temporary files

    
    
• On success, responds with UpdateAgreementOutput with field(s):
  • agreement_id(String):

    A unique identifier for the agreement. This identifier is returned when you create an agreement.

• On failure, responds with SdkError<UpdateAgreementError>

impl Client

pub fn update_certificate(&self) -> UpdateCertificateFluentBuilder

Constructs a fluent builder for the UpdateCertificate operation.

• The fluent builder is configurable:
  • certificate_id(impl Into<String>) / set_certificate_id(Option<String>):
    required: true
    

    The identifier of the certificate object that you are updating.

    
    
  • active_date(DateTime) / set_active_date(Option<DateTime>):
    required: false
    

    An optional date that specifies when the certificate becomes active. If you do not specify a value, ActiveDate takes the same value as NotBeforeDate, which is specified by the CA.

    
    
  • inactive_date(DateTime) / set_inactive_date(Option<DateTime>):
    required: false
    

    An optional date that specifies when the certificate becomes inactive. If you do not specify a value, InactiveDate takes the same value as NotAfterDate, which is specified by the CA.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A short description to help identify the certificate.

    
    
• On success, responds with UpdateCertificateOutput with field(s):
  • certificate_id(String):

    Returns the identifier of the certificate object that you are updating.

• On failure, responds with SdkError<UpdateCertificateError>

impl Client

pub fn update_connector(&self) -> UpdateConnectorFluentBuilder

Constructs a fluent builder for the UpdateConnector operation.

• The fluent builder is configurable:
  • connector_id(impl Into<String>) / set_connector_id(Option<String>):
    required: true
    

    The unique identifier for the connector.

    
    
  • url(impl Into<String>) / set_url(Option<String>):
    required: false
    

    The URL of the partner’s AS2 or SFTP endpoint.

    When creating AS2 connectors or service-managed SFTP connectors (connectors without egress configuration), you must provide a URL to specify the remote server endpoint. For VPC Lattice type connectors, the URL must be null.

    
    
  • as2_config(As2ConnectorConfig) / set_as2_config(Option<As2ConnectorConfig>):
    required: false
    

    A structure that contains the parameters for an AS2 connector object.

    
    
  • access_role(impl Into<String>) / set_access_role(Option<String>):
    required: false
    

    Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

    For AS2 connectors

    With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for –send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

    If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

    For SFTP connectors

    Make sure that the access role provides read and write access to the parent directory of the file location that’s used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.

    
    
  • logging_role(impl Into<String>) / set_logging_role(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.

    
    
  • sftp_config(SftpConnectorConfig) / set_sftp_config(Option<SftpConnectorConfig>):
    required: false
    

    A structure that contains the parameters for an SFTP connector object.

    
    
  • security_policy_name(impl Into<String>) / set_security_policy_name(Option<String>):
    required: false
    

    Specifies the name of the security policy for the connector.

    
    
  • egress_config(UpdateConnectorEgressConfig) / set_egress_config(Option<UpdateConnectorEgressConfig>):
    required: false
    

    Updates the egress configuration for the connector, allowing you to modify how traffic is routed from the connector to the SFTP server. Changes to VPC configuration may require connector restart.

    
    
• On success, responds with UpdateConnectorOutput with field(s):
  • connector_id(String):

    Returns the identifier of the connector object that you are updating.

• On failure, responds with SdkError<UpdateConnectorError>

impl Client

pub fn update_host_key(&self) -> UpdateHostKeyFluentBuilder

Constructs a fluent builder for the UpdateHostKey operation.

• The fluent builder is configurable:
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    The identifier of the server that contains the host key that you are updating.

    
    
  • host_key_id(impl Into<String>) / set_host_key_id(Option<String>):
    required: true
    

    The identifier of the host key that you are updating.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: true
    

    An updated description for the host key.

    
    
• On success, responds with UpdateHostKeyOutput with field(s):
  • server_id(String):

    Returns the server identifier for the server that contains the updated host key.

  • host_key_id(String):

    Returns the host key identifier for the updated host key.

• On failure, responds with SdkError<UpdateHostKeyError>

impl Client

pub fn update_profile(&self) -> UpdateProfileFluentBuilder

Constructs a fluent builder for the UpdateProfile operation.

• The fluent builder is configurable:
  • profile_id(impl Into<String>) / set_profile_id(Option<String>):
    required: true
    

    The identifier of the profile object that you are updating.

    
    
  • certificate_ids(impl Into<String>) / set_certificate_ids(Option<Vec::<String>>):
    required: false
    

    An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

    
    
• On success, responds with UpdateProfileOutput with field(s):
  • profile_id(String):

    Returns the identifier for the profile that’s being updated.

• On failure, responds with SdkError<UpdateProfileError>

impl Client

pub fn update_server(&self) -> UpdateServerFluentBuilder

Constructs a fluent builder for the UpdateServer operation.

• The fluent builder is configurable:
  • certificate(impl Into<String>) / set_certificate(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

    To request a new public certificate, see Request a public certificate in the Amazon Web ServicesCertificate Manager User Guide.

    To import an existing certificate into ACM, see Importing certificates into ACM in the Amazon Web ServicesCertificate Manager User Guide.

    To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web ServicesCertificate Manager User Guide.

    Certificates with the following cryptographic algorithms and key sizes are supported:

    • 2048-bit RSA (RSA_2048)

    • 4096-bit RSA (RSA_4096)

    • Elliptic Prime Curve 256 bit (EC_prime256v1)

    • Elliptic Prime Curve 384 bit (EC_secp384r1)

    • Elliptic Prime Curve 521 bit (EC_secp521r1)

    The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.

    
    
  • protocol_details(ProtocolDetails) / set_protocol_details(Option<ProtocolDetails>):
    required: false
    

    The protocol settings that are configured for your server.

    Avoid placing Network Load Balancers (NLBs) or NAT gateways in front of Transfer Family servers, as this increases costs and can cause performance issues, including reduced connection limits for FTPS. For more details, see Avoid placing NLBs and NATs in front of Transfer Family.

    • To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.

    • To ignore the error that is generated when the client attempts to use the SETSTAT command on a file that you are uploading to an Amazon S3 bucket, use the SetStatOption parameter. To have the Transfer Family server ignore the SETSTAT command and upload files without needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT call.

    • To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the TlsSessionResumptionMode parameter.

    • As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

    
    
  • endpoint_details(EndpointDetails) / set_endpoint_details(Option<EndpointDetails>):
    required: false
    

    The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC’s default security groups are automatically assigned to your endpoint.

    
    
  • endpoint_type(EndpointType) / set_endpoint_type(Option<EndpointType>):
    required: false
    

    The type of endpoint that you want your server to use. You can choose to make your server’s endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.

    After May 19, 2021, you won’t be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn’t already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.

    For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

    It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server’s endpoint and use VPC security groups to restrict traffic by the client’s public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.

    
    
  • host_key(impl Into<String>) / set_host_key(Option<String>):
    required: false
    

    The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want to rotate keys, or have a set of active keys that use different algorithms.

    Use the following command to generate an RSA 2048 bit key with no passphrase:

    ssh-keygen -t rsa -b 2048 -N “” -m PEM -f my-new-server-key.

    Use a minimum value of 2048 for the -b option. You can create a stronger key by using 3072 or 4096.

    Use the following command to generate an ECDSA 256 bit key with no passphrase:

    ssh-keygen -t ecdsa -b 256 -N “” -m PEM -f my-new-server-key.

    Valid values for the -b option for ECDSA are 256, 384, and 521.

    Use the following command to generate an ED25519 key with no passphrase:

    ssh-keygen -t ed25519 -N “” -f my-new-server-key.

    For all of these commands, you can replace my-new-server-key with a string of your choice.

    If you aren’t planning to migrate existing users from an existing SFTP-enabled server to a new server, don’t update the host key. Accidentally changing a server’s host key can be disruptive.

    For more information, see Manage host keys for your SFTP-enabled server in the Transfer Family User Guide.

    
    
  • identity_provider_details(IdentityProviderDetails) / set_identity_provider_details(Option<IdentityProviderDetails>):
    required: false
    

    An array containing all of the information required to call a customer’s authentication API method.

    
    
  • logging_role(impl Into<String>) / set_logging_role(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, you can view user activity in your CloudWatch logs.

    
    
  • post_authentication_login_banner(impl Into<String>) / set_post_authentication_login_banner(Option<String>):
    required: false
    

    Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.

    The SFTP protocol does not support post-authentication display banners.

    
    
  • pre_authentication_login_banner(impl Into<String>) / set_pre_authentication_login_banner(Option<String>):
    required: false
    

    Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:

    This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.

    
    
  • protocols(Protocol) / set_protocols(Option<Vec::<Protocol>>):
    required: false
    

    Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server’s endpoint. The available protocols are:

    • SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH

    • FTPS (File Transfer Protocol Secure): File transfer with TLS encryption

    • FTP (File Transfer Protocol): Unencrypted file transfer

    • AS2 (Applicability Statement 2): used for transporting structured business-to-business data

    • If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.

    • If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

    • If Protocol includes FTP, then AddressAllocationIds cannot be associated.

    • If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set any of the supported identity types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

    • If Protocol includes AS2, then the EndpointType must be VPC, and domain must be Amazon S3.

    
    
  • security_policy_name(impl Into<String>) / set_security_policy_name(Option<String>):
    required: false
    

    Specifies the name of the security policy for the server.

    
    
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.

    
    
  • workflow_details(WorkflowDetails) / set_workflow_details(Option<WorkflowDetails>):
    required: false
    

    Specifies the workflow ID for the workflow to assign and the execution role that’s used for executing the workflow.

    In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects while the file is still being uploaded.

    To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

    aws transfer update-server –server-id s-01234567890abcdef –workflow-details ‘{“OnUpload”:[]}’

    
    
  • structured_log_destinations(impl Into<String>) / set_structured_log_destinations(Option<Vec::<String>>):
    required: false
    

    Specifies the log groups to which your server logs are sent.

    To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:

    arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:

    For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:

    If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an update-server call. For example:

    update-server –server-id s-1234567890abcdef0 –structured-log-destinations

    
    
  • s3_storage_options(S3StorageOptions) / set_s3_storage_options(Option<S3StorageOptions>):
    required: false
    

    Specifies whether or not performance for your Amazon S3 directories is optimized.

    • If using the console, this is enabled by default.

    • If using the API or CLI, this is disabled by default.

    By default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.

    
    
  • ip_address_type(IpAddressType) / set_ip_address_type(Option<IpAddressType>):
    required: false
    

    Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and IPv6) for your Transfer Family endpoint. The default value is IPV4.

    The IpAddressType parameter has the following limitations:

    • It cannot be changed while the server is online. You must stop the server before modifying this parameter.

    • It cannot be updated to DUALSTACK if the server has AddressAllocationIds specified.

    When using DUALSTACK as the IpAddressType, you cannot set the AddressAllocationIds parameter for the EndpointDetails for the server.

    
    
  • identity_provider_type(IdentityProviderType) / set_identity_provider_type(Option<IdentityProviderType>):
    required: false
    

    The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service.

    Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails parameter.

    Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter.

    Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter for the IdentityProviderDetails data type.

    
    
• On success, responds with UpdateServerOutput with field(s):
  • server_id(String):

    A system-assigned unique identifier for a server that the Transfer Family user is assigned to.

• On failure, responds with SdkError<UpdateServerError>

impl Client

pub fn update_user(&self) -> UpdateUserFluentBuilder

Constructs a fluent builder for the UpdateUser operation.

• The fluent builder is configurable:
  • home_directory(impl Into<String>) / set_home_directory(Option<String>):
    required: false
    

    The landing directory (folder) for a user when they log in to the server using the client.

    A HomeDirectory example is /bucket_name/home/mydirectory.

    You can use the HomeDirectory parameter for HomeDirectoryType when it is set to either PATH or LOGICAL.

    
    
  • home_directory_type(HomeDirectoryType) / set_home_directory_type(Option<HomeDirectoryType>):
    required: false
    

    The type of landing directory (folder) that you want your users’ home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your users.

    If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your template.

    
    
  • home_directory_mappings(HomeDirectoryMapEntry) / set_home_directory_mappings(Option<Vec::<HomeDirectoryMapEntry>>):
    required: false
    

    Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL.

    The following is an Entry and Target pair example.

    [ { “Entry”: “/directory1”, “Target”: “/bucket_name/home/mydirectory” } ]

    In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory (“chroot”). To do this, you can set Entry to ‘/’ and set Target to the HomeDirectory parameter value.

    The following is an Entry and Target pair example for chroot.

    [ { “Entry”: “/”, “Target”: “/bucket_name/home/mydirectory” } ]

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: false
    

    A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user’s access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

    This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies.

    For session policies, Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

    For an example of a session policy, see Creating a session policy.

    For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.

    
    
  • posix_profile(PosixProfile) / set_posix_profile(Option<PosixProfile>):
    required: false
    

    Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users’ access to your Amazon Elastic File Systems (Amazon EFS). The POSIX permissions that are set on files and directories in your file system determines the level of access your users get when transferring files into and out of your Amazon EFS file systems.

    
    
  • role(impl Into<String>) / set_role(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users’ access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users’ transfer requests.

    
    
  • server_id(impl Into<String>) / set_server_id(Option<String>):
    required: true
    

    A system-assigned unique identifier for a Transfer Family server instance that the user is assigned to.

    
    
  • user_name(impl Into<String>) / set_user_name(Option<String>):
    required: true
    

    A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore ‘_’, hyphen ‘-’, period ‘.’, and at sign ‘@’. The user name can’t start with a hyphen, period, or at sign.

    
    
• On success, responds with UpdateUserOutput with field(s):
  • server_id(String):

    A system-assigned unique identifier for a Transfer Family server instance that the account is assigned to.

  • user_name(String):

    The unique identifier for a user that is assigned to a server instance that was specified in the request.

• On failure, responds with SdkError<UpdateUserError>

impl Client

pub fn update_web_app(&self) -> UpdateWebAppFluentBuilder

Constructs a fluent builder for the UpdateWebApp operation.

• The fluent builder is configurable:
  • web_app_id(impl Into<String>) / set_web_app_id(Option<String>):
    required: true
    

    Provide the identifier of the web app that you are updating.

    
    
  • identity_provider_details(UpdateWebAppIdentityProviderDetails) / set_identity_provider_details(Option<UpdateWebAppIdentityProviderDetails>):
    required: false
    

    Provide updated identity provider values in a WebAppIdentityProviderDetails object.

    
    
  • access_endpoint(impl Into<String>) / set_access_endpoint(Option<String>):
    required: false
    

    The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.

    
    
  • web_app_units(WebAppUnits) / set_web_app_units(Option<WebAppUnits>):
    required: false
    

    A union that contains the value for number of concurrent connections or the user sessions on your web app.

    
    
• On success, responds with UpdateWebAppOutput with field(s):
  • web_app_id(String):

    Returns the unique identifier for the web app being updated.

• On failure, responds with SdkError<UpdateWebAppError>

impl Client

pub fn update_web_app_customization( &self, ) -> UpdateWebAppCustomizationFluentBuilder

Constructs a fluent builder for the UpdateWebAppCustomization operation.

• The fluent builder is configurable:
  • web_app_id(impl Into<String>) / set_web_app_id(Option<String>):
    required: true
    

    Provide the identifier of the web app that you are updating.

    
    
  • title(impl Into<String>) / set_title(Option<String>):
    required: false
    

    Provide an updated title.

    
    
  • logo_file(Blob) / set_logo_file(Option<Blob>):
    required: false
    

    Specify logo file data string (in base64 encoding).

    
    
  • favicon_file(Blob) / set_favicon_file(Option<Blob>):
    required: false
    

    Specify an icon file data string (in base64 encoding).

    
    
• On success, responds with UpdateWebAppCustomizationOutput with field(s):
  • web_app_id(String):

    Returns the unique identifier for the web app being updated.

• On failure, responds with SdkError<UpdateWebAppCustomizationError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.

impl Waiters for Client

fn wait_until_server_offline(&self) -> ServerOfflineFluentBuilder

Wait for server_offline

fn wait_until_server_online(&self) -> ServerOnlineFluentBuilder

Wait for server_online