/*******************************************************************************
* 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.SageMaker;
using Amazon.SageMaker.Model;
namespace Amazon.PowerShell.Cmdlets.SM
{
///
/// Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model
/// artifacts from the Amazon Simple Storage Service bucket that you specify. After the
/// model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket
/// that you specify.
///
[Cmdlet("New", "SMEdgePackagingJob", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("None")]
[AWSCmdlet("Calls the Amazon SageMaker Service CreateEdgePackagingJob API operation.", Operation = new[] {"CreateEdgePackagingJob"}, SelectReturnType = typeof(Amazon.SageMaker.Model.CreateEdgePackagingJobResponse))]
[AWSCmdletOutput("None or Amazon.SageMaker.Model.CreateEdgePackagingJobResponse",
"This cmdlet does not generate any output." +
"The service response (type Amazon.SageMaker.Model.CreateEdgePackagingJobResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewSMEdgePackagingJobCmdlet : AmazonSageMakerClientCmdlet, IExecutor
{
#region Parameter CompilationJobName
///
///
/// The name of the SageMaker Neo compilation job that will be used to locate model artifacts
/// for packaging.
///
///
#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 CompilationJobName { get; set; }
#endregion
#region Parameter EdgePackagingJobName
///
///
/// The name of the edge packaging job.
///
///
#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 EdgePackagingJobName { get; set; }
#endregion
#region Parameter OutputConfig_KmsKeyId
///
///
/// The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that
/// Amazon SageMaker uses to encrypt data on the storage volume after compilation job.
/// If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon
/// S3 for your role's account.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String OutputConfig_KmsKeyId { get; set; }
#endregion
#region Parameter ModelName
///
///
/// The name of the model.
///
///
#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 ModelName { get; set; }
#endregion
#region Parameter ModelVersion
///
///
/// The version of the model.
///
///
#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 ModelVersion { get; set; }
#endregion
#region Parameter OutputConfig_PresetDeploymentConfig
///
///
/// The configuration used to create deployment artifacts. Specify configuration options
/// with a JSON string. The available configuration options for each type are:ComponentName
(optional) - Name of the GreenGrass V2 component. If not
/// specified, the default name generated consists of "SagemakerEdgeManager" and the name
/// of your SageMaker Edge Manager packaging job.ComponentDescription
(optional) - Description of the component.ComponentVersion
(optional) - The version of the component.Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic
/// versions follow a major.minor.patch number system. For example, version 1.0.0
/// represents the first major release for a component. For more information, see the
/// semantic version specification.PlatformOS
(optional) - The name of the operating system for the platform.
/// Supported platforms include Windows and Linux.PlatformArchitecture
(optional) - The processor architecture for the
/// platform. Supported architectures Windows include: Windows32_x86, Windows64_x64.Supported architectures for Linux include: Linux x86_64, Linux ARMV8.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String OutputConfig_PresetDeploymentConfig { get; set; }
#endregion
#region Parameter OutputConfig_PresetDeploymentType
///
///
/// The deployment type SageMaker Edge Manager will create. Currently only supports Amazon
/// Web Services IoT Greengrass Version 2 components.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.SageMaker.EdgePresetDeploymentType")]
public Amazon.SageMaker.EdgePresetDeploymentType OutputConfig_PresetDeploymentType { get; set; }
#endregion
#region Parameter ResourceKey
///
///
/// The Amazon Web Services KMS key to use when encrypting the EBS volume the edge packaging
/// job runs on.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ResourceKey { get; set; }
#endregion
#region Parameter RoleArn
///
///
/// The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download
/// and upload the model, and to contact SageMaker Neo.
///
///
#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 RoleArn { get; set; }
#endregion
#region Parameter OutputConfig_S3OutputLocation
///
///
/// The Amazon Simple Storage (S3) bucker URI.
///
///
#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 OutputConfig_S3OutputLocation { get; set; }
#endregion
#region Parameter Tag
///
///
/// Creates tags for the packaging job.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Tags")]
public Amazon.SageMaker.Model.Tag[] Tag { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateEdgePackagingJobResponse).
/// 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; } = "*";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the EdgePackagingJobName parameter.
/// The -PassThru parameter is deprecated, use -Select '^EdgePackagingJobName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^EdgePackagingJobName' 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.EdgePackagingJobName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-SMEdgePackagingJob (CreateEdgePackagingJob)"))
{
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.EdgePackagingJobName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.CompilationJobName = this.CompilationJobName;
#if MODULAR
if (this.CompilationJobName == null && ParameterWasBound(nameof(this.CompilationJobName)))
{
WriteWarning("You are passing $null as a value for parameter CompilationJobName 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.EdgePackagingJobName = this.EdgePackagingJobName;
#if MODULAR
if (this.EdgePackagingJobName == null && ParameterWasBound(nameof(this.EdgePackagingJobName)))
{
WriteWarning("You are passing $null as a value for parameter EdgePackagingJobName 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.ModelName = this.ModelName;
#if MODULAR
if (this.ModelName == null && ParameterWasBound(nameof(this.ModelName)))
{
WriteWarning("You are passing $null as a value for parameter ModelName 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.ModelVersion = this.ModelVersion;
#if MODULAR
if (this.ModelVersion == null && ParameterWasBound(nameof(this.ModelVersion)))
{
WriteWarning("You are passing $null as a value for parameter ModelVersion 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.OutputConfig_KmsKeyId = this.OutputConfig_KmsKeyId;
context.OutputConfig_PresetDeploymentConfig = this.OutputConfig_PresetDeploymentConfig;
context.OutputConfig_PresetDeploymentType = this.OutputConfig_PresetDeploymentType;
context.OutputConfig_S3OutputLocation = this.OutputConfig_S3OutputLocation;
#if MODULAR
if (this.OutputConfig_S3OutputLocation == null && ParameterWasBound(nameof(this.OutputConfig_S3OutputLocation)))
{
WriteWarning("You are passing $null as a value for parameter OutputConfig_S3OutputLocation 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.ResourceKey = this.ResourceKey;
context.RoleArn = this.RoleArn;
#if MODULAR
if (this.RoleArn == null && ParameterWasBound(nameof(this.RoleArn)))
{
WriteWarning("You are passing $null as a value for parameter RoleArn 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
if (this.Tag != null)
{
context.Tag = new List(this.Tag);
}
// 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.SageMaker.Model.CreateEdgePackagingJobRequest();
if (cmdletContext.CompilationJobName != null)
{
request.CompilationJobName = cmdletContext.CompilationJobName;
}
if (cmdletContext.EdgePackagingJobName != null)
{
request.EdgePackagingJobName = cmdletContext.EdgePackagingJobName;
}
if (cmdletContext.ModelName != null)
{
request.ModelName = cmdletContext.ModelName;
}
if (cmdletContext.ModelVersion != null)
{
request.ModelVersion = cmdletContext.ModelVersion;
}
// populate OutputConfig
var requestOutputConfigIsNull = true;
request.OutputConfig = new Amazon.SageMaker.Model.EdgeOutputConfig();
System.String requestOutputConfig_outputConfig_KmsKeyId = null;
if (cmdletContext.OutputConfig_KmsKeyId != null)
{
requestOutputConfig_outputConfig_KmsKeyId = cmdletContext.OutputConfig_KmsKeyId;
}
if (requestOutputConfig_outputConfig_KmsKeyId != null)
{
request.OutputConfig.KmsKeyId = requestOutputConfig_outputConfig_KmsKeyId;
requestOutputConfigIsNull = false;
}
System.String requestOutputConfig_outputConfig_PresetDeploymentConfig = null;
if (cmdletContext.OutputConfig_PresetDeploymentConfig != null)
{
requestOutputConfig_outputConfig_PresetDeploymentConfig = cmdletContext.OutputConfig_PresetDeploymentConfig;
}
if (requestOutputConfig_outputConfig_PresetDeploymentConfig != null)
{
request.OutputConfig.PresetDeploymentConfig = requestOutputConfig_outputConfig_PresetDeploymentConfig;
requestOutputConfigIsNull = false;
}
Amazon.SageMaker.EdgePresetDeploymentType requestOutputConfig_outputConfig_PresetDeploymentType = null;
if (cmdletContext.OutputConfig_PresetDeploymentType != null)
{
requestOutputConfig_outputConfig_PresetDeploymentType = cmdletContext.OutputConfig_PresetDeploymentType;
}
if (requestOutputConfig_outputConfig_PresetDeploymentType != null)
{
request.OutputConfig.PresetDeploymentType = requestOutputConfig_outputConfig_PresetDeploymentType;
requestOutputConfigIsNull = false;
}
System.String requestOutputConfig_outputConfig_S3OutputLocation = null;
if (cmdletContext.OutputConfig_S3OutputLocation != null)
{
requestOutputConfig_outputConfig_S3OutputLocation = cmdletContext.OutputConfig_S3OutputLocation;
}
if (requestOutputConfig_outputConfig_S3OutputLocation != null)
{
request.OutputConfig.S3OutputLocation = requestOutputConfig_outputConfig_S3OutputLocation;
requestOutputConfigIsNull = false;
}
// determine if request.OutputConfig should be set to null
if (requestOutputConfigIsNull)
{
request.OutputConfig = null;
}
if (cmdletContext.ResourceKey != null)
{
request.ResourceKey = cmdletContext.ResourceKey;
}
if (cmdletContext.RoleArn != null)
{
request.RoleArn = cmdletContext.RoleArn;
}
if (cmdletContext.Tag != null)
{
request.Tags = cmdletContext.Tag;
}
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.SageMaker.Model.CreateEdgePackagingJobResponse CallAWSServiceOperation(IAmazonSageMaker client, Amazon.SageMaker.Model.CreateEdgePackagingJobRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon SageMaker Service", "CreateEdgePackagingJob");
try
{
#if DESKTOP
return client.CreateEdgePackagingJob(request);
#elif CORECLR
return client.CreateEdgePackagingJobAsync(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 CompilationJobName { get; set; }
public System.String EdgePackagingJobName { get; set; }
public System.String ModelName { get; set; }
public System.String ModelVersion { get; set; }
public System.String OutputConfig_KmsKeyId { get; set; }
public System.String OutputConfig_PresetDeploymentConfig { get; set; }
public Amazon.SageMaker.EdgePresetDeploymentType OutputConfig_PresetDeploymentType { get; set; }
public System.String OutputConfig_S3OutputLocation { get; set; }
public System.String ResourceKey { get; set; }
public System.String RoleArn { get; set; }
public List Tag { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => null;
}
}
}