AWS.Tools.Transfer.dll-Help.xml
|
<helpItems schema="maml">
<command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Add-TFRResourceTag</name> <description> <para>Calls the AWS Transfer for SFTP TagResource API operation.</para> </description> <verb>Add</verb> <noun>TFRResourceTag</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities. There is no response returned from this call. </para> </description> <syntax> <syntaxItem> <name>Add-TFRResourceTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Arn</name> <description> <para>An Amazon Resource Name (ARN) for a specific AWS resource, such as a server, user, or role. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to user accounts for any purpose. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Transfer.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Arn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Arn</name> <description> <para>An Amazon Resource Name (ARN) for a specific AWS resource, such as a server, user, or role. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Arn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to user accounts for any purpose. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Transfer.Model.Tag[]</parameterValue> <type> <name>Amazon.Transfer.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the Arn parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Transfer.Model.TagResourceResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Add-TFRResourceTag.html&tocid=Add-TFRResourceTag</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/API_Reference.html</uri> </navigationLink> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-TFRResourceTagList</name> <description> <para>Calls the AWS Transfer for SFTP ListTagsForResource API operation.</para> </description> <verb>Get</verb> <noun>TFRResourceTagList</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-TFRResourceTagList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Arn</name> <description> <para>Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific AWS resource, such as a server, user, or role. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Specifies the number of tags to return as a response to the <code>ListTagsForResource</code> request. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>When you request additional results from the <code>ListTagsForResource</code> operation, a <code>NextToken</code> parameter is returned in the input. You can then pass in a subsequent command to the <code>NextToken</code> parameter to continue listing additional tags. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Arn</name> <description> <para>Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific AWS resource, such as a server, user, or role. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Specifies the number of tags to return as a response to the <code>ListTagsForResource</code> request. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>When you request additional results from the <code>ListTagsForResource</code> operation, a <code>NextToken</code> parameter is returned in the input. You can then pass in a subsequent command to the <code>NextToken</code> parameter to continue listing additional tags. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Transfer.Model.Tag</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Amazon.Transfer.Model.Tag objects. The service call response (type Amazon.Transfer.Model.ListTagsForResourceResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Arn (type System.String), NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-TFRResourceTagList.html&tocid=Get-TFRResourceTagList</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/API_Reference.html</uri> </navigationLink> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-TFRServer</name> <description> <para>Calls the AWS Transfer for SFTP DescribeServer API operation.</para> </description> <verb>Get</verb> <noun>TFRServer</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes the server that you specify by passing the <code>ServerId</code> parameter. The response contains a description of the server's properties. </para> </description> <syntax> <syntaxItem> <name>Get-TFRServer</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ServerId</name> <description> <para>A system-assigned unique identifier for an SFTP server. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ServerId</name> <description> <para>A system-assigned unique identifier for an SFTP server. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Transfer.Model.DescribedServer</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Transfer.Model.DescribedServer object. The service call response (type Amazon.Transfer.Model.DescribeServerResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-TFRServer.html&tocid=Get-TFRServer</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/API_Reference.html</uri> </navigationLink> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-TFRServerList</name> <description> <para>Calls the AWS Transfer for SFTP ListServers API operation.</para> </description> <verb>Get</verb> <noun>TFRServerList</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-TFRServerList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Specifies the number of servers to return as a response to the <code>ListServers</code> query. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>When additional results are obtained from the <code>ListServers</code> command, a <code>NextToken</code> parameter is returned in the output. You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional servers. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Specifies the number of servers to return as a response to the <code>ListServers</code> query. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>When additional results are obtained from the <code>ListServers</code> command, a <code>NextToken</code> parameter is returned in the output. You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional servers. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Transfer.Model.ListedServer</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Amazon.Transfer.Model.ListedServer objects. The service call response (type Amazon.Transfer.Model.ListServersResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-TFRServerList.html&tocid=Get-TFRServerList</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/API_Reference.html</uri> </navigationLink> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-TFRUser</name> <description> <para>Calls the AWS Transfer for SFTP DescribeUser API operation.</para> </description> <verb>Get</verb> <noun>TFRUser</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes the user assigned to a specific server, as identified by its <code>ServerId</code> property. The response from this call returns the properties of the user associated with the <code>ServerId</code> value that was specified. </para> </description> <syntax> <syntaxItem> <name>Get-TFRUser</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>UserName</name> <description> <para>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 for SFTP service and perform file transfer tasks. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ServerId</name> <description> <para>A system-assigned unique identifier for an SFTP server that has this user assigned. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ServerId</name> <description> <para>A system-assigned unique identifier for an SFTP server that has this user assigned. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>UserName</name> <description> <para>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 for SFTP service and perform file transfer tasks. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Transfer.Model.DescribeUserResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Transfer.Model.DescribeUserResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-TFRUser.html&tocid=Get-TFRUser</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/API_Reference.html</uri> </navigationLink> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-TFRUserList</name> <description> <para>Calls the AWS Transfer for SFTP ListUsers API operation.</para> </description> <verb>Get</verb> <noun>TFRUserList</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the users for the server that you specify by passing the <code>ServerId</code> parameter.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-TFRUserList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ServerId</name> <description> <para>A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server that has users assigned to it. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Specifies the number of users to return as a response to the <code>ListUsers</code> request. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>When you can get additional results from the <code>ListUsers</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass in a subsequent command to the <code>NextToken</code> parameter to continue listing additional users. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Specifies the number of users to return as a response to the <code>ListUsers</code> request. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>When you can get additional results from the <code>ListUsers</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass in a subsequent command to the <code>NextToken</code> parameter to continue listing additional users. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ServerId</name> <description> <para>A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server that has users assigned to it. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Transfer.Model.ListedUser</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Amazon.Transfer.Model.ListedUser objects. The service call response (type Amazon.Transfer.Model.ListUsersResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String), ServerId (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-TFRUserList.html&tocid=Get-TFRUserList</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/API_Reference.html</uri> </navigationLink> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Import-TFRSshPublicKey</name> <description> <para>Calls the AWS Transfer for SFTP ImportSshPublicKey API operation.</para> </description> <verb>Import</verb> <noun>TFRSshPublicKey</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Adds a Secure Shell (SSH) public key to a user account identified by a <code>UserName</code> value assigned to a specific server, identified by <code>ServerId</code>. The response returns the <code>UserName</code> value, the <code>ServerId</code> value, and the name of the <code>SshPublicKeyId</code>. </para> </description> <syntax> <syntaxItem> <name>Import-TFRSshPublicKey</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SshPublicKeyBody</name> <description> <para>The public key portion of an SSH key pair. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ServerId</name> <description> <para>A system-assigned unique identifier for an SFTP server. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>UserName</name> <description> <para>The name of the user account that is assigned to one or more servers. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ServerId</name> <description> <para>A system-assigned unique identifier for an SFTP server. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SshPublicKeyBody</name> <description> <para>The public key portion of an SSH key pair. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>UserName</name> <description> <para>The name of the user account that is assigned to one or more servers. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Transfer.Model.ImportSshPublicKeyResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Transfer.Model.ImportSshPublicKeyResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Import-TFRSshPublicKey.html&tocid=Import-TFRSshPublicKey</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/API_Reference.html</uri> </navigationLink> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>New-TFRServer</name> <description> <para>Calls the AWS Transfer for SFTP CreateServer API operation.</para> </description> <verb>New</verb> <noun>TFRServer</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS. When you make updates to your server or when you work with users, use the service-generated <code>ServerId</code> property that is assigned to the newly created server. </para> </description> <syntax> <syntaxItem> <name>New-TFRServer</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointType</name> <description> <para>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. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Transfer.EndpointType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HostKey</name> <description> <para>The RSA private key as generated by the <code>ssh-keygen -N "" -f my-new-server-key</code> command. <important><para>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.</para></important> For more information, see "https://docs.aws.amazon.com/transfer/latest/userguide/change-host-key" in the <i>AWS SFTP User Guide.</i> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IdentityProviderType</name> <description> <para>Specifies the mode of authentication for the SFTP server. The default value is <code>SERVICE_MANAGED</code>, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The <code>API_GATEWAY</code> setting requires you to provide an API Gateway endpoint URL to call for authentication using the <code>IdentityProviderDetails</code> parameter. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Transfer.IdentityProviderType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IdentityProviderDetails_InvocationRole</name> <description> <para>The <code>InvocationRole</code> parameter provides the type of <code>InvocationRole</code> used to authenticate the user account. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LoggingRole</name> <description> <para>A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Key-value pairs that can be used to group and search for servers. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Transfer.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IdentityProviderDetails_Url</name> <description> <para>The <code>Url</code> parameter provides contains the location of the service endpoint used to authenticate users. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointDetails_VpcEndpointId</name> <description> <para>The ID of the VPC endpoint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointDetails_VpcEndpointId</name> <description> <para>The ID of the VPC endpoint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointType</name> <description> <para>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. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Transfer.EndpointType</parameterValue> <type> <name>Amazon.Transfer.EndpointType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HostKey</name> <description> <para>The RSA private key as generated by the <code>ssh-keygen -N "" -f my-new-server-key</code> command. <important><para>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.</para></important> For more information, see "https://docs.aws.amazon.com/transfer/latest/userguide/change-host-key" in the <i>AWS SFTP User Guide.</i> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IdentityProviderDetails_InvocationRole</name> <description> <para>The <code>InvocationRole</code> parameter provides the type of <code>InvocationRole</code> used to authenticate the user account. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IdentityProviderDetails_Url</name> <description> <para>The <code>Url</code> parameter provides contains the location of the service endpoint used to authenticate users. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IdentityProviderType</name> <description> <para>Specifies the mode of authentication for the SFTP server. The default value is <code>SERVICE_MANAGED</code>, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The <code>API_GATEWAY</code> setting requires you to provide an API Gateway endpoint URL to call for authentication using the <code>IdentityProviderDetails</code> parameter. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Transfer.IdentityProviderType</parameterValue> <type> <name>Amazon.Transfer.IdentityProviderType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LoggingRole</name> <description> <para>A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Key-value pairs that can be used to group and search for servers. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Transfer.Model.Tag[]</parameterValue> <type> <name>Amazon.Transfer.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a System.String object. The service call response (type Amazon.Transfer.Model.CreateServerResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=New-TFRServer.html&tocid=New-TFRServer</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/API_Reference.html</uri> </navigationLink> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>New-TFRUser</name> <description> <para>Calls the AWS Transfer for SFTP CreateUser API operation.</para> </description> <verb>New</verb> <noun>TFRUser</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>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 <code>IdentityProviderType</code> set to <code>SERVICE_MANAGED</code>. Using parameters for <code>CreateUser</code>, 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. </para> </description> <syntax> <syntaxItem> <name>New-TFRUser</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ServerId</name> <description> <para>A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HomeDirectory</name> <description> <para>The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is <code>/home/<i>username</i></code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Policy</name> <description> <para>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 <code>${Transfer:UserName}</code>, <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>. 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 <code>Policy</code> argument. For an example of a scope-down policy, see "https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down">Creating a Scope-Down Policy. For more information, see "https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html" in the <i>AWS Security Token Service API Reference</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Role</name> <description> <para>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 contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SshPublicKeyBody</name> <description> <para>The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Transfer.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>UserName</name> <description> <para>A unique string that identifies a user and is associated with a server as specified by the <code>ServerId</code>. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HomeDirectory</name> <description> <para>The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is <code>/home/<i>username</i></code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Policy</name> <description> <para>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 <code>${Transfer:UserName}</code>, <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>. 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 <code>Policy</code> argument. For an example of a scope-down policy, see "https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down">Creating a Scope-Down Policy. For more information, see "https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html" in the <i>AWS Security Token Service API Reference</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Role</name> <description> <para>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 contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ServerId</name> <description> <para>A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SshPublicKeyBody</name> <description> <para>The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Transfer.Model.Tag[]</parameterValue> <type> <name>Amazon.Transfer.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>UserName</name> <description> <para>A unique string that identifies a user and is associated with a server as specified by the <code>ServerId</code>. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Transfer.Model.CreateUserResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Transfer.Model.CreateUserResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=New-TFRUser.html&tocid=New-TFRUser</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/API_Reference.html</uri> </navigationLink> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-TFRResourceTag</name> <description> <para>Calls the AWS Transfer for SFTP UntagResource API operation.</para> </description> <verb>Remove</verb> <noun>TFRResourceTag</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities. No response is returned from this call. </para> </description> <syntax> <syntaxItem> <name>Remove-TFRResourceTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Arn</name> <description> <para>This is the value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific AWS resource, such as a server, user, or role. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>TagKeys are key-value pairs assigned to ARNs that can be used to group and search for resources by type. This metadata can be attached to resources for any purpose. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Arn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Arn</name> <description> <para>This is the value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific AWS resource, such as a server, user, or role. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Arn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>TagKeys are key-value pairs assigned to ARNs that can be used to group and search for resources by type. This metadata can be attached to resources for any purpose. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the Arn parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Transfer.Model.UntagResourceResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-TFRResourceTag.html&tocid=Remove-TFRResourceTag</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/API_Reference.html</uri> </navigationLink> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-TFRServer</name> <description> <para>Calls the AWS Transfer for SFTP DeleteServer API operation.</para> </description> <verb>Remove</verb> <noun>TFRServer</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the Secure File Transfer Protocol (SFTP) server that you specify. No response returns from this operation. </para> </description> <syntax> <syntaxItem> <name>Remove-TFRServer</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ServerId</name> <description> <para>A unique system-assigned identifier for an SFTP server instance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ServerId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ServerId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ServerId</name> <description> <para>A unique system-assigned identifier for an SFTP server instance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ServerId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Transfer.Model.DeleteServerResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-TFRServer.html&tocid=Remove-TFRServer</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/API_Reference.html</uri> </navigationLink> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-TFRSshPublicKey</name> <description> <para>Calls the AWS Transfer for SFTP DeleteSshPublicKey API operation.</para> </description> <verb>Remove</verb> <noun>TFRSshPublicKey</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a user's Secure Shell (SSH) public key. No response is returned from this operation. </para> </description> <syntax> <syntaxItem> <name>Remove-TFRSshPublicKey</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SshPublicKeyId</name> <description> <para>A unique identifier used to reference your user's specific SSH key. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ServerId</name> <description> <para>A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>UserName</name> <description> <para>A unique string that identifies a user whose public key is being deleted. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the SshPublicKeyId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the SshPublicKeyId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ServerId</name> <description> <para>A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SshPublicKeyId</name> <description> <para>A unique identifier used to reference your user's specific SSH key. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>UserName</name> <description> <para>A unique string that identifies a user whose public key is being deleted. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the SshPublicKeyId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Transfer.Model.DeleteSshPublicKeyResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-TFRSshPublicKey.html&tocid=Remove-TFRSshPublicKey</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/API_Reference.html</uri> </navigationLink> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-TFRUser</name> <description> <para>Calls the AWS Transfer for SFTP DeleteUser API operation.</para> </description> <verb>Remove</verb> <noun>TFRUser</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the user belonging to the server you specify. No response returns from this operation. When you delete a user from a server, the user's information is lost. </para> </description> <syntax> <syntaxItem> <name>Remove-TFRUser</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>UserName</name> <description> <para>A unique string that identifies a user that is being deleted from the server. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ServerId</name> <description> <para>A system-assigned unique identifier for an SFTP server instance that has the user assigned to it. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the UserName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the UserName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ServerId</name> <description> <para>A system-assigned unique identifier for an SFTP server instance that has the user assigned to it. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>UserName</name> <description> <para>A unique string that identifies a user that is being deleted from the server. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the UserName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Transfer.Model.DeleteUserResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-TFRUser.html&tocid=Remove-TFRUser</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/API_Reference.html</uri> </navigationLink> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Start-TFRServer</name> <description> <para>Calls the AWS Transfer for SFTP StartServer API operation.</para> </description> <verb>Start</verb> <noun>TFRServer</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Changes the state of a Secure File Transfer Protocol (SFTP) server from <code>OFFLINE</code> to <code>ONLINE</code>. It has no impact on an SFTP server that is already <code>ONLINE</code>. An <code>ONLINE</code> server can accept and process file transfer jobs. The state of <code>STARTING</code> indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of <code>START_FAILED</code> can indicate an error condition. No response is returned from this call. </para> </description> <syntax> <syntaxItem> <name>Start-TFRServer</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ServerId</name> <description> <para>A system-assigned unique identifier for an SFTP server that you start. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ServerId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ServerId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ServerId</name> <description> <para>A system-assigned unique identifier for an SFTP server that you start. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ServerId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Transfer.Model.StartServerResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Start-TFRServer.html&tocid=Start-TFRServer</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/API_Reference.html</uri> </navigationLink> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Stop-TFRServer</name> <description> <para>Calls the AWS Transfer for SFTP StopServer API operation.</para> </description> <verb>Stop</verb> <noun>TFRServer</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Changes the state of an SFTP server from <code>ONLINE</code> to <code>OFFLINE</code>. An <code>OFFLINE</code> 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 a server will not reduce or impact your Secure File Transfer Protocol (SFTP) endpoint billing. The state of <code>STOPPING</code> indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of <code>STOP_FAILED</code> can indicate an error condition. No response is returned from this call. </para> </description> <syntax> <syntaxItem> <name>Stop-TFRServer</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ServerId</name> <description> <para>A system-assigned unique identifier for an SFTP server that you stopped. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ServerId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ServerId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ServerId</name> <description> <para>A system-assigned unique identifier for an SFTP server that you stopped. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ServerId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Transfer.Model.StopServerResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Stop-TFRServer.html&tocid=Stop-TFRServer</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/API_Reference.html</uri> </navigationLink> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Test-TFRIdentityProvider</name> <description> <para>Calls the AWS Transfer for SFTP TestIdentityProvider API operation.</para> </description> <verb>Test</verb> <noun>TFRIdentityProvider</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>If the <code>IdentityProviderType</code> of the server is <code>API_Gateway</code>, tests whether your API Gateway is set up successfully. We highly recommend 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. </para> </description> <syntax> <syntaxItem> <name>Test-TFRIdentityProvider</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ServerId</name> <description> <para>A system-assigned identifier for a specific server. That server's user authentication method is tested with a user name and password. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>UserName</name> <description> <para>This request parameter is the name of the user account to be tested. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UserPassword</name> <description> <para>The password of the user account to be tested. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ServerId</name> <description> <para>A system-assigned identifier for a specific server. That server's user authentication method is tested with a user name and password. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>UserName</name> <description> <para>This request parameter is the name of the user account to be tested. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UserPassword</name> <description> <para>The password of the user account to be tested. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Transfer.Model.TestIdentityProviderResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Transfer.Model.TestIdentityProviderResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Test-TFRIdentityProvider.html&tocid=Test-TFRIdentityProvider</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/API_Reference.html</uri> </navigationLink> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Update-TFRServer</name> <description> <para>Calls the AWS Transfer for SFTP UpdateServer API operation.</para> </description> <verb>Update</verb> <noun>TFRServer</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates the server properties after that server has been created. The <code>UpdateServer</code> call returns the <code>ServerId</code> of the Secure File Transfer Protocol (SFTP) server you updated. </para> </description> <syntax> <syntaxItem> <name>Update-TFRServer</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ServerId</name> <description> <para>A system-assigned unique identifier for an SFTP server instance that the user account is assigned to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointType</name> <description> <para>The type of endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, your SFTP server isn't accessible over the public internet. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Transfer.EndpointType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HostKey</name> <description> <para>The RSA private key as generated by <code>ssh-keygen -N "" -f my-new-server-key</code>. <important><para>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.</para></important> For more information, see "https://docs.aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" in the <i>AWS SFTP User Guide.</i> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IdentityProviderDetails_InvocationRole</name> <description> <para>The <code>InvocationRole</code> parameter provides the type of <code>InvocationRole</code> used to authenticate the user account. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LoggingRole</name> <description> <para>A value that changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IdentityProviderDetails_Url</name> <description> <para>The <code>Url</code> parameter provides contains the location of the service endpoint used to authenticate users. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointDetails_VpcEndpointId</name> <description> <para>The ID of the VPC endpoint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointDetails_VpcEndpointId</name> <description> <para>The ID of the VPC endpoint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointType</name> <description> <para>The type of endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, your SFTP server isn't accessible over the public internet. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Transfer.EndpointType</parameterValue> <type> <name>Amazon.Transfer.EndpointType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HostKey</name> <description> <para>The RSA private key as generated by <code>ssh-keygen -N "" -f my-new-server-key</code>. <important><para>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.</para></important> For more information, see "https://docs.aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" in the <i>AWS SFTP User Guide.</i> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IdentityProviderDetails_InvocationRole</name> <description> <para>The <code>InvocationRole</code> parameter provides the type of <code>InvocationRole</code> used to authenticate the user account. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IdentityProviderDetails_Url</name> <description> <para>The <code>Url</code> parameter provides contains the location of the service endpoint used to authenticate users. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LoggingRole</name> <description> <para>A value that changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ServerId</name> <description> <para>A system-assigned unique identifier for an SFTP server instance that the user account is assigned to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a System.String object. The service call response (type Amazon.Transfer.Model.UpdateServerResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-TFRServer.html&tocid=Update-TFRServer</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/API_Reference.html</uri> </navigationLink> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Update-TFRUser</name> <description> <para>Calls the AWS Transfer for SFTP UpdateUser API operation.</para> </description> <verb>Update</verb> <noun>TFRUser</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the <code>UserName</code> and <code>ServerId</code> you specify. The response returns the <code>ServerId</code> and the <code>UserName</code> for the updated user. </para> </description> <syntax> <syntaxItem> <name>Update-TFRUser</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>UserName</name> <description> <para>A unique string that identifies a user and is associated with a server as specified by the <code>ServerId</code>. 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. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HomeDirectory</name> <description> <para>A parameter that specifies the landing directory (folder) for a user when they log in to the server using their client. An example is <code>/home/<i>username</i></code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Policy</name> <description> <para>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 user access to portions of your Amazon S3 bucket. Variables you can use inside this policy include <code>${Transfer:UserName}</code>, <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>. 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 <code>Policy</code> argument. For an example of a scope-down policy, see "https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down">Creating a Scope-Down Policy. For more information, see "https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html" in the <i>AWS Security Token Service API Reference</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Role</name> <description> <para>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 contain a trust relationship that allows the Secure File Transfer Protocol (SFTP) server to access your resources when servicing your SFTP user's transfer requests. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ServerId</name> <description> <para>A system-assigned unique identifier for an SFTP server instance that the user account is assigned to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HomeDirectory</name> <description> <para>A parameter that specifies the landing directory (folder) for a user when they log in to the server using their client. An example is <code>/home/<i>username</i></code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Policy</name> <description> <para>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 user access to portions of your Amazon S3 bucket. Variables you can use inside this policy include <code>${Transfer:UserName}</code>, <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>. 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 <code>Policy</code> argument. For an example of a scope-down policy, see "https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down">Creating a Scope-Down Policy. For more information, see "https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html" in the <i>AWS Security Token Service API Reference</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Role</name> <description> <para>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 contain a trust relationship that allows the Secure File Transfer Protocol (SFTP) server to access your resources when servicing your SFTP user's transfer requests. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ServerId</name> <description> <para>A system-assigned unique identifier for an SFTP server instance that the user account is assigned to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>UserName</name> <description> <para>A unique string that identifies a user and is associated with a server as specified by the <code>ServerId</code>. 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. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Transfer.Model.UpdateUserResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Transfer.Model.UpdateUserResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-TFRUser.html&tocid=Update-TFRUser</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/API_Reference.html</uri> </navigationLink> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/transfer/latest/userguide/</uri> </navigationLink> </relatedLinks> </command> </helpItems> |