/******************************************************************************* * 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.WorkSpaces; using Amazon.WorkSpaces.Model; namespace Amazon.PowerShell.Cmdlets.WKS { /// /// Terminates the specified WorkSpaces. /// /// /// Terminating a WorkSpace is a permanent action and cannot be undone. The user's data /// is destroyed. If you need to archive any user data, contact Amazon Web Services Support /// before terminating the WorkSpace. /// /// You can terminate a WorkSpace that is in any state except SUSPENDED. /// /// This operation is asynchronous and returns before the WorkSpaces have been completely /// terminated. After a WorkSpace is terminated, the TERMINATED state is /// returned only briefly before the WorkSpace directory metadata is cleaned up, so this /// state is rarely returned. To confirm that a WorkSpace is terminated, check for the /// WorkSpace ID by using /// DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has /// been successfully terminated. /// /// Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. /// If there are no WorkSpaces being used with your Simple AD or AD Connector directory /// for 30 consecutive days, this directory will be automatically deregistered for use /// with Amazon WorkSpaces, and you will be charged for this directory as per the Directory /// Service pricing terms. /// /// To delete empty directories, see /// Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector /// directory, you can always create a new one when you want to start using WorkSpaces /// again. /// /// [Cmdlet("Remove", "WKSWorkspace", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.High, DefaultParameterSetName="IdFromRequestObject")] [OutputType("Amazon.WorkSpaces.Model.FailedWorkspaceChangeRequest")] [AWSCmdlet("Calls the Amazon WorkSpaces TerminateWorkspaces API operation.", Operation = new[] {"TerminateWorkspaces"}, SelectReturnType = typeof(Amazon.WorkSpaces.Model.TerminateWorkspacesResponse))] [AWSCmdletOutput("Amazon.WorkSpaces.Model.FailedWorkspaceChangeRequest or Amazon.WorkSpaces.Model.TerminateWorkspacesResponse", "This cmdlet returns a collection of Amazon.WorkSpaces.Model.FailedWorkspaceChangeRequest objects.", "The service call response (type Amazon.WorkSpaces.Model.TerminateWorkspacesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class RemoveWKSWorkspaceCmdlet : AmazonWorkSpacesClientCmdlet, IExecutor { #region Parameter Request /// /// /// The WorkSpaces to terminate. You can specify up to 25 WorkSpaces. /// /// [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true, ParameterSetName = "IdFromRequestObject")] [Alias("TerminateWorkspaceRequest","TerminateWorkspaceRequests")] public Amazon.WorkSpaces.Model.TerminateRequest[] Request { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'FailedRequests'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkSpaces.Model.TerminateWorkspacesResponse). /// Specifying the name of a property of type Amazon.WorkSpaces.Model.TerminateWorkspacesResponse 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; } = "FailedRequests"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the Request parameter. /// The -PassThru parameter is deprecated, use -Select '^Request' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Request' 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 = string.Empty; if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Remove-WKSWorkspace (TerminateWorkspaces)")) { 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.Request; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute if (this.Request != null) { context.Request = new List(this.Request); } #if MODULAR if (this.Request == null && ParameterWasBound(nameof(this.Request))) { WriteWarning("You are passing $null as a value for parameter Request 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.WorkSpaces.Model.TerminateWorkspacesRequest(); if (cmdletContext.Request != null) { request.TerminateWorkspaceRequests = cmdletContext.Request; } 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.WorkSpaces.Model.TerminateWorkspacesResponse CallAWSServiceOperation(IAmazonWorkSpaces client, Amazon.WorkSpaces.Model.TerminateWorkspacesRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon WorkSpaces", "TerminateWorkspaces"); try { #if DESKTOP return client.TerminateWorkspaces(request); #elif CORECLR return client.TerminateWorkspacesAsync(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 List Request { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.FailedRequests; } } }