/******************************************************************************* * 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.KinesisVideo; using Amazon.KinesisVideo.Model; namespace Amazon.PowerShell.Cmdlets.KV { /// /// Provides an endpoint for the specified signaling channel to send and receive messages. /// This API uses the SingleMasterChannelEndpointConfiguration input parameter, /// which consists of the Protocols and Role properties. /// /// /// Protocols is used to determine the communication mechanism. For example, /// if you specify WSS as the protocol, this API produces a secure websocket /// endpoint. If you specify HTTPS as the protocol, this API generates an /// HTTPS endpoint. /// Role determines the messaging permissions. A MASTER role /// results in this API generating an endpoint that a client can use to communicate with /// any of the viewers on the channel. A VIEWER role results in this API /// generating an endpoint that a client can use to communicate only with a MASTER. /// /// /// [Cmdlet("Get", "KVSignalingChannelEndpoint")] [OutputType("Amazon.KinesisVideo.Model.ResourceEndpointListItem")] [AWSCmdlet("Calls the Amazon Kinesis Video Streams GetSignalingChannelEndpoint API operation.", Operation = new[] {"GetSignalingChannelEndpoint"}, SelectReturnType = typeof(Amazon.KinesisVideo.Model.GetSignalingChannelEndpointResponse))] [AWSCmdletOutput("Amazon.KinesisVideo.Model.ResourceEndpointListItem or Amazon.KinesisVideo.Model.GetSignalingChannelEndpointResponse", "This cmdlet returns a collection of Amazon.KinesisVideo.Model.ResourceEndpointListItem objects.", "The service call response (type Amazon.KinesisVideo.Model.GetSignalingChannelEndpointResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetKVSignalingChannelEndpointCmdlet : AmazonKinesisVideoClientCmdlet, IExecutor { #region Parameter ChannelARN /// /// /// The Amazon Resource Name (ARN) of the signalling channel for which you want to get /// an endpoint. /// /// #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 ChannelARN { get; set; } #endregion #region Parameter SingleMasterChannelEndpointConfiguration_Protocol /// /// /// This property is used to determine the nature of communication over this SINGLE_MASTER /// signaling channel. If WSS is specified, this API returns a websocket /// endpoint. If HTTPS is specified, this API returns an HTTPS /// endpoint. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("SingleMasterChannelEndpointConfiguration_Protocols")] public System.String[] SingleMasterChannelEndpointConfiguration_Protocol { get; set; } #endregion #region Parameter SingleMasterChannelEndpointConfiguration_Role /// /// /// This property is used to determine messaging permissions in this SINGLE_MASTER /// signaling channel. If MASTER is specified, this API returns an endpoint /// that a client can use to receive offers from and send answers to any of the viewers /// on this signaling channel. If VIEWER is specified, this API returns an /// endpoint that a client can use only to send offers to another MASTER /// client on this signaling channel. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.KinesisVideo.ChannelRole")] public Amazon.KinesisVideo.ChannelRole SingleMasterChannelEndpointConfiguration_Role { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'ResourceEndpointList'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisVideo.Model.GetSignalingChannelEndpointResponse). /// Specifying the name of a property of type Amazon.KinesisVideo.Model.GetSignalingChannelEndpointResponse 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; } = "ResourceEndpointList"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the ChannelARN parameter. /// The -PassThru parameter is deprecated, use -Select '^ChannelARN' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ChannelARN' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { get; set; } #endregion protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); 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.ChannelARN; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.ChannelARN = this.ChannelARN; #if MODULAR if (this.ChannelARN == null && ParameterWasBound(nameof(this.ChannelARN))) { WriteWarning("You are passing $null as a value for parameter ChannelARN 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.SingleMasterChannelEndpointConfiguration_Protocol != null) { context.SingleMasterChannelEndpointConfiguration_Protocol = new List(this.SingleMasterChannelEndpointConfiguration_Protocol); } context.SingleMasterChannelEndpointConfiguration_Role = this.SingleMasterChannelEndpointConfiguration_Role; // 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.KinesisVideo.Model.GetSignalingChannelEndpointRequest(); if (cmdletContext.ChannelARN != null) { request.ChannelARN = cmdletContext.ChannelARN; } // populate SingleMasterChannelEndpointConfiguration var requestSingleMasterChannelEndpointConfigurationIsNull = true; request.SingleMasterChannelEndpointConfiguration = new Amazon.KinesisVideo.Model.SingleMasterChannelEndpointConfiguration(); List requestSingleMasterChannelEndpointConfiguration_singleMasterChannelEndpointConfiguration_Protocol = null; if (cmdletContext.SingleMasterChannelEndpointConfiguration_Protocol != null) { requestSingleMasterChannelEndpointConfiguration_singleMasterChannelEndpointConfiguration_Protocol = cmdletContext.SingleMasterChannelEndpointConfiguration_Protocol; } if (requestSingleMasterChannelEndpointConfiguration_singleMasterChannelEndpointConfiguration_Protocol != null) { request.SingleMasterChannelEndpointConfiguration.Protocols = requestSingleMasterChannelEndpointConfiguration_singleMasterChannelEndpointConfiguration_Protocol; requestSingleMasterChannelEndpointConfigurationIsNull = false; } Amazon.KinesisVideo.ChannelRole requestSingleMasterChannelEndpointConfiguration_singleMasterChannelEndpointConfiguration_Role = null; if (cmdletContext.SingleMasterChannelEndpointConfiguration_Role != null) { requestSingleMasterChannelEndpointConfiguration_singleMasterChannelEndpointConfiguration_Role = cmdletContext.SingleMasterChannelEndpointConfiguration_Role; } if (requestSingleMasterChannelEndpointConfiguration_singleMasterChannelEndpointConfiguration_Role != null) { request.SingleMasterChannelEndpointConfiguration.Role = requestSingleMasterChannelEndpointConfiguration_singleMasterChannelEndpointConfiguration_Role; requestSingleMasterChannelEndpointConfigurationIsNull = false; } // determine if request.SingleMasterChannelEndpointConfiguration should be set to null if (requestSingleMasterChannelEndpointConfigurationIsNull) { request.SingleMasterChannelEndpointConfiguration = 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.KinesisVideo.Model.GetSignalingChannelEndpointResponse CallAWSServiceOperation(IAmazonKinesisVideo client, Amazon.KinesisVideo.Model.GetSignalingChannelEndpointRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Kinesis Video Streams", "GetSignalingChannelEndpoint"); try { #if DESKTOP return client.GetSignalingChannelEndpoint(request); #elif CORECLR return client.GetSignalingChannelEndpointAsync(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 ChannelARN { get; set; } public List SingleMasterChannelEndpointConfiguration_Protocol { get; set; } public Amazon.KinesisVideo.ChannelRole SingleMasterChannelEndpointConfiguration_Role { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.ResourceEndpointList; } } }