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_access(params = {}) ⇒ Types::CreateAccessResponse
Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Transfer Family.
-
#create_agreement(params = {}) ⇒ Types::CreateAgreementResponse
Creates an agreement.
-
#create_connector(params = {}) ⇒ Types::CreateConnectorResponse
Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol.
-
#create_profile(params = {}) ⇒ Types::CreateProfileResponse
Creates the local or partner profile to use for AS2 transfers.
-
#create_server(params = {}) ⇒ Types::CreateServerResponse
Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services.
-
#create_user(params = {}) ⇒ Types::CreateUserResponse
Creates a user and associates them with an existing file transfer protocol-enabled server.
-
#create_workflow(params = {}) ⇒ Types::CreateWorkflowResponse
Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.
-
#delete_access(params = {}) ⇒ Struct
Allows you to delete the access specified in the
ServerID
andExternalID
parameters. -
#delete_agreement(params = {}) ⇒ Struct
Delete the agreement that's specified in the provided
AgreementId
. -
#delete_certificate(params = {}) ⇒ Struct
Deletes the certificate that's specified in the
CertificateId
parameter. -
#delete_connector(params = {}) ⇒ Struct
Deletes the connector that's specified in the provided
ConnectorId
. -
#delete_host_key(params = {}) ⇒ Struct
Deletes the host key that's specified in the
HostKeyId
parameter. -
#delete_profile(params = {}) ⇒ Struct
Deletes the profile that's specified in the
ProfileId
parameter. -
#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.
-
#delete_workflow(params = {}) ⇒ Struct
Deletes the specified workflow.
-
#describe_access(params = {}) ⇒ Types::DescribeAccessResponse
Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its
ServerId
property and itsExternalId
. -
#describe_agreement(params = {}) ⇒ Types::DescribeAgreementResponse
Describes the agreement that's identified by the
AgreementId
. -
#describe_certificate(params = {}) ⇒ Types::DescribeCertificateResponse
Describes the certificate that's identified by the
CertificateId
. -
#describe_connector(params = {}) ⇒ Types::DescribeConnectorResponse
Describes the connector that's identified by the
ConnectorId.
. -
#describe_execution(params = {}) ⇒ Types::DescribeExecutionResponse
You can use
DescribeExecution
to check the details of the execution of the specified workflow. -
#describe_host_key(params = {}) ⇒ Types::DescribeHostKeyResponse
Returns the details of the host key that's specified by the
HostKeyId
andServerId
. -
#describe_profile(params = {}) ⇒ Types::DescribeProfileResponse
Returns the details of the profile that's specified by the
ProfileId
. -
#describe_security_policy(params = {}) ⇒ Types::DescribeSecurityPolicyResponse
Describes the security policy that is attached to your server or SFTP connector.
-
#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. -
#describe_workflow(params = {}) ⇒ Types::DescribeWorkflowResponse
Describes the specified workflow.
-
#import_certificate(params = {}) ⇒ Types::ImportCertificateResponse
Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.
-
#import_host_key(params = {}) ⇒ Types::ImportHostKeyResponse
Adds a host key to the server that's specified by the
ServerId
parameter. -
#import_ssh_public_key(params = {}) ⇒ Types::ImportSshPublicKeyResponse
Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a
UserName
value assigned to the specific file transfer protocol-enabled server, identified byServerId
. -
#list_accesses(params = {}) ⇒ Types::ListAccessesResponse
Lists the details for all the accesses you have on your server.
-
#list_agreements(params = {}) ⇒ Types::ListAgreementsResponse
Returns a list of the agreements for the server that's identified by the
ServerId
that you supply. -
#list_certificates(params = {}) ⇒ Types::ListCertificatesResponse
Returns a list of the current certificates that have been imported into Transfer Family.
-
#list_connectors(params = {}) ⇒ Types::ListConnectorsResponse
Lists the connectors for the specified Region.
-
#list_executions(params = {}) ⇒ Types::ListExecutionsResponse
Lists all in-progress executions for the specified workflow.
-
#list_host_keys(params = {}) ⇒ Types::ListHostKeysResponse
Returns a list of host keys for the server that's specified by the
ServerId
parameter. -
#list_profiles(params = {}) ⇒ Types::ListProfilesResponse
Returns a list of the profiles for your system.
-
#list_security_policies(params = {}) ⇒ Types::ListSecurityPoliciesResponse
Lists the security policies that are attached to your servers and SFTP connectors.
-
#list_servers(params = {}) ⇒ Types::ListServersResponse
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all of the tags associated with the Amazon Resource Name (ARN) that 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. -
#list_workflows(params = {}) ⇒ Types::ListWorkflowsResponse
Lists all workflows associated with your Amazon Web Services account for your current region.
-
#send_workflow_step_state(params = {}) ⇒ Struct
Sends a callback for asynchronous custom steps.
-
#start_directory_listing(params = {}) ⇒ Types::StartDirectoryListingResponse
Retrieves a list of the contents of a directory from a remote SFTP server.
-
#start_file_transfer(params = {}) ⇒ Types::StartFileTransferResponse
Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
-
#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_connection(params = {}) ⇒ Types::TestConnectionResponse
Tests whether your SFTP connector is set up successfully.
-
#test_identity_provider(params = {}) ⇒ Types::TestIdentityProviderResponse
If the
IdentityProviderType
of a file transfer protocol-enabled server isAWS_DIRECTORY_SERVICE
orAPI_Gateway
, tests whether your identity provider 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_access(params = {}) ⇒ Types::UpdateAccessResponse
Allows you to update parameters for the access specified in the
ServerID
andExternalID
parameters. -
#update_agreement(params = {}) ⇒ Types::UpdateAgreementResponse
Updates some of the parameters for an existing agreement.
-
#update_certificate(params = {}) ⇒ Types::UpdateCertificateResponse
Updates the active and inactive dates for a certificate.
-
#update_connector(params = {}) ⇒ Types::UpdateConnectorResponse
Updates some of the parameters for an existing connector.
-
#update_host_key(params = {}) ⇒ Types::UpdateHostKeyResponse
Updates the description for the host key that's specified by the
ServerId
andHostKeyId
parameters. -
#update_profile(params = {}) ⇒ Types::UpdateProfileResponse
Updates some of the parameters for an existing profile.
-
#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.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
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.
453 454 455 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 453 def initialize(*args) super end |
Instance Method Details
#create_access(params = {}) ⇒ Types::CreateAccessResponse
Used by administrators to choose which groups in the directory should
have access to upload and download files over the enabled protocols
using 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.
624 625 626 627 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 624 def create_access(params = {}, = {}) req = build_request(:create_access, params) req.send_request() end |
#create_agreement(params = {}) ⇒ Types::CreateAgreementResponse
Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes.
The partner is identified with the PartnerProfileId
, and the AS2
process is identified with the LocalProfileId
.
729 730 731 732 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 729 def create_agreement(params = {}, = {}) req = build_request(:create_agreement, params) req.send_request() end |
#create_connector(params = {}) ⇒ Types::CreateConnectorResponse
Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol. For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server. For more details about connectors, see Configure AS2 connectors and Create SFTP connectors.
As2Config
) or SFTP (SftpConfig
).
850 851 852 853 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 850 def create_connector(params = {}, = {}) req = build_request(:create_connector, params) req.send_request() end |
#create_profile(params = {}) ⇒ Types::CreateProfileResponse
Creates the local or partner profile to use for AS2 transfers.
911 912 913 914 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 911 def create_profile(params = {}, = {}) req = build_request(:create_profile, params) req.send_request() end |
#create_server(params = {}) ⇒ Types::CreateServerResponse
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.
1275 1276 1277 1278 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1275 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 Identity and Access Management (IAM) role. You can also
optionally add a session policy, and assign metadata with tags that
can be used to group and search for users.
1463 1464 1465 1466 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1463 def create_user(params = {}, = {}) req = build_request(:create_user, params) req.send_request() end |
#create_workflow(params = {}) ⇒ Types::CreateWorkflowResponse
Allows you to create a workflow with specified steps and step details
the workflow invokes after file transfer completes. After creating a
workflow, you can associate the workflow created with any transfer
servers by specifying the workflow-details
field in CreateServer
and UpdateServer
operations.
1654 1655 1656 1657 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1654 def create_workflow(params = {}, = {}) req = build_request(:create_workflow, params) req.send_request() end |
#delete_access(params = {}) ⇒ Struct
Allows you to delete the access specified in the ServerID
and
ExternalID
parameters.
1698 1699 1700 1701 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1698 def delete_access(params = {}, = {}) req = build_request(:delete_access, params) req.send_request() end |
#delete_agreement(params = {}) ⇒ Struct
Delete the agreement that's specified in the provided AgreementId
.
1726 1727 1728 1729 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1726 def delete_agreement(params = {}, = {}) req = build_request(:delete_agreement, params) req.send_request() end |
#delete_certificate(params = {}) ⇒ Struct
Deletes the certificate that's specified in the CertificateId
parameter.
1749 1750 1751 1752 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1749 def delete_certificate(params = {}, = {}) req = build_request(:delete_certificate, params) req.send_request() end |
#delete_connector(params = {}) ⇒ Struct
Deletes the connector that's specified in the provided ConnectorId
.
1771 1772 1773 1774 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1771 def delete_connector(params = {}, = {}) req = build_request(:delete_connector, params) req.send_request() end |
#delete_host_key(params = {}) ⇒ Struct
Deletes the host key that's specified in the HostKeyId
parameter.
1798 1799 1800 1801 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1798 def delete_host_key(params = {}, = {}) req = build_request(:delete_host_key, params) req.send_request() end |
#delete_profile(params = {}) ⇒ Struct
Deletes the profile that's specified in the ProfileId
parameter.
1820 1821 1822 1823 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1820 def delete_profile(params = {}, = {}) req = build_request(:delete_profile, 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.
1844 1845 1846 1847 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1844 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.
1876 1877 1878 1879 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1876 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.
1911 1912 1913 1914 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1911 def delete_user(params = {}, = {}) req = build_request(:delete_user, params) req.send_request() end |
#delete_workflow(params = {}) ⇒ Struct
Deletes the specified workflow.
1933 1934 1935 1936 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1933 def delete_workflow(params = {}, = {}) req = build_request(:delete_workflow, params) req.send_request() end |
#describe_access(params = {}) ⇒ Types::DescribeAccessResponse
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.
2001 2002 2003 2004 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2001 def describe_access(params = {}, = {}) req = build_request(:describe_access, params) req.send_request() end |
#describe_agreement(params = {}) ⇒ Types::DescribeAgreementResponse
Describes the agreement that's identified by the AgreementId
.
2045 2046 2047 2048 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2045 def describe_agreement(params = {}, = {}) req = build_request(:describe_agreement, params) req.send_request() end |
#describe_certificate(params = {}) ⇒ Types::DescribeCertificateResponse
Describes the certificate that's identified by the CertificateId
.
2089 2090 2091 2092 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2089 def describe_certificate(params = {}, = {}) req = build_request(:describe_certificate, params) req.send_request() end |
#describe_connector(params = {}) ⇒ Types::DescribeConnectorResponse
Describes the connector that's identified by the ConnectorId.
2139 2140 2141 2142 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2139 def describe_connector(params = {}, = {}) req = build_request(:describe_connector, params) req.send_request() end |
#describe_execution(params = {}) ⇒ Types::DescribeExecutionResponse
You can use DescribeExecution
to check the details of the execution
of the specified workflow.
If you provide an ID for an execution that is not in progress, or if
the execution doesn't match the specified workflow ID, you receive a
ResourceNotFound
exception.
2209 2210 2211 2212 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2209 def describe_execution(params = {}, = {}) req = build_request(:describe_execution, params) req.send_request() end |
#describe_host_key(params = {}) ⇒ Types::DescribeHostKeyResponse
Returns the details of the host key that's specified by the
HostKeyId
and ServerId
.
2251 2252 2253 2254 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2251 def describe_host_key(params = {}, = {}) req = build_request(:describe_host_key, params) req.send_request() end |
#describe_profile(params = {}) ⇒ Types::DescribeProfileResponse
Returns the details of the profile that's specified by the
ProfileId
.
2288 2289 2290 2291 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2288 def describe_profile(params = {}, = {}) req = build_request(:describe_profile, params) req.send_request() end |
#describe_security_policy(params = {}) ⇒ Types::DescribeSecurityPolicyResponse
Describes the security policy that is attached to your server or SFTP connector. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.
2340 2341 2342 2343 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2340 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
.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- server_offline
- server_online
2425 2426 2427 2428 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2425 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.
2486 2487 2488 2489 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2486 def describe_user(params = {}, = {}) req = build_request(:describe_user, params) req.send_request() end |
#describe_workflow(params = {}) ⇒ Types::DescribeWorkflowResponse
Describes the specified workflow.
2575 2576 2577 2578 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2575 def describe_workflow(params = {}, = {}) req = build_request(:describe_workflow, params) req.send_request() end |
#import_certificate(params = {}) ⇒ Types::ImportCertificateResponse
Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.
2655 2656 2657 2658 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2655 def import_certificate(params = {}, = {}) req = build_request(:import_certificate, params) req.send_request() end |
#import_host_key(params = {}) ⇒ Types::ImportHostKeyResponse
Adds a host key to the server that's specified by the ServerId
parameter.
2706 2707 2708 2709 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2706 def import_host_key(params = {}, = {}) req = build_request(:import_host_key, params) req.send_request() end |
#import_ssh_public_key(params = {}) ⇒ Types::ImportSshPublicKeyResponse
Adds a Secure Shell (SSH) public key to a Transfer Family user
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
.
2754 2755 2756 2757 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2754 def import_ssh_public_key(params = {}, = {}) req = build_request(:import_ssh_public_key, params) req.send_request() end |
#list_accesses(params = {}) ⇒ Types::ListAccessesResponse
Lists the details for all the accesses you have on your server.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2804 2805 2806 2807 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2804 def list_accesses(params = {}, = {}) req = build_request(:list_accesses, params) req.send_request() end |
#list_agreements(params = {}) ⇒ Types::ListAgreementsResponse
Returns a list of the agreements for the server that's identified by
the ServerId
that you supply. If you want to limit the results to a
certain number, supply a value for the MaxResults
parameter. If you
ran the command previously and received a value for NextToken
, you
can supply that value to continue listing agreements from where you
left off.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2859 2860 2861 2862 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2859 def list_agreements(params = {}, = {}) req = build_request(:list_agreements, params) req.send_request() end |
#list_certificates(params = {}) ⇒ Types::ListCertificatesResponse
Returns a list of the current certificates that have been imported
into Transfer Family. If you want to limit the results to a certain
number, supply a value for the MaxResults
parameter. If you ran the
command previously and received a value for the NextToken
parameter,
you can supply that value to continue listing certificates from where
you left off.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2911 2912 2913 2914 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2911 def list_certificates(params = {}, = {}) req = build_request(:list_certificates, params) req.send_request() end |
#list_connectors(params = {}) ⇒ Types::ListConnectorsResponse
Lists the connectors for the specified Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2953 2954 2955 2956 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2953 def list_connectors(params = {}, = {}) req = build_request(:list_connectors, params) req.send_request() end |
#list_executions(params = {}) ⇒ Types::ListExecutionsResponse
Lists all in-progress executions for the specified workflow.
ListExecutions
returns
a ResourceNotFound
exception.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3030 3031 3032 3033 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3030 def list_executions(params = {}, = {}) req = build_request(:list_executions, params) req.send_request() end |
#list_host_keys(params = {}) ⇒ Types::ListHostKeysResponse
Returns a list of host keys for the server that's specified by the
ServerId
parameter.
3080 3081 3082 3083 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3080 def list_host_keys(params = {}, = {}) req = build_request(:list_host_keys, params) req.send_request() end |
#list_profiles(params = {}) ⇒ Types::ListProfilesResponse
Returns a list of the profiles for your system. If you want to limit
the results to a certain number, supply a value for the MaxResults
parameter. If you ran the command previously and received a value for
NextToken
, you can supply that value to continue listing profiles
from where you left off.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3132 3133 3134 3135 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3132 def list_profiles(params = {}, = {}) req = build_request(:list_profiles, params) req.send_request() end |
#list_security_policies(params = {}) ⇒ Types::ListSecurityPoliciesResponse
Lists the security policies that are attached to your servers and SFTP connectors. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3181 3182 3183 3184 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3181 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 Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3230 3231 3232 3233 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3230 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 Name (ARN) that 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.
3281 3282 3283 3284 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3281 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.
3335 3336 3337 3338 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3335 def list_users(params = {}, = {}) req = build_request(:list_users, params) req.send_request() end |
#list_workflows(params = {}) ⇒ Types::ListWorkflowsResponse
Lists all workflows associated with your Amazon Web Services account for your current region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3377 3378 3379 3380 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3377 def list_workflows(params = {}, = {}) req = build_request(:list_workflows, params) req.send_request() end |
#send_workflow_step_state(params = {}) ⇒ Struct
Sends a callback for asynchronous custom steps.
The ExecutionId
, WorkflowId
, and Token
are passed to the target
resource during execution of a custom step of a workflow. You must
include those with their callback as well as providing a status.
3416 3417 3418 3419 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3416 def send_workflow_step_state(params = {}, = {}) req = build_request(:send_workflow_step_state, params) req.send_request() end |
#start_directory_listing(params = {}) ⇒ Types::StartDirectoryListingResponse
Retrieves a list of the contents of a directory from a remote SFTP
server. You specify the connector ID, the output path, and the remote
directory path. You can also specify the optional MaxItems
value to
control the maximum number of items that are listed from the remote
directory. This API returns a list of all files and directories in the
remote directory (up to the maximum value), but does not return files
or folders in sub-directories. That is, it only returns a list of
files and directories one-level deep.
After you receive the listing file, you can provide the files that you
want to transfer to the RetrieveFilePaths
parameter of the
StartFileTransfer
API call.
The naming convention for the output file is
connector-ID-listing-ID.json
. The output file contains the following
information:
filePath
: the complete path of a remote file, relative to the directory of the listing request for your SFTP connector on the remote server.modifiedTimestamp
: the last time the file was modified, in UTC time format. This field is optional. If the remote file attributes don't contain a timestamp, it is omitted from the file listing.size
: the size of the file, in bytes. This field is optional. If the remote file attributes don't contain a file size, it is omitted from the file listing.path
: the complete path of a remote directory, relative to the directory of the listing request for your SFTP connector on the remote server.truncated
: a flag indicating whether the list output contains all of the items contained in the remote directory or not. If yourTruncated
output value is true, you can increase the value provided in the optionalmax-items
input attribute to be able to list more items (up to the maximum allowed list size of 10,000 items).
3499 3500 3501 3502 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3499 def start_directory_listing(params = {}, = {}) req = build_request(:start_directory_listing, params) req.send_request() end |
#start_file_transfer(params = {}) ⇒ Types::StartFileTransferResponse
Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
For an AS2 connector, you specify the
ConnectorId
and one or moreSendFilePaths
to identify the files you want to transfer.For an SFTP connector, the file transfer can be either outbound or inbound. In both cases, you specify the
ConnectorId
. Depending on the direction of the transfer, you also specify the following items:If you are transferring file from a partner's SFTP server to Amazon Web Services storage, you specify one or more
RetrieveFilePaths
to identify the files you want to transfer, and aLocalDirectoryPath
to specify the destination folder.If you are transferring file to a partner's SFTP server from Amazon Web Services storage, you specify one or more
SendFilePaths
to identify the files you want to transfer, and aRemoteDirectoryPath
to specify the destination folder.
3574 3575 3576 3577 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3574 def start_file_transfer(params = {}, = {}) req = build_request(:start_file_transfer, 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.
3605 3606 3607 3608 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3605 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.
3642 3643 3644 3645 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3642 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.
3680 3681 3682 3683 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3680 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#test_connection(params = {}) ⇒ Types::TestConnectionResponse
Tests whether your SFTP connector is set up successfully. We highly recommend that you call this operation to test your ability to transfer files between local Amazon Web Services storage and a trading partner's SFTP server.
3715 3716 3717 3718 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3715 def test_connection(params = {}, = {}) req = build_request(:test_connection, params) req.send_request() end |
#test_identity_provider(params = {}) ⇒ Types::TestIdentityProviderResponse
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.
The ServerId
and UserName
parameters are required. The
ServerProtocol
, SourceIp
, and UserPassword
are all optional.
Note the following:
You cannot use
TestIdentityProvider
if theIdentityProviderType
of your server isSERVICE_MANAGED
.TestIdentityProvider
does not work with keys: it only accepts passwords.TestIdentityProvider
can test the password operation for a custom Identity Provider that handles keys and passwords.If you provide any incorrect values for any parameters, the
Response
field is empty.If you provide a server ID for a server that uses service-managed users, you get an error:
An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-server-ID not configured for external auth
If you enter a Server ID for the
--server-id
parameter that does not identify an actual Transfer server, you receive the following error:An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server
.It is possible your sever is in a different region. You can specify a region by adding the following:
--region region-code
, such as--region us-east-2
to specify a server in US East (Ohio).
3817 3818 3819 3820 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3817 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.
3851 3852 3853 3854 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3851 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_access(params = {}) ⇒ Types::UpdateAccessResponse
Allows you to update parameters for the access specified in the
ServerID
and ExternalID
parameters.
4016 4017 4018 4019 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 4016 def update_access(params = {}, = {}) req = build_request(:update_access, params) req.send_request() end |
#update_agreement(params = {}) ⇒ Types::UpdateAgreementResponse
Updates some of the parameters for an existing agreement. Provide the
AgreementId
and the ServerId
for the agreement that you want to
update, along with the new values for the parameters to update.
4114 4115 4116 4117 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 4114 def update_agreement(params = {}, = {}) req = build_request(:update_agreement, params) req.send_request() end |
#update_certificate(params = {}) ⇒ Types::UpdateCertificateResponse
Updates the active and inactive dates for a certificate.
4154 4155 4156 4157 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 4154 def update_certificate(params = {}, = {}) req = build_request(:update_certificate, params) req.send_request() end |
#update_connector(params = {}) ⇒ Types::UpdateConnectorResponse
Updates some of the parameters for an existing connector. Provide the
ConnectorId
for the connector that you want to update, along with
the new values for the parameters to update.
4255 4256 4257 4258 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 4255 def update_connector(params = {}, = {}) req = build_request(:update_connector, params) req.send_request() end |
#update_host_key(params = {}) ⇒ Types::UpdateHostKeyResponse
Updates the description for the host key that's specified by the
ServerId
and HostKeyId
parameters.
4295 4296 4297 4298 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 4295 def update_host_key(params = {}, = {}) req = build_request(:update_host_key, params) req.send_request() end |
#update_profile(params = {}) ⇒ Types::UpdateProfileResponse
Updates some of the parameters for an existing profile. Provide the
ProfileId
for the profile that you want to update, along with the
new values for the parameters to update.
4330 4331 4332 4333 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 4330 def update_profile(params = {}, = {}) req = build_request(:update_profile, 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.
4660 4661 4662 4663 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 4660 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.
In the console, you can select Restricted when you create or update
a user. This ensures that the user can't access anything outside of
their home directory. The programmatic way to configure this behavior
is to update the user. Set their HomeDirectoryType
to LOGICAL
, and
specify HomeDirectoryMappings
with Entry
as root (/
) and
Target
as their home directory.
For example, if the user's home directory is /test/admin-user
, the
following command updates the user so that their configuration in the
console shows the Restricted flag as selected.
aws transfer update-user --server-id <server-id> --user-name
admin-user --home-directory-type LOGICAL --home-directory-mappings
"[\{"Entry":"/", "Target":"/test/admin-user"\}]"
4834 4835 4836 4837 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 4834 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay
and :max_attempts
values.
waiter_name | params | :delay | :max_attempts |
---|---|---|---|
server_offline | #describe_server | 30 | 120 |
server_online | #describe_server | 30 | 120 |
4950 4951 4952 4953 4954 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 4950 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |