/******************************************************************************* * 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 { /// /// The UpdateNotificationSettings operation creates, updates, disables /// or re-enables notifications for a HIT type. If you call the UpdateNotificationSettings /// operation for a HIT type that already has a notification specification, the operation /// replaces the old specification with a new one. You can call the UpdateNotificationSettings /// operation to enable or disable notifications for the HIT type, without having to modify /// the notification specification itself by providing updates to the Active status without /// specifying a new notification specification. To change the Active status of a HIT /// type's notifications, the HIT type must already have a notification specification, /// or one must be provided in the same call to UpdateNotificationSettings. /// [Cmdlet("Update", "MTRNotificationSetting", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("None")] [AWSCmdlet("Calls the Amazon MTurk Service UpdateNotificationSettings API operation.", Operation = new[] {"UpdateNotificationSettings"}, SelectReturnType = typeof(Amazon.MTurk.Model.UpdateNotificationSettingsResponse))] [AWSCmdletOutput("None or Amazon.MTurk.Model.UpdateNotificationSettingsResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.MTurk.Model.UpdateNotificationSettingsResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class UpdateMTRNotificationSettingCmdlet : AmazonMTurkClientCmdlet, IExecutor { #region Parameter Active /// /// /// Specifies whether notifications are sent for HITs of this HIT type, according to /// the notification specification. You must specify either the Notification parameter /// or the Active parameter for the call to UpdateNotificationSettings to succeed. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? Active { get; set; } #endregion #region Parameter Notification_Destination /// /// /// The target for notification messages. The Destination’s format is determined by the /// specified Transport: /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Notification_Destination { get; set; } #endregion #region Parameter Notification_EventType /// /// /// The list of events that should cause notifications to be sent. Valid Values: AssignmentAccepted /// | AssignmentAbandoned | AssignmentReturned | AssignmentSubmitted | AssignmentRejected /// | AssignmentApproved | HITCreated | HITExtended | HITDisposed | HITReviewable | HITExpired /// | Ping. The Ping event is only valid for the SendTestEventNotification operation. /// /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Notification_EventTypes")] public System.String[] Notification_EventType { get; set; } #endregion #region Parameter HITTypeId /// /// /// The ID of the HIT type whose notification specification is being updated. /// /// #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 HITTypeId { get; set; } #endregion #region Parameter Notification_Transport /// /// /// The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email /// | SQS | SNS. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.MTurk.NotificationTransport")] public Amazon.MTurk.NotificationTransport Notification_Transport { get; set; } #endregion #region Parameter Notification_Version /// /// /// The version of the Notification API to use. Valid value is 2006-05-05. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Notification_Version { 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.MTurk.Model.UpdateNotificationSettingsResponse). /// 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 HITTypeId parameter. /// The -PassThru parameter is deprecated, use -Select '^HITTypeId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^HITTypeId' 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.HITTypeId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-MTRNotificationSetting (UpdateNotificationSettings)")) { 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.HITTypeId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.Active = this.Active; context.HITTypeId = this.HITTypeId; #if MODULAR if (this.HITTypeId == null && ParameterWasBound(nameof(this.HITTypeId))) { WriteWarning("You are passing $null as a value for parameter HITTypeId 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.Notification_Destination = this.Notification_Destination; if (this.Notification_EventType != null) { context.Notification_EventType = new List(this.Notification_EventType); } context.Notification_Transport = this.Notification_Transport; context.Notification_Version = this.Notification_Version; // 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.UpdateNotificationSettingsRequest(); if (cmdletContext.Active != null) { request.Active = cmdletContext.Active.Value; } if (cmdletContext.HITTypeId != null) { request.HITTypeId = cmdletContext.HITTypeId; } // populate Notification var requestNotificationIsNull = true; request.Notification = new Amazon.MTurk.Model.NotificationSpecification(); System.String requestNotification_notification_Destination = null; if (cmdletContext.Notification_Destination != null) { requestNotification_notification_Destination = cmdletContext.Notification_Destination; } if (requestNotification_notification_Destination != null) { request.Notification.Destination = requestNotification_notification_Destination; requestNotificationIsNull = false; } List requestNotification_notification_EventType = null; if (cmdletContext.Notification_EventType != null) { requestNotification_notification_EventType = cmdletContext.Notification_EventType; } if (requestNotification_notification_EventType != null) { request.Notification.EventTypes = requestNotification_notification_EventType; requestNotificationIsNull = false; } Amazon.MTurk.NotificationTransport requestNotification_notification_Transport = null; if (cmdletContext.Notification_Transport != null) { requestNotification_notification_Transport = cmdletContext.Notification_Transport; } if (requestNotification_notification_Transport != null) { request.Notification.Transport = requestNotification_notification_Transport; requestNotificationIsNull = false; } System.String requestNotification_notification_Version = null; if (cmdletContext.Notification_Version != null) { requestNotification_notification_Version = cmdletContext.Notification_Version; } if (requestNotification_notification_Version != null) { request.Notification.Version = requestNotification_notification_Version; requestNotificationIsNull = false; } // determine if request.Notification should be set to null if (requestNotificationIsNull) { request.Notification = null; } 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.UpdateNotificationSettingsResponse CallAWSServiceOperation(IAmazonMTurk client, Amazon.MTurk.Model.UpdateNotificationSettingsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon MTurk Service", "UpdateNotificationSettings"); try { #if DESKTOP return client.UpdateNotificationSettings(request); #elif CORECLR return client.UpdateNotificationSettingsAsync(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? Active { get; set; } public System.String HITTypeId { get; set; } public System.String Notification_Destination { get; set; } public List Notification_EventType { get; set; } public Amazon.MTurk.NotificationTransport Notification_Transport { get; set; } public System.String Notification_Version { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => null; } } }