/*******************************************************************************
* 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.MigrationHubStrategyRecommendations;
using Amazon.MigrationHubStrategyRecommendations.Model;
namespace Amazon.PowerShell.Cmdlets.MHS
{
///
/// Starts a file import.
///
[Cmdlet("Start", "MHSImportFileTask", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the Migration Hub Strategy Recommendations StartImportFileTask API operation.", Operation = new[] {"StartImportFileTask"}, SelectReturnType = typeof(Amazon.MigrationHubStrategyRecommendations.Model.StartImportFileTaskResponse))]
[AWSCmdletOutput("System.String or Amazon.MigrationHubStrategyRecommendations.Model.StartImportFileTaskResponse",
"This cmdlet returns a System.String object.",
"The service call response (type Amazon.MigrationHubStrategyRecommendations.Model.StartImportFileTaskResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class StartMHSImportFileTaskCmdlet : AmazonMigrationHubStrategyRecommendationsClientCmdlet, IExecutor
{
#region Parameter DataSourceType
///
///
/// Specifies the source that the servers are coming from. By default, Strategy Recommendations
/// assumes that the servers specified in the import file are available in AWS Application
/// Discovery Service.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.MigrationHubStrategyRecommendations.DataSourceType")]
public Amazon.MigrationHubStrategyRecommendations.DataSourceType DataSourceType { get; set; }
#endregion
#region Parameter GroupId
///
///
/// Groups the resources in the import file together with a unique name. This ID can be
/// as filter in ListApplicationComponents
and ListServers
.
///
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public Amazon.MigrationHubStrategyRecommendations.Model.Group[] GroupId { get; set; }
#endregion
#region Parameter Name
///
///
/// A descriptive name for the request.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String Name { get; set; }
#endregion
#region Parameter S3Bucket
///
///
/// The S3 bucket where the import file is located. The bucket name is required to begin
/// with migrationhub-strategy-
.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String S3Bucket { get; set; }
#endregion
#region Parameter S3bucketForReportData
///
///
/// The S3 bucket where Strategy Recommendations uploads import results. The bucket name
/// is required to begin with migrationhub-strategy-.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String S3bucketForReportData { get; set; }
#endregion
#region Parameter S3key
///
///
/// The Amazon S3 key name of the import file.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String S3key { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'Id'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MigrationHubStrategyRecommendations.Model.StartImportFileTaskResponse).
/// Specifying the name of a property of type Amazon.MigrationHubStrategyRecommendations.Model.StartImportFileTaskResponse 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; } = "Id";
#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.Name), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Start-MHSImportFileTask (StartImportFileTask)"))
{
return;
}
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
}
context.DataSourceType = this.DataSourceType;
if (this.GroupId != null)
{
context.GroupId = new List(this.GroupId);
}
context.Name = this.Name;
#if MODULAR
if (this.Name == null && ParameterWasBound(nameof(this.Name)))
{
WriteWarning("You are passing $null as a value for parameter Name 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.S3Bucket = this.S3Bucket;
#if MODULAR
if (this.S3Bucket == null && ParameterWasBound(nameof(this.S3Bucket)))
{
WriteWarning("You are passing $null as a value for parameter S3Bucket 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.S3bucketForReportData = this.S3bucketForReportData;
context.S3key = this.S3key;
#if MODULAR
if (this.S3key == null && ParameterWasBound(nameof(this.S3key)))
{
WriteWarning("You are passing $null as a value for parameter S3key 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
// 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.MigrationHubStrategyRecommendations.Model.StartImportFileTaskRequest();
if (cmdletContext.DataSourceType != null)
{
request.DataSourceType = cmdletContext.DataSourceType;
}
if (cmdletContext.GroupId != null)
{
request.GroupId = cmdletContext.GroupId;
}
if (cmdletContext.Name != null)
{
request.Name = cmdletContext.Name;
}
if (cmdletContext.S3Bucket != null)
{
request.S3Bucket = cmdletContext.S3Bucket;
}
if (cmdletContext.S3bucketForReportData != null)
{
request.S3bucketForReportData = cmdletContext.S3bucketForReportData;
}
if (cmdletContext.S3key != null)
{
request.S3key = cmdletContext.S3key;
}
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.MigrationHubStrategyRecommendations.Model.StartImportFileTaskResponse CallAWSServiceOperation(IAmazonMigrationHubStrategyRecommendations client, Amazon.MigrationHubStrategyRecommendations.Model.StartImportFileTaskRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Migration Hub Strategy Recommendations", "StartImportFileTask");
try
{
#if DESKTOP
return client.StartImportFileTask(request);
#elif CORECLR
return client.StartImportFileTaskAsync(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 Amazon.MigrationHubStrategyRecommendations.DataSourceType DataSourceType { get; set; }
public List GroupId { get; set; }
public System.String Name { get; set; }
public System.String S3Bucket { get; set; }
public System.String S3bucketForReportData { get; set; }
public System.String S3key { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.Id;
}
}
}