lib/aws-sdk-transfer/client.rb in aws-sdk-transfer-1.33.0 vs lib/aws-sdk-transfer/client.rb in aws-sdk-transfer-1.34.0

- old
+ new

@@ -347,19 +347,20 @@ # # @option params [String] :home_directory # The landing directory (folder) for a user when they log in to the # server using the client. # - # A `HomeDirectory` example is `/directory_name/home/mydirectory`. + # A `HomeDirectory` example is `/bucket_name/home/mydirectory`. # # @option params [String] :home_directory_type - # The type of landing directory (folder) that you want your users' home - # directory to be when they log in to 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 - # must provide mappings in the `HomeDirectoryMappings` for how you want - # to make Amazon S3 paths visible to your users. + # The type of landing directory (folder) you want your users' home + # directory to be when they log into the server. If you set it to + # `PATH`, the user will see the absolute Amazon S3 bucket or EFS 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 or EFS + # paths visible to your users. # # @option params [Array<Types::HomeDirectoryMapEntry>] :home_directory_mappings # Logical directory mappings that specify what Amazon S3 or Amazon EFS # paths and keys should be visible to your user and how you want to make # them visible. You must specify the `Entry` and `Target` pair, where @@ -396,21 +397,19 @@ # The end of the key name must end in a `/` for it to be considered a # folder. # # </note> # - # Required: No - # # @option params [String] :policy # A scope-down policy for your user so that you can use the same IAM # role across multiple users. This policy scopes down user access to # 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"> This only applies when domain of `ServerId` is S3. Amazon EFS does not - # use scope down policy. + # use scope-down policies. # # For scope-down policies, AWS Transfer Family 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. @@ -435,17 +434,17 @@ # that are set on files and directories in your file system determine # the level of access your users get when transferring files into and # out of your Amazon EFS file systems. # # @option params [required, String] :role - # Specifies the IAM role that controls your users' access to your - # Amazon S3 bucket or EFS file system. The policies attached to this - # role determine the level of access that you want to provide your users - # when transferring files into and out of your Amazon S3 bucket or EFS - # file system. The IAM role should also contain a trust relationship - # that allows the server to access your resources when servicing your - # users' transfer requests. + # Specifies the Amazon Resource Name (ARN) of the IAM role that controls + # your users' access to your Amazon S3 bucket or EFS file system. The + # policies attached to this role determine the level of access that you + # want to provide your users when transferring files into and out of + # your Amazon S3 bucket or EFS file system. The IAM role should also + # 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 server instance. This is the # specific server that you added your user to. # @@ -456,11 +455,11 @@ # protocols using AWS Transfer Family. If you know the group name, you # can view the SID values by running the following command using Windows # PowerShell. # # `Get-ADGroup -Filter \{samAccountName -like "YourGroupName*"\} - # -Properties * | Select SamaccountName,ObjectSid` + # -Properties * | Select SamAccountName,ObjectSid` # # In that command, replace *YourGroupName* with the name of your Active # Directory group. # # The regex used to validate this parameter is a string of characters @@ -578,16 +577,16 @@ # it inside your VPC. With an endpoint that is hosted in a VPC, you can # restrict access to your server and resources only within your VPC or # choose to make it internet facing by attaching Elastic IP addresses # directly to it. # - # <note markdown="1"> After March 31, 2021, you won't be able to create a server using + # <note markdown="1"> After May 19, 2021, you won't be able to create a server using # `EndpointType=VPC_ENDPOINT` in your AWS account if your account - # hasn't already done so before March 31, 2021. If you have already + # hasn't already done so before May 19, 2021. If you have already # created servers with `EndpointType=VPC_ENDPOINT` in your AWS account - # on or before March 31, 2021, you will not be affected. After this - # date, use `EndpointType`=`VPC`. + # on or before May 19, 2021, you will not be affected. After this date, + # use `EndpointType`=`VPC`. # # For more information, see # https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint. # # It is recommended that you use `VPC` as the `EndpointType`. With this @@ -740,14 +739,15 @@ # A `HomeDirectory` example is `/bucket_name/home/mydirectory`. # # @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 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. + # `PATH`, the user will see the absolute Amazon S3 bucket or EFS 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 or EFS + # paths visible to your users. # # @option params [Array<Types::HomeDirectoryMapEntry>] :home_directory_mappings # Logical directory mappings that specify what Amazon S3 or EFS 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 @@ -781,14 +781,14 @@ # name ends in a `/` for it to be considered a folder. # # </note> # # @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 that you can use inside this - # policy include `$\{Transfer:UserName\}`, + # A scope-down policy for your user so that you can use the same IAM + # role across multiple users. This policy scopes down user access to + # 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"> This only applies when domain of ServerId is S3. EFS does not use # scope down policy. # @@ -817,17 +817,17 @@ # permissions that are set on files and directories in Amazon EFS # determine the level of access your users get when transferring files # into and out of your Amazon EFS file systems. # # @option params [required, String] :role - # Specifies the IAM role that controls your users' access to your - # Amazon S3 bucket or EFS file system. 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 EFS - # file system. The IAM role should also contain a trust relationship - # that allows the server to access your resources when servicing your - # users' transfer requests. + # Specifies the Amazon Resource Name (ARN) of the IAM role that controls + # your users' access to your Amazon S3 bucket or EFS file system. The + # policies attached to this role determine the level of access that you + # want to provide your users when transferring files into and out of + # your Amazon S3 bucket or EFS file system. The IAM role should also + # 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 server instance. This is the # specific server that you added your user to. # @@ -909,11 +909,11 @@ # protocols using AWS Transfer Family. If you know the group name, you # can view the SID values by running the following command using Windows # PowerShell. # # `Get-ADGroup -Filter \{samAccountName -like "YourGroupName*"\} - # -Properties * | Select SamaccountName,ObjectSid` + # -Properties * | Select SamAccountName,ObjectSid` # # In that command, replace *YourGroupName* with the name of your Active # Directory group. # # The regex used to validate this parameter is a string of characters @@ -1043,18 +1043,18 @@ # A system-assigned unique identifier for a server that has this access # assigned. # # @option params [required, String] :external_id # A unique identifier that is required to identify specific groups - # within your directory. The users of the group you associate have + # within your directory. The users of the group that you associate have # access to your Amazon S3 or Amazon EFS resources over the enabled # protocols using AWS Transfer Family. If you know the group name, you # can view the SID values by running the following command using Windows # PowerShell. # # `Get-ADGroup -Filter \{samAccountName -like "YourGroupName*"\} - # -Properties * | Select SamaccountName,ObjectSid` + # -Properties * | Select SamAccountName,ObjectSid` # # In that command, replace *YourGroupName* with the name of your Active # Directory group. # # The regex used to validate this parameter is a string of characters @@ -1764,19 +1764,20 @@ # # @option params [String] :home_directory # The landing directory (folder) for a user when they log in to the # server using the client. # - # A `HomeDirectory` example is `/directory_name/home/mydirectory`. + # A `HomeDirectory` example is `/bucket_name/home/mydirectory`. # # @option params [String] :home_directory_type - # The type of landing directory (folder) that you want your users' home - # directory to be when they log in to 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 - # must provide mappings in the `HomeDirectoryMappings` for how you want - # to make Amazon S3 paths visible to your users. + # The type of landing directory (folder) you want your users' home + # directory to be when they log into the server. If you set it to + # `PATH`, the user will see the absolute Amazon S3 bucket or EFS 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 or EFS + # paths visible to your users. # # @option params [Array<Types::HomeDirectoryMapEntry>] :home_directory_mappings # Logical directory mappings that specify what Amazon S3 or Amazon EFS # paths and keys should be visible to your user and how you want to make # them visible. You must specify the `Entry` and `Target` pair, where @@ -1813,12 +1814,10 @@ # The end of the key name must end in a `/` for it to be considered a # folder. # # </note> # - # Required: No - # # @option params [String] :policy # A scope-down policy for your user so that you can use the same IAM # role across multiple users. This policy scopes down user access to # portions of their Amazon S3 bucket. Variables that you can use inside # this policy include `$\{Transfer:UserName\}`, @@ -1852,17 +1851,17 @@ # that are set on files and directories in your file system determine # the level of access your users get when transferring files into and # out of your Amazon EFS file systems. # # @option params [String] :role - # Specifies the IAM role that controls your users' access to your - # Amazon S3 bucket or EFS file system. The policies attached to this - # role determine the level of access that you want to provide your users - # when transferring files into and out of your Amazon S3 bucket or EFS - # file system. The IAM role should also contain a trust relationship - # that allows the server to access your resources when servicing your - # users' transfer requests. + # Specifies the Amazon Resource Name (ARN) of the IAM role that controls + # your users' access to your Amazon S3 bucket or EFS file system. The + # policies attached to this role determine the level of access that you + # want to provide your users when transferring files into and out of + # your Amazon S3 bucket or EFS file system. The IAM role should also + # 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 server instance. This is the # specific server that you added your user to. # @@ -1873,11 +1872,11 @@ # protocols using AWS Transfer Family. If you know the group name, you # can view the SID values by running the following command using Windows # PowerShell. # # `Get-ADGroup -Filter \{samAccountName -like "YourGroupName*"\} - # -Properties * | Select SamaccountName,ObjectSid` + # -Properties * | Select SamAccountName,ObjectSid` # # In that command, replace *YourGroupName* with the name of your Active # Directory group. # # The regex used to validate this parameter is a string of characters @@ -1984,16 +1983,16 @@ # it inside your VPC. With an endpoint that is hosted in a VPC, you can # restrict access to your server and resources only within your VPC or # choose to make it internet facing by attaching Elastic IP addresses # directly to it. # - # <note markdown="1"> After March 31, 2021, you won't be able to create a server using + # <note markdown="1"> After May 19, 2021, you won't be able to create a server using # `EndpointType=VPC_ENDPOINT` in your AWS account if your account - # hasn't already done so before March 31, 2021. If you have already + # hasn't already done so before May 19, 2021. If you have already # created servers with `EndpointType=VPC_ENDPOINT` in your AWS account - # on or before March 31, 2021, you will not be affected. After this - # date, use `EndpointType`=`VPC`. + # on or before May 19, 2021, you will not be affected. After this date, + # use `EndpointType`=`VPC`. # # For more information, see # https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint. # # It is recommended that you use `VPC` as the `EndpointType`. With this @@ -2114,14 +2113,14 @@ # # 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 server using their file transfer protocol client. + # The landing directory (folder) for a user when they log in to the + # server using the client. # - # An example is `your-Amazon-S3-bucket-name>/home/username`. + # A `HomeDirectory` example is `/bucket_name/home/mydirectory`. # # @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 server. If you set it to # `PATH`, the user will see the absolute Amazon S3 bucket or EFS paths @@ -2159,17 +2158,20 @@ # name ends in a / for it to be considered a folder. # # </note> # # @option params [String] :policy - # Allows you to supply a scope-down policy for your user so you can use - # the same IAM role across 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\}`, + # A scope-down policy for your user so that you can use the same IAM + # role across multiple users. This policy scopes down user access to + # 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 Family stores the policy as a + # <note markdown="1"> This only applies when domain of `ServerId` is S3. Amazon EFS does not + # use scope-down policies. + # + # For scope-down policies, AWS Transfer Family 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 [Creating a scope-down @@ -2192,16 +2194,17 @@ # The POSIX permissions that are set on files and directories in your # file system determines the level of access your users get when # transferring files into and out of your Amazon EFS file systems. # # @option params [String] :role - # The IAM role that controls your users' access to your Amazon S3 - # bucket. The policies attached to this role determine the level of - # access you want to provide your users when transferring files into and - # out of your S3 bucket or buckets. The IAM role should also contain a - # trust relationship that allows the server to access your resources - # when servicing your users' transfer requests. + # Specifies the Amazon Resource Name (ARN) of the IAM role that controls + # your users' access to your Amazon S3 bucket or EFS file system. The + # policies attached to this role determine the level of access that you + # want to provide your users when transferring files into and out of + # your Amazon S3 bucket or EFS file system. The IAM role should also + # 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 server instance that the # user account is assigned to. # @@ -2265,10 +2268,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-transfer' - context[:gem_version] = '1.33.0' + context[:gem_version] = '1.34.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated