lib/aws-sdk-transfer/client.rb in aws-sdk-transfer-1.91.0 vs lib/aws-sdk-transfer/client.rb in aws-sdk-transfer-1.92.0
- old
+ new
@@ -20,10 +20,11 @@
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
require 'aws-sdk-core/plugins/response_paging.rb'
require 'aws-sdk-core/plugins/stub_responses.rb'
require 'aws-sdk-core/plugins/idempotency_token.rb'
+require 'aws-sdk-core/plugins/invocation_id.rb'
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
require 'aws-sdk-core/plugins/transfer_encoding.rb'
require 'aws-sdk-core/plugins/http_checksum.rb'
@@ -70,10 +71,11 @@
add_plugin(Aws::Plugins::EndpointDiscovery)
add_plugin(Aws::Plugins::EndpointPattern)
add_plugin(Aws::Plugins::ResponsePaging)
add_plugin(Aws::Plugins::StubResponses)
add_plugin(Aws::Plugins::IdempotencyToken)
+ add_plugin(Aws::Plugins::InvocationId)
add_plugin(Aws::Plugins::JsonvalueConverter)
add_plugin(Aws::Plugins::ClientMetricsPlugin)
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
add_plugin(Aws::Plugins::TransferEncoding)
add_plugin(Aws::Plugins::HttpChecksum)
@@ -194,15 +196,22 @@
#
# @option options [Boolean] :disable_request_compression (false)
# When set to 'true' the request body will not be compressed
# for supported operations.
#
- # @option options [String] :endpoint
- # The client endpoint is normally constructed from the `:region`
- # option. You should only configure an `:endpoint` when connecting
- # to test or custom endpoints. This should be a valid HTTP(S) URI.
+ # @option options [String, URI::HTTPS, URI::HTTP] :endpoint
+ # Normally you should not configure the `:endpoint` option
+ # directly. This is normally constructed from the `:region`
+ # option. Configuring `:endpoint` is normally reserved for
+ # connecting to test or custom endpoints. The endpoint should
+ # be a URI formatted like:
#
+ # 'http://example.com'
+ # 'https://example.com'
+ # 'http://example.com:123'
+ #
+ #
# @option options [Integer] :endpoint_cache_max_entries (1000)
# Used for the maximum size limit of the LRU cache storing endpoints data
# for endpoint discovery enabled operations. Defaults to 1000.
#
# @option options [Integer] :endpoint_cache_max_threads (10)
@@ -345,55 +354,70 @@
# sending the request.
#
# @option options [Aws::Transfer::EndpointProvider] :endpoint_provider
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::Transfer::EndpointParameters`
#
- # @option options [URI::HTTP,String] :http_proxy A proxy to send
- # requests through. Formatted like 'http://proxy.com:123'.
+ # @option options [Float] :http_continue_timeout (1)
+ # The number of seconds to wait for a 100-continue response before sending the
+ # request body. This option has no effect unless the request has "Expect"
+ # header set to "100-continue". Defaults to `nil` which disables this
+ # behaviour. This value can safely be set per request on the session.
#
- # @option options [Float] :http_open_timeout (15) The number of
- # seconds to wait when opening a HTTP session before raising a
- # `Timeout::Error`.
+ # @option options [Float] :http_idle_timeout (5)
+ # The number of seconds a connection is allowed to sit idle before it
+ # is considered stale. Stale connections are closed and removed from the
+ # pool before making a request.
#
- # @option options [Float] :http_read_timeout (60) The default
- # number of seconds to wait for response data. This value can
- # safely be set per-request on the session.
+ # @option options [Float] :http_open_timeout (15)
+ # The default number of seconds to wait for response data.
+ # This value can safely be set per-request on the session.
#
- # @option options [Float] :http_idle_timeout (5) The number of
- # seconds a connection is allowed to sit idle before it is
- # considered stale. Stale connections are closed and removed
- # from the pool before making a request.
+ # @option options [URI::HTTP,String] :http_proxy
+ # A proxy to send requests through. Formatted like 'http://proxy.com:123'.
#
- # @option options [Float] :http_continue_timeout (1) The number of
- # seconds to wait for a 100-continue response before sending the
- # request body. This option has no effect unless the request has
- # "Expect" header set to "100-continue". Defaults to `nil` which
- # disables this behaviour. This value can safely be set per
- # request on the session.
+ # @option options [Float] :http_read_timeout (60)
+ # The default number of seconds to wait for response data.
+ # This value can safely be set per-request on the session.
#
- # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
- # in seconds.
+ # @option options [Boolean] :http_wire_trace (false)
+ # When `true`, HTTP debug output will be sent to the `:logger`.
#
- # @option options [Boolean] :http_wire_trace (false) When `true`,
- # HTTP debug output will be sent to the `:logger`.
+ # @option options [Proc] :on_chunk_received
+ # When a Proc object is provided, it will be used as callback when each chunk
+ # of the response body is received. It provides three arguments: the chunk,
+ # the number of bytes received, and the total number of
+ # bytes in the response (or nil if the server did not send a `content-length`).
#
- # @option options [Boolean] :ssl_verify_peer (true) When `true`,
- # SSL peer certificates are verified when establishing a
- # connection.
+ # @option options [Proc] :on_chunk_sent
+ # When a Proc object is provided, it will be used as callback when each chunk
+ # of the request body is sent. It provides three arguments: the chunk,
+ # the number of bytes read from the body, and the total number of
+ # bytes in the body.
#
- # @option options [String] :ssl_ca_bundle Full path to the SSL
- # certificate authority bundle file that should be used when
- # verifying peer certificates. If you do not pass
- # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
- # will be used if available.
+ # @option options [Boolean] :raise_response_errors (true)
+ # When `true`, response errors are raised.
#
- # @option options [String] :ssl_ca_directory Full path of the
- # directory that contains the unbundled SSL certificate
+ # @option options [String] :ssl_ca_bundle
+ # Full path to the SSL certificate authority bundle file that should be used when
+ # verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
+ # `:ssl_ca_directory` the the system default will be used if available.
+ #
+ # @option options [String] :ssl_ca_directory
+ # Full path of the directory that contains the unbundled SSL certificate
# authority files for verifying peer certificates. If you do
- # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
- # system default will be used if available.
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
+ # default will be used if available.
#
+ # @option options [String] :ssl_ca_store
+ # Sets the X509::Store to verify peer certificate.
+ #
+ # @option options [Float] :ssl_timeout
+ # Sets the SSL timeout in seconds
+ #
+ # @option options [Boolean] :ssl_verify_peer (true)
+ # When `true`, SSL peer certificates are verified when establishing a connection.
+ #
def initialize(*args)
super
end
# @!group API Operations
@@ -2521,19 +2545,12 @@
# Imports the signing and encryption certificates that you need to
# create local (AS2) profiles and partner profiles.
#
# @option params [required, String] :usage
- # Specifies how this certificate is used. It can be used in the
- # following ways:
+ # Specifies whether this certificate is used for signing or encryption.
#
- # * `SIGNING`: For signing AS2 messages
- #
- # * `ENCRYPTION`: For encrypting AS2 messages
- #
- # * `TLS`: For securing AS2 communications sent over HTTPS
- #
# @option params [required, String] :certificate
# * For the CLI, provide a file path for a certificate in URI format.
# For example, `--certificate file://encryption-cert.pem`.
# Alternatively, you can provide the raw content.
#
@@ -3358,10 +3375,93 @@
def send_workflow_step_state(params = {}, options = {})
req = build_request(:send_workflow_step_state, params)
req.send_request(options)
end
+ # 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 your
+ # `Truncated` output value is true, you can increase the value
+ # provided in the optional `max-items` input attribute to be able to
+ # list more items (up to the maximum allowed list size of 10,000
+ # items).
+ #
+ # @option params [required, String] :connector_id
+ # The unique identifier for the connector.
+ #
+ # @option params [required, String] :remote_directory_path
+ # Specifies the directory on the remote SFTP server for which you want
+ # to list its contents.
+ #
+ # @option params [Integer] :max_items
+ # An optional parameter where you can specify the maximum number of
+ # file/directory names to retrieve. The default value is 1,000.
+ #
+ # @option params [required, String] :output_directory_path
+ # Specifies the path (bucket and prefix) in Amazon S3 storage to store
+ # the results of the directory listing.
+ #
+ # @return [Types::StartDirectoryListingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::StartDirectoryListingResponse#listing_id #listing_id} => String
+ # * {Types::StartDirectoryListingResponse#output_file_name #output_file_name} => String
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.start_directory_listing({
+ # connector_id: "ConnectorId", # required
+ # remote_directory_path: "FilePath", # required
+ # max_items: 1,
+ # output_directory_path: "FilePath", # required
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.listing_id #=> String
+ # resp.output_file_name #=> String
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StartDirectoryListing AWS API Documentation
+ #
+ # @overload start_directory_listing(params = {})
+ # @param [Hash] params ({})
+ def start_directory_listing(params = {}, options = {})
+ req = build_request(:start_directory_listing, params)
+ req.send_request(options)
+ end
+
# 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 more
# `SendFilePaths` to identify the files you want to transfer.
@@ -3370,11 +3470,11 @@
# 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
- # `RetreiveFilePaths` to identify the files you want to transfer,
+ # `RetrieveFilePaths` to identify the files you want to transfer,
# and a `LocalDirectoryPath` 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 a
@@ -4706,10 +4806,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-transfer'
- context[:gem_version] = '1.91.0'
+ context[:gem_version] = '1.92.0'
Seahorse::Client::Request.new(handlers, context)
end
# Polls an API operation until a resource enters a desired state.
#