AWS.Transfer (aws-elixir v0.8.0) View Source

Amazon Web Services Transfer Family is a fully managed service that enables the transfer of files over the File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3).

Amazon Web Services helps you seamlessly migrate your file transfer workflows to Amazon Web Services Transfer Family by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53 so nothing changes for your customers and partners, or their applications. With your data in Amazon S3, you can use it with Amazon Web Services services for processing, analytics, machine learning, and archiving. Getting started with Amazon Web Services Transfer Family is easy since there is no infrastructure to buy and set up.

Link to this section Summary

Functions

Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Amazon Web Services Transfer Family.

Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.

Creates a user and associates them with an existing file transfer protocol-enabled server.

Allows you to delete the access specified in the ServerID and ExternalID parameters.

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

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

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

Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its ExternalID.

Describes the security policy that is attached to your file transfer protocol-enabled server.

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

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

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.

Lists the details for all the accesses you have on your server.

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

Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.

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

Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE.

Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE.

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).

If the IdentityProviderType of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is set up successfully.

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).

Allows you to update parameters for the access specified in the ServerID and ExternalID parameters.

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

Assigns new properties to a user.

Link to this section Functions

Link to this function

create_access(client, input, options \\ [])

View Source

Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Amazon Web Services Transfer Family.

For example, a Microsoft Active Directory might contain 50,000 users, but only a small fraction might need the ability to transfer files to the server. An administrator can use CreateAccess to limit the access to the correct set of users who need this ability.

Link to this function

create_server(client, input, options \\ [])

View Source

Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.

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.

Link to this function

create_user(client, input, options \\ [])

View Source

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 Amazon Web Services 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.

Link to this function

delete_access(client, input, options \\ [])

View Source

Allows you to delete the access specified in the ServerID and ExternalID parameters.

Link to this function

delete_server(client, input, options \\ [])

View Source

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

No response returns from this operation.

Link to this function

delete_ssh_public_key(client, input, options \\ [])

View Source

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

No response is returned from this operation.

Link to this function

delete_user(client, input, options \\ [])

View Source

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.

Link to this function

describe_access(client, input, options \\ [])

View Source

Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its ExternalID.

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

Link to this function

describe_security_policy(client, input, options \\ [])

View Source

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.

Link to this function

describe_server(client, input, options \\ [])

View Source

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.

Link to this function

describe_user(client, input, options \\ [])

View Source

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.

Link to this function

import_ssh_public_key(client, input, options \\ [])

View Source

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.

Link to this function

list_accesses(client, input, options \\ [])

View Source

Lists the details for all the accesses you have on your server.

Link to this function

list_security_policies(client, input, options \\ [])

View Source

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

Link to this function

list_servers(client, input, options \\ [])

View Source

Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.

The resource can be a user, server, or role.

Link to this function

list_users(client, input, options \\ [])

View Source

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

Link to this function

start_server(client, input, options \\ [])

View Source

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.

Link to this function

stop_server(client, input, options \\ [])

View Source

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.

Link to this function

tag_resource(client, input, options \\ [])

View Source

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.

Link to this function

test_identity_provider(client, input, options \\ [])

View Source

If the IdentityProviderType of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider 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 identity provider integration to ensure that your users can successfully use the service.

Link to this function

untag_resource(client, input, options \\ [])

View Source

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.

Link to this function

update_access(client, input, options \\ [])

View Source

Allows you to update parameters for the access specified in the ServerID and ExternalID parameters.

Link to this function

update_server(client, input, options \\ [])

View Source

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.

Link to this function

update_user(client, input, options \\ [])

View Source

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.