Struct rusoto_transfer::TransferClient

pub struct TransferClient { /* fields omitted */ }

A client for the AWS Transfer API.

Implementations

impl TransferClient

pub fn new(region: Region) -> TransferClient

Creates a client backed by the default tokio event loop.

The client will use the default credentials provider and tls client.

pub fn new_with<P, D>(
    request_dispatcher: D,
    credentials_provider: P,
    region: Region
) -> TransferClient where
    P: ProvideAwsCredentials + Send + Sync + 'static,
    D: DispatchSignedRequest + Send + Sync + 'static, 

pub fn new_with_client(client: Client, region: Region) -> TransferClient

Trait Implementations

impl Clone for TransferClient

pub fn clone(&self) -> TransferClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Transfer for TransferClient

pub fn create_server<'life0, 'async_trait>(
    &'life0 self,
    input: CreateServerRequest
) -> Pin<Box<dyn Future<Output = Result<CreateServerResponse, RusotoError<CreateServerError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Instantiates an autoscaling virtual server based on the selected file transfer protocol in AWS. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server.

pub fn create_user<'life0, 'async_trait>(
    &'life0 self,
    input: CreateUserRequest
) -> Pin<Box<dyn Future<Output = Result<CreateUserResponse, RusotoError<CreateUserError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.

pub fn delete_server<'life0, 'async_trait>(
    &'life0 self,
    input: DeleteServerRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteServerError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Deletes the file transfer protocol-enabled server that you specify.

No response returns from this operation.

pub fn delete_ssh_public_key<'life0, 'async_trait>(
    &'life0 self,
    input: DeleteSshPublicKeyRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteSshPublicKeyError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Deletes a user's Secure Shell (SSH) public key.

No response is returned from this operation.

pub fn delete_user<'life0, 'async_trait>(
    &'life0 self,
    input: DeleteUserRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteUserError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Deletes the user belonging to a file transfer protocol-enabled server you specify.

No response returns from this operation.

When you delete a user from a server, the user's information is lost.

pub fn describe_security_policy<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeSecurityPolicyRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeSecurityPolicyResponse, RusotoError<DescribeSecurityPolicyError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Describes the security policy that is attached to your file transfer protocol-enabled server. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies.

pub fn describe_server<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeServerRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeServerResponse, RusotoError<DescribeServerError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

The response contains a description of a server's properties. When you set EndpointType to VPC, the response will contain the EndpointDetails.

pub fn describe_user<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeUserRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeUserResponse, RusotoError<DescribeUserError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property.

The response from this call returns the properties of the user associated with the ServerId value that was specified.

pub fn import_ssh_public_key<'life0, 'async_trait>(
    &'life0 self,
    input: ImportSshPublicKeyRequest
) -> Pin<Box<dyn Future<Output = Result<ImportSshPublicKeyResponse, RusotoError<ImportSshPublicKeyError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to the specific file transfer protocol-enabled server, identified by ServerId.

The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.

pub fn list_security_policies<'life0, 'async_trait>(
    &'life0 self,
    input: ListSecurityPoliciesRequest
) -> Pin<Box<dyn Future<Output = Result<ListSecurityPoliciesResponse, RusotoError<ListSecurityPoliciesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Lists the security policies that are attached to your file transfer protocol-enabled servers.

pub fn list_servers<'life0, 'async_trait>(
    &'life0 self,
    input: ListServersRequest
) -> Pin<Box<dyn Future<Output = Result<ListServersResponse, RusotoError<ListServersError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Lists the file transfer protocol-enabled servers that are associated with your AWS account.

pub fn list_tags_for_resource<'life0, 'async_trait>(
    &'life0 self,
    input: ListTagsForResourceRequest
) -> Pin<Box<dyn Future<Output = Result<ListTagsForResourceResponse, RusotoError<ListTagsForResourceError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role.

pub fn list_users<'life0, 'async_trait>(
    &'life0 self,
    input: ListUsersRequest
) -> Pin<Box<dyn Future<Output = Result<ListUsersResponse, RusotoError<ListUsersError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

pub fn start_server<'life0, 'async_trait>(
    &'life0 self,
    input: StartServerRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<StartServerError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It has no impact on a server that is already ONLINE. An ONLINE server can accept and process file transfer jobs.

The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition.

No response is returned from this call.

pub fn stop_server<'life0, 'async_trait>(
    &'life0 self,
    input: StopServerRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<StopServerError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server.

Stopping the server will not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed.

The state of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.

No response is returned from this call.

pub fn tag_resource<'life0, 'async_trait>(
    &'life0 self,
    input: TagResourceRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<TagResourceError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

There is no response returned from this call.

pub fn test_identity_provider<'life0, 'async_trait>(
    &'life0 self,
    input: TestIdentityProviderRequest
) -> Pin<Box<dyn Future<Output = Result<TestIdentityProviderResponse, RusotoError<TestIdentityProviderError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

If the IdentityProviderType of a file transfer protocol-enabled server is API_Gateway, tests whether your API Gateway is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the API Gateway integration to ensure that your users can successfully use the service.

pub fn untag_resource<'life0, 'async_trait>(
    &'life0 self,
    input: UntagResourceRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<UntagResourceError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

No response is returned from this call.

pub fn update_server<'life0, 'async_trait>(
    &'life0 self,
    input: UpdateServerRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateServerResponse, RusotoError<UpdateServerError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Updates the file transfer protocol-enabled server's properties after that server has been created.

The UpdateServer call returns the ServerId of the server you updated.

pub fn update_user<'life0, 'async_trait>(
    &'life0 self,
    input: UpdateUserRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateUserResponse, RusotoError<UpdateUserError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId you specify.

The response returns the ServerId and the UserName for the updated user.