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_web_app(params = {}) ⇒ Types::CreateWebAppResponse
Creates a web app based on specified parameters, and returns the ID for the new web app.
-
#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
ServerIDandExternalIDparameters. -
#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
CertificateIdparameter. -
#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
HostKeyIdparameter. -
#delete_profile(params = {}) ⇒ Struct
Deletes the profile that's specified in the
ProfileIdparameter. -
#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_web_app(params = {}) ⇒ Struct
Deletes the specified web app.
-
#delete_web_app_customization(params = {}) ⇒ Struct
Deletes the
WebAppCustomizationobject that corresponds to the web app ID specified. -
#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
ServerIdproperty 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
DescribeExecutionto 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
HostKeyIdandServerId. -
#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
ServerIdparameter. -
#describe_user(params = {}) ⇒ Types::DescribeUserResponse
Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its
ServerIdproperty. -
#describe_web_app(params = {}) ⇒ Types::DescribeWebAppResponse
Describes the web app that's identified by
WebAppId. -
#describe_web_app_customization(params = {}) ⇒ Types::DescribeWebAppCustomizationResponse
Describes the web app customization object that's identified by
WebAppId. -
#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
ServerIdparameter. -
#import_ssh_public_key(params = {}) ⇒ Types::ImportSshPublicKeyResponse
Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a
UserNamevalue 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
ServerIdthat 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_file_transfer_results(params = {}) ⇒ Types::ListFileTransferResultsResponse
Returns real-time updates and detailed information on the status of each individual file being transferred in a specific file transfer operation.
-
#list_host_keys(params = {}) ⇒ Types::ListHostKeysResponse
Returns a list of host keys for the server that's specified by the
ServerIdparameter. -
#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
ServerIdparameter. -
#list_web_apps(params = {}) ⇒ Types::ListWebAppsResponse
Lists all web apps associated with your Amazon Web Services account for your current region.
-
#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_remote_delete(params = {}) ⇒ Types::StartRemoteDeleteResponse
Deletes a file or directory on the remote SFTP server.
-
#start_remote_move(params = {}) ⇒ Types::StartRemoteMoveResponse
Moves or renames a file or directory on the remote SFTP server.
-
#start_server(params = {}) ⇒ Struct
Changes the state of a file transfer protocol-enabled server from
OFFLINEtoONLINE. -
#stop_server(params = {}) ⇒ Struct
Changes the state of a file transfer protocol-enabled server from
ONLINEtoOFFLINE. -
#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
IdentityProviderTypeof a file transfer protocol-enabled server isAWS_DIRECTORY_SERVICEorAPI_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
ServerIDandExternalIDparameters. -
#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 host key that's specified by the
ServerIdandHostKeyIdparameters. -
#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.
-
#update_web_app(params = {}) ⇒ Types::UpdateWebAppResponse
Assigns new properties to a web app.
-
#update_web_app_customization(params = {}) ⇒ Types::UpdateWebAppCustomizationResponse
Assigns new customization properties to a web app.
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.
486 487 488 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 486 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.
657 658 659 660 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 657 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.
BaseDirectory or CustomDirectories, but not both.
Specifying both causes the command to fail.
816 817 818 819 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 816 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).
968 969 970 971 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 968 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.
1029 1030 1031 1032 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1029 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.
1452 1453 1454 1455 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1452 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.
1640 1641 1642 1643 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1640 def create_user(params = {}, = {}) req = build_request(:create_user, params) req.send_request() end |
#create_web_app(params = {}) ⇒ Types::CreateWebAppResponse
Creates a web app based on specified parameters, and returns the ID for the new web app. You can configure the web app to be publicly accessible or hosted within a VPC.
For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.
1739 1740 1741 1742 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1739 def create_web_app(params = {}, = {}) req = build_request(:create_web_app, 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.
1942 1943 1944 1945 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1942 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.
1986 1987 1988 1989 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 1986 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.
2014 2015 2016 2017 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2014 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.
2037 2038 2039 2040 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2037 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.
2059 2060 2061 2062 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2059 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.
2086 2087 2088 2089 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2086 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.
2108 2109 2110 2111 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2108 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.
2132 2133 2134 2135 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2132 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.
2164 2165 2166 2167 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2164 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.
2199 2200 2201 2202 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2199 def delete_user(params = {}, = {}) req = build_request(:delete_user, params) req.send_request() end |
#delete_web_app(params = {}) ⇒ Struct
Deletes the specified web app.
2221 2222 2223 2224 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2221 def delete_web_app(params = {}, = {}) req = build_request(:delete_web_app, params) req.send_request() end |
#delete_web_app_customization(params = {}) ⇒ Struct
Deletes the WebAppCustomization object that corresponds to the web
app ID specified.
2245 2246 2247 2248 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2245 def delete_web_app_customization(params = {}, = {}) req = build_request(:delete_web_app_customization, params) req.send_request() end |
#delete_workflow(params = {}) ⇒ Struct
Deletes the specified workflow.
2267 2268 2269 2270 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2267 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.
2335 2336 2337 2338 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2335 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.
2386 2387 2388 2389 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2386 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.
DaysUntilExpiry for imported certificates. This metric tracks
the number of days until the certificate expires based on the
InactiveDate. The metric is available in the AWS/Transfer
namespace and includes the CertificateId as a dimension.
2438 2439 2440 2441 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2438 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.
2501 2502 2503 2504 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2501 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.
2571 2572 2573 2574 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2571 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.
2615 2616 2617 2618 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2615 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.
2652 2653 2654 2655 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2652 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.
2704 2705 2706 2707 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2704 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
2794 2795 2796 2797 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2794 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.
2855 2856 2857 2858 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2855 def describe_user(params = {}, = {}) req = build_request(:describe_user, params) req.send_request() end |
#describe_web_app(params = {}) ⇒ Types::DescribeWebAppResponse
Describes the web app that's identified by WebAppId. The response
includes endpoint configuration details such as whether the web app is
publicly accessible or VPC hosted.
For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.
2908 2909 2910 2911 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2908 def describe_web_app(params = {}, = {}) req = build_request(:describe_web_app, params) req.send_request() end |
#describe_web_app_customization(params = {}) ⇒ Types::DescribeWebAppCustomizationResponse
Describes the web app customization object that's identified by
WebAppId.
2941 2942 2943 2944 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 2941 def describe_web_app_customization(params = {}, = {}) req = build_request(:describe_web_app_customization, params) req.send_request() end |
#describe_workflow(params = {}) ⇒ Types::DescribeWorkflowResponse
Describes the specified workflow.
3032 3033 3034 3035 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3032 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.
You can import both the certificate and its chain in the Certificate
parameter.
After importing a certificate, Transfer Family automatically creates a
Amazon CloudWatch metric called DaysUntilExpiry that tracks the
number of days until the certificate expires. The metric is based on
the InactiveDate parameter and is published daily in the
AWS/Transfer namespace.
It can take up to a full day after importing a certificate for
Transfer Family to emit the DaysUntilExpiry metric to your account.
Certificate parameter to upload both the certificate
and its chain, don't use the CertificateChain parameter.
CloudWatch monitoring
The DaysUntilExpiry metric includes the following specifications:
Units: Count (days)
Dimensions:
CertificateId(always present),Description(if provided during certificate import)Statistics: Minimum, Maximum, Average
Frequency: Published daily
3154 3155 3156 3157 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3154 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.
3221 3222 3223 3224 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3221 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.
3269 3270 3271 3272 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3269 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.
3319 3320 3321 3322 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3319 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.
3374 3375 3376 3377 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3374 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.
3426 3427 3428 3429 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3426 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.
3468 3469 3470 3471 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3468 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.
3545 3546 3547 3548 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3545 def list_executions(params = {}, = {}) req = build_request(:list_executions, params) req.send_request() end |
#list_file_transfer_results(params = {}) ⇒ Types::ListFileTransferResultsResponse
Returns real-time updates and detailed information on the status of
each individual file being transferred in a specific file transfer
operation. You specify the file transfer by providing its
ConnectorId and its TransferId.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3612 3613 3614 3615 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3612 def list_file_transfer_results(params = {}, = {}) req = build_request(:list_file_transfer_results, 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.
3664 3665 3666 3667 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3664 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.
3716 3717 3718 3719 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3716 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.
3765 3766 3767 3768 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3765 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.
3814 3815 3816 3817 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3814 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.
3865 3866 3867 3868 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3865 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.
3919 3920 3921 3922 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3919 def list_users(params = {}, = {}) req = build_request(:list_users, params) req.send_request() end |
#list_web_apps(params = {}) ⇒ Types::ListWebAppsResponse
Lists all web apps associated with your Amazon Web Services account for your current region. The response includes the endpoint type for each web app, showing whether it is publicly accessible or VPC hosted.
For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3971 3972 3973 3974 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 3971 def list_web_apps(params = {}, = {}) req = build_request(:list_web_apps, 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.
4013 4014 4015 4016 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 4013 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.
4052 4053 4054 4055 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 4052 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 yourTruncatedoutput value is true, you can increase the value provided in the optionalmax-itemsinput attribute to be able to list more items (up to the maximum allowed list size of 200,000 items).
4135 4136 4137 4138 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 4135 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
ConnectorIdand one or moreSendFilePathsto 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
RetrieveFilePathsto identify the files you want to transfer, and aLocalDirectoryPathto 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
SendFilePathsto identify the files you want to transfer, and aRemoteDirectoryPathto specify the destination folder.
4221 4222 4223 4224 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 4221 def start_file_transfer(params = {}, = {}) req = build_request(:start_file_transfer, params) req.send_request() end |
#start_remote_delete(params = {}) ⇒ Types::StartRemoteDeleteResponse
Deletes a file or directory on the remote SFTP server.
4254 4255 4256 4257 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 4254 def start_remote_delete(params = {}, = {}) req = build_request(:start_remote_delete, params) req.send_request() end |
#start_remote_move(params = {}) ⇒ Types::StartRemoteMoveResponse
Moves or renames a file or directory on the remote SFTP server.
4291 4292 4293 4294 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 4291 def start_remote_move(params = {}, = {}) req = build_request(:start_remote_move, 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.
4322 4323 4324 4325 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 4322 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.
4359 4360 4361 4362 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 4359 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.
4397 4398 4399 4400 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 4397 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.
4434 4435 4436 4437 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 4434 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
TestIdentityProviderif theIdentityProviderTypeof your server isSERVICE_MANAGED.TestIdentityProviderdoes not work with keys: it only accepts passwords.TestIdentityProvidercan test the password operation for a custom Identity Provider that handles keys and passwords.If you provide any incorrect values for any parameters, the
Responsefield 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 authIf you enter a Server ID for the
--server-idparameter 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-2to specify a server in US East (Ohio).
4536 4537 4538 4539 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 4536 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.
4570 4571 4572 4573 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 4570 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.
4735 4736 4737 4738 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 4735 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.
BaseDirectory or CustomDirectories, but not both.
Specifying both causes the command to fail.
If you update an agreement from using base directory to custom directories, the base directory is no longer used. Similarly, if you change from custom directories to a base directory, the custom directories are no longer used.
4892 4893 4894 4895 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 4892 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.
4936 4937 4938 4939 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 4936 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.
5067 5068 5069 5070 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 5067 def update_connector(params = {}, = {}) req = build_request(:update_connector, params) req.send_request() end |
#update_host_key(params = {}) ⇒ Types::UpdateHostKeyResponse
Updates the host key that's specified by the ServerId and
HostKeyId parameters. You can update the description of the host
key, change where the host key is stored by specifying the
StorageType, and specify the KMS key used to encrypt the host key
when it's stored in Secrets Manager.
To change a host key's storage type from SERVICE_MANAGED to
SECRETS_MANAGER, you must have the transfer:ExportHostKey
permission. transfer:ExportHostKey is a permission-only action that
has no corresponding API operation.
5131 5132 5133 5134 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 5131 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.
5166 5167 5168 5169 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 5166 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.
5570 5571 5572 5573 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 5570 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"}]"
5744 5745 5746 5747 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 5744 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |
#update_web_app(params = {}) ⇒ Types::UpdateWebAppResponse
Assigns new properties to a web app. You can modify the access point, identity provider details, endpoint configuration, and the web app units.
For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.
5813 5814 5815 5816 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 5813 def update_web_app(params = {}, = {}) req = build_request(:update_web_app, params) req.send_request() end |
#update_web_app_customization(params = {}) ⇒ Types::UpdateWebAppCustomizationResponse
Assigns new customization properties to a web app. You can modify the icon file, logo file, and title.
5854 5855 5856 5857 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 5854 def update_web_app_customization(params = {}, = {}) req = build_request(:update_web_app_customization, 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 |
5970 5971 5972 5973 5974 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/client.rb', line 5970 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |