/******************************************************************************* * 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.SQS; using Amazon.SQS.Model; namespace Amazon.PowerShell.Cmdlets.SQS { /// /// Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds /// parameter enables long-poll support. For more information, see Amazon /// SQS Long Polling in the Amazon SQS Developer Guide. /// /// /// /// Short poll is the default behavior where a weighted random set of machines is sampled /// on a ReceiveMessage call. Thus, only the messages on the sampled machines /// are returned. If the number of messages in the queue is small (fewer than 1,000), /// you most likely get fewer messages than you requested per ReceiveMessage /// call. If the number of messages in the queue is extremely small, you might not receive /// any messages in a particular ReceiveMessage response. If this happens, /// repeat the request. /// /// For each message returned, the response includes the following: /// /// The receipt handle is the identifier you must provide when deleting the message. For /// more information, see Queue /// and Message Identifiers in the Amazon SQS Developer Guide. /// /// You can provide the VisibilityTimeout parameter in your request. The /// parameter is applied to the messages that Amazon SQS returns in the response. If you /// don't include the parameter, the overall visibility timeout for the queue is used /// for the returned messages. For more information, see Visibility /// Timeout in the Amazon SQS Developer Guide. /// /// A message that isn't deleted or a message whose visibility isn't extended before the /// visibility timeout expires counts as a failed receive. Depending on the configuration /// of the queue, the message might be sent to the dead-letter queue. /// /// In the future, new attributes might be added. If you write code that calls this action, /// we recommend that you structure your code so that it can handle new attributes gracefully. /// /// [Cmdlet("Receive", "SQSMessage", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.SQS.Model.Message")] [AWSCmdlet("Calls the Amazon Simple Queue Service (SQS) ReceiveMessage API operation.", Operation = new[] {"ReceiveMessage"}, SelectReturnType = typeof(Amazon.SQS.Model.ReceiveMessageResponse))] [AWSCmdletOutput("Amazon.SQS.Model.Message or Amazon.SQS.Model.ReceiveMessageResponse", "This cmdlet returns a collection of Amazon.SQS.Model.Message objects.", "The service call response (type Amazon.SQS.Model.ReceiveMessageResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class ReceiveSQSMessageCmdlet : AmazonSQSClientCmdlet, IExecutor { #region Parameter AttributeName /// /// /// A list of attributes that need to be returned along with each message. These attributes /// include: /// /// [System.Management.Automation.Parameter(Position = 3, ValueFromPipelineByPropertyName = true)] [Alias("AttributeNames")] public System.String[] AttributeName { get; set; } #endregion #region Parameter MessageCount /// /// /// The maximum number of messages to return. Amazon SQS never returns more messages than /// this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: /// 1. /// /// [System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)] [Alias("MaxNumberOfMessages")] public System.Int32? MessageCount { get; set; } #endregion #region Parameter MessageAttributeName /// /// /// The name of the message attribute, where N is the index.When using ReceiveMessage, you can send a list of attribute names to /// receive, or you can return all of the attributes by specifying All or /// .* in your request. You can also use all message attributes starting /// with a prefix, for example bar.*. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MessageAttributeNames")] public System.String[] MessageAttributeName { get; set; } #endregion #region Parameter QueueUrl /// /// /// The URL of the Amazon SQS queue from which messages are received.Queue URLs and names are case-sensitive. /// /// #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 QueueUrl { get; set; } #endregion #region Parameter ReceiveRequestAttemptId /// /// /// This parameter applies only to FIFO (first-in-first-out) queues.The token used for deduplication of ReceiveMessage calls. If a networking /// issue occurs after a ReceiveMessage action, and instead of a response /// you receive a generic error, it is possible to retry the same action with an identical /// ReceiveRequestAttemptId to retrieve the same set of messages, even if /// their visibility timeout has not yet expired.The maximum length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId /// can contain alphanumeric characters (a-z, A-Z, 0-9) /// and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).For best practices of using ReceiveRequestAttemptId, see Using /// the ReceiveRequestAttemptId Request Parameter in the Amazon SQS Developer Guide. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ReceiveRequestAttemptId { get; set; } #endregion #region Parameter VisibilityTimeout /// /// /// The duration (in seconds) that the received messages are hidden from subsequent retrieve /// requests after being retrieved by a ReceiveMessage request. /// /// [System.Management.Automation.Parameter(Position = 2, ValueFromPipelineByPropertyName = true)] public System.Int32? VisibilityTimeout { get; set; } #endregion #region Parameter WaitTimeInSeconds /// /// /// The duration (in seconds) for which the call waits for a message to arrive in the /// queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. /// If no messages are available and the wait time expires, the call returns successfully /// with an empty list of messages.To avoid HTTP errors, ensure that the HTTP response timeout for ReceiveMessage /// requests is longer than the WaitTimeSeconds parameter. For example, with /// the Java SDK, you can set HTTP transport settings using the /// NettyNioAsyncHttpClient for asynchronous clients, or the /// ApacheHttpClient for synchronous clients. /// /// [System.Management.Automation.Parameter(Position = 4, ValueFromPipelineByPropertyName = true)] [Alias("WaitTimeSeconds")] public System.Int32? WaitTimeInSeconds { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'Messages'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SQS.Model.ReceiveMessageResponse). /// Specifying the name of a property of type Amazon.SQS.Model.ReceiveMessageResponse 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; } = "Messages"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the QueueUrl parameter. /// The -PassThru parameter is deprecated, use -Select '^QueueUrl' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^QueueUrl' 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.QueueUrl), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Receive-SQSMessage (ReceiveMessage)")) { 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.QueueUrl; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute if (this.AttributeName != null) { context.AttributeName = new List(this.AttributeName); } context.MessageCount = this.MessageCount; if (this.MessageAttributeName != null) { context.MessageAttributeName = new List(this.MessageAttributeName); } context.QueueUrl = this.QueueUrl; #if MODULAR if (this.QueueUrl == null && ParameterWasBound(nameof(this.QueueUrl))) { WriteWarning("You are passing $null as a value for parameter QueueUrl 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.ReceiveRequestAttemptId = this.ReceiveRequestAttemptId; context.VisibilityTimeout = this.VisibilityTimeout; context.WaitTimeInSeconds = this.WaitTimeInSeconds; // 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.SQS.Model.ReceiveMessageRequest(); if (cmdletContext.AttributeName != null) { request.AttributeNames = cmdletContext.AttributeName; } if (cmdletContext.MessageCount != null) { request.MaxNumberOfMessages = cmdletContext.MessageCount.Value; } if (cmdletContext.MessageAttributeName != null) { request.MessageAttributeNames = cmdletContext.MessageAttributeName; } if (cmdletContext.QueueUrl != null) { request.QueueUrl = cmdletContext.QueueUrl; } if (cmdletContext.ReceiveRequestAttemptId != null) { request.ReceiveRequestAttemptId = cmdletContext.ReceiveRequestAttemptId; } if (cmdletContext.VisibilityTimeout != null) { request.VisibilityTimeout = cmdletContext.VisibilityTimeout.Value; } if (cmdletContext.WaitTimeInSeconds != null) { request.WaitTimeSeconds = cmdletContext.WaitTimeInSeconds.Value; } 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.SQS.Model.ReceiveMessageResponse CallAWSServiceOperation(IAmazonSQS client, Amazon.SQS.Model.ReceiveMessageRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Simple Queue Service (SQS)", "ReceiveMessage"); try { #if DESKTOP return client.ReceiveMessage(request); #elif CORECLR return client.ReceiveMessageAsync(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 List AttributeName { get; set; } public System.Int32? MessageCount { get; set; } public List MessageAttributeName { get; set; } public System.String QueueUrl { get; set; } public System.String ReceiveRequestAttemptId { get; set; } public System.Int32? VisibilityTimeout { get; set; } public System.Int32? WaitTimeInSeconds { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Messages; } } }