lib/aws-sdk-transfer/client.rb in aws-sdk-transfer-1.67.0 vs lib/aws-sdk-transfer/client.rb in aws-sdk-transfer-1.68.0
- old
+ new
@@ -887,12 +887,13 @@
#
#
# [1]: https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key
#
# @option params [Types::IdentityProviderDetails] :identity_provider_details
- # Required when `IdentityProviderType` is set to `AWS_DIRECTORY_SERVICE`
- # or `API_GATEWAY`. Accepts an array containing all of the information
+ # Required when `IdentityProviderType` is set to
+ # `AWS_DIRECTORY_SERVICE`, `Amazon Web Services_LAMBDA` or
+ # `API_GATEWAY`. Accepts an array containing all of the information
# required to use a directory in `AWS_DIRECTORY_SERVICE` or invoke a
# customer-supplied authentication API, including the API Gateway URL.
# Not required when `IdentityProviderType` is set to `SERVICE_MANAGED`.
#
# @option params [String] :identity_provider_type
@@ -912,11 +913,11 @@
# Amazon API Gateway endpoint URL to call for authentication by using
# the `IdentityProviderDetails` parameter.
#
# Use the `AWS_LAMBDA` value to directly use an Lambda function as your
# identity provider. If you choose this value, you must specify the ARN
- # for the Lambda function in the `Function` parameter or the
+ # for the Lambda function in the `Function` parameter for the
# `IdentityProviderDetails` data type.
#
# @option params [String] :logging_role
# The Amazon Resource Name (ARN) of the Identity and Access Management
# (IAM) role that allows a server to turn on Amazon CloudWatch logging
@@ -1015,11 +1016,12 @@
# role that's used for executing the workflow.
#
# In addition to a workflow to execute when a file is uploaded
# completely, `WorkflowDetails` 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.
+ # upload occurs when the server session disconnects while the file is
+ # still being uploaded.
#
# @return [Types::CreateServerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateServerResponse#server_id #server_id} => String
#
@@ -1040,10 +1042,11 @@
# identity_provider_details: {
# url: "Url",
# invocation_role: "Role",
# directory_id: "DirectoryId",
# function: "Function",
+ # sftp_authentication_methods: "PASSWORD", # accepts PASSWORD, PUBLIC_KEY, PUBLIC_KEY_OR_PASSWORD, PUBLIC_KEY_AND_PASSWORD
# },
# identity_provider_type: "SERVICE_MANAGED", # accepts SERVICE_MANAGED, API_GATEWAY, AWS_DIRECTORY_SERVICE, AWS_LAMBDA
# logging_role: "Role",
# post_authentication_login_banner: "PostAuthenticationLoginBanner",
# pre_authentication_login_banner: "PreAuthenticationLoginBanner",
@@ -1301,13 +1304,13 @@
#
# @option params [Array<Types::WorkflowStep>] :on_exception_steps
# Specifies the steps (actions) to take if errors are encountered during
# execution of the workflow.
#
- # <note markdown="1"> For custom steps, the lambda function needs to send `FAILURE` to the
+ # <note markdown="1"> For custom steps, the Lambda function needs to send `FAILURE` to the
# call back API to kick off the exception steps. Additionally, if the
- # lambda does not send `SUCCESS` before it times out, the exception
+ # Lambda does not send `SUCCESS` before it times out, the exception
# steps are executed.
#
# </note>
#
# @option params [Array<Types::Tag>] :tags
@@ -1570,11 +1573,11 @@
def delete_connector(params = {}, options = {})
req = build_request(:delete_connector, params)
req.send_request(options)
end
- # Deletes the host key that's specified in the `HoskKeyId` parameter.
+ # Deletes the host key that's specified in the `HostKeyId` parameter.
#
# @option params [required, String] :server_id
# The identifier of the server that contains the host key that you are
# deleting.
#
@@ -1933,10 +1936,18 @@
end
# You can use `DescribeExecution` to check the details of the execution
# of the specified workflow.
#
+ # <note markdown="1"> This API call only returns details for in-progress workflows.
+ #
+ # 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.
+ #
+ # </note>
+ #
# @option params [required, String] :execution_id
# A unique identifier for the execution of a workflow.
#
# @option params [required, String] :workflow_id
# A unique identifier for the workflow.
@@ -2160,10 +2171,11 @@
# resp.server.host_key_fingerprint #=> String
# resp.server.identity_provider_details.url #=> String
# resp.server.identity_provider_details.invocation_role #=> String
# resp.server.identity_provider_details.directory_id #=> String
# resp.server.identity_provider_details.function #=> String
+ # resp.server.identity_provider_details.sftp_authentication_methods #=> String, one of "PASSWORD", "PUBLIC_KEY", "PUBLIC_KEY_OR_PASSWORD", "PUBLIC_KEY_AND_PASSWORD"
# resp.server.identity_provider_type #=> String, one of "SERVICE_MANAGED", "API_GATEWAY", "AWS_DIRECTORY_SERVICE", "AWS_LAMBDA"
# resp.server.logging_role #=> String
# resp.server.post_authentication_login_banner #=> String
# resp.server.pre_authentication_login_banner #=> String
# resp.server.protocols #=> Array
@@ -2468,13 +2480,13 @@
def import_host_key(params = {}, options = {})
req = build_request(:import_host_key, params)
req.send_request(options)
end
- # Adds a Secure Shell (SSH) public key to a user account identified by a
- # `UserName` value assigned to the specific file transfer
- # protocol-enabled server, identified by `ServerId`.
+ # 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`.
#
# @option params [required, String] :server_id
@@ -2484,11 +2496,12 @@
# The public key portion of an SSH key pair.
#
# Transfer Family accepts RSA, ECDSA, and ED25519 keys.
#
# @option params [required, String] :user_name
- # The name of the user account that is assigned to one or more servers.
+ # The name of the Transfer Family user that is assigned to one or more
+ # servers.
#
# @return [Types::ImportSshPublicKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ImportSshPublicKeyResponse#server_id #server_id} => String
# * {Types::ImportSshPublicKeyResponse#ssh_public_key_id #ssh_public_key_id} => String
@@ -2714,23 +2727,28 @@
def list_connectors(params = {}, options = {})
req = build_request(:list_connectors, params)
req.send_request(options)
end
- # Lists all executions for the specified workflow.
+ # Lists all in-progress executions for the specified workflow.
#
+ # <note markdown="1"> If the specified workflow ID cannot be found, `ListExecutions` returns
+ # a `ResourceNotFound` exception.
+ #
+ # </note>
+ #
# @option params [Integer] :max_results
# Specifies the maximum number of executions to return.
#
# @option params [String] :next_token
# `ListExecutions` returns the `NextToken` parameter in the output. You
# can then pass the `NextToken` parameter in a subsequent command to
# continue listing additional executions.
#
# This is useful for pagination, for instance. If you have 100
# executions for a workflow, you might only want to list first 10. If
- # so, call the API by specifying the `max-results`\:
+ # so, call the API by specifying the `max-results`:
#
# `aws transfer list-executions --max-results 10`
#
# This returns details for the first 10 executions, as well as the
# pointer (`NextToken`) to the eleventh execution. You can now call the
@@ -3084,11 +3102,12 @@
def list_users(params = {}, options = {})
req = build_request(:list_users, params)
req.send_request(options)
end
- # Lists all of your workflows.
+ # Lists all workflows associated with your Amazon Web Services account
+ # for your current region.
#
# @option params [Integer] :max_results
# Specifies the maximum number of workflows to return.
#
# @option params [String] :next_token
@@ -3279,12 +3298,12 @@
# An Amazon Resource Name (ARN) for a specific Amazon Web Services
# resource, such as a server, user, or role.
#
# @option params [required, Array<Types::Tag>] :tags
# Key-value pairs assigned to ARNs that you can use to group and search
- # for resources by type. You can attach this metadata to user accounts
- # for any purpose.
+ # for resources by type. You can attach this metadata to resources
+ # (servers, users, workflows, and so on) for any purpose.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
@@ -3316,15 +3335,21 @@
# successfully use the service.
#
# The `ServerId` and `UserName` parameters are required. The
# `ServerProtocol`, `SourceIp`, and `UserPassword` are all optional.
#
- # <note markdown="1"> You cannot use `TestIdentityProvider` if the `IdentityProviderType` of
- # your server is `SERVICE_MANAGED`.
+ # Note the following:
#
- # </note>
+ # * You cannot use `TestIdentityProvider` if the `IdentityProviderType`
+ # of your server is `SERVICE_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:
@@ -3336,12 +3361,16 @@
# * 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`
+ # 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)**.
+ #
# @option params [required, String] :server_id
# A system-assigned identifier for a specific server. That server's
# user authentication method is tested with a user name and password.
#
# @option params [String] :server_protocol
@@ -3353,18 +3382,20 @@
#
# * File Transfer Protocol Secure (FTPS)
#
# * File Transfer Protocol (FTP)
#
+ # * Applicability Statement 2 (AS2)
+ #
# @option params [String] :source_ip
- # The source IP address of the user account to be tested.
+ # The source IP address of the account to be tested.
#
# @option params [required, String] :user_name
- # The name of the user account to be tested.
+ # The name of the account to be tested.
#
# @option params [String] :user_password
- # The password of the user account to be tested.
+ # The password of the account to be tested.
#
# @return [Types::TestIdentityProviderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::TestIdentityProviderResponse#response #response} => String
# * {Types::TestIdentityProviderResponse#status_code #status_code} => Integer
@@ -4058,20 +4089,21 @@
# Specifies the name of the security policy that is attached to the
# server.
#
# @option params [required, String] :server_id
# A system-assigned unique identifier for a server instance that the
- # user account is assigned to.
+ # Transfer Family user is assigned to.
#
# @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 addition to a workflow to execute when a file is uploaded
# completely, `WorkflowDetails` 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.
+ # upload occurs when the server session disconnects while the file is
+ # still being uploaded.
#
# 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
@@ -4103,10 +4135,11 @@
# identity_provider_details: {
# url: "Url",
# invocation_role: "Role",
# directory_id: "DirectoryId",
# function: "Function",
+ # sftp_authentication_methods: "PASSWORD", # accepts PASSWORD, PUBLIC_KEY, PUBLIC_KEY_OR_PASSWORD, PUBLIC_KEY_AND_PASSWORD
# },
# logging_role: "NullableRole",
# post_authentication_login_banner: "PostAuthenticationLoginBanner",
# pre_authentication_login_banner: "PreAuthenticationLoginBanner",
# protocols: ["SFTP"], # accepts SFTP, FTP, FTPS, AS2
@@ -4232,12 +4265,12 @@
# file system. The IAM role should also contain a trust relationship
# that allows the server to access your resources when servicing your
# users' transfer requests.
#
# @option params [required, String] :server_id
- # A system-assigned unique identifier for a server instance that the
- # user account is assigned to.
+ # A system-assigned unique identifier for a Transfer Family server
+ # instance that the user is assigned to.
#
# @option params [required, String] :user_name
# A unique string that identifies a user and is associated with a server
# as specified by the `ServerId`. This user name must be a minimum of 3
# and a maximum of 100 characters long. The following are valid
@@ -4297,10 +4330,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-transfer'
- context[:gem_version] = '1.67.0'
+ context[:gem_version] = '1.68.0'
Seahorse::Client::Request.new(handlers, context)
end
# Polls an API operation until a resource enters a desired state.
#