lib/aws-sdk-transfer/client.rb in aws-sdk-transfer-1.27.0 vs lib/aws-sdk-transfer/client.rb in aws-sdk-transfer-1.28.0

- old
+ new

@@ -382,21 +382,21 @@ # [2]: https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html # [3]: https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html # # @option params [Types::EndpointDetails] :endpoint_details # The virtual private cloud (VPC) endpoint settings that are configured - # for your file transfer protocol-enabled server. When you host your - # endpoint within your VPC, you can make it accessible only to resources - # within your VPC, or you can attach Elastic IPs and make it accessible - # to clients over the internet. Your VPC's default security groups are - # automatically assigned to your endpoint. + # for your server. When you host your endpoint within your VPC, you can + # make it accessible only to resources within your VPC, or you can + # attach Elastic IPs and make it accessible to clients over the + # internet. Your VPC's default security groups are automatically + # assigned to your endpoint. # # @option params [String] :endpoint_type - # The type of VPC endpoint that you want your file transfer - # protocol-enabled server to connect to. You can choose to connect to - # the public internet or a VPC endpoint. With a VPC endpoint, you can - # restrict access to your server and resources only within your VPC. + # The type of VPC endpoint that you want your server to connect to. You + # can choose to connect to the public internet or a VPC endpoint. With a + # VPC endpoint, you can restrict access to your server and resources + # only within your VPC. # # <note markdown="1"> It is recommended that you use `VPC` as the `EndpointType`. With this # endpoint type, you have the option to directly associate up to three # Elastic IPv4 addresses (BYO IP included) with your server's endpoint # and use VPC security groups to restrict traffic by the client's @@ -425,17 +425,17 @@ # an array containing all of the information required to call 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 - # Specifies the mode of authentication for a file transfer - # protocol-enabled server. The default value is `SERVICE_MANAGED`, which - # allows you to store and access user credentials within the AWS - # Transfer Family service. Use the `API_GATEWAY` value to integrate with - # an identity provider of your choosing. The `API_GATEWAY` setting - # requires you to provide an API Gateway endpoint URL to call for - # authentication using the `IdentityProviderDetails` parameter. + # Specifies the mode of authentication for a server. The default value + # is `SERVICE_MANAGED`, which allows you to store and access user + # credentials within the AWS Transfer Family service. Use the + # `API_GATEWAY` value to integrate with an identity provider of your + # choosing. The `API_GATEWAY` setting requires you to provide an API + # Gateway endpoint URL to call for authentication using the + # `IdentityProviderDetails` parameter. # # @option params [String] :logging_role # Allows the service to write your users' activity to your Amazon # CloudWatch logs for monitoring and auditing purposes. # @@ -451,12 +451,12 @@ # encryption # # * `FTP` (File Transfer Protocol): Unencrypted file transfer # # <note markdown="1"> If you select `FTPS`, you must choose a certificate stored in AWS - # Certificate Manager (ACM) which will be used to identify your file - # transfer protocol-enabled server when clients connect to it over FTPS. + # Certificate Manager (ACM) which will be used to identify your server + # when clients connect to it over FTPS. # # If `Protocol` includes either `FTP` or `FTPS`, then the `EndpointType` # must be `VPC` and the `IdentityProviderType` must be `API_GATEWAY`. # # If `Protocol` includes `FTP`, then `AddressAllocationIds` cannot be @@ -471,12 +471,11 @@ # @option params [String] :security_policy_name # Specifies the name of the security policy that is attached to the # server. # # @option params [Array<Types::Tag>] :tags - # Key-value pairs that can be used to group and search for file transfer - # protocol-enabled servers. + # Key-value pairs that can be used to group and search for servers. # # @return [Types::CreateServerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateServerResponse#server_id #server_id} => String # @@ -487,10 +486,11 @@ # endpoint_details: { # address_allocation_ids: ["AddressAllocationId"], # subnet_ids: ["SubnetId"], # vpc_endpoint_id: "VpcEndpointId", # vpc_id: "VpcId", + # security_group_ids: ["SecurityGroupId"], # }, # endpoint_type: "PUBLIC", # accepts PUBLIC, VPC, VPC_ENDPOINT # host_key: "HostKey", # identity_provider_details: { # url: "Url", @@ -529,24 +529,23 @@ # user's AWS Identity and Access Management (IAM) role. You can also # optionally add a scope-down policy, and assign metadata with tags that # can be used to group and search for users. # # @option params [String] :home_directory - # The landing directory (folder) for a user when they log in to the file - # transfer protocol-enabled server using the client. + # The landing directory (folder) for a user when they log in to the + # server using the client. # # An example is <i> # <code>your-Amazon-S3-bucket-name&gt;/home/username</code> </i>. # # @option params [String] :home_directory_type # The type of landing directory (folder) you want your users' home - # directory to be when they log into the file transfer protocol-enabled - # server. If you set it to `PATH`, the user will see the absolute Amazon - # S3 bucket paths as is in their file transfer protocol clients. If you - # set it `LOGICAL`, you will need to provide mappings in the - # `HomeDirectoryMappings` for how you want to make Amazon S3 paths - # visible to your users. + # directory to be when they log into the server. If you set it to + # `PATH`, the user will see the absolute Amazon S3 bucket paths as is in + # their file transfer protocol clients. If you set it `LOGICAL`, you + # will need to provide mappings in the `HomeDirectoryMappings` for how + # you want to make Amazon S3 paths visible to your users. # # @option params [Array<Types::HomeDirectoryMapEntry>] :home_directory_mappings # Logical directory mappings that specify what Amazon S3 paths and keys # should be visible to your user and how you want to make them visible. # You will need to specify the "`Entry`" and "`Target`" pair, where @@ -603,34 +602,32 @@ # @option params [required, String] :role # The IAM role that controls your users' 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 file transfer - # protocol-enabled server to access your resources when servicing your - # users' transfer requests. + # 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 file transfer - # protocol-enabled server instance. This is the specific server that you - # added your user to. + # A system-assigned unique identifier for a server instance. This is the + # specific server that you added your user to. # # @option params [String] :ssh_public_key_body # The public portion of the Secure Shell (SSH) key used to authenticate - # the user to the file transfer protocol-enabled server. + # the user to the server. # # @option params [Array<Types::Tag>] :tags # 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 file - # transfer protocol-enabled 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 characters: a-z, A-Z, 0-9, underscore '\_', - # hyphen '-', period '.', and at sign '@'. The user name can't - # start with a hyphen, period, and at sign. + # A unique string that identifies a user and is associated with a 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 characters: + # a-z, A-Z, 0-9, underscore '\_', hyphen '-', period '.', and at + # sign '@'. The user name can't start with a hyphen, period, or at + # sign. # # @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 @@ -676,12 +673,11 @@ # Deletes the file transfer protocol-enabled server that you specify. # # No response returns from this operation. # # @option params [required, String] :server_id - # A unique system-assigned identifier for a file transfer - # protocol-enabled server instance. + # A unique system-assigned identifier for a server instance. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # @@ -740,16 +736,16 @@ # <note markdown="1"> When you delete a user from a server, the user's information is lost. # # </note> # # @option params [required, String] :server_id - # A system-assigned unique identifier for a file transfer - # protocol-enabled server instance that has the user assigned to it. + # A system-assigned unique identifier for a server instance that has the + # user assigned to it. # # @option params [required, String] :user_name # A unique string that identifies a user that is being deleted from a - # file transfer protocol-enabled server. + # server. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # @@ -818,12 +814,11 @@ # The response contains a description of a server's properties. When # you set `EndpointType` to VPC, the response will contain the # `EndpointDetails`. # # @option params [required, String] :server_id - # A system-assigned unique identifier for a file transfer - # protocol-enabled server. + # A system-assigned unique identifier for a server. # # @return [Types::DescribeServerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeServerResponse#server #server} => Types::DescribedServer # @@ -841,10 +836,12 @@ # resp.server.endpoint_details.address_allocation_ids[0] #=> String # resp.server.endpoint_details.subnet_ids #=> Array # resp.server.endpoint_details.subnet_ids[0] #=> String # resp.server.endpoint_details.vpc_endpoint_id #=> String # resp.server.endpoint_details.vpc_id #=> String + # resp.server.endpoint_details.security_group_ids #=> Array + # resp.server.endpoint_details.security_group_ids[0] #=> String # resp.server.endpoint_type #=> String, one of "PUBLIC", "VPC", "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" @@ -873,18 +870,17 @@ # # The response from this call returns the properties of the user # associated with the `ServerId` value that was specified. # # @option params [required, String] :server_id - # A system-assigned unique identifier for a file transfer - # protocol-enabled server that has this user assigned. + # A system-assigned unique identifier for a server that has this user + # assigned. # # @option params [required, String] :user_name - # The name of the user assigned to one or more file transfer - # protocol-enabled servers. User names are part of the sign-in - # credentials to use the AWS Transfer Family service and perform file - # transfer tasks. + # The name of the user assigned to one or more servers. User names are + # part of the sign-in credentials to use the AWS Transfer Family service + # and perform file transfer tasks. # # @return [Types::DescribeUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeUserResponse#server_id #server_id} => String # * {Types::DescribeUserResponse#user #user} => Types::DescribedUser @@ -931,19 +927,17 @@ # # The response returns the `UserName` value, the `ServerId` value, and # the name of the `SshPublicKeyId`. # # @option params [required, String] :server_id - # A system-assigned unique identifier for a file transfer - # protocol-enabled server. + # A system-assigned unique identifier for a server. # # @option params [required, String] :ssh_public_key_body # The public key portion of an SSH key pair. # # @option params [required, String] :user_name - # The name of the user account that is assigned to one or more file - # transfer protocol-enabled servers. + # The name of the user account 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 @@ -1016,18 +1010,18 @@ # Lists the file transfer protocol-enabled servers that are associated # with your AWS account. # # @option params [Integer] :max_results - # Specifies the number of file transfer protocol-enabled servers to - # return as a response to the `ListServers` query. + # Specifies the number of servers to return as a response to the + # `ListServers` query. # # @option params [String] :next_token # When additional results are obtained from the `ListServers` command, a # `NextToken` parameter is returned in the output. You can then pass the # `NextToken` parameter in a subsequent command to continue listing - # additional file transfer protocol-enabled servers. + # additional servers. # # @return [Types::ListServersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListServersResponse#next_token #next_token} => String # * {Types::ListServersResponse#servers #servers} => Array&lt;Types::ListedServer&gt; @@ -1125,12 +1119,12 @@ # `NextToken` parameter is returned in the output. You can then pass in # a subsequent command to the `NextToken` parameter to continue listing # additional users. # # @option params [required, String] :server_id - # A system-assigned unique identifier for a file transfer - # protocol-enabled server that has users assigned to it. + # A system-assigned unique identifier for a server that has users + # assigned to it. # # @return [Types::ListUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListUsersResponse#next_token #next_token} => String # * {Types::ListUsersResponse#server_id #server_id} => String @@ -1177,12 +1171,11 @@ # online. The values of `START_FAILED` can indicate an error condition. # # No response is returned from this call. # # @option params [required, String] :server_id - # A system-assigned unique identifier for a file transfer - # protocol-enabled server that you start. + # A system-assigned unique identifier for a server that you start. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # @@ -1201,22 +1194,25 @@ # Changes the state of a file transfer protocol-enabled server from # `ONLINE` to `OFFLINE`. An `OFFLINE` server cannot accept and process # file transfer jobs. Information tied to your server, such as server # and user properties, are not affected by stopping your server. - # Stopping the server will not reduce or impact your file transfer - # protocol endpoint billing. # + # <note markdown="1"> Stopping the server will not reduce or impact your file transfer + # protocol endpoint billing; you must delete the server to stop being + # billed. + # + # </note> + # # The state of `STOPPING` indicates that the server is in an # intermediate state, either not fully able to respond, or not fully # offline. The values of `STOP_FAILED` can indicate an error condition. # # No response is returned from this call. # # @option params [required, String] :server_id - # A system-assigned unique identifier for a file transfer - # protocol-enabled server that you stopped. + # A system-assigned unique identifier for a server that you stopped. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # @@ -1277,13 +1273,12 @@ # your authentication method as soon as you create your server. By doing # so, you can troubleshoot issues with the API Gateway integration to # ensure that your users can successfully use the service. # # @option params [required, String] :server_id - # A system-assigned identifier for a specific file transfer - # protocol-enabled server. That server's user authentication method is - # tested with a user name and password. + # 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 # The type of file transfer protocol to be tested. # # The available protocols are: @@ -1415,20 +1410,20 @@ # [2]: https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html # [3]: https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html # # @option params [Types::EndpointDetails] :endpoint_details # The virtual private cloud (VPC) endpoint settings that are configured - # for your file transfer protocol-enabled server. With a VPC endpoint, - # you can restrict access to your server to resources only within your - # VPC. To control incoming internet traffic, you will need to associate - # one or more Elastic IP addresses with your server's endpoint. + # for your server. With a VPC endpoint, you can restrict access to your + # server to resources only within your VPC. To control incoming internet + # traffic, you will need to associate one or more Elastic IP addresses + # with your server's endpoint. # # @option params [String] :endpoint_type - # The type of endpoint that you want your file transfer protocol-enabled - # server to connect to. You can choose to connect to the public internet - # or a VPC endpoint. With a VPC endpoint, you can restrict access to - # your server and resources only within your VPC. + # The type of endpoint that you want your server to connect to. You can + # choose to connect to the public internet or a VPC endpoint. With a VPC + # endpoint, you can restrict access to your server and resources only + # within your VPC. # # <note markdown="1"> It is recommended that you use `VPC` as the `EndpointType`. With this # endpoint type, you have the option to directly associate up to three # Elastic IPv4 addresses (BYO IP included) with your server's endpoint # and use VPC security groups to restrict traffic by the client's @@ -1440,13 +1435,12 @@ # @option params [String] :host_key # The RSA private key as generated by `ssh-keygen -N "" -m PEM -f # my-new-server-key`. # # If you aren't planning to migrate existing users from an existing - # file transfer protocol-enabled server to a new server, don't update - # the host key. Accidentally changing a server's host key can be - # disruptive. + # 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 # server][1] in the *AWS Transfer Family User Guide*. # # @@ -1494,12 +1488,12 @@ # @option params [String] :security_policy_name # 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 file transfer - # protocol-enabled server instance that the user account is assigned to. + # A system-assigned unique identifier for a server instance that the + # user account is assigned to. # # @return [Types::UpdateServerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateServerResponse#server_id #server_id} => String # @@ -1510,10 +1504,11 @@ # endpoint_details: { # address_allocation_ids: ["AddressAllocationId"], # subnet_ids: ["SubnetId"], # vpc_endpoint_id: "VpcEndpointId", # vpc_id: "VpcId", + # security_group_ids: ["SecurityGroupId"], # }, # endpoint_type: "PUBLIC", # accepts PUBLIC, VPC, VPC_ENDPOINT # host_key: "HostKey", # identity_provider_details: { # url: "Url", @@ -1545,23 +1540,21 @@ # The response returns the `ServerId` and the `UserName` for the updated # user. # # @option params [String] :home_directory # Specifies the landing directory (folder) for a user when they log in - # to the file transfer protocol-enabled server using their file transfer - # protocol client. + # to the server using their file transfer protocol client. # # An example is `your-Amazon-S3-bucket-name>/home/username`. # # @option params [String] :home_directory_type # The type of landing directory (folder) you want your users' home - # directory to be when they log into the file transfer protocol-enabled - # server. If you set it to `PATH`, the user will see the absolute Amazon - # S3 bucket paths as is in their file transfer protocol clients. If you - # set it `LOGICAL`, you will need to provide mappings in the - # `HomeDirectoryMappings` for how you want to make Amazon S3 paths - # visible to your users. + # directory to be when they log into the server. If you set it to + # `PATH`, the user will see the absolute Amazon S3 bucket paths as is in + # their file transfer protocol clients. If you set it `LOGICAL`, you + # will need to provide mappings in the `HomeDirectoryMappings` for how + # you want to make Amazon S3 paths visible to your users. # # @option params [Array<Types::HomeDirectoryMapEntry>] :home_directory_mappings # Logical directory mappings that specify what Amazon S3 paths and keys # should be visible to your user and how you want to make them visible. # You will need to specify the "`Entry`" and "`Target`" pair, where @@ -1618,25 +1611,24 @@ # @option params [String] :role # The IAM role that controls your users' 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 file transfer - # protocol-enabled server to access your resources when servicing your - # users' transfer requests. + # 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 file transfer - # protocol-enabled server instance that the user account is assigned to. + # A system-assigned unique identifier for a server instance that the + # user account is assigned to. # # @option params [required, String] :user_name - # A unique string that identifies a user and is associated with a file - # transfer protocol-enabled 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 characters: a-z, A-Z, 0-9, underscore '\_', - # hyphen '-', period '.', and at sign '@'. The user name can't - # start with a hyphen, period, and at sign. + # 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 + # characters: a-z, A-Z, 0-9, underscore '\_', hyphen '-', period + # '.', and at sign '@'. The user name can't start with a hyphen, + # period, or at sign. # # @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 @@ -1683,10 +1675,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-transfer' - context[:gem_version] = '1.27.0' + context[:gem_version] = '1.28.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated