/******************************************************************************* * 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.DataPipeline; using Amazon.DataPipeline.Model; namespace Amazon.PowerShell.Cmdlets.DP { /// /// Requests that the status of the specified physical or logical pipeline objects be /// updated in the specified pipeline. This update might not occur immediately, but is /// eventually consistent. The status that can be set depends on the type of object (for /// example, DataNode or Activity). You cannot perform this operation on FINISHED /// pipelines and attempting to do so returns InvalidRequestException. /// [Cmdlet("Set", "DPStatus", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("None")] [AWSCmdlet("Calls the AWS Data Pipeline SetStatus API operation.", Operation = new[] {"SetStatus"}, SelectReturnType = typeof(Amazon.DataPipeline.Model.SetStatusResponse))] [AWSCmdletOutput("None or Amazon.DataPipeline.Model.SetStatusResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.DataPipeline.Model.SetStatusResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class SetDPStatusCmdlet : AmazonDataPipelineClientCmdlet, IExecutor { #region Parameter ObjectId /// /// /// The IDs of the objects. The corresponding objects can be either physical or components, /// but not a mix of both types. /// /// #if !MODULAR [System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyCollection] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [Alias("ObjectIds")] public System.String[] ObjectId { get; set; } #endregion #region Parameter PipelineId /// /// /// The ID of the pipeline that contains the objects. /// /// #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 PipelineId { get; set; } #endregion #region Parameter Status /// /// /// The status to be set on all the objects specified in objectIds. For components, /// use PAUSE or RESUME. For instances, use TRY_CANCEL, /// RERUN, or MARK_FINISHED. /// /// #if !MODULAR [System.Management.Automation.Parameter(Position = 2, ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(Position = 2, ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String Status { 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.DataPipeline.Model.SetStatusResponse). /// 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 /// /// Returns the object ids /// The -PassThru parameter is deprecated, use -Select instead. This parameter will be removed in future /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select 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.PipelineId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Set-DPStatus (SetStatus)")) { 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) => context.ObjectId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute if (this.ObjectId != null) { context.ObjectId = new List(this.ObjectId); } #if MODULAR if (this.ObjectId == null && ParameterWasBound(nameof(this.ObjectId))) { WriteWarning("You are passing $null as a value for parameter ObjectId 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.PipelineId = this.PipelineId; #if MODULAR if (this.PipelineId == null && ParameterWasBound(nameof(this.PipelineId))) { WriteWarning("You are passing $null as a value for parameter PipelineId 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.Status = this.Status; #if MODULAR if (this.Status == null && ParameterWasBound(nameof(this.Status))) { WriteWarning("You are passing $null as a value for parameter Status 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.DataPipeline.Model.SetStatusRequest(); if (cmdletContext.ObjectId != null) { request.ObjectIds = cmdletContext.ObjectId; } if (cmdletContext.PipelineId != null) { request.PipelineId = cmdletContext.PipelineId; } if (cmdletContext.Status != null) { request.Status = cmdletContext.Status; } 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.DataPipeline.Model.SetStatusResponse CallAWSServiceOperation(IAmazonDataPipeline client, Amazon.DataPipeline.Model.SetStatusRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Data Pipeline", "SetStatus"); try { #if DESKTOP return client.SetStatus(request); #elif CORECLR return client.SetStatusAsync(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 ObjectId { get; set; } public System.String PipelineId { get; set; } public System.String Status { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => null; } } }