lib/aws-sdk-transfer/client.rb in aws-sdk-transfer-1.12.0 vs lib/aws-sdk-transfer/client.rb in aws-sdk-transfer-1.13.0

- old
+ new

@@ -263,49 +263,51 @@ end # @!group API Operations # Instantiates an autoscaling virtual server based on Secure File - # Transfer Protocol (SFTP) in AWS. The call returns the `ServerId` - # property assigned by the service to the newly created server. - # Reference this `ServerId` property when you make updates to your - # server, or work with users. + # Transfer Protocol (SFTP) in AWS. When you make updates to your server + # or when you work with users, use the service-generated `ServerId` + # property that is assigned to the newly created server. # - # 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. + # configure for your SFTP server. This parameter is required when you + # specify a value for the `EndpointType` parameter. # # @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. + # The type of VPC endpoint that you want your SFTP server to 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 + # The RSA private key as generated by the `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.* + # Accidentally changing a server's host key can be disruptive. # + # For more information, see + # "https://docs.aws.amazon.com/transfer/latest/userguide/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. + # This parameter is required when the `IdentityProviderType` is set to + # `API_GATEWAY`. Accepts an array containing all of the information + # required to call a customer-supplied authentication API, including the + # API Gateway URL. This property is not required when the + # `IdentityProviderType` is set to `SERVICE_MANAGED`. # # @option params [String] :identity_provider_type - # The mode of authentication enabled for this service. The default value - # is `SERVICE_MANAGED`, which allows you to store and access SFTP user - # credentials within the service. An `IdentityProviderType` value of - # `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. + # Specifies the mode of authentication for the SFTP server. The default + # value is `SERVICE_MANAGED`, which allows you to store and access SFTP + # user credentials within the AWS Transfer for SFTP 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 # A value that allows the service to write your SFTP users' activity to # your Amazon CloudWatch logs for monitoring and auditing purposes. # @@ -349,32 +351,45 @@ def create_server(params = {}, options = {}) req = build_request(:create_server, params) req.send_request(options) end - # Adds a user and associate them with an existing Secure File Transfer - # Protocol (SFTP) server. Using parameters for `CreateUser`, you can - # specify the user name, set the home directory, store the user's - # public key, and assign the 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. + # Creates a user and associates them with an existing Secure File + # Transfer Protocol (SFTP) server. You can only create and associate + # users with SFTP servers that have the `IdentityProviderType` set to + # `SERVICE_MANAGED`. Using parameters for `CreateUser`, you can specify + # the user name, set the home directory, store the user's public key, + # and assign the 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. # - # The response returns the `UserName` and `ServerId` values of the new - # user for that server. - # # @option params [String] :home_directory # The landing directory (folder) for a user when they log in to the # server using their SFTP client. An example is `/home/username `. # # @option params [String] :policy # A scope-down policy for your user so you can use the same IAM role # across multiple users. This policy scopes down user access to portions - # of their Amazon S3 bucket. Variables you can use inside this policy - # include `$\{Transfer:UserName\}`, `$\{Transfer:HomeDirectory\}`, and - # `$\{Transfer:HomeBucket\}`. + # of their Amazon S3 bucket. Variables that you can use inside this + # policy include `$\{Transfer:UserName\}`, + # `$\{Transfer:HomeDirectory\}`, and `$\{Transfer:HomeBucket\}`. # + # <note markdown="1"> For scope-down policies, AWS Transfer for SFTP stores the policy as a + # JSON blob, instead of the Amazon Resource Name (ARN) of the policy. + # You save the policy as a JSON blob and pass it in the `Policy` + # argument. + # + # For an example of a scope-down policy, see + # "https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down"&gt;Creating + # a Scope-Down Policy. + # + # For more information, see + # "https://docs.aws.amazon.com/STS/latest/APIReference/API\_AssumeRole.html" + # in the *AWS Security Token Service API Reference*. + # + # </note> + # # @option params [required, String] :role # 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 @@ -384,11 +399,11 @@ # @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. # # @option params [String] :ssh_public_key_body - # The public portion of the Secure Shall (SSH) key used to authenticate + # The public portion of the Secure Shell (SSH) key used to authenticate # the user to the SFTP 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. @@ -435,15 +450,13 @@ req = build_request(:create_user, params) req.send_request(options) end # Deletes the Secure File Transfer Protocol (SFTP) server that you - # specify. If you used `SERVICE_MANAGED` as your `IdentityProviderType`, - # you need to delete all users associated with this server before - # deleting the server itself + # specify. # - # No response returns from this call. + # No response returns from this operation. # # @option params [required, String] :server_id # A unique system-assigned identifier for an SFTP server instance. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. @@ -463,11 +476,11 @@ req.send_request(options) end # Deletes a user's Secure Shell (SSH) public key. # - # No response is returned from this call. + # No response is returned from this operation. # # @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. # @@ -497,11 +510,11 @@ req.send_request(options) end # Deletes the user belonging to the server you specify. # - # No response returns from this call. + # No response returns from this operation. # # <note markdown="1"> When you delete a user from a server, the user's information is lost. # # </note> # @@ -585,12 +598,12 @@ # A system-assigned unique identifier for an SFTP server that has this # user assigned. # # @option params [required, String] :user_name # 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 service and - # perform file transfer tasks. + # part of the sign-in credentials to use the AWS Transfer for SFTP + # 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 @@ -678,11 +691,11 @@ # @option params [Integer] :max_results # 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 + # 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 servers. # # @return [Types::ListServersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -730,13 +743,13 @@ # Specifies the number of tags to return as a response to the # `ListTagsForResource` request. # # @option params [String] :next_token # When you request additional results from the `ListTagsForResource` - # call, a `NextToken` parameter is returned in the input. You can then - # pass in a subsequent command the `NextToken` parameter to continue - # listing additional tags. + # operation, a `NextToken` parameter is returned in the input. You can + # then pass in a subsequent command to the `NextToken` parameter to + # continue listing additional tags. # # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListTagsForResourceResponse#arn #arn} => String # * {Types::ListTagsForResourceResponse#next_token #next_token} => String @@ -775,16 +788,16 @@ # `ListUsers` request. # # @option params [String] :next_token # When you can get additional results from the `ListUsers` call, a # `NextToken` parameter is returned in the output. You can then pass in - # a subsequent command the `NextToken` parameter to continue listing + # 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 Secure File Transfer - # Protocol (SFTP) server that has users are assigned to it. + # Protocol (SFTP) 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 @@ -854,11 +867,11 @@ # Information tied to your server such as server and user properties are # not affected by stopping your server. Stopping a server will not # reduce or impact your Secure File Transfer Protocol (SFTP) endpoint # billing. # - # The states of `STOPPING` indicates that the server is in an + # 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. # @@ -921,29 +934,30 @@ req.send_request(options) end # If the `IdentityProviderType` of the server is `API_Gateway`, tests # whether your API Gateway is set up successfully. We highly recommend - # that you call this method to test 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 + # that you call this operation to test 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 server. That server's + # A system-assigned identifier for a specific server. That server's # user authentication method is tested with a user name and password. # # @option params [required, String] :user_name - # This request parameter is name of the user account to be tested. + # This request parameter is the name of the user account to be tested. # # @option params [String] :user_password # The password of the user account to be tested. # # @return [Types::TestIdentityProviderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::TestIdentityProviderResponse#message #message} => String + # * {Types::TestIdentityProviderResponse#response #response} => String # * {Types::TestIdentityProviderResponse#status_code #status_code} => Integer + # * {Types::TestIdentityProviderResponse#message #message} => String # * {Types::TestIdentityProviderResponse#url #url} => String # # @example Request syntax with placeholder values # # resp = client.test_identity_provider({ @@ -952,12 +966,13 @@ # user_password: "UserPassword", # }) # # @example Response structure # - # resp.message #=> String + # resp.response #=> String # resp.status_code #=> Integer + # resp.message #=> String # resp.url #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TestIdentityProvider AWS API Documentation # # @overload test_identity_provider(params = {}) @@ -1021,13 +1036,16 @@ # 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.* + # Accidentally changing a server's host key can be disruptive. # + # For more information, see + # "https://docs.aws.amazon.com/transfer/latest/userguide/configuring-servers.html#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 @@ -1078,22 +1096,37 @@ # # The response returns the `ServerId` and the `UserName` for the updated # user. # # @option params [String] :home_directory - # The HomeDirectory parameter specifies the landing directory (folder) - # for a user when they log in to the server using their client. An - # example would be: `/home/username `. + # A parameter that specifies the landing directory (folder) for a user + # when they log in to the server using their client. An example is + # `/home/username `. # # @option params [String] :policy # Allows you to supply a scope-down policy for your user so you can use # the same AWS Identity and Access Management (IAM) role across multiple - # users. The policy scopes down users access to portions of your Amazon + # users. The policy scopes down user access to portions of your Amazon # S3 bucket. Variables you can use inside this policy include # `$\{Transfer:UserName\}`, `$\{Transfer:HomeDirectory\}`, and # `$\{Transfer:HomeBucket\}`. # + # <note markdown="1"> For scope-down policies, AWS Transfer for SFTP stores the policy as a + # JSON blob, instead of the Amazon Resource Name (ARN) of the policy. + # You save the policy as a JSON blob and pass it in the `Policy` + # argument. + # + # For an example of a scope-down policy, see + # "https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down"&gt;Creating + # a Scope-Down Policy. + # + # For more information, see + # "https://docs.aws.amazon.com/STS/latest/APIReference/API\_AssumeRole.html" + # in the *AWS Security Token Service API Reference*. + # + # </note> + # # @option params [String] :role # 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 @@ -1105,12 +1138,12 @@ # A system-assigned unique identifier for an SFTP 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 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. This user name is a + # as specified by the `ServerId`. This is the string that will be used + # by 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: @@ -1153,10 +1186,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-transfer' - context[:gem_version] = '1.12.0' + context[:gem_version] = '1.13.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated