/******************************************************************************* * 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 { /// /// Creates a lifecycle configuration that you can associate with a notebook instance. /// A lifecycle configuration is a collection of shell scripts that run when you /// create or start a notebook instance. /// /// /// /// Each lifecycle configuration script has a limit of 16384 characters. /// /// The value of the $PATH environment variable that is available to both /// scripts is /sbin:bin:/usr/sbin:/usr/bin. /// /// View CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances /// in log stream [notebook-instance-name]/[LifecycleConfigHook]. /// /// Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script /// runs for longer than 5 minutes, it fails and the notebook instance is not created /// or started. /// /// For information about notebook instance lifestyle configurations, see Step /// 2.1: (Optional) Customize a Notebook Instance. /// /// [Cmdlet("New", "SMNotebookInstanceLifecycleConfig", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("System.String")] [AWSCmdlet("Calls the Amazon SageMaker Service CreateNotebookInstanceLifecycleConfig API operation.", Operation = new[] {"CreateNotebookInstanceLifecycleConfig"}, SelectReturnType = typeof(Amazon.SageMaker.Model.CreateNotebookInstanceLifecycleConfigResponse))] [AWSCmdletOutput("System.String or Amazon.SageMaker.Model.CreateNotebookInstanceLifecycleConfigResponse", "This cmdlet returns a System.String object.", "The service call response (type Amazon.SageMaker.Model.CreateNotebookInstanceLifecycleConfigResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewSMNotebookInstanceLifecycleConfigCmdlet : AmazonSageMakerClientCmdlet, IExecutor { #region Parameter NotebookInstanceLifecycleConfigName /// /// /// The name of the lifecycle configuration. /// /// #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 NotebookInstanceLifecycleConfigName { get; set; } #endregion #region Parameter OnCreate /// /// /// A shell script that runs only once, when you create a notebook instance. The shell /// script must be a base64-encoded string. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public Amazon.SageMaker.Model.NotebookInstanceLifecycleHook[] OnCreate { get; set; } #endregion #region Parameter OnStart /// /// /// A shell script that runs every time you start a notebook instance, including when /// you create the notebook instance. The shell script must be a base64-encoded string. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public Amazon.SageMaker.Model.NotebookInstanceLifecycleHook[] OnStart { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'NotebookInstanceLifecycleConfigArn'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateNotebookInstanceLifecycleConfigResponse). /// Specifying the name of a property of type Amazon.SageMaker.Model.CreateNotebookInstanceLifecycleConfigResponse 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; } = "NotebookInstanceLifecycleConfigArn"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the NotebookInstanceLifecycleConfigName parameter. /// The -PassThru parameter is deprecated, use -Select '^NotebookInstanceLifecycleConfigName' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^NotebookInstanceLifecycleConfigName' 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.NotebookInstanceLifecycleConfigName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-SMNotebookInstanceLifecycleConfig (CreateNotebookInstanceLifecycleConfig)")) { 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.NotebookInstanceLifecycleConfigName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.NotebookInstanceLifecycleConfigName = this.NotebookInstanceLifecycleConfigName; #if MODULAR if (this.NotebookInstanceLifecycleConfigName == null && ParameterWasBound(nameof(this.NotebookInstanceLifecycleConfigName))) { WriteWarning("You are passing $null as a value for parameter NotebookInstanceLifecycleConfigName 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.OnCreate != null) { context.OnCreate = new List(this.OnCreate); } if (this.OnStart != null) { context.OnStart = new List(this.OnStart); } // 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.CreateNotebookInstanceLifecycleConfigRequest(); if (cmdletContext.NotebookInstanceLifecycleConfigName != null) { request.NotebookInstanceLifecycleConfigName = cmdletContext.NotebookInstanceLifecycleConfigName; } if (cmdletContext.OnCreate != null) { request.OnCreate = cmdletContext.OnCreate; } if (cmdletContext.OnStart != null) { request.OnStart = cmdletContext.OnStart; } 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.CreateNotebookInstanceLifecycleConfigResponse CallAWSServiceOperation(IAmazonSageMaker client, Amazon.SageMaker.Model.CreateNotebookInstanceLifecycleConfigRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon SageMaker Service", "CreateNotebookInstanceLifecycleConfig"); try { #if DESKTOP return client.CreateNotebookInstanceLifecycleConfig(request); #elif CORECLR return client.CreateNotebookInstanceLifecycleConfigAsync(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 NotebookInstanceLifecycleConfigName { get; set; } public List OnCreate { get; set; } public List OnStart { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.NotebookInstanceLifecycleConfigArn; } } }