aws-sdk-transfer 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 577b6c986a605a38fe7fffde692cc06295ed4130
-  data.tar.gz: 35f8073536f46860cad09934415c4cbc00b19708
+  metadata.gz: 1ea87342c0472c14fc27069bc7cfc9c5d6aeb55d
+  data.tar.gz: e257eb864adf2fdd0365016bc11b28d449efc241
 SHA512:
-  metadata.gz: 9603c36cdfdab8258d902526a3ee9417e679387cd530f621e588e7b90cb3a00e68950553e5ff5453ea69132c48cc2485e35df9b9135ef35c8e37561a4c98685b
-  data.tar.gz: ae04ca58577582e82ba851f4182baafddb89a61e4206203e02410633542db2739942689129166b23e82158f89752bcdc89cb1eab07e85f2e1fc466c1d44eb95d
+  metadata.gz: f7dde31138d738f9daf428296ebe60096d185d657b1ac238d75dedcb2320446f14bac64b1ce5d62758a5fc28d080afa035b06da27ed68854dcd1216763709652
+  data.tar.gz: 75130b22d2a57a2a60dbba7292d1f060f9cd380fc47a286709367b95b56ae1f0314fdcc2ad74a87b78eea37f57b3146b5458ce8e567e7742d0b5ed1608ca03ea

data/lib/aws-sdk-transfer.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-transfer/customizations'
 # @service
 module Aws::Transfer
 
-  GEM_VERSION = '1.12.0'
+  GEM_VERSION = '1.13.0'
 
 end

data/lib/aws-sdk-transfer/client.rb

@@ -265,45 +265,47 @@ module Aws::Transfer
     # @!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.
-    #
-    # The response returns the `ServerId` value for the newly created
-    # server.
+    # 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.
     #
     # @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
@@ -351,16 +353,14 @@ module Aws::Transfer
       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.
-    #
-    # The response returns the `UserName` and `ServerId` values of the new
-    # user for that server.
+    # 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.
     #
     # @option params [String] :home_directory
     #   The landing directory (folder) for a user when they log in to the
@@ -369,9 +369,24 @@ module Aws::Transfer
     # @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
@@ -386,7 +401,7 @@ module Aws::Transfer
     #   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
@@ -437,11 +452,9 @@ module Aws::Transfer
     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.
@@ -465,7 +478,7 @@ module Aws::Transfer
 
     # 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
@@ -499,7 +512,7 @@ module Aws::Transfer
 
     # 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.
     #
@@ -587,8 +600,8 @@ module Aws::Transfer
     #
     # @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:
     #
@@ -680,7 +693,7 @@ module Aws::Transfer
     #   `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.
@@ -732,9 +745,9 @@ module Aws::Transfer
     #
     # @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:
     #
@@ -777,12 +790,12 @@ module Aws::Transfer
     # @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:
     #
@@ -856,7 +869,7 @@ module Aws::Transfer
     # 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.
     #
@@ -923,25 +936,26 @@ module Aws::Transfer
 
     # 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
@@ -954,8 +968,9 @@ module Aws::Transfer
     #
     # @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
@@ -1023,8 +1038,11 @@ module Aws::Transfer
     #
     #   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
@@ -1080,18 +1098,33 @@ module Aws::Transfer
     # 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
@@ -1107,8 +1140,8 @@ module Aws::Transfer
     #
     # @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.
@@ -1155,7 +1188,7 @@ module Aws::Transfer
         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
 

data/lib/aws-sdk-transfer/client_api.rb

@@ -57,6 +57,7 @@ module Aws::Transfer
     ResourceExistsException = Shapes::StructureShape.new(name: 'ResourceExistsException')
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
     ResourceType = Shapes::StringShape.new(name: 'ResourceType')
+    Response = Shapes::StringShape.new(name: 'Response')
     Role = Shapes::StringShape.new(name: 'Role')
     ServerId = Shapes::StringShape.new(name: 'ServerId')
     ServiceErrorMessage = Shapes::StringShape.new(name: 'ServiceErrorMessage')
@@ -279,8 +280,9 @@ module Aws::Transfer
     TestIdentityProviderRequest.add_member(:user_password, Shapes::ShapeRef.new(shape: UserPassword, location_name: "UserPassword"))
     TestIdentityProviderRequest.struct_class = Types::TestIdentityProviderRequest
 
-    TestIdentityProviderResponse.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
+    TestIdentityProviderResponse.add_member(:response, Shapes::ShapeRef.new(shape: Response, location_name: "Response"))
     TestIdentityProviderResponse.add_member(:status_code, Shapes::ShapeRef.new(shape: StatusCode, required: true, location_name: "StatusCode"))
+    TestIdentityProviderResponse.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
     TestIdentityProviderResponse.add_member(:url, Shapes::ShapeRef.new(shape: Url, required: true, location_name: "Url"))
     TestIdentityProviderResponse.struct_class = Types::TestIdentityProviderResponse
 

data/lib/aws-sdk-transfer/types.rb

@@ -33,39 +33,45 @@ module Aws::Transfer
     #
     # @!attribute [rw] 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.
     #   @return [Types::EndpointDetails]
     #
     # @!attribute [rw] 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.
     #   @return [String]
     #
     # @!attribute [rw] 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.*
     #   @return [String]
     #
     # @!attribute [rw] 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`.
     #   @return [Types::IdentityProviderDetails]
     #
     # @!attribute [rw] 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.
     #   @return [String]
     #
     # @!attribute [rw] logging_role
@@ -127,9 +133,24 @@ module Aws::Transfer
     # @!attribute [rw] 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\}`,
+    #   portions 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>
     #   @return [String]
     #
     # @!attribute [rw] role
@@ -148,7 +169,7 @@ module Aws::Transfer
     #   @return [String]
     #
     # @!attribute [rw] ssh_public_key_body
-    #   The public portion of the Secure Shall (SSH) key used to
+    #   The public portion of the Secure Shell (SSH) key used to
     #   authenticate the user to the SFTP server.
     #   @return [String]
     #
@@ -316,8 +337,8 @@ module Aws::Transfer
     #
     # @!attribute [rw] 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 [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeUserRequest AWS API Documentation
@@ -346,10 +367,10 @@ module Aws::Transfer
       include Aws::Structure
     end
 
-    # Describe the properties of the server that was specified. Information
-    # returned includes: the server Amazon Resource Name (ARN), the
-    # authentication configuration and type, the logging role, server Id and
-    # state, and assigned tags or metadata.
+    # Describes the properties of the server that was specified. Information
+    # returned includes the following: the server Amazon Resource Name
+    # (ARN), the authentication configuration and type, the logging role,
+    # the server ID and state, and assigned tags or metadata.
     #
     # @!attribute [rw] arn
     #   Specifies the unique Amazon Resource Name (ARN) for the server to be
@@ -368,8 +389,8 @@ module Aws::Transfer
     #   @return [String]
     #
     # @!attribute [rw] host_key_fingerprint
-    #   This value contains the Message-Digest Algorithm (MD5) hash of the
-    #   server's host key. This value is equivalent to the output of
+    #   This value contains the message-digest algorithm (MD5) hash of the
+    #   server's host key. This value is equivalent to the output of the
     #   `ssh-keygen -l -E md5 -f my-new-server-key` command.
     #   @return [String]
     #
@@ -381,8 +402,8 @@ module Aws::Transfer
     #
     # @!attribute [rw] identity_provider_type
     #   This property defines the mode of authentication method enabled for
-    #   this service. A value of `SERVICE_MANAGED`, means that you are using
-    #   this Server to store and access SFTP user credentials within the
+    #   this service. A value of `SERVICE_MANAGED` means that you are using
+    #   this server to store and access SFTP user credentials within the
     #   service. A value of `API_GATEWAY` indicates that you have integrated
     #   an API Gateway endpoint that will be invoked for authenticating your
     #   user into the service.
@@ -391,12 +412,12 @@ module Aws::Transfer
     # @!attribute [rw] logging_role
     #   This property is an AWS Identity and Access Management (IAM) entity
     #   that allows the server to turn on Amazon CloudWatch logging for
-    #   Amazon S3 events. When set, user activity can be view in your
+    #   Amazon S3 events. When set, user activity can be viewed in your
     #   CloudWatch logs.
     #   @return [String]
     #
     # @!attribute [rw] server_id
-    #   This property is a unique system assigned identifier for the SFTP
+    #   This property is a unique system-assigned identifier for the SFTP
     #   server that you instantiate.
     #   @return [String]
     #
@@ -406,7 +427,7 @@ module Aws::Transfer
     #   transfer files. A `State` value of `OFFLINE` means that the server
     #   cannot perform file transfer operations.
     #
-    #   The states of `STARTING` and `STOPPING` indicated that the server is
+    #   The states of `STARTING` and `STOPPING` indicate that the server is
     #   in an intermediate state, either not fully able to respond, or not
     #   fully offline. The values of `START_FAILED` or `STOP_FAILED` can
     #   indicate an error condition.
@@ -440,7 +461,7 @@ module Aws::Transfer
       include Aws::Structure
     end
 
-    # Returns properties of the user that you wish to describe.
+    # Returns properties of the user that you want to describe.
     #
     # @!attribute [rw] arn
     #   This property contains the unique Amazon Resource Name (ARN) for the
@@ -448,9 +469,9 @@ module Aws::Transfer
     #   @return [String]
     #
     # @!attribute [rw] home_directory
-    #   This property specifies the landing directory (or folder) which is
+    #   This property specifies the landing directory (or folder), which is
     #   the location that files are written to or read from in an Amazon S3
-    #   bucket for the described user. An example would be:
+    #   bucket for the described user. An example is
     #   `/bucket_name/home/username `.
     #   @return [String]
     #
@@ -521,7 +542,7 @@ module Aws::Transfer
     end
 
     # Returns information related to the type of user authentication that is
-    # in use for a server's users. A server can only have one method of
+    # in use for a server's users. A server can have only one method of
     # authentication.
     #
     # @note When making an API call, you may pass IdentityProviderDetails
@@ -533,13 +554,13 @@ module Aws::Transfer
     #       }
     #
     # @!attribute [rw] url
-    #   The `IdentityProviderDetail` parameter contains the location of the
-    #   service endpoint used to authenticate users.
+    #   The `Url` parameter provides contains the location of the service
+    #   endpoint used to authenticate users.
     #   @return [String]
     #
     # @!attribute [rw] invocation_role
-    #   The `Role` parameter provides the type of `InvocationRole` used to
-    #   authenticate the user account.
+    #   The `InvocationRole` parameter provides the type of `InvocationRole`
+    #   used to authenticate the user account.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/IdentityProviderDetails AWS API Documentation
@@ -581,9 +602,9 @@ module Aws::Transfer
       include Aws::Structure
     end
 
-    # This response identifies the user, server they belong to, and the
+    # This response identifies the user, the server they belong to, and the
     # identifier of the SSH public key associated with that user. A user can
-    # have more than one key on each server that they are associate with.
+    # have more than one key on each server that they are associated with.
     #
     # @!attribute [rw] server_id
     #   A system-assigned unique identifier for an SFTP server.
@@ -658,8 +679,8 @@ module Aws::Transfer
     #   @return [Integer]
     #
     # @!attribute [rw] next_token
-    #   When additional results are obtained from the ListServers command, a
-    #   `NextToken` parameter is returned in the output. You can then pass
+    #   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 [String]
@@ -713,9 +734,9 @@ module Aws::Transfer
     #
     # @!attribute [rw] 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 [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListTagsForResourceRequest AWS API Documentation
@@ -734,14 +755,14 @@ module Aws::Transfer
     # @!attribute [rw] next_token
     #   When you can get additional results from the `ListTagsForResource`
     #   call, a `NextToken` parameter is returned in the output. You can
-    #   then pass in a subsequent command the `NextToken` parameter to
+    #   then pass in a subsequent command to the `NextToken` parameter to
     #   continue listing additional tags.
     #   @return [String]
     #
     # @!attribute [rw] tags
     #   Key-value pairs that are assigned to a resource, usually for the
     #   purpose of grouping and searching for items. Tags are metadata that
-    #   you define that you can use for any purpose.
+    #   you define.
     #   @return [Array<Types::Tag>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListTagsForResourceResponse AWS API Documentation
@@ -770,13 +791,13 @@ module Aws::Transfer
     # @!attribute [rw] 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
+    #   in a subsequent command to the `NextToken` parameter to continue
     #   listing additional users.
     #   @return [String]
     #
     # @!attribute [rw] 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 [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListUsersRequest AWS API Documentation
@@ -791,7 +812,7 @@ module Aws::Transfer
     # @!attribute [rw] 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
+    #   in a subsequent command to the `NextToken` parameter to continue
     #   listing additional users.
     #   @return [String]
     #
@@ -822,10 +843,9 @@ module Aws::Transfer
     #
     # @!attribute [rw] identity_provider_type
     #   The authentication method used to validate a user for the server
-    #   that was specified. listed. This can include Secure Shell (SSH),
-    #   user name and password combinations, or your own custom
-    #   authentication method. Valid values include `SERVICE_MANAGED` or
-    #   `API_GATEWAY`.
+    #   that was specified. This can include Secure Shell (SSH), user name
+    #   and password combinations, or your own custom authentication method.
+    #   Valid values include `SERVICE_MANAGED` or `API_GATEWAY`.
     #   @return [String]
     #
     # @!attribute [rw] endpoint_type
@@ -851,7 +871,7 @@ module Aws::Transfer
     #   `OFFLINE` means that the server cannot perform file transfer
     #   operations.
     #
-    #   The states of `STARTING` and `STOPPING` indicated that the server is
+    #   The states of `STARTING` and `STOPPING` indicate that the server is
     #   in an intermediate state, either not fully able to respond, or not
     #   fully offline. The values of `START_FAILED` or `STOP_FAILED` can
     #   indicate an error condition.
@@ -880,7 +900,7 @@ module Aws::Transfer
     #
     # @!attribute [rw] arn
     #   This property is the unique Amazon Resource Name (ARN) for the user
-    #   that you wish to learn about.
+    #   that you want to learn about.
     #   @return [String]
     #
     # @!attribute [rw] home_directory
@@ -890,10 +910,10 @@ module Aws::Transfer
     #
     # @!attribute [rw] role
     #   The role in use by this user. A *role* is an AWS Identity and Access
-    #   Management (IAM) entity that in this case allows the SFTP server to
-    #   act on a user's behalf. It allows the server to inherit the trust
-    #   relationship that enables that user to perform file operations to
-    #   their Amazon S3 bucket.
+    #   Management (IAM) entity that, in this case, allows the SFTP server
+    #   to act on a user's behalf. It allows the server to inherit the
+    #   trust relationship that enables that user to perform file operations
+    #   to their Amazon S3 bucket.
     #   @return [String]
     #
     # @!attribute [rw] ssh_public_key_count
@@ -1112,12 +1132,12 @@ module Aws::Transfer
     #       }
     #
     # @!attribute [rw] 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.
     #   @return [String]
     #
     # @!attribute [rw] 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.
     #   @return [String]
     #
     # @!attribute [rw] user_password
@@ -1133,14 +1153,18 @@ module Aws::Transfer
       include Aws::Structure
     end
 
-    # @!attribute [rw] message
-    #   The result of the authorization test as a message.
+    # @!attribute [rw] response
+    #   The response that is returned from your API Gateway.
     #   @return [String]
     #
     # @!attribute [rw] status_code
     #   The HTTP status code that is the response from your API Gateway.
     #   @return [Integer]
     #
+    # @!attribute [rw] message
+    #   A message that indicates whether the test was successful or not.
+    #   @return [String]
+    #
     # @!attribute [rw] url
     #   The endpoint of the service used to authenticate a user.
     #   @return [String]
@@ -1148,8 +1172,9 @@ module Aws::Transfer
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TestIdentityProviderResponse AWS API Documentation
     #
     class TestIdentityProviderResponse < Struct.new(
-      :message,
+      :response,
       :status_code,
+      :message,
       :url)
       include Aws::Structure
     end
@@ -1218,8 +1243,11 @@ module Aws::Transfer
     #
     #   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.*
     #   @return [String]
     #
     # @!attribute [rw] identity_provider_details
@@ -1275,18 +1303,33 @@ module Aws::Transfer
     #       }
     #
     # @!attribute [rw] 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 `.
     #   @return [String]
     #
     # @!attribute [rw] 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
+    #   multiple 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>
     #   @return [String]
     #
     # @!attribute [rw] role
@@ -1306,8 +1349,8 @@ module Aws::Transfer
     #
     # @!attribute [rw] 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
+    #   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 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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-transfer
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.13.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-25 00:00:00.000000000 Z
+date: 2019-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core