/******************************************************************************* * 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 { /// /// Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a /// phone number, or a message to a mobile platform endpoint (when you specify the TargetArn). /// /// /// /// If you send a message to a topic, Amazon SNS delivers the message to each endpoint /// that is subscribed to the topic. The format of the message depends on the notification /// protocol for each subscribed endpoint. /// /// When a messageId is returned, the message is saved and Amazon SNS immediately /// delivers it to subscribers. /// /// To use the Publish action for publishing a message to a mobile endpoint, /// such as an app on a Kindle device or mobile phone, you must specify the EndpointArn /// for the TargetArn parameter. The EndpointArn is returned when making a call with the /// CreatePlatformEndpoint action. /// /// For more information about formatting messages, see Send /// Custom Platform-Specific Payloads in Messages to Mobile Devices. /// /// You can publish messages only to topics and endpoints in the same Amazon Web Services /// Region. /// /// [Cmdlet("Publish", "SNSMessage", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("System.String")] [AWSCmdlet("Calls the Amazon Simple Notification Service (SNS) Publish API operation.", Operation = new[] {"Publish"}, SelectReturnType = typeof(Amazon.SimpleNotificationService.Model.PublishResponse))] [AWSCmdletOutput("System.String or Amazon.SimpleNotificationService.Model.PublishResponse", "This cmdlet returns a System.String object.", "The service call response (type Amazon.SimpleNotificationService.Model.PublishResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class PublishSNSMessageCmdlet : AmazonSimpleNotificationServiceClientCmdlet, IExecutor { #region Parameter Message /// /// /// The message you want to send.If you are publishing to a topic and you want to send the same message to all transport /// protocols, include the text of the message as a String value. If you want to send /// different messages for each transport protocol, set the value of the MessageStructure /// parameter to json and use a JSON object for the Message /// parameter. Constraints:JSON-specific constraints: /// /// #if !MODULAR [System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String Message { get; set; } #endregion #region Parameter MessageAttribute /// /// /// Message attributes for Publish action. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MessageAttributes")] public System.Collections.Hashtable MessageAttribute { get; set; } #endregion #region Parameter MessageDeduplicationId /// /// /// This parameter applies only to FIFO (first-in-first-out) topics. The MessageDeduplicationId /// can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation /// (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).Every message must have a unique MessageDeduplicationId, which is a token /// used for deduplication of sent messages. If a message with a particular MessageDeduplicationId /// is sent successfully, any message sent with the same MessageDeduplicationId /// during the 5-minute deduplication interval is treated as a duplicate. If the topic has ContentBasedDeduplication set, the system generates /// a MessageDeduplicationId based on the contents of the message. Your MessageDeduplicationId /// overrides the generated one. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String MessageDeduplicationId { get; set; } #endregion #region Parameter MessageGroupId /// /// /// This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId /// can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation /// (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).The MessageGroupId is a tag that specifies that a message belongs to /// a specific message group. Messages that belong to the same message group are processed /// in a FIFO manner (however, messages in different message groups might be processed /// out of order). Every message must include a MessageGroupId. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String MessageGroupId { get; set; } #endregion #region Parameter MessageStructure /// /// /// Set MessageStructure to json if you want to send a different /// message for each protocol. For example, using one publish action, you can send a short /// message to your SMS subscribers and a longer message to your email subscribers. If /// you set MessageStructure to json, the value of the Message /// parameter must: You can define other top-level keys that define the message you want to send to a /// specific transport protocol (e.g., "http").Valid value: json /// /// [System.Management.Automation.Parameter(Position = 2, ValueFromPipelineByPropertyName = true)] public System.String MessageStructure { get; set; } #endregion #region Parameter PhoneNumber /// /// /// The phone number to which you want to deliver an SMS message. Use E.164 format.If you don't specify a value for the PhoneNumber parameter, you must /// specify a value for the TargetArn or TopicArn parameters. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String PhoneNumber { get; set; } #endregion #region Parameter Subject /// /// /// Optional parameter to be used as the "Subject" line when the message is delivered /// to email endpoints. This field will also be included, if present, in the standard /// JSON messages delivered to other endpoints.Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation /// mark; must not include line breaks or control characters; and must be less than 100 /// characters long. /// /// [System.Management.Automation.Parameter(Position = 3, ValueFromPipelineByPropertyName = true)] public System.String Subject { get; set; } #endregion #region Parameter TargetArn /// /// /// If you don't specify a value for the TargetArn parameter, you must specify /// a value for the PhoneNumber or TopicArn parameters. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String TargetArn { get; set; } #endregion #region Parameter TopicArn /// /// /// The topic you want to publish to.If you don't specify a value for the TopicArn parameter, you must specify /// a value for the PhoneNumber or TargetArn parameters. /// /// [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] public System.String TopicArn { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'MessageId'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleNotificationService.Model.PublishResponse). /// Specifying the name of a property of type Amazon.SimpleNotificationService.Model.PublishResponse 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; } = "MessageId"; #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-SNSMessage (Publish)")) { 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 context.Message = this.Message; #if MODULAR if (this.Message == null && ParameterWasBound(nameof(this.Message))) { WriteWarning("You are passing $null as a value for parameter Message 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 if (this.MessageAttribute != null) { context.MessageAttribute = new Dictionary(StringComparer.Ordinal); foreach (var hashKey in this.MessageAttribute.Keys) { context.MessageAttribute.Add((String)hashKey, (MessageAttributeValue)(this.MessageAttribute[hashKey])); } } context.MessageDeduplicationId = this.MessageDeduplicationId; context.MessageGroupId = this.MessageGroupId; context.MessageStructure = this.MessageStructure; context.PhoneNumber = this.PhoneNumber; context.Subject = this.Subject; context.TargetArn = this.TargetArn; context.TopicArn = this.TopicArn; // 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.PublishRequest(); if (cmdletContext.Message != null) { request.Message = cmdletContext.Message; } if (cmdletContext.MessageAttribute != null) { request.MessageAttributes = cmdletContext.MessageAttribute; } if (cmdletContext.MessageDeduplicationId != null) { request.MessageDeduplicationId = cmdletContext.MessageDeduplicationId; } if (cmdletContext.MessageGroupId != null) { request.MessageGroupId = cmdletContext.MessageGroupId; } if (cmdletContext.MessageStructure != null) { request.MessageStructure = cmdletContext.MessageStructure; } if (cmdletContext.PhoneNumber != null) { request.PhoneNumber = cmdletContext.PhoneNumber; } if (cmdletContext.Subject != null) { request.Subject = cmdletContext.Subject; } if (cmdletContext.TargetArn != null) { request.TargetArn = cmdletContext.TargetArn; } 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.PublishResponse CallAWSServiceOperation(IAmazonSimpleNotificationService client, Amazon.SimpleNotificationService.Model.PublishRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Simple Notification Service (SNS)", "Publish"); try { #if DESKTOP return client.Publish(request); #elif CORECLR return client.PublishAsync(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 Message { get; set; } public Dictionary MessageAttribute { get; set; } public System.String MessageDeduplicationId { get; set; } public System.String MessageGroupId { get; set; } public System.String MessageStructure { get; set; } public System.String PhoneNumber { get; set; } public System.String Subject { get; set; } public System.String TargetArn { get; set; } public System.String TopicArn { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.MessageId; } } }