/******************************************************************************* * 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.WorkDocs; using Amazon.WorkDocs.Model; namespace Amazon.PowerShell.Cmdlets.WD { /// /// Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a /// confirmation message, and must confirm the subscription. /// /// /// /// For more information, see Setting /// up notifications for an IAM user or role in the Amazon WorkDocs Developer Guide. /// /// [Cmdlet("New", "WDNotificationSubscription", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.WorkDocs.Model.Subscription")] [AWSCmdlet("Calls the Amazon WorkDocs CreateNotificationSubscription API operation.", Operation = new[] {"CreateNotificationSubscription"}, SelectReturnType = typeof(Amazon.WorkDocs.Model.CreateNotificationSubscriptionResponse))] [AWSCmdletOutput("Amazon.WorkDocs.Model.Subscription or Amazon.WorkDocs.Model.CreateNotificationSubscriptionResponse", "This cmdlet returns an Amazon.WorkDocs.Model.Subscription object.", "The service call response (type Amazon.WorkDocs.Model.CreateNotificationSubscriptionResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewWDNotificationSubscriptionCmdlet : AmazonWorkDocsClientCmdlet, IExecutor { #region Parameter Endpoint /// /// /// The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint /// is a URL that begins with https. /// /// #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 Endpoint { get; set; } #endregion #region Parameter OrganizationId /// /// /// The ID of the organization. /// /// #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 OrganizationId { get; set; } #endregion #region Parameter Protocol /// /// /// The protocol to use. The supported value is https, which delivers JSON-encoded messages /// using HTTPS POST. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [AWSConstantClassSource("Amazon.WorkDocs.SubscriptionProtocolType")] public Amazon.WorkDocs.SubscriptionProtocolType Protocol { get; set; } #endregion #region Parameter SubscriptionType /// /// /// The notification type. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [AWSConstantClassSource("Amazon.WorkDocs.SubscriptionType")] public Amazon.WorkDocs.SubscriptionType SubscriptionType { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'Subscription'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkDocs.Model.CreateNotificationSubscriptionResponse). /// Specifying the name of a property of type Amazon.WorkDocs.Model.CreateNotificationSubscriptionResponse will result in that property being returned. /// 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; } = "Subscription"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the OrganizationId parameter. /// The -PassThru parameter is deprecated, use -Select '^OrganizationId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^OrganizationId' 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.OrganizationId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-WDNotificationSubscription (CreateNotificationSubscription)")) { 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.OrganizationId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.Endpoint = this.Endpoint; #if MODULAR if (this.Endpoint == null && ParameterWasBound(nameof(this.Endpoint))) { WriteWarning("You are passing $null as a value for parameter Endpoint 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.OrganizationId = this.OrganizationId; #if MODULAR if (this.OrganizationId == null && ParameterWasBound(nameof(this.OrganizationId))) { WriteWarning("You are passing $null as a value for parameter OrganizationId 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.Protocol = this.Protocol; #if MODULAR if (this.Protocol == null && ParameterWasBound(nameof(this.Protocol))) { WriteWarning("You are passing $null as a value for parameter Protocol 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.SubscriptionType = this.SubscriptionType; #if MODULAR if (this.SubscriptionType == null && ParameterWasBound(nameof(this.SubscriptionType))) { WriteWarning("You are passing $null as a value for parameter SubscriptionType 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.WorkDocs.Model.CreateNotificationSubscriptionRequest(); if (cmdletContext.Endpoint != null) { request.Endpoint = cmdletContext.Endpoint; } if (cmdletContext.OrganizationId != null) { request.OrganizationId = cmdletContext.OrganizationId; } if (cmdletContext.Protocol != null) { request.Protocol = cmdletContext.Protocol; } if (cmdletContext.SubscriptionType != null) { request.SubscriptionType = cmdletContext.SubscriptionType; } 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.WorkDocs.Model.CreateNotificationSubscriptionResponse CallAWSServiceOperation(IAmazonWorkDocs client, Amazon.WorkDocs.Model.CreateNotificationSubscriptionRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon WorkDocs", "CreateNotificationSubscription"); try { #if DESKTOP return client.CreateNotificationSubscription(request); #elif CORECLR return client.CreateNotificationSubscriptionAsync(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 Endpoint { get; set; } public System.String OrganizationId { get; set; } public Amazon.WorkDocs.SubscriptionProtocolType Protocol { get; set; } public Amazon.WorkDocs.SubscriptionType SubscriptionType { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Subscription; } } }