/******************************************************************************* * 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.ChimeSDKMessaging; using Amazon.ChimeSDKMessaging.Model; namespace Amazon.PowerShell.Cmdlets.CHMMG { /// /// Gets message status for a specified messageId. Use this API to determine /// the intermediate status of messages going through channel flow processing. The API /// provides an alternative to retrieving message status if the event was not received /// because a client wasn't connected to a websocket. /// /// /// /// Messages can have any one of these statuses. ///
SENT
/// Message processed successfully ///
PENDING
/// Ongoing processing ///
FAILED
/// Processing failed ///
DENIED
/// Message denied by the processor ///
///
[Cmdlet("Get", "CHMMGChannelMessageStatus")] [OutputType("Amazon.ChimeSDKMessaging.Model.ChannelMessageStatusStructure")] [AWSCmdlet("Calls the Amazon Chime SDK Messaging GetChannelMessageStatus API operation.", Operation = new[] {"GetChannelMessageStatus"}, SelectReturnType = typeof(Amazon.ChimeSDKMessaging.Model.GetChannelMessageStatusResponse))] [AWSCmdletOutput("Amazon.ChimeSDKMessaging.Model.ChannelMessageStatusStructure or Amazon.ChimeSDKMessaging.Model.GetChannelMessageStatusResponse", "This cmdlet returns an Amazon.ChimeSDKMessaging.Model.ChannelMessageStatusStructure object.", "The service call response (type Amazon.ChimeSDKMessaging.Model.GetChannelMessageStatusResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetCHMMGChannelMessageStatusCmdlet : AmazonChimeSDKMessagingClientCmdlet, IExecutor { #region Parameter ChannelArn /// /// /// The ARN 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 ChannelArn { get; set; } #endregion #region Parameter ChimeBearer /// /// /// The AppInstanceUserArn of the user making the API call. /// /// #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 ChimeBearer { get; set; } #endregion #region Parameter MessageId /// /// /// The ID of the message. /// /// #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 MessageId { get; set; } #endregion #region Parameter SubChannelId /// /// /// The ID of the SubChannel in the request.Only required when getting message status in a SubChannel that the user belongs to. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String SubChannelId { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'Status'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMessaging.Model.GetChannelMessageStatusResponse). /// Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.GetChannelMessageStatusResponse 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; } = "Status"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the MessageId parameter. /// The -PassThru parameter is deprecated, use -Select '^MessageId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^MessageId' 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.MessageId; } #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 context.ChimeBearer = this.ChimeBearer; #if MODULAR if (this.ChimeBearer == null && ParameterWasBound(nameof(this.ChimeBearer))) { WriteWarning("You are passing $null as a value for parameter ChimeBearer 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.MessageId = this.MessageId; #if MODULAR if (this.MessageId == null && ParameterWasBound(nameof(this.MessageId))) { WriteWarning("You are passing $null as a value for parameter MessageId 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.SubChannelId = this.SubChannelId; // 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.ChimeSDKMessaging.Model.GetChannelMessageStatusRequest(); if (cmdletContext.ChannelArn != null) { request.ChannelArn = cmdletContext.ChannelArn; } if (cmdletContext.ChimeBearer != null) { request.ChimeBearer = cmdletContext.ChimeBearer; } if (cmdletContext.MessageId != null) { request.MessageId = cmdletContext.MessageId; } if (cmdletContext.SubChannelId != null) { request.SubChannelId = cmdletContext.SubChannelId; } 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.ChimeSDKMessaging.Model.GetChannelMessageStatusResponse CallAWSServiceOperation(IAmazonChimeSDKMessaging client, Amazon.ChimeSDKMessaging.Model.GetChannelMessageStatusRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Chime SDK Messaging", "GetChannelMessageStatus"); try { #if DESKTOP return client.GetChannelMessageStatus(request); #elif CORECLR return client.GetChannelMessageStatusAsync(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 System.String ChimeBearer { get; set; } public System.String MessageId { get; set; } public System.String SubChannelId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Status; } } }