lib/aws-sdk-transfer/client.rb in aws-sdk-transfer-1.4.0 vs lib/aws-sdk-transfer/client.rb in aws-sdk-transfer-1.5.0
- old
+ new
@@ -207,10 +207,53 @@
#
# @option options [Boolean] :validate_params (true)
# When `true`, request parameters are validated before
# sending the request.
#
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
+ # requests through. Formatted like 'http://proxy.com:123'.
+ #
+ # @option options [Float] :http_open_timeout (15) The number of
+ # seconds to wait when opening a HTTP session before rasing a
+ # `Timeout::Error`.
+ #
+ # @option options [Integer] :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 yeidled by {#session_for}.
+ #
+ # @option options [Float] :http_idle_timeout (5) The number of
+ # seconds a connection is allowed to sit idble before it is
+ # considered stale. Stale connections are closed and removed
+ # from the pool before making a request.
+ #
+ # @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 yeidled by {#session_for}.
+ #
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
+ # HTTP debug output will be sent to the `:logger`.
+ #
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
+ # SSL peer certificates are verified when establishing a
+ # connection.
+ #
+ # @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.
+ #
def initialize(*args)
super
end
# @!group API Operations
@@ -222,10 +265,14 @@
# server, or work with users.
#
# The response returns the `ServerId` value for the newly created
# server.
#
+ # @option params [Types::EndpointDetails] :endpoint_details
+ #
+ # @option params [String] :endpoint_type
+ #
# @option params [Types::IdentityProviderDetails] :identity_provider_details
# An array containing all of the information required to call a
# customer-supplied authentication API. This parameter is not required
# when the `IdentityProviderType` value of server that is created uses
# the `SERVICE_MANAGED` authentication method.
@@ -237,11 +284,11 @@
# `API_GATEWAY` indicates that user authentication requires a call to an
# API Gateway endpoint URL provided by you to integrate an identity
# provider of your choice.
#
# @option params [String] :logging_role
- # A value that allows the service to write your SFTP users’ activity to
+ # A value that allows the service to write your SFTP users' activity to
# your Amazon CloudWatch logs for monitoring and auditing purposes.
#
# @option params [Array<Types::Tag>] :tags
# Key-value pairs that can be used to group and search for servers.
#
@@ -250,10 +297,14 @@
# * {Types::CreateServerResponse#server_id #server_id} => String
#
# @example Request syntax with placeholder values
#
# resp = client.create_server({
+ # endpoint_details: {
+ # vpc_endpoint_id: "VpcEndpointId",
+ # },
+ # endpoint_type: "PUBLIC", # accepts PUBLIC, VPC_ENDPOINT
# identity_provider_details: {
# url: "Url",
# invocation_role: "Role",
# },
# identity_provider_type: "SERVICE_MANAGED", # accepts SERVICE_MANAGED, API_GATEWAY
@@ -300,16 +351,16 @@
# of their Amazon S3 bucket. Variables you can use inside this policy
# include `$\{Transfer:UserName\}`, `$\{Transfer:HomeDirectory\}`, and
# `$\{Transfer:HomeBucket\}`.
#
# @option params [required, String] :role
- # The IAM role that controls your user’s access to your Amazon S3
+ # The IAM role that controls your user's access to your Amazon S3
# bucket. The policies attached to this role will determine the level of
# access you want to provide your users when transferring files into and
# out of your Amazon S3 bucket or buckets. The IAM role should also
# contain a trust relationship that allows the SFTP server to access
- # your resources when servicing your SFTP user’s transfer requests.
+ # your resources when servicing your SFTP user's transfer requests.
#
# @option params [required, String] :server_id
# A system-assigned unique identifier for an SFTP server instance. This
# is the specific SFTP server that you added your user to.
#
@@ -395,11 +446,11 @@
# @option params [required, String] :server_id
# A system-assigned unique identifier for a Secure File Transfer
# Protocol (SFTP) server instance that has the user assigned to it.
#
# @option params [required, String] :ssh_public_key_id
- # A unique identifier used to reference your user’s specific SSH key.
+ # A unique identifier used to reference your user's specific SSH key.
#
# @option params [required, String] :user_name
# A unique string that identifies a user whose public key is being
# deleted.
#
@@ -475,10 +526,12 @@
# })
#
# @example Response structure
#
# resp.server.arn #=> String
+ # resp.server.endpoint_details.vpc_endpoint_id #=> String
+ # resp.server.endpoint_type #=> String, one of "PUBLIC", "VPC_ENDPOINT"
# resp.server.identity_provider_details.url #=> String
# resp.server.identity_provider_details.invocation_role #=> String
# resp.server.identity_provider_type #=> String, one of "SERVICE_MANAGED", "API_GATEWAY"
# resp.server.logging_role #=> String
# resp.server.server_id #=> String
@@ -623,10 +676,11 @@
#
# resp.next_token #=> String
# resp.servers #=> Array
# resp.servers[0].arn #=> String
# resp.servers[0].identity_provider_type #=> String, one of "SERVICE_MANAGED", "API_GATEWAY"
+ # resp.servers[0].endpoint_type #=> String, one of "PUBLIC", "VPC_ENDPOINT"
# resp.servers[0].logging_role #=> String
# resp.servers[0].server_id #=> String
# resp.servers[0].state #=> String, one of "OFFLINE", "ONLINE", "STARTING", "STOPPING", "START_FAILED", "STOP_FAILED"
# resp.servers[0].user_count #=> Integer
#
@@ -925,10 +979,14 @@
# Updates the server properties after that server has been created.
#
# The `UpdateServer` call returns the `ServerId` of the Secure File
# Transfer Protocol (SFTP) server you updated.
#
+ # @option params [Types::EndpointDetails] :endpoint_details
+ #
+ # @option params [String] :endpoint_type
+ #
# @option params [Types::IdentityProviderDetails] :identity_provider_details
# This response parameter is an array containing all of the information
# required to call a customer's authentication API method.
#
# @option params [String] :logging_role
@@ -945,10 +1003,14 @@
# * {Types::UpdateServerResponse#server_id #server_id} => String
#
# @example Request syntax with placeholder values
#
# resp = client.update_server({
+ # endpoint_details: {
+ # vpc_endpoint_id: "VpcEndpointId",
+ # },
+ # endpoint_type: "PUBLIC", # accepts PUBLIC, VPC_ENDPOINT
# identity_provider_details: {
# url: "Url",
# invocation_role: "Role",
# },
# logging_role: "NullableRole",
@@ -987,17 +1049,17 @@
# S3 bucket. Variables you can use inside this policy include
# `$\{Transfer:UserName\}`, `$\{Transfer:HomeDirectory\}`, and
# `$\{Transfer:HomeBucket\}`.
#
# @option params [String] :role
- # The IAM role that controls your user’s access to your Amazon S3
+ # The IAM role that controls your user's access to your Amazon S3
# bucket. The policies attached to this role will determine the level of
# access you want to provide your users when transferring files into and
# out of your Amazon S3 bucket or buckets. The IAM role should also
# contain a trust relationship that allows the Secure File Transfer
# Protocol (SFTP) server to access your resources when servicing your
- # SFTP user’s transfer requests.
+ # SFTP user's transfer requests.
#
# @option params [required, String] :server_id
# A system-assigned unique identifier for an SFTP server instance that
# the user account is assigned to.
#
@@ -1046,10 +1108,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-transfer'
- context[:gem_version] = '1.4.0'
+ context[:gem_version] = '1.5.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated