/******************************************************************************* * 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.MTurk; using Amazon.MTurk.Model; namespace Amazon.PowerShell.Cmdlets.MTR { /// <summary> /// The <code>RejectAssignment</code> operation rejects the results of a completed assignment. /// /// /// /// <para> /// You can include an optional feedback message with the rejection, which the Worker /// can see in the Status section of the web site. When you include a feedback message /// with the rejection, it helps the Worker understand why the assignment was rejected, /// and can improve the quality of the results the Worker submits in the future. /// </para><para> /// Only the Requester who created the HIT can reject an assignment for the HIT. /// </para> /// </summary> [Cmdlet("Deny", "MTRAssignment", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("None")] [AWSCmdlet("Calls the Amazon MTurk Service RejectAssignment API operation.", Operation = new[] {"RejectAssignment"}, SelectReturnType = typeof(Amazon.MTurk.Model.RejectAssignmentResponse))] [AWSCmdletOutput("None or Amazon.MTurk.Model.RejectAssignmentResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.MTurk.Model.RejectAssignmentResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class DenyMTRAssignmentCmdlet : AmazonMTurkClientCmdlet, IExecutor { #region Parameter AssignmentId /// <summary> /// <para> /// <para> The ID of the assignment. The assignment must correspond to a HIT created by the /// Requester. </para> /// </para> /// </summary> #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 AssignmentId { get; set; } #endregion #region Parameter RequesterFeedback /// <summary> /// <para> /// <para> A message for the Worker, which the Worker can see in the Status section of the web /// site. </para> /// </para> /// </summary> #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 RequesterFeedback { get; set; } #endregion #region Parameter Select /// <summary> /// 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.MTurk.Model.RejectAssignmentResponse). /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public string Select { get; set; } = "*"; #endregion #region Parameter PassThru /// <summary> /// Changes the cmdlet behavior to return the value passed to the AssignmentId parameter. /// The -PassThru parameter is deprecated, use -Select '^AssignmentId' instead. This parameter will be removed in a future version. /// </summary> [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^AssignmentId' 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 /// <summary> /// This parameter overrides confirmation prompts to force /// the cmdlet to continue its operation. This parameter should always /// be used with caution. /// </summary> [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.AssignmentId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Deny-MTRAssignment (RejectAssignment)")) { 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<Amazon.MTurk.Model.RejectAssignmentResponse, DenyMTRAssignmentCmdlet>(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.AssignmentId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AssignmentId = this.AssignmentId; #if MODULAR if (this.AssignmentId == null && ParameterWasBound(nameof(this.AssignmentId))) { WriteWarning("You are passing $null as a value for parameter AssignmentId 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.RequesterFeedback = this.RequesterFeedback; #if MODULAR if (this.RequesterFeedback == null && ParameterWasBound(nameof(this.RequesterFeedback))) { WriteWarning("You are passing $null as a value for parameter RequesterFeedback 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.MTurk.Model.RejectAssignmentRequest(); if (cmdletContext.AssignmentId != null) { request.AssignmentId = cmdletContext.AssignmentId; } if (cmdletContext.RequesterFeedback != null) { request.RequesterFeedback = cmdletContext.RequesterFeedback; } 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.MTurk.Model.RejectAssignmentResponse CallAWSServiceOperation(IAmazonMTurk client, Amazon.MTurk.Model.RejectAssignmentRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon MTurk Service", "RejectAssignment"); try { #if DESKTOP return client.RejectAssignment(request); #elif CORECLR return client.RejectAssignmentAsync(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 AssignmentId { get; set; } public System.String RequesterFeedback { get; set; } public System.Func<Amazon.MTurk.Model.RejectAssignmentResponse, DenyMTRAssignmentCmdlet, object> Select { get; set; } = (response, cmdlet) => null; } } }