/******************************************************************************* * 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.PinpointEmail; using Amazon.PinpointEmail.Model; namespace Amazon.PowerShell.Cmdlets.PINE { /// /// Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When /// you enable the Deliverability dashboard, you gain access to reputation, deliverability, /// and other metrics for the domains that you use to send email using Amazon Pinpoint. /// You also gain the ability to perform predictive inbox placement tests. /// /// /// /// When you use the Deliverability dashboard, you pay a monthly subscription charge, /// in addition to any other fees that you accrue by using Amazon Pinpoint. For more information /// about the features and cost of a Deliverability dashboard subscription, see Amazon /// Pinpoint Pricing. /// /// [Cmdlet("Write", "PINEDeliverabilityDashboardOption", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("None")] [AWSCmdlet("Calls the Amazon Pinpoint Email PutDeliverabilityDashboardOption API operation.", Operation = new[] {"PutDeliverabilityDashboardOption"}, SelectReturnType = typeof(Amazon.PinpointEmail.Model.PutDeliverabilityDashboardOptionResponse))] [AWSCmdletOutput("None or Amazon.PinpointEmail.Model.PutDeliverabilityDashboardOptionResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.PinpointEmail.Model.PutDeliverabilityDashboardOptionResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class WritePINEDeliverabilityDashboardOptionCmdlet : AmazonPinpointEmailClientCmdlet, IExecutor { #region Parameter DashboardEnabled /// /// /// Specifies whether to enable the Deliverability dashboard for your Amazon Pinpoint /// account. To enable the dashboard, set this value to true. /// /// #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.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.Boolean? DashboardEnabled { get; set; } #endregion #region Parameter SubscribedDomain /// /// /// An array of objects, one for each verified domain that you use to send email and enabled /// the Deliverability dashboard for. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("SubscribedDomains")] public Amazon.PinpointEmail.Model.DomainDeliverabilityTrackingOption[] SubscribedDomain { 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.PinpointEmail.Model.PutDeliverabilityDashboardOptionResponse). /// 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 DashboardEnabled parameter. /// The -PassThru parameter is deprecated, use -Select '^DashboardEnabled' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^DashboardEnabled' 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.DashboardEnabled), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Write-PINEDeliverabilityDashboardOption (PutDeliverabilityDashboardOption)")) { 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.DashboardEnabled; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.DashboardEnabled = this.DashboardEnabled; #if MODULAR if (this.DashboardEnabled == null && ParameterWasBound(nameof(this.DashboardEnabled))) { WriteWarning("You are passing $null as a value for parameter DashboardEnabled 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 if (this.SubscribedDomain != null) { context.SubscribedDomain = new List(this.SubscribedDomain); } // 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.PinpointEmail.Model.PutDeliverabilityDashboardOptionRequest(); if (cmdletContext.DashboardEnabled != null) { request.DashboardEnabled = cmdletContext.DashboardEnabled.Value; } if (cmdletContext.SubscribedDomain != null) { request.SubscribedDomains = cmdletContext.SubscribedDomain; } 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.PinpointEmail.Model.PutDeliverabilityDashboardOptionResponse CallAWSServiceOperation(IAmazonPinpointEmail client, Amazon.PinpointEmail.Model.PutDeliverabilityDashboardOptionRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Pinpoint Email", "PutDeliverabilityDashboardOption"); try { #if DESKTOP return client.PutDeliverabilityDashboardOption(request); #elif CORECLR return client.PutDeliverabilityDashboardOptionAsync(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? DashboardEnabled { get; set; } public List SubscribedDomain { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => null; } } }