/******************************************************************************* * 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.Chime; using Amazon.Chime.Model; namespace Amazon.PowerShell.Cmdlets.CHM { /// /// Creates a channel to which you can add users and send messages. /// /// /// Restriction: You can't change a channel's privacy. /// /// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn /// of the user that makes the API call as the value in the header. /// This API is is no longer supported and will not be updated. We recommend using /// the latest version, CreateChannel, /// in the Amazon Chime SDK. /// /// Using the latest version requires migrating to a dedicated namespace. For more information, /// refer to Migrating /// from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. ///

This operation is deprecated. ///
[Cmdlet("New", "CHMChannel", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("System.String")] [AWSCmdlet("Calls the Amazon Chime CreateChannel API operation.", Operation = new[] {"CreateChannel"}, SelectReturnType = typeof(Amazon.Chime.Model.CreateChannelResponse))] [AWSCmdletOutput("System.String or Amazon.Chime.Model.CreateChannelResponse", "This cmdlet returns a System.String object.", "The service call response (type Amazon.Chime.Model.CreateChannelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] [System.ObsoleteAttribute("Replaced by CreateChannel in the Amazon Chime SDK Messaging Namespace")] public partial class NewCHMChannelCmdlet : AmazonChimeClientCmdlet, IExecutor { protected override bool IsSensitiveRequest { get; set; } = true; #region Parameter AppInstanceArn /// /// /// The ARN of the channel request. /// /// #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 AppInstanceArn { get; set; } #endregion #region Parameter ChimeBearer /// /// /// The AppInstanceUserArn of the user that makes the API call. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ChimeBearer { get; set; } #endregion #region Parameter ClientRequestToken /// /// /// The client token for the request. An Idempotency token. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ClientRequestToken { get; set; } #endregion #region Parameter Metadata /// /// /// The metadata of the creation request. Limited to 1KB and UTF-8. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Metadata { get; set; } #endregion #region Parameter Mode /// /// /// The channel mode: UNRESTRICTED or RESTRICTED. Administrators, /// moderators, and channel members can add themselves and other members to unrestricted /// channels. Only administrators and moderators can add members to restricted channels. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.Chime.ChannelMode")] public Amazon.Chime.ChannelMode Mode { get; set; } #endregion #region Parameter Name /// /// /// The name of the channel. /// /// #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 Name { get; set; } #endregion #region Parameter Privacy /// /// /// The channel's privacy level: PUBLIC or PRIVATE. Private /// channels aren't discoverable by users outside the channel. Public channels are discoverable /// by anyone in the AppInstance. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.Chime.ChannelPrivacy")] public Amazon.Chime.ChannelPrivacy Privacy { get; set; } #endregion #region Parameter Tag /// /// /// The tags for the creation request. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Tags")] public Amazon.Chime.Model.Tag[] Tag { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'ChannelArn'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Chime.Model.CreateChannelResponse). /// Specifying the name of a property of type Amazon.Chime.Model.CreateChannelResponse 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; } = "ChannelArn"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the AppInstanceArn parameter. /// The -PassThru parameter is deprecated, use -Select '^AppInstanceArn' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^AppInstanceArn' 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.Name), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-CHMChannel (CreateChannel)")) { 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.AppInstanceArn; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AppInstanceArn = this.AppInstanceArn; #if MODULAR if (this.AppInstanceArn == null && ParameterWasBound(nameof(this.AppInstanceArn))) { WriteWarning("You are passing $null as a value for parameter AppInstanceArn 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.ChimeBearer = this.ChimeBearer; context.ClientRequestToken = this.ClientRequestToken; context.Metadata = this.Metadata; context.Mode = this.Mode; context.Name = this.Name; #if MODULAR if (this.Name == null && ParameterWasBound(nameof(this.Name))) { WriteWarning("You are passing $null as a value for parameter Name 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.Privacy = this.Privacy; if (this.Tag != null) { context.Tag = new List(this.Tag); } // 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.Chime.Model.CreateChannelRequest(); if (cmdletContext.AppInstanceArn != null) { request.AppInstanceArn = cmdletContext.AppInstanceArn; } if (cmdletContext.ChimeBearer != null) { request.ChimeBearer = cmdletContext.ChimeBearer; } if (cmdletContext.ClientRequestToken != null) { request.ClientRequestToken = cmdletContext.ClientRequestToken; } if (cmdletContext.Metadata != null) { request.Metadata = cmdletContext.Metadata; } if (cmdletContext.Mode != null) { request.Mode = cmdletContext.Mode; } if (cmdletContext.Name != null) { request.Name = cmdletContext.Name; } if (cmdletContext.Privacy != null) { request.Privacy = cmdletContext.Privacy; } if (cmdletContext.Tag != null) { request.Tags = cmdletContext.Tag; } 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.Chime.Model.CreateChannelResponse CallAWSServiceOperation(IAmazonChime client, Amazon.Chime.Model.CreateChannelRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Chime", "CreateChannel"); try { #if DESKTOP return client.CreateChannel(request); #elif CORECLR return client.CreateChannelAsync(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 AppInstanceArn { get; set; } public System.String ChimeBearer { get; set; } public System.String ClientRequestToken { get; set; } public System.String Metadata { get; set; } public Amazon.Chime.ChannelMode Mode { get; set; } public System.String Name { get; set; } public Amazon.Chime.ChannelPrivacy Privacy { get; set; } public List Tag { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.ChannelArn; } } }