lib/aws-sdk-transfer/client.rb in aws-sdk-transfer-1.5.0 vs lib/aws-sdk-transfer/client.rb in aws-sdk-transfer-1.6.0

- old
+ new

@@ -266,13 +266,27 @@ # # The response returns the `ServerId` value for the newly created # server. # # @option params [Types::EndpointDetails] :endpoint_details + # The virtual private cloud (VPC) endpoint settings that you want to + # configure for your SFTP server. # # @option params [String] :endpoint_type + # The type of VPC endpoint that you want your SFTP server connect to. If + # you connect to a VPC endpoint, your SFTP server isn't accessible over + # the public internet. # + # @option params [String] :host_key + # The RSA private key as generated by `ssh-keygen -N "" -f + # my-new-server-key` command. + # + # If you aren't planning to migrate existing users from an existing + # SFTP server to a new AWS SFTP server, don't update the host key. + # Accidentally changing a server's host key can be disruptive. For more + # information, see change-host-key in the *AWS SFTP User Guide.* + # # @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. @@ -301,10 +315,11 @@ # resp = client.create_server({ # endpoint_details: { # vpc_endpoint_id: "VpcEndpointId", # }, # endpoint_type: "PUBLIC", # accepts PUBLIC, VPC_ENDPOINT + # host_key: "HostKey", # identity_provider_details: { # url: "Url", # invocation_role: "Role", # }, # identity_provider_type: "SERVICE_MANAGED", # accepts SERVICE_MANAGED, API_GATEWAY @@ -372,11 +387,14 @@ # Key-value pairs that can be used to group and search for users. Tags # are metadata attached to users for any purpose. # # @option params [required, String] :user_name # A unique string that identifies a user and is associated with a server - # as specified by the `ServerId`. + # as specified by the `ServerId`. This user name must be a minimum of 3 + # and a maximum of 32 characters long. The following are valid + # characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name + # can't start with a hyphen. # # @return [Types::CreateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateUserResponse#server_id #server_id} => String # * {Types::CreateUserResponse#user_name #user_name} => String @@ -528,10 +546,11 @@ # @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.host_key_fingerprint #=> String # 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 @@ -980,21 +999,37 @@ # # The `UpdateServer` call returns the `ServerId` of the Secure File # Transfer Protocol (SFTP) server you updated. # # @option params [Types::EndpointDetails] :endpoint_details + # The virtual private cloud (VPC) endpoint settings that are configured + # for your SFTP server. With a VPC endpoint, your SFTP server isn't + # accessible over the public internet. # # @option params [String] :endpoint_type + # The type of endpoint that you want your SFTP server to connect to. You + # can choose to connect to the public internet or a virtual private + # cloud (VPC) endpoint. With a VPC endpoint, your SFTP server isn't + # accessible over the public internet. # + # @option params [String] :host_key + # The RSA private key as generated by `ssh-keygen -N "" -f + # my-new-server-key`. + # + # If you aren't planning to migrate existing users from an existing + # SFTP server to a new AWS SFTP server, don't update the host key. + # Accidentally changing a server's host key can be disruptive. For more + # information, see change-host-key in the *AWS SFTP User Guide.* + # # @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 - # Changes the AWS Identity and Access Management (IAM) role that allows - # Amazon S3 events to be logged in Amazon CloudWatch, turning logging on - # or off. + # A value that changes the AWS Identity and Access Management (IAM) role + # that allows Amazon S3 events to be logged in Amazon CloudWatch, + # turning logging on or off. # # @option params [required, String] :server_id # A system-assigned unique identifier for an SFTP server instance that # the user account is assigned to. # @@ -1007,10 +1042,11 @@ # resp = client.update_server({ # endpoint_details: { # vpc_endpoint_id: "VpcEndpointId", # }, # endpoint_type: "PUBLIC", # accepts PUBLIC, VPC_ENDPOINT + # host_key: "HostKey", # identity_provider_details: { # url: "Url", # invocation_role: "Role", # }, # logging_role: "NullableRole", @@ -1064,11 +1100,14 @@ # the user account 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 is the string that will be used by - # your user when they log in to your SFTP server. + # your user when they log in to your SFTP server. This user name is a + # minimum of 3 and a maximum of 32 characters long. The following are + # valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name + # can't start with a hyphen. # # @return [Types::UpdateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateUserResponse#server_id #server_id} => String # * {Types::UpdateUserResponse#user_name #user_name} => String @@ -1108,10 +1147,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-transfer' - context[:gem_version] = '1.5.0' + context[:gem_version] = '1.6.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated