/*******************************************************************************
* 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.ImportExport;
using Amazon.ImportExport.Model;
namespace Amazon.PowerShell.Cmdlets.IE
{
/// <summary>
/// This operation generates a pre-paid UPS shipping label that you will use to ship your
/// device to AWS for processing.
/// </summary>
[Cmdlet("Get", "IEShippingLabel")]
[OutputType("Amazon.ImportExport.Model.GetShippingLabelResponse")]
[AWSCmdlet("Calls the AWS Import/Export GetShippingLabel API operation.", Operation = new[] {"GetShippingLabel"}, SelectReturnType = typeof(Amazon.ImportExport.Model.GetShippingLabelResponse))]
[AWSCmdletOutput("Amazon.ImportExport.Model.GetShippingLabelResponse",
"This cmdlet returns an Amazon.ImportExport.Model.GetShippingLabelResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetIEShippingLabelCmdlet : AmazonImportExportClientCmdlet, IExecutor
{
#region Parameter APIVersion
/// <summary>
/// <para>
/// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String APIVersion { get; set; }
#endregion
#region Parameter City
/// <summary>
/// <para>
/// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String City { get; set; }
#endregion
#region Parameter Company
/// <summary>
/// <para>
/// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Company { get; set; }
#endregion
#region Parameter Country
/// <summary>
/// <para>
/// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Country { get; set; }
#endregion
#region Parameter JobId
/// <summary>
/// <para>
/// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
/// </para>
/// </summary>
#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.AllowEmptyCollection]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
[Alias("JobIds")]
public System.String[] JobId { get; set; }
#endregion
#region Parameter Name
/// <summary>
/// <para>
/// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Name { get; set; }
#endregion
#region Parameter PhoneNumber
/// <summary>
/// <para>
/// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String PhoneNumber { get; set; }
#endregion
#region Parameter PostalCode
/// <summary>
/// <para>
/// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String PostalCode { get; set; }
#endregion
#region Parameter StateOrProvince
/// <summary>
/// <para>
/// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String StateOrProvince { get; set; }
#endregion
#region Parameter Street1
/// <summary>
/// <para>
/// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Street1 { get; set; }
#endregion
#region Parameter Street2
/// <summary>
/// <para>
/// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Street2 { get; set; }
#endregion
#region Parameter Street3
/// <summary>
/// <para>
/// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Street3 { get; set; }
#endregion
#region Parameter Select
/// <summary>
/// Use the -Select parameter to control the cmdlet output. The default value is '*'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ImportExport.Model.GetShippingLabelResponse).
/// Specifying the name of a property of type Amazon.ImportExport.Model.GetShippingLabelResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "*";
#endregion
#region Parameter PassThru
/// <summary>
/// Changes the cmdlet behavior to return the value passed to the JobId parameter.
/// The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version.
/// </summary>
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v2";
base.ProcessRecord();
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<Amazon.ImportExport.Model.GetShippingLabelResponse, GetIEShippingLabelCmdlet>(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.JobId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.APIVersion = this.APIVersion;
context.City = this.City;
context.Company = this.Company;
context.Country = this.Country;
if (this.JobId != null)
{
context.JobId = new List<System.String>(this.JobId);
}
#if MODULAR
if (this.JobId == null && ParameterWasBound(nameof(this.JobId)))
{
WriteWarning("You are passing $null as a value for parameter JobId 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.Name = this.Name;
context.PhoneNumber = this.PhoneNumber;
context.PostalCode = this.PostalCode;
context.StateOrProvince = this.StateOrProvince;
context.Street1 = this.Street1;
context.Street2 = this.Street2;
context.Street3 = this.Street3;
// 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.ImportExport.Model.GetShippingLabelRequest();
if (cmdletContext.APIVersion != null)
{
request.APIVersion = cmdletContext.APIVersion;
}
if (cmdletContext.City != null)
{
request.City = cmdletContext.City;
}
if (cmdletContext.Company != null)
{
request.Company = cmdletContext.Company;
}
if (cmdletContext.Country != null)
{
request.Country = cmdletContext.Country;
}
if (cmdletContext.JobId != null)
{
request.JobIds = cmdletContext.JobId;
}
if (cmdletContext.Name != null)
{
request.Name = cmdletContext.Name;
}
if (cmdletContext.PhoneNumber != null)
{
request.PhoneNumber = cmdletContext.PhoneNumber;
}
if (cmdletContext.PostalCode != null)
{
request.PostalCode = cmdletContext.PostalCode;
}
if (cmdletContext.StateOrProvince != null)
{
request.StateOrProvince = cmdletContext.StateOrProvince;
}
if (cmdletContext.Street1 != null)
{
request.Street1 = cmdletContext.Street1;
}
if (cmdletContext.Street2 != null)
{
request.Street2 = cmdletContext.Street2;
}
if (cmdletContext.Street3 != null)
{
request.Street3 = cmdletContext.Street3;
}
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.ImportExport.Model.GetShippingLabelResponse CallAWSServiceOperation(IAmazonImportExport client, Amazon.ImportExport.Model.GetShippingLabelRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Import/Export", "GetShippingLabel");
try
{
#if DESKTOP
return client.GetShippingLabel(request);
#elif CORECLR
return client.GetShippingLabelAsync(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 APIVersion { get; set; }
public System.String City { get; set; }
public System.String Company { get; set; }
public System.String Country { get; set; }
public List<System.String> JobId { get; set; }
public System.String Name { get; set; }
public System.String PhoneNumber { get; set; }
public System.String PostalCode { get; set; }
public System.String StateOrProvince { get; set; }
public System.String Street1 { get; set; }
public System.String Street2 { get; set; }
public System.String Street3 { get; set; }
public System.Func<Amazon.ImportExport.Model.GetShippingLabelResponse, GetIEShippingLabelCmdlet, object> Select { get; set; } =
(response, cmdlet) => response;
}
}
}