/*******************************************************************************
* 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
{
///
/// Gets attributes for the specified queue.
///
///
/// To determine whether a queue is FIFO,
/// you can check whether QueueName ends with the .fifo suffix.
///
///
[Cmdlet("Get", "SQSQueueAttribute")]
[OutputType("Amazon.SQS.Model.GetQueueAttributesResponse")]
[AWSCmdlet("Calls the Amazon Simple Queue Service (SQS) GetQueueAttributes API operation.", Operation = new[] {"GetQueueAttributes"}, SelectReturnType = typeof(Amazon.SQS.Model.GetQueueAttributesResponse))]
[AWSCmdletOutput("Amazon.SQS.Model.GetQueueAttributesResponse",
"This cmdlet returns an Amazon.SQS.Model.GetQueueAttributesResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetSQSQueueAttributeCmdlet : AmazonSQSClientCmdlet, IExecutor
{
#region Parameter AttributeName
///
///
/// A list of attributes for which to retrieve information.The AttributeNames parameter is optional, but if you don't specify values
/// for this parameter, the request returns empty results.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.The following attributes are supported:The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible,
/// and ApproximateNumberOfMessages metrics may not achieve consistency until
/// at least 1 minute after the producers stop sending messages. This period is required
/// for the queue metadata to reach eventual consistency. All – Returns all values. ApproximateNumberOfMessages – Returns the approximate number of messages
/// available for retrieval from the queue.ApproximateNumberOfMessagesDelayed – Returns the approximate number
/// of messages in the queue that are delayed and not available for reading immediately.
/// This can happen when the queue is configured as a delay queue or when a message has
/// been sent with a delay parameter.ApproximateNumberOfMessagesNotVisible – Returns the approximate number
/// of messages that are in flight. Messages are considered to be in flight if
/// they have been sent to a client but have not yet been deleted or have not yet reached
/// the end of their visibility window. CreatedTimestamp – Returns the time when the queue was created in seconds
/// (epoch time).DelaySeconds – Returns the default delay on the queue in seconds.LastModifiedTimestamp – Returns the time when the queue was last changed
/// in seconds (epoch time).MaximumMessageSize – Returns the limit of how many bytes a message can
/// contain before Amazon SQS rejects it.MessageRetentionPeriod – Returns the length of time, in seconds, for
/// which Amazon SQS retains a message. When you change a queue's attributes, the change
/// can take up to 60 seconds for most of the attributes to propagate throughout the Amazon
/// SQS system. Changes made to the MessageRetentionPeriod attribute can
/// take up to 15 minutes and will impact existing messages in the queue potentially causing
/// them to be expired and deleted if the MessageRetentionPeriod is reduced
/// below the age of existing messages.Policy – Returns the policy of the queue.QueueArn – Returns the Amazon resource name (ARN) of the queue.ReceiveMessageWaitTimeSeconds – Returns the length of time, in seconds,
/// for which the ReceiveMessage action waits for a message to arrive. VisibilityTimeout – Returns the visibility timeout for the queue. For
/// more information about the visibility timeout, see Visibility
/// Timeout in the Amazon SQS Developer Guide.
The following attributes apply only to dead-letter
/// queues:RedrivePolicy – The string that includes the parameters for the dead-letter
/// queue functionality of the source queue as a JSON object. The parameters are as follows:deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter
/// queue to which Amazon SQS moves messages after the value of maxReceiveCount
/// is exceeded.maxReceiveCount – The number of times a message is delivered to the
/// source queue before being moved to the dead-letter queue. Default: 10. When the ReceiveCount
/// for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves
/// the message to the dead-letter-queue.
RedriveAllowPolicy – The string that includes the parameters for the
/// permissions for the dead-letter queue redrive permission and which source queues can
/// specify dead-letter queues as a JSON object. The parameters are as follows:redrivePermission – The permission type that defines which source queues
/// can specify the current queue as the dead-letter queue. Valid values are:allowAll – (Default) Any source queues in this Amazon Web Services account
/// in the same Region can specify this queue as the dead-letter queue.denyAll – No source queues can specify this queue as the dead-letter
/// queue.byQueue – Only queues specified by the sourceQueueArns
/// parameter can specify this queue as the dead-letter queue.
sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues
/// that can specify this queue as the dead-letter queue and redrive messages. You can
/// specify this parameter only when the redrivePermission parameter is set
/// to byQueue. You can specify up to 10 source queue ARNs. To allow more
/// than 10 source queues to specify dead-letter queues, set the redrivePermission
/// parameter to allowAll.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter
/// queue of a standard queue must also be a standard queue.The following attributes apply only to server-side-encryption:KmsMasterKeyId – Returns the ID of an Amazon Web Services managed customer
/// master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key
/// Terms. KmsDataKeyReusePeriodSeconds – Returns the length of time, in seconds,
/// for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling
/// KMS again. For more information, see How
/// Does the Data Key Reuse Period Work?. SqsManagedSseEnabled – Returns information about whether the queue is
/// using SSE-SQS encryption using SQS owned encryption keys. Only one server-side encryption
/// option is supported per queue (for example, SSE-KMS
/// or SSE-SQS).
The following attributes apply only to FIFO
/// (first-in-first-out) queues:FifoQueue – Returns information about whether the queue is FIFO. For
/// more information, see FIFO
/// queue logic in the Amazon SQS Developer Guide.To determine whether a queue is FIFO,
/// you can check whether QueueName ends with the .fifo suffix.ContentBasedDeduplication – Returns whether content-based deduplication
/// is enabled for the queue. For more information, see Exactly-once
/// processing in the Amazon SQS Developer Guide.
The following attributes apply only to high
/// throughput for FIFO queues:DeduplicationScope – Specifies whether message deduplication occurs
/// at the message group or queue level. Valid values are messageGroup and
/// queue.FifoThroughputLimit – Specifies whether the FIFO queue throughput quota
/// applies to the entire queue or per message group. Valid values are perQueue
/// and perMessageGroupId. The perMessageGroupId value is allowed
/// only when the value for DeduplicationScope is messageGroup.
To enable high throughput for FIFO queues, do the following:- Set
DeduplicationScope to messageGroup. - Set
FifoThroughputLimit to perMessageGroupId.
If you set these attributes to anything other than the values shown for enabling high
/// throughput, normal throughput is in effect and deduplication occurs as specified.For information on throughput quotas, see Quotas
/// related to messages in the Amazon SQS Developer Guide.
///
///
[System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)]
[Alias("AttributeNames")]
public System.String[] AttributeName { get; set; }
#endregion
#region Parameter QueueUrl
///
///
/// The URL of the Amazon SQS queue whose attribute information is retrieved.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 Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is '*'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SQS.Model.GetQueueAttributesResponse).
/// Specifying the name of a property of type Amazon.SQS.Model.GetQueueAttributesResponse 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; } = "*";
#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
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.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.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
// 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.GetQueueAttributesRequest();
if (cmdletContext.AttributeName != null)
{
request.AttributeNames = cmdletContext.AttributeName;
}
if (cmdletContext.QueueUrl != null)
{
request.QueueUrl = cmdletContext.QueueUrl;
}
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.GetQueueAttributesResponse CallAWSServiceOperation(IAmazonSQS client, Amazon.SQS.Model.GetQueueAttributesRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Simple Queue Service (SQS)", "GetQueueAttributes");
try
{
#if DESKTOP
return client.GetQueueAttributes(request);
#elif CORECLR
return client.GetQueueAttributesAsync(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.String QueueUrl { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}