Class: Aws::Transfer::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb

Overview

An API client for Transfer. To construct a client, you need to configure a :region and :credentials.

client = Aws::Transfer::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::SharedCredentials - Used for loading credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



319
320
321
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 319

def initialize(*args)
  super
end

Instance Method Details

#create_server(params = {}) ⇒ Types::CreateServerResponse

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.

Examples:

Request syntax with placeholder values


resp = client.create_server({
  certificate: "Certificate",
  endpoint_details: {
    address_allocation_ids: ["AddressAllocationId"],
    subnet_ids: ["SubnetId"],
    vpc_endpoint_id: "VpcEndpointId",
    vpc_id: "VpcId",
  },
  endpoint_type: "PUBLIC", # accepts PUBLIC, VPC, VPC_ENDPOINT
  host_key: "HostKey",
  identity_provider_details: {
    url: "Url",
    invocation_role: "Role",
  },
  identity_provider_type: "SERVICE_MANAGED", # accepts SERVICE_MANAGED, API_GATEWAY
  logging_role: "Role",
  protocols: ["SFTP"], # accepts SFTP, FTP, FTPS
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.server_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :certificate (String) —

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

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

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

    To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS 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.

  • :endpoint_details (Types::EndpointDetails) —

    The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IPs and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.

  • :endpoint_type (String) —

    The type of VPC endpoint that you want your file transfer protocol-enabled server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.

    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 (String) —

    The RSA private key as generated by the ssh-keygen -N "" -m PEM -f my-new-server-key command.

    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 Change the host key for your SFTP-enabled server in the AWS Transfer Family User Guide.

  • :identity_provider_details (Types::IdentityProviderDetails) —

    Required when IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to SERVICE_MANAGED.

  • :identity_provider_type (String) —

    Specifies the mode of authentication for a file transfer protocol-enabled server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the AWS Transfer Family service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.

  • :logging_role (String) —

    Allows the service to write your users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.

  • :protocols (Array<String>) —

    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

    If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be 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 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 to SERVICE_MANAGED.

  • :tags (Array<Types::Tag>) —

    Key-value pairs that can be used to group and search for file transfer protocol-enabled servers.

Returns:

See Also:



499
500
501
502
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 499

def create_server(params = {}, options = {})
  req = build_request(:create_server, params)
  req.send_request(options)
end

#create_user(params = {}) ⇒ Types::CreateUserResponse

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.

Examples:

Request syntax with placeholder values


resp = client.create_user({
  home_directory: "HomeDirectory",
  home_directory_type: "PATH", # accepts PATH, LOGICAL
  home_directory_mappings: [
    {
      entry: "MapEntry", # required
      target: "MapTarget", # required
    },
  ],
  policy: "Policy",
  role: "Role", # required
  server_id: "ServerId", # required
  ssh_public_key_body: "SshPublicKeyBody",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  user_name: "UserName", # required
})

Response structure


resp.server_id #=> String
resp.user_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :home_directory (String) —

    The landing directory (folder) for a user when they log in to the file transfer protocol-enabled server using the client.

    An example is your-Amazon-S3-bucket-name>/home/username .

  • :home_directory_type (String) —

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

  • :home_directory_mappings (Array<Types::HomeDirectoryMapEntry>) —

    Logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "Entry" and "Target" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your IAM role provides access to paths in Target. The following is an example.

    '[ "/bucket2/documentation", \{ "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/$\{transfer:UserName\}.pdf" \} ]'

    In most cases, you can use this value instead of the scope-down 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 HomeDirectory parameter value.

    If the target of a logical directory entry does not exist in Amazon S3, the entry will be ignored. As a workaround, you can use the Amazon S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a '/' for it to be considered a folder.

  • :policy (String) —

    A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include $\{Transfer:UserName\}, $\{Transfer:HomeDirectory\}, and $\{Transfer:HomeBucket\}.

    For scope-down policies, AWS 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 scope-down policy, see Creating a scope-down policy.

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

  • :role (required, String) —

    The IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the file transfer protocol-enabled server to access your resources when servicing your users' transfer requests.

  • :server_id (required, String) —

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

  • :ssh_public_key_body (String) —

    The public portion of the Secure Shell (SSH) key used to authenticate the user to the file transfer protocol-enabled server.

  • :tags (Array<Types::Tag>) —

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

  • :user_name (required, String) —

    A unique string that identifies a user and is associated with a file transfer protocol-enabled server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

Returns:

See Also:



650
651
652
653
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 650

def create_user(params = {}, options = {})
  req = build_request(:create_user, params)
  req.send_request(options)
end

#delete_server(params = {}) ⇒ Struct

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

No response returns from this operation.

Examples:

Request syntax with placeholder values


resp = client.delete_server({
  server_id: "ServerId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :server_id (required, String) —

    A unique system-assigned identifier for a file transfer protocol-enabled server instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



675
676
677
678
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 675

def delete_server(params = {}, options = {})
  req = build_request(:delete_server, params)
  req.send_request(options)
end

#delete_ssh_public_key(params = {}) ⇒ Struct

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

No response is returned from this operation.

Examples:

Request syntax with placeholder values


resp = client.delete_ssh_public_key({
  server_id: "ServerId", # required
  ssh_public_key_id: "SshPublicKeyId", # required
  user_name: "UserName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :server_id (required, String) —

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

  • :ssh_public_key_id (required, String) —

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

  • :user_name (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



709
710
711
712
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 709

def delete_ssh_public_key(params = {}, options = {})
  req = build_request(:delete_ssh_public_key, params)
  req.send_request(options)
end

#delete_user(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.delete_user({
  server_id: "ServerId", # required
  user_name: "UserName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :server_id (required, String) —

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

  • :user_name (required, String) —

    A unique string that identifies a user that is being deleted from a file transfer protocol-enabled server.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



744
745
746
747
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 744

def delete_user(params = {}, options = {})
  req = build_request(:delete_user, params)
  req.send_request(options)
end

#describe_server(params = {}) ⇒ Types::DescribeServerResponse

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.

Examples:

Request syntax with placeholder values


resp = client.describe_server({
  server_id: "ServerId", # required
})

Response structure


resp.server.arn #=> String
resp.server.certificate #=> String
resp.server.endpoint_details.address_allocation_ids #=> Array
resp.server.endpoint_details.address_allocation_ids[0] #=> String
resp.server.endpoint_details.subnet_ids #=> Array
resp.server.endpoint_details.subnet_ids[0] #=> String
resp.server.endpoint_details.vpc_endpoint_id #=> String
resp.server.endpoint_details.vpc_id #=> String
resp.server.endpoint_type #=> String, one of "PUBLIC", "VPC", "VPC_ENDPOINT"
resp.server.host_key_fingerprint #=> String
resp.server.identity_provider_details.url #=> String
resp.server.identity_provider_details.invocation_role #=> String
resp.server.identity_provider_type #=> String, one of "SERVICE_MANAGED", "API_GATEWAY"
resp.server.logging_role #=> String
resp.server.protocols #=> Array
resp.server.protocols[0] #=> String, one of "SFTP", "FTP", "FTPS"
resp.server.server_id #=> String
resp.server.state #=> String, one of "OFFLINE", "ONLINE", "STARTING", "STOPPING", "START_FAILED", "STOP_FAILED"
resp.server.tags #=> Array
resp.server.tags[0].key #=> String
resp.server.tags[0].value #=> String
resp.server.user_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :server_id (required, String) —

    A system-assigned unique identifier for a file transfer protocol-enabled server.

Returns:

See Also:



799
800
801
802
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 799

def describe_server(params = {}, options = {})
  req = build_request(:describe_server, params)
  req.send_request(options)
end

#describe_user(params = {}) ⇒ Types::DescribeUserResponse

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.

Examples:

Request syntax with placeholder values


resp = client.describe_user({
  server_id: "ServerId", # required
  user_name: "UserName", # required
})

Response structure


resp.server_id #=> String
resp.user.arn #=> String
resp.user.home_directory #=> String
resp.user.home_directory_mappings #=> Array
resp.user.home_directory_mappings[0].entry #=> String
resp.user.home_directory_mappings[0].target #=> String
resp.user.home_directory_type #=> String, one of "PATH", "LOGICAL"
resp.user.policy #=> String
resp.user.role #=> String
resp.user.ssh_public_keys #=> Array
resp.user.ssh_public_keys[0].date_imported #=> Time
resp.user.ssh_public_keys[0].ssh_public_key_body #=> String
resp.user.ssh_public_keys[0].ssh_public_key_id #=> String
resp.user.tags #=> Array
resp.user.tags[0].key #=> String
resp.user.tags[0].value #=> String
resp.user.user_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :server_id (required, String) —

    A system-assigned unique identifier for a file transfer protocol-enabled server that has this user assigned.

  • :user_name (required, String) —

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

Returns:

See Also:



856
857
858
859
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 856

def describe_user(params = {}, options = {})
  req = build_request(:describe_user, params)
  req.send_request(options)
end

#import_ssh_public_key(params = {}) ⇒ Types::ImportSshPublicKeyResponse

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.

Examples:

Request syntax with placeholder values


resp = client.import_ssh_public_key({
  server_id: "ServerId", # required
  ssh_public_key_body: "SshPublicKeyBody", # required
  user_name: "UserName", # required
})

Response structure


resp.server_id #=> String
resp.ssh_public_key_id #=> String
resp.user_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :server_id (required, String) —

    A system-assigned unique identifier for a file transfer protocol-enabled server.

  • :ssh_public_key_body (required, String) —

    The public key portion of an SSH key pair.

  • :user_name (required, String) —

    The name of the user account that is assigned to one or more file transfer protocol-enabled servers.

Returns:

See Also:



903
904
905
906
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 903

def import_ssh_public_key(params = {}, options = {})
  req = build_request(:import_ssh_public_key, params)
  req.send_request(options)
end

#list_servers(params = {}) ⇒ Types::ListServersResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_servers({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.servers #=> Array
resp.servers[0].arn #=> String
resp.servers[0].identity_provider_type #=> String, one of "SERVICE_MANAGED", "API_GATEWAY"
resp.servers[0].endpoint_type #=> String, one of "PUBLIC", "VPC", "VPC_ENDPOINT"
resp.servers[0].logging_role #=> String
resp.servers[0].server_id #=> String
resp.servers[0].state #=> String, one of "OFFLINE", "ONLINE", "STARTING", "STOPPING", "START_FAILED", "STOP_FAILED"
resp.servers[0].user_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Specifies the number of file transfer protocol-enabled servers to return as a response to the ListServers query.

  • :next_token (String) —

    When additional results are obtained from theListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional file transfer protocol-enabled servers.

Returns:

See Also:



951
952
953
954
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 951

def list_servers(params = {}, options = {})
  req = build_request(:list_servers, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  arn: "Arn", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.arn #=> String
resp.next_token #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

  • :max_results (Integer) —

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

  • :next_token (String) —

    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.

Returns:

See Also:



1002
1003
1004
1005
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1002

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_users(params = {}) ⇒ Types::ListUsersResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_users({
  max_results: 1,
  next_token: "NextToken",
  server_id: "ServerId", # required
})

Response structure


resp.next_token #=> String
resp.server_id #=> String
resp.users #=> Array
resp.users[0].arn #=> String
resp.users[0].home_directory #=> String
resp.users[0].home_directory_type #=> String, one of "PATH", "LOGICAL"
resp.users[0].role #=> String
resp.users[0].ssh_public_key_count #=> Integer
resp.users[0].user_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

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

  • :next_token (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 (required, String) —

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

Returns:

See Also:



1056
1057
1058
1059
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1056

def list_users(params = {}, options = {})
  req = build_request(:list_users, params)
  req.send_request(options)
end

#start_server(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.start_server({
  server_id: "ServerId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :server_id (required, String) —

    A system-assigned unique identifier for a file transfer protocol-enabled server that you start.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1088
1089
1090
1091
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1088

def start_server(params = {}, options = {})
  req = build_request(:start_server, params)
  req.send_request(options)
end

#stop_server(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.stop_server({
  server_id: "ServerId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :server_id (required, String) —

    A system-assigned unique identifier for a file transfer protocol-enabled server that you stopped.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1122
1123
1124
1125
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1122

def stop_server(params = {}, options = {})
  req = build_request(:stop_server, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  arn: "Arn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

  • :tags (required, Array<Types::Tag>) —

    Key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to user accounts for any purpose.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1160
1161
1162
1163
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1160

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#test_identity_provider(params = {}) ⇒ Types::TestIdentityProviderResponse

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.

Examples:

Request syntax with placeholder values


resp = client.test_identity_provider({
  server_id: "ServerId", # required
  server_protocol: "SFTP", # accepts SFTP, FTP, FTPS
  source_ip: "SourceIp",
  user_name: "UserName", # required
  user_password: "UserPassword",
})

Response structure


resp.response #=> String
resp.status_code #=> Integer
resp.message #=> String
resp.url #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :server_id (required, String) —

    A system-assigned identifier for a specific file transfer protocol-enabled server. That server's user authentication method is tested with a user name and password.

  • :server_protocol (String) —

    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)

  • :source_ip (String) —

    The source IP address of the user account to be tested.

  • :user_name (required, String) —

    The name of the user account to be tested.

  • :user_password (String) —

    The password of the user account to be tested.

Returns:

See Also:



1225
1226
1227
1228
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1225

def test_identity_provider(params = {}, options = {})
  req = build_request(:test_identity_provider, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

  • :tag_keys (required, Array<String>) —

    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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1259
1260
1261
1262
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1259

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_server(params = {}) ⇒ Types::UpdateServerResponse

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.

Examples:

Request syntax with placeholder values


resp = client.update_server({
  certificate: "Certificate",
  endpoint_details: {
    address_allocation_ids: ["AddressAllocationId"],
    subnet_ids: ["SubnetId"],
    vpc_endpoint_id: "VpcEndpointId",
    vpc_id: "VpcId",
  },
  endpoint_type: "PUBLIC", # accepts PUBLIC, VPC, VPC_ENDPOINT
  host_key: "HostKey",
  identity_provider_details: {
    url: "Url",
    invocation_role: "Role",
  },
  logging_role: "NullableRole",
  protocols: ["SFTP"], # accepts SFTP, FTP, FTPS
  server_id: "ServerId", # required
})

Response structure


resp.server_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :certificate (String) —

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

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

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

    To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS 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.

  • :endpoint_details (Types::EndpointDetails) —

    The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.

  • :endpoint_type (String) —

    The type of endpoint that you want your file transfer protocol-enabled server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.

    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 (String) —

    The RSA private key as generated by ssh-keygen -N "" -m PEM -f my-new-server-key.

    If you aren't planning to migrate existing users from an existing file transfer protocol-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 Change the host key for your SFTP-enabled server in the AWS Transfer Family User Guide.

  • :identity_provider_details (Types::IdentityProviderDetails) —

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

  • :logging_role (String) —

    Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.

  • :protocols (Array<String>) —

    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:

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

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

    • File Transfer Protocol (FTP): Unencrypted file transfer

    If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be 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 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 to SERVICE_MANAGED.

  • :server_id (required, String) —

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

Returns:

See Also:



1422
1423
1424
1425
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1422

def update_server(params = {}, options = {})
  req = build_request(:update_server, params)
  req.send_request(options)
end

#update_user(params = {}) ⇒ Types::UpdateUserResponse

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.

Examples:

Request syntax with placeholder values


resp = client.update_user({
  home_directory: "HomeDirectory",
  home_directory_type: "PATH", # accepts PATH, LOGICAL
  home_directory_mappings: [
    {
      entry: "MapEntry", # required
      target: "MapTarget", # required
    },
  ],
  policy: "Policy",
  role: "Role",
  server_id: "ServerId", # required
  user_name: "UserName", # required
})

Response structure


resp.server_id #=> String
resp.user_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :home_directory (String) —

    Specifies the landing directory (folder) for a user when they log in to the file transfer protocol-enabled server using their file transfer protocol client.

    An example is your-Amazon-S3-bucket-name>/home/username.

  • :home_directory_type (String) —

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

  • :home_directory_mappings (Array<Types::HomeDirectoryMapEntry>) —

    Logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "Entry" and "Target" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your IAM role provides access to paths in Target. The following is an example.

    '[ "/bucket2/documentation", \{ "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/$\{transfer:UserName\}.pdf" \} ]'

    In most cases, you can use this value instead of the scope-down 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 HomeDirectory parameter value.

    If the target of a logical directory entry does not exist in Amazon S3, the entry will be ignored. As a workaround, you can use the Amazon S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

  • :policy (String) —

    Allows you to supply a scope-down policy for your user so you can use the same IAM role across multiple users. The policy scopes down user access to portions of your Amazon S3 bucket. Variables you can use inside this policy include $\{Transfer:UserName\}, $\{Transfer:HomeDirectory\}, and $\{Transfer:HomeBucket\}.

    For scope-down policies, AWS 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 scope-down policy, see Creating a scope-down policy.

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

  • :role (String) —

    The IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the file transfer protocol-enabled server to access your resources when servicing your users' transfer requests.

  • :server_id (required, String) —

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

  • :user_name (required, String) —

    A unique string that identifies a user and is associated with a file transfer protocol-enabled server as specified by the ServerId. This is the string that will be used by your user when they log in to your server. This user name is a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

Returns:

See Also:



1556
1557
1558
1559
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1556

def update_user(params = {}, options = {})
  req = build_request(:update_user, params)
  req.send_request(options)
end