/******************************************************************************* * 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.Ivschat; using Amazon.Ivschat.Model; namespace Amazon.PowerShell.Cmdlets.IVSC { /// /// Sends an event to a room. Use this within your application’s business logic to send /// events to clients of a room; e.g., to notify clients to change the way the chat UI /// is rendered. /// [Cmdlet("Send", "IVSCEvent", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("System.String")] [AWSCmdlet("Calls the Amazon Interactive Video Service Chat SendEvent API operation.", Operation = new[] {"SendEvent"}, SelectReturnType = typeof(Amazon.Ivschat.Model.SendEventResponse))] [AWSCmdletOutput("System.String or Amazon.Ivschat.Model.SendEventResponse", "This cmdlet returns a System.String object.", "The service call response (type Amazon.Ivschat.Model.SendEventResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class SendIVSCEventCmdlet : AmazonIvschatClientCmdlet, IExecutor { #region Parameter Attribute /// /// /// Application-defined metadata to attach to the event sent to clients. The maximum length /// of the metadata is 1 KB total. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Attributes")] public System.Collections.Hashtable Attribute { get; set; } #endregion #region Parameter EventName /// /// /// Application-defined name of the event to send to clients. /// /// #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 EventName { get; set; } #endregion #region Parameter RoomIdentifier /// /// /// Identifier of the room to which the event will be sent. Currently this must be an /// ARN. /// /// #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 RoomIdentifier { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'Id'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Ivschat.Model.SendEventResponse). /// Specifying the name of a property of type Amazon.Ivschat.Model.SendEventResponse 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; } = "Id"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the RoomIdentifier parameter. /// The -PassThru parameter is deprecated, use -Select '^RoomIdentifier' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^RoomIdentifier' 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.RoomIdentifier), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Send-IVSCEvent (SendEvent)")) { 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.RoomIdentifier; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute if (this.Attribute != null) { context.Attribute = new Dictionary(StringComparer.Ordinal); foreach (var hashKey in this.Attribute.Keys) { context.Attribute.Add((String)hashKey, (String)(this.Attribute[hashKey])); } } context.EventName = this.EventName; #if MODULAR if (this.EventName == null && ParameterWasBound(nameof(this.EventName))) { WriteWarning("You are passing $null as a value for parameter EventName 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.RoomIdentifier = this.RoomIdentifier; #if MODULAR if (this.RoomIdentifier == null && ParameterWasBound(nameof(this.RoomIdentifier))) { WriteWarning("You are passing $null as a value for parameter RoomIdentifier 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.Ivschat.Model.SendEventRequest(); if (cmdletContext.Attribute != null) { request.Attributes = cmdletContext.Attribute; } if (cmdletContext.EventName != null) { request.EventName = cmdletContext.EventName; } if (cmdletContext.RoomIdentifier != null) { request.RoomIdentifier = cmdletContext.RoomIdentifier; } 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.Ivschat.Model.SendEventResponse CallAWSServiceOperation(IAmazonIvschat client, Amazon.Ivschat.Model.SendEventRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Interactive Video Service Chat", "SendEvent"); try { #if DESKTOP return client.SendEvent(request); #elif CORECLR return client.SendEventAsync(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 Dictionary Attribute { get; set; } public System.String EventName { get; set; } public System.String RoomIdentifier { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Id; } } }