/******************************************************************************* * 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.SimpleNotificationService; using Amazon.SimpleNotificationService.Model; namespace Amazon.PowerShell.Cmdlets.SNS { /// /// Publishes up to ten messages to the specified topic. This is a batch version of Publish. /// For FIFO topics, multiple messages within a single batch are published in the order /// they are sent, and messages are deduplicated within the batch and across batches for /// 5 minutes. /// /// /// /// The result of publishing each message is reported individually in the response. Because /// the batch request can result in a combination of successful and unsuccessful actions, /// you should check for batch errors even when the call returns an HTTP status code of /// 200. /// /// The maximum allowed individual message size and the maximum total payload size (the /// sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 /// bytes). /// /// Some actions take lists of parameters. These lists are specified using the param.n /// notation. Values of n are integers starting from 1. For example, a parameter /// list with two elements looks like this: /// /// &AttributeName.1=first /// /// &AttributeName.2=second /// /// If you send a batch message to a topic, Amazon SNS publishes the batch message to /// each endpoint that is subscribed to the topic. The format of the batch message depends /// on the notification protocol for each subscribed endpoint. /// /// When a messageId is returned, the batch message is saved and Amazon SNS /// immediately delivers the message to subscribers. /// /// [Cmdlet("Publish", "SNSBatch", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.SimpleNotificationService.Model.PublishBatchResponse")] [AWSCmdlet("Calls the Amazon Simple Notification Service (SNS) PublishBatch API operation.", Operation = new[] {"PublishBatch"}, SelectReturnType = typeof(Amazon.SimpleNotificationService.Model.PublishBatchResponse))] [AWSCmdletOutput("Amazon.SimpleNotificationService.Model.PublishBatchResponse", "This cmdlet returns an Amazon.SimpleNotificationService.Model.PublishBatchResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class PublishSNSBatchCmdlet : AmazonSimpleNotificationServiceClientCmdlet, IExecutor { #region Parameter PublishBatchRequestEntry /// /// /// A list of PublishBatch request entries to be sent to the SNS topic. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyCollection] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [Alias("PublishBatchRequestEntries")] public Amazon.SimpleNotificationService.Model.PublishBatchRequestEntry[] PublishBatchRequestEntry { get; set; } #endregion #region Parameter TopicArn /// /// /// The Amazon resource name (ARN) of the topic you want to batch publish to. /// /// #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 TopicArn { 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.SimpleNotificationService.Model.PublishBatchResponse). /// Specifying the name of a property of type Amazon.SimpleNotificationService.Model.PublishBatchResponse 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 TopicArn parameter. /// The -PassThru parameter is deprecated, use -Select '^TopicArn' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^TopicArn' 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.TopicArn), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Publish-SNSBatch (PublishBatch)")) { 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.TopicArn; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute if (this.PublishBatchRequestEntry != null) { context.PublishBatchRequestEntry = new List(this.PublishBatchRequestEntry); } #if MODULAR if (this.PublishBatchRequestEntry == null && ParameterWasBound(nameof(this.PublishBatchRequestEntry))) { WriteWarning("You are passing $null as a value for parameter PublishBatchRequestEntry 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.TopicArn = this.TopicArn; #if MODULAR if (this.TopicArn == null && ParameterWasBound(nameof(this.TopicArn))) { WriteWarning("You are passing $null as a value for parameter TopicArn 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.SimpleNotificationService.Model.PublishBatchRequest(); if (cmdletContext.PublishBatchRequestEntry != null) { request.PublishBatchRequestEntries = cmdletContext.PublishBatchRequestEntry; } if (cmdletContext.TopicArn != null) { request.TopicArn = cmdletContext.TopicArn; } 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.SimpleNotificationService.Model.PublishBatchResponse CallAWSServiceOperation(IAmazonSimpleNotificationService client, Amazon.SimpleNotificationService.Model.PublishBatchRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Simple Notification Service (SNS)", "PublishBatch"); try { #if DESKTOP return client.PublishBatch(request); #elif CORECLR return client.PublishBatchAsync(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 PublishBatchRequestEntry { get; set; } public System.String TopicArn { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }