Transfer

public struct Transfer

Client object for interacting with AWS Transfer service.

AWS 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). AWS helps you seamlessly migrate your file transfer workflows to AWS 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 AWS services for processing, analytics, machine learning, and archiving. Getting started with AWS Transfer Family is easy since there is no infrastructure to buy and set up.

Member variables

Initialization

  • Initialize the Transfer client

    Declaration

    Swift

    public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

    Parameters

    accessKeyId

    Public access key provided by AWS
    secretAccessKey

    Private access key provided by AWS
    sessionToken

    Token provided by STS.AssumeRole() which allows access to another AWS account
    region

    Region of server you want to communicate with
    endpoint

    Custom endpoint URL to use instead of standard AWS servers
    middlewares

    Array of middlewares to apply to requests and responses
    eventLoopGroupProvider

    EventLoopGroup to use. Use useAWSClientShared if the client shall manage its own EventLoopGroup.

API Calls

  • 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.

    Declaration

    Swift

    public func createServer(_ input: CreateServerRequest) -> EventLoopFuture<CreateServerResponse>

  • 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.

    Declaration

    Swift

    public func createUser(_ input: CreateUserRequest) -> EventLoopFuture<CreateUserResponse>

  • Deletes the file transfer protocol-enabled server that you specify. No response returns from this operation.

    Declaration

    Swift

    @discardableResult
public func deleteServer(_ input: DeleteServerRequest) -> EventLoopFuture<Void>

  • Deletes a user’s Secure Shell (SSH) public key. No response is returned from this operation.

    Declaration

    Swift

    @discardableResult
public func deleteSshPublicKey(_ input: DeleteSshPublicKeyRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func deleteUser(_ input: DeleteUserRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    public func describeSecurityPolicy(_ input: DescribeSecurityPolicyRequest) -> EventLoopFuture<DescribeSecurityPolicyResponse>

  • 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.

    Declaration

    Swift

    public func describeServer(_ input: DescribeServerRequest) -> EventLoopFuture<DescribeServerResponse>

  • 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.

    Declaration

    Swift

    public func describeUser(_ input: DescribeUserRequest) -> EventLoopFuture<DescribeUserResponse>

  • 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.

    Declaration

    Swift

    public func importSshPublicKey(_ input: ImportSshPublicKeyRequest) -> EventLoopFuture<ImportSshPublicKeyResponse>

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

    Declaration

    Swift

    public func listSecurityPolicies(_ input: ListSecurityPoliciesRequest) -> EventLoopFuture<ListSecurityPoliciesResponse>

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

    Declaration

    Swift

    public func listServers(_ input: ListServersRequest) -> EventLoopFuture<ListServersResponse>

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

    Declaration

    Swift

    public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse>

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

    Declaration

    Swift

    public func listUsers(_ input: ListUsersRequest) -> EventLoopFuture<ListUsersResponse>

  • 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.

    Declaration

    Swift

    @discardableResult
public func startServer(_ input: StartServerRequest) -> EventLoopFuture<Void>

  • 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. 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.

    Declaration

    Swift

    @discardableResult
public func stopServer(_ input: StopServerRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    public func testIdentityProvider(_ input: TestIdentityProviderRequest) -> EventLoopFuture<TestIdentityProviderResponse>

  • 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.

    Declaration

    Swift

    @discardableResult
public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    public func updateServer(_ input: UpdateServerRequest) -> EventLoopFuture<UpdateServerResponse>

  • 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.

    Declaration

    Swift

    public func updateUser(_ input: UpdateUserRequest) -> EventLoopFuture<UpdateUserResponse>

Paginators

Shapes

Enums

  • Undocumented

    See more

    Declaration

    Swift

    public enum EndpointType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum HomeDirectoryType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum IdentityProviderType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum `Protocol` : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum State : String, CustomStringConvertible, Codable