lib/aws-sdk-transfer/client.rb in aws-sdk-transfer-1.59.0 vs lib/aws-sdk-transfer/client.rb in aws-sdk-transfer-1.60.0
- old
+ new
@@ -542,11 +542,12 @@
#
# @option params [required, String] :base_directory
# The landing directory (folder) for files transferred by using the AS2
# protocol.
#
- # A `BaseDirectory` example is `/DOC-EXAMPLE-BUCKET/home/mydirectory `.
+ # A `BaseDirectory` example is
+ # *DOC-EXAMPLE-BUCKET*/*home*/*mydirectory*.
#
# @option params [required, String] :access_role
# With AS2, you can send files by calling `StartFileTransfer` and
# specifying the file paths in the request parameter, `SendFilePaths`.
# We use the file’s parent directory (for example, for
@@ -602,12 +603,17 @@
req.send_request(options)
end
# Creates the connector, which captures the parameters for an outbound
# connection for the AS2 protocol. The connector is required for sending
- # files from a customer's non Amazon Web Services server.
+ # files to an externally hosted AS2 server. For more details about
+ # connectors, see [Create AS2 connectors][1].
#
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/transfer/latest/userguide/create-b2b-server.html#configure-as2-connector
+ #
# @option params [required, String] :url
# The URL of the partner's AS2 endpoint.
#
# @option params [required, Types::As2ConnectorConfig] :as_2_config
# A structure that contains the parameters for a connector object.
@@ -675,12 +681,11 @@
def create_connector(params = {}, options = {})
req = build_request(:create_connector, params)
req.send_request(options)
end
- # Creates the profile for the AS2 process. The agreement is between the
- # partner and the AS2 process.
+ # Creates the local or partner profile to use for AS2 transfers.
#
# @option params [required, String] :as_2_id
# The `As2Id` is the *AS2-name*, as defined in the [RFC 4130][1]. For
# inbound transfers, this is the `AS2-From` header for the AS2 messages
# sent from the partner. For outbound connectors, this is the `AS2-To`
@@ -690,14 +695,19 @@
#
#
# [1]: https://datatracker.ietf.org/doc/html/rfc4130
#
# @option params [required, String] :profile_type
- # Indicates whether to list only `LOCAL` type profiles or only `PARTNER`
- # type profiles. If not supplied in the request, the command lists all
- # types of profiles.
+ # Determines the type of profile to create:
#
+ # * Specify `LOCAL` to create a local profile. A local profile
+ # represents the AS2-enabled Transfer Family server organization or
+ # party.
+ #
+ # * Specify `PARTNER` to create a partner profile. A partner profile
+ # represents a remote organization, external to Transfer Family.
+ #
# @option params [Array<String>] :certificate_ids
# An array of identifiers for the imported certificates. You use this
# identifier for working with profiles and partner profiles.
#
# @option params [Array<Types::Tag>] :tags
@@ -822,11 +832,13 @@
# `VPC_ENDPOINT`.
#
# </note>
#
# @option params [String] :host_key
- # The RSA, ECDSA, or ED25519 private key to use for your server.
+ # The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled
+ # server. You can add multiple host keys, in case you want to rotate
+ # keys, or have a set of active keys that use different algorithms.
#
# Use the following command to generate an RSA 2048 bit key with no
# passphrase:
#
# `ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key`.
@@ -851,11 +863,11 @@
#
# If you aren't planning to migrate existing users from an existing
# SFTP-enabled server to a new server, don't update the host key.
# Accidentally changing a server's host key can be disruptive.
#
- # For more information, see [Change the host key for your SFTP-enabled
+ # For more information, see [Update host keys for your SFTP-enabled
# server][1] in the *Transfer Family User Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key
@@ -983,10 +995,15 @@
#
# @option params [Types::WorkflowDetails] :workflow_details
# Specifies the workflow ID for the workflow to assign and the execution
# role that's used for executing the workflow.
#
+ # In additon to a workflow to execute when a file is uploaded
+ # completely, `WorkflowDeatails` can also contain a workflow ID (and
+ # execution role) for a workflow to execute on partial upload. A partial
+ # upload occurs when a file is open when the session disconnects.
+ #
# @return [Types::CreateServerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateServerResponse#server_id #server_id} => String
#
# @example Request syntax with placeholder values
@@ -1026,16 +1043,22 @@
# key: "TagKey", # required
# value: "TagValue", # required
# },
# ],
# workflow_details: {
- # on_upload: [ # required
+ # on_upload: [
# {
# workflow_id: "WorkflowId", # required
# execution_role: "Role", # required
# },
# ],
+ # on_partial_upload: [
+ # {
+ # workflow_id: "WorkflowId", # required
+ # execution_role: "Role", # required
+ # },
+ # ],
# },
# })
#
# @example Response structure
#
@@ -1416,11 +1439,12 @@
# @option params [required, String] :agreement_id
# A unique identifier for the agreement. This identifier is returned
# when you create an agreement.
#
# @option params [required, String] :server_id
- # The server ID associated with the agreement that you are deleting.
+ # The server identifier associated with the agreement that you are
+ # deleting.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
@@ -1440,11 +1464,11 @@
# Deletes the certificate that's specified in the `CertificateId`
# parameter.
#
# @option params [required, String] :certificate_id
- # The ID of the certificate object that you are deleting.
+ # The identifier of the certificate object that you are deleting.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
@@ -1484,15 +1508,15 @@
end
# Deletes the host key that's specified in the `HoskKeyId` parameter.
#
# @option params [required, String] :server_id
- # Provide the ID of the server that contains the host key that you are
+ # The identifier of the server that contains the host key that you are
# deleting.
#
# @option params [required, String] :host_key_id
- # The ID of the host key that you are deleting.
+ # The identifier of the host key that you are deleting.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
@@ -1511,11 +1535,11 @@
end
# Deletes the profile that's specified in the `ProfileId` parameter.
#
# @option params [required, String] :profile_id
- # The ID of the profile that you are deleting.
+ # The identifier of the profile that you are deleting.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
@@ -1717,11 +1741,11 @@
# @option params [required, String] :agreement_id
# A unique identifier for the agreement. This identifier is returned
# when you create an agreement.
#
# @option params [required, String] :server_id
- # The server ID that's associated with the agreement.
+ # The server identifier that's associated with the agreement.
#
# @return [Types::DescribeAgreementResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeAgreementResponse#agreement #agreement} => Types::DescribedAgreement
#
@@ -1907,15 +1931,15 @@
# Returns the details of the host key that's specified by the
# `HostKeyId` and `ServerId`.
#
# @option params [required, String] :server_id
- # Provide the ID of the server that contains the host key that you want
+ # The identifier of the server that contains the host key that you want
# described.
#
# @option params [required, String] :host_key_id
- # Provide the ID of the host key that you want described.
+ # The identifier of the host key that you want described.
#
# @return [Types::DescribeHostKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeHostKeyResponse#host_key #host_key} => Types::DescribedHostKey
#
@@ -2087,10 +2111,13 @@
# resp.server.tags[0].value #=> String
# resp.server.user_count #=> Integer
# resp.server.workflow_details.on_upload #=> Array
# resp.server.workflow_details.on_upload[0].workflow_id #=> String
# resp.server.workflow_details.on_upload[0].execution_role #=> String
+ # resp.server.workflow_details.on_partial_upload #=> Array
+ # resp.server.workflow_details.on_partial_upload[0].workflow_id #=> String
+ # resp.server.workflow_details.on_partial_upload[0].execution_role #=> String
#
#
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
#
# * server_offline
@@ -2300,23 +2327,24 @@
def import_certificate(params = {}, options = {})
req = build_request(:import_certificate, params)
req.send_request(options)
end
- # Adds a host key to the server specified by the `ServerId` parameter.
+ # Adds a host key to the server that's specified by the `ServerId`
+ # parameter.
#
# @option params [required, String] :server_id
- # Provide the ID of the server that contains the host key that you are
+ # The identifier of the server that contains the host key that you are
# importing.
#
# @option params [required, String] :host_key_body
# The public key portion of an SSH key pair.
#
# Transfer Family accepts RSA, ECDSA, and ED25519 keys.
#
# @option params [String] :description
- # Enter a text description to identify this host key.
+ # The text description that identifies this host key.
#
# @option params [Array<Types::Tag>] :tags
# Key-value pairs that can be used to group and search for host keys.
#
# @return [Types::ImportHostKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -2668,23 +2696,23 @@
def list_executions(params = {}, options = {})
req = build_request(:list_executions, params)
req.send_request(options)
end
- # Returns a list of host keys for the server specified by the `ServerId`
- # paramter.
+ # Returns a list of host keys for the server that's specified by the
+ # `ServerId` parameter.
#
# @option params [Integer] :max_results
# The maximum number of host keys to return.
#
# @option params [String] :next_token
# When there are additional results that were not returned, a
# `NextToken` parameter is returned. You can use that value for a
# subsequent call to `ListHostKeys` to continue listing results.
#
# @option params [required, String] :server_id
- # Provide the ID of the server that contains the host keys that you want
+ # The identifier of the server that contains the host keys that you want
# to view.
#
# @return [Types::ListHostKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListHostKeysResponse#next_token #next_token} => String
@@ -3046,12 +3074,12 @@
def send_workflow_step_state(params = {}, options = {})
req = build_request(:send_workflow_step_state, params)
req.send_request(options)
end
- # Begins an outbound file transfer. You specify the `ConnectorId` and
- # the file paths for where to send the files.
+ # Begins an outbound file transfer to a remote AS2 server. You specify
+ # the `ConnectorId` and the file paths for where to send the files.
#
# @option params [required, String] :connector_id
# The unique identifier for the connector.
#
# @option params [required, Array<String>] :send_file_paths
@@ -3649,22 +3677,22 @@
def update_connector(params = {}, options = {})
req = build_request(:update_connector, params)
req.send_request(options)
end
- # Updates the description for the host key specified by the specified by
- # the `ServerId` and `HostKeyId` parameters.
+ # Updates the description for the host key that's specified by the
+ # `ServerId` and `HostKeyId` parameters.
#
# @option params [required, String] :server_id
- # Provide the ID of the server that contains the host key that you are
+ # The identifier of the server that contains the host key that you are
# updating.
#
# @option params [required, String] :host_key_id
- # Provide the ID of the host key that you are updating.
+ # The identifier of the host key that you are updating.
#
# @option params [required, String] :description
- # Provide an updated description for the host key.
+ # An updated description for the host key.
#
# @return [Types::UpdateHostKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateHostKeyResponse#server_id #server_id} => String
# * {Types::UpdateHostKeyResponse#host_key_id #host_key_id} => String
@@ -3830,11 +3858,13 @@
# `VPC_ENDPOINT`.
#
# </note>
#
# @option params [String] :host_key
- # The RSA, ECDSA, or ED25519 private key to use for your server.
+ # The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled
+ # server. You can add multiple host keys, in case you want to rotate
+ # keys, or have a set of active keys that use different algorithms.
#
# Use the following command to generate an RSA 2048 bit key with no
# passphrase:
#
# `ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key`.
@@ -3859,11 +3889,11 @@
#
# If you aren't planning to migrate existing users from an existing
# SFTP-enabled server to a new server, don't update the host key.
# Accidentally changing a server's host key can be disruptive.
#
- # For more information, see [Change the host key for your SFTP-enabled
+ # For more information, see [Update host keys for your SFTP-enabled
# server][1] in the *Transfer Family User Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key
@@ -3943,10 +3973,15 @@
#
# @option params [Types::WorkflowDetails] :workflow_details
# Specifies the workflow ID for the workflow to assign and the execution
# role that's used for executing the workflow.
#
+ # In additon to a workflow to execute when a file is uploaded
+ # completely, `WorkflowDeatails` can also contain a workflow ID (and
+ # execution role) for a workflow to execute on partial upload. A partial
+ # upload occurs when a file is open when the session disconnects.
+ #
# To remove an associated workflow from a server, you can provide an
# empty `OnUpload` object, as in the following example.
#
# `aws transfer update-server --server-id s-01234567890abcdef
# --workflow-details '\{"OnUpload":[]\}'`
@@ -3985,16 +4020,22 @@
# pre_authentication_login_banner: "PreAuthenticationLoginBanner",
# protocols: ["SFTP"], # accepts SFTP, FTP, FTPS, AS2
# security_policy_name: "SecurityPolicyName",
# server_id: "ServerId", # required
# workflow_details: {
- # on_upload: [ # required
+ # on_upload: [
# {
# workflow_id: "WorkflowId", # required
# execution_role: "Role", # required
# },
# ],
+ # on_partial_upload: [
+ # {
+ # workflow_id: "WorkflowId", # required
+ # execution_role: "Role", # required
+ # },
+ # ],
# },
# })
#
# @example Response structure
#
@@ -4165,10 +4206,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-transfer'
- context[:gem_version] = '1.59.0'
+ context[:gem_version] = '1.60.0'
Seahorse::Client::Request.new(handlers, context)
end
# Polls an API operation until a resource enters a desired state.
#