Class: Aws::Transfer::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Transfer::Client
- 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
API Operations collapse
-
#create_server(params = {}) ⇒ Types::CreateServerResponse
Instantiates an autoscaling virtual server based on the selected file transfer protocol in AWS.
-
#create_user(params = {}) ⇒ Types::CreateUserResponse
Creates a user and associates them with an existing file transfer protocol-enabled server.
-
#delete_server(params = {}) ⇒ Struct
Deletes the file transfer protocol-enabled server that you specify.
-
#delete_ssh_public_key(params = {}) ⇒ Struct
Deletes a user's Secure Shell (SSH) public key.
-
#delete_user(params = {}) ⇒ Struct
Deletes the user belonging to a file transfer protocol-enabled server you specify.
-
#describe_security_policy(params = {}) ⇒ Types::DescribeSecurityPolicyResponse
Describes the security policy that is attached to your file transfer protocol-enabled server.
-
#describe_server(params = {}) ⇒ Types::DescribeServerResponse
Describes a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. -
#describe_user(params = {}) ⇒ Types::DescribeUserResponse
Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId
property. -
#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 byServerId
. -
#list_security_policies(params = {}) ⇒ Types::ListSecurityPoliciesResponse
Lists the security policies that are attached to your file transfer protocol-enabled servers.
-
#list_servers(params = {}) ⇒ Types::ListServersResponse
Lists the file transfer protocol-enabled servers that are associated with your AWS account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all of the tags associated with the Amazon Resource Number (ARN) you specify.
-
#list_users(params = {}) ⇒ Types::ListUsersResponse
Lists the users for a file transfer protocol-enabled server that you specify by passing the
ServerId
parameter. -
#start_server(params = {}) ⇒ Struct
Changes the state of a file transfer protocol-enabled server from
OFFLINE
toONLINE
. -
#stop_server(params = {}) ⇒ Struct
Changes the state of a file transfer protocol-enabled server from
ONLINE
toOFFLINE
. -
#tag_resource(params = {}) ⇒ Struct
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
-
#test_identity_provider(params = {}) ⇒ Types::TestIdentityProviderResponse
If the
IdentityProviderType
of a file transfer protocol-enabled server isAPI_Gateway
, tests whether your API Gateway is set up successfully. -
#untag_resource(params = {}) ⇒ Struct
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
-
#update_server(params = {}) ⇒ Types::UpdateServerResponse
Updates the file transfer protocol-enabled server's properties after that server has been created.
-
#update_user(params = {}) ⇒ Types::UpdateUserResponse
Assigns new properties to a user.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
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.
334 335 336 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 334 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.
522 523 524 525 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 522 def create_server(params = {}, = {}) req = build_request(:create_server, params) req.send_request() 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.
678 679 680 681 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 678 def create_user(params = {}, = {}) req = build_request(:create_user, params) req.send_request() end |
#delete_server(params = {}) ⇒ Struct
Deletes the file transfer protocol-enabled server that you specify.
No response returns from this operation.
702 703 704 705 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 702 def delete_server(params = {}, = {}) req = build_request(:delete_server, params) req.send_request() end |
#delete_ssh_public_key(params = {}) ⇒ Struct
Deletes a user's Secure Shell (SSH) public key.
No response is returned from this operation.
736 737 738 739 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 736 def delete_ssh_public_key(params = {}, = {}) req = build_request(:delete_ssh_public_key, params) req.send_request() end |
#delete_user(params = {}) ⇒ Struct
Deletes the user belonging to a file transfer protocol-enabled server you specify.
No response returns from this operation.
771 772 773 774 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 771 def delete_user(params = {}, = {}) req = build_request(:delete_user, params) req.send_request() end |
#describe_security_policy(params = {}) ⇒ Types::DescribeSecurityPolicyResponse
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.
816 817 818 819 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 816 def describe_security_policy(params = {}, = {}) req = build_request(:describe_security_policy, params) req.send_request() 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
.
874 875 876 877 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 874 def describe_server(params = {}, = {}) req = build_request(:describe_server, params) req.send_request() 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.
934 935 936 937 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 934 def describe_user(params = {}, = {}) req = build_request(:describe_user, params) req.send_request() 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
.
979 980 981 982 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 979 def import_ssh_public_key(params = {}, = {}) req = build_request(:import_ssh_public_key, params) req.send_request() end |
#list_security_policies(params = {}) ⇒ Types::ListSecurityPoliciesResponse
Lists the security policies that are attached to your file transfer protocol-enabled servers.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1021 1022 1023 1024 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1021 def list_security_policies(params = {}, = {}) req = build_request(:list_security_policies, params) req.send_request() 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.
1070 1071 1072 1073 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1070 def list_servers(params = {}, = {}) req = build_request(:list_servers, params) req.send_request() 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.
1121 1122 1123 1124 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1121 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() 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.
1175 1176 1177 1178 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1175 def list_users(params = {}, = {}) req = build_request(:list_users, params) req.send_request() 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.
1206 1207 1208 1209 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1206 def start_server(params = {}, = {}) req = build_request(:start_server, params) req.send_request() 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.
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.
1243 1244 1245 1246 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1243 def stop_server(params = {}, = {}) req = build_request(:stop_server, params) req.send_request() 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.
1281 1282 1283 1284 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1281 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() 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.
1345 1346 1347 1348 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1345 def test_identity_provider(params = {}, = {}) req = build_request(:test_identity_provider, params) req.send_request() 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.
1379 1380 1381 1382 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1379 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() 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.
1547 1548 1549 1550 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1547 def update_server(params = {}, = {}) req = build_request(:update_server, params) req.send_request() 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.
1685 1686 1687 1688 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1685 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |