/******************************************************************************* * 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.IoT; using Amazon.IoT.Model; namespace Amazon.PowerShell.Cmdlets.IOT { /// /// Deletes a job and its related job executions. /// /// /// /// Deleting a job may take time, depending on the number of job executions created for /// the job and various other factors. While the job is being deleted, the status of the /// job will be shown as "DELETION_IN_PROGRESS". Attempting to delete or cancel a job /// whose status is already "DELETION_IN_PROGRESS" will result in an error. /// /// Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException /// will occur. /// /// Requires permission to access the DeleteJob /// action. /// /// [Cmdlet("Remove", "IOTJob", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.High)] [OutputType("None")] [AWSCmdlet("Calls the AWS IoT DeleteJob API operation.", Operation = new[] {"DeleteJob"}, SelectReturnType = typeof(Amazon.IoT.Model.DeleteJobResponse))] [AWSCmdletOutput("None or Amazon.IoT.Model.DeleteJobResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.IoT.Model.DeleteJobResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class RemoveIOTJobCmdlet : AmazonIoTClientCmdlet, IExecutor { #region Parameter Enforce /// /// /// (Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you /// can only delete a job which is in a terminal state ("COMPLETED" or "CANCELED") or /// an exception will occur. The default is false.Deleting a job which is "IN_PROGRESS", will cause a device which is executing the /// job to be unable to access job information or update the job execution status. Use /// caution and ensure that each device executing a job which is deleted is able to recover /// to a valid state. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? Enforce { get; set; } #endregion #region Parameter JobId /// /// /// The ID of the job to be deleted.After a job deletion is completed, you may reuse this jobId when you create a new /// job. However, this is not recommended, and you must ensure that your devices are not /// using the jobId to refer to the deleted 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 JobId { get; set; } #endregion #region Parameter NamespaceId /// /// /// The namespace used to indicate that a job is a customer-managed job.When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs /// notifications to MQTT topics that contain the value in the following format.$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/The namespaceId feature is in public preview. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String NamespaceId { 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.IoT.Model.DeleteJobResponse). /// 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 JobId parameter. /// The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. /// [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 #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.JobId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Remove-IOTJob (DeleteJob)")) { 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.JobId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.Enforce = this.Enforce; context.JobId = 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.NamespaceId = this.NamespaceId; // 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.IoT.Model.DeleteJobRequest(); if (cmdletContext.Enforce != null) { request.Force = cmdletContext.Enforce.Value; } if (cmdletContext.JobId != null) { request.JobId = cmdletContext.JobId; } if (cmdletContext.NamespaceId != null) { request.NamespaceId = cmdletContext.NamespaceId; } 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.IoT.Model.DeleteJobResponse CallAWSServiceOperation(IAmazonIoT client, Amazon.IoT.Model.DeleteJobRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS IoT", "DeleteJob"); try { #if DESKTOP return client.DeleteJob(request); #elif CORECLR return client.DeleteJobAsync(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.Boolean? Enforce { get; set; } public System.String JobId { get; set; } public System.String NamespaceId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => null; } } }