You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Module: Aws::Transfer

Defined in:
(unknown)

Overview

This module provides a client for making API requests to AWS Transfer for SFTP.

Aws::Transfer::Client

The Client class provides one-to-one mapping for each API operation.

transfer = Aws::Transfer::Client.new(region: 'us-east-1')
transfer.operation_names
#=> [:create_server, :create_user, :delete_server, :delete_ssh_public_key, ...]

Each API operation method accepts a hash of request parameters and returns a response object.

resp = transfer.create_server(params)

See Client for more information.

Aws::Transfer::Errors

Errors returned from AWS Transfer for SFTP are defined in the Errors module and extend Errors::ServiceError.

begin
  # do stuff
rescue Aws::Transfer::Errors::ServiceError
  # rescues all errors returned by AWS Transfer for SFTP
end

See Errors for more information.

Defined Under Namespace

Modules: Errors, Types Classes: Client