/*******************************************************************************
* Copyright 2012-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use
* this file except in compliance with the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file.
* This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
* *****************************************************************************
*
* AWS Tools for Windows (TM) PowerShell (TM)
*
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Management.Automation;
using System.Text;
using Amazon.PowerShell.Common;
using Amazon.Runtime;
using Amazon.Transfer;
using Amazon.Transfer.Model;
namespace Amazon.PowerShell.Cmdlets.TFR
{
///
/// Begins a file transfer between local Amazon Web Services storage and a remote AS2
/// or SFTP server.
///
/// -
/// For an AS2 connector, you specify the
ConnectorId
and one or more SendFilePaths
/// to identify the files you want to transfer.
/// -
/// For an SFTP connector, the file transfer can be either outbound or inbound. In both
/// cases, you specify the
ConnectorId
. Depending on the direction of the
/// transfer, you also specify the following items:
/// -
/// If you are transferring file from a partner's SFTP server to a Transfer Family server,
/// you specify one or more
RetreiveFilePaths
to identify the files you want
/// to transfer, and a LocalDirectoryPath
to specify the destination folder.
/// -
/// If you are transferring file to a partner's SFTP server from Amazon Web Services storage,
/// you specify one or more
SendFilePaths
to identify the files you want
/// to transfer, and a RemoteDirectoryPath
to specify the destination folder.
///
///
[Cmdlet("Start", "TFRFileTransfer", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the AWS Transfer for SFTP StartFileTransfer API operation.", Operation = new[] {"StartFileTransfer"}, SelectReturnType = typeof(Amazon.Transfer.Model.StartFileTransferResponse))]
[AWSCmdletOutput("System.String or Amazon.Transfer.Model.StartFileTransferResponse",
"This cmdlet returns a System.String object.",
"The service call response (type Amazon.Transfer.Model.StartFileTransferResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class StartTFRFileTransferCmdlet : AmazonTransferClientCmdlet, IExecutor
{
#region Parameter ConnectorId
///
///
/// The unique identifier for the connector.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
#else
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String ConnectorId { get; set; }
#endregion
#region Parameter LocalDirectoryPath
///
///
/// For an inbound transfer, the LocaDirectoryPath
specifies the destination
/// for one or more files that are transferred from the partner's SFTP server.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String LocalDirectoryPath { get; set; }
#endregion
#region Parameter RemoteDirectoryPath
///
///
/// For an outbound transfer, the RemoteDirectoryPath
specifies the destination
/// for one or more files that are transferred to the partner's SFTP server. If you don't
/// specify a RemoteDirectoryPath
, the destination for transferred files
/// is the SFTP user's home directory.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String RemoteDirectoryPath { get; set; }
#endregion
#region Parameter RetrieveFilePath
///
///
/// One or more source paths for the partner's SFTP server. Each string represents a source
/// file path for one inbound file transfer.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("RetrieveFilePaths")]
public System.String[] RetrieveFilePath { get; set; }
#endregion
#region Parameter SendFilePath
///
///
/// One or more source paths for the Transfer Family server. Each string represents a
/// source file path for one outbound file transfer. For example, DOC-EXAMPLE-BUCKET/myfile.txt
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("SendFilePaths")]
public System.String[] SendFilePath { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'TransferId'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Transfer.Model.StartFileTransferResponse).
/// Specifying the name of a property of type Amazon.Transfer.Model.StartFileTransferResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "TransferId";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the ConnectorId parameter.
/// The -PassThru parameter is deprecated, use -Select '^ConnectorId' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ConnectorId' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
#region Parameter Force
///
/// This parameter overrides confirmation prompts to force
/// the cmdlet to continue its operation. This parameter should always
/// be used with caution.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter Force { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.ConnectorId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Start-TFRFileTransfer (StartFileTransfer)"))
{
return;
}
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
if (this.PassThru.IsPresent)
{
throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select));
}
}
else if (this.PassThru.IsPresent)
{
context.Select = (response, cmdlet) => this.ConnectorId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.ConnectorId = this.ConnectorId;
#if MODULAR
if (this.ConnectorId == null && ParameterWasBound(nameof(this.ConnectorId)))
{
WriteWarning("You are passing $null as a value for parameter ConnectorId which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.LocalDirectoryPath = this.LocalDirectoryPath;
context.RemoteDirectoryPath = this.RemoteDirectoryPath;
if (this.RetrieveFilePath != null)
{
context.RetrieveFilePath = new List(this.RetrieveFilePath);
}
if (this.SendFilePath != null)
{
context.SendFilePath = new List(this.SendFilePath);
}
// allow further manipulation of loaded context prior to processing
PostExecutionContextLoad(context);
var output = Execute(context) as CmdletOutput;
ProcessOutput(output);
}
#region IExecutor Members
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
// create request
var request = new Amazon.Transfer.Model.StartFileTransferRequest();
if (cmdletContext.ConnectorId != null)
{
request.ConnectorId = cmdletContext.ConnectorId;
}
if (cmdletContext.LocalDirectoryPath != null)
{
request.LocalDirectoryPath = cmdletContext.LocalDirectoryPath;
}
if (cmdletContext.RemoteDirectoryPath != null)
{
request.RemoteDirectoryPath = cmdletContext.RemoteDirectoryPath;
}
if (cmdletContext.RetrieveFilePath != null)
{
request.RetrieveFilePaths = cmdletContext.RetrieveFilePath;
}
if (cmdletContext.SendFilePath != null)
{
request.SendFilePaths = cmdletContext.SendFilePath;
}
CmdletOutput output;
// issue call
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
pipelineOutput = cmdletContext.Select(response, this);
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
}
catch (Exception e)
{
output = new CmdletOutput { ErrorResponse = e };
}
return output;
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.Transfer.Model.StartFileTransferResponse CallAWSServiceOperation(IAmazonTransfer client, Amazon.Transfer.Model.StartFileTransferRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Transfer for SFTP", "StartFileTransfer");
try
{
#if DESKTOP
return client.StartFileTransfer(request);
#elif CORECLR
return client.StartFileTransferAsync(request).GetAwaiter().GetResult();
#else
#error "Unknown build edition"
#endif
}
catch (AmazonServiceException exc)
{
var webException = exc.InnerException as System.Net.WebException;
if (webException != null)
{
throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException);
}
throw;
}
}
#endregion
internal partial class CmdletContext : ExecutorContext
{
public System.String ConnectorId { get; set; }
public System.String LocalDirectoryPath { get; set; }
public System.String RemoteDirectoryPath { get; set; }
public List RetrieveFilePath { get; set; }
public List SendFilePath { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.TransferId;
}
}
}