![]() |
![]()
| ![]() |
![]()
NAMEPaws::SNS::Publish - Arguments for method Publish on Paws::SNS DESCRIPTIONThis class represents the parameters used for calling the method Publish on the Amazon Simple Notification Service service. Use the attributes of this class as arguments to method Publish. You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to Publish. SYNOPSISmy $sns = Paws->service('SNS'); my $PublishResponse = $sns->Publish( Message => 'Mymessage', MessageAttributes => { 'MyString' => { DataType => 'MyString', BinaryValue => 'BlobBinary', # OPTIONAL StringValue => 'MyString', }, }, # OPTIONAL MessageDeduplicationId => 'MyString', # OPTIONAL MessageGroupId => 'MyString', # OPTIONAL MessageStructure => 'MymessageStructure', # OPTIONAL PhoneNumber => 'MyString', # OPTIONAL Subject => 'Mysubject', # OPTIONAL TargetArn => 'MyString', # OPTIONAL TopicArn => 'MytopicARN', # OPTIONAL ); # Results: my $MessageId = $PublishResponse->MessageId; my $SequenceNumber = $PublishResponse->SequenceNumber; # Returns a L<Paws::SNS::PublishResponse> object. Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/sns/Publish> ATTRIBUTESREQUIRED Message => StrThe 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:
MessageAttributes => Paws::SNS::MessageAttributeMapMessage attributes for Publish action. MessageDeduplicationId => StrThis 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. MessageGroupId => StrThis 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". MessageStructure => StrSet "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" PhoneNumber => StrThe 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. Subject => StrOptional 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. TargetArn => StrIf you don't specify a value for the "TargetArn" parameter, you must specify a value for the "PhoneNumber" or "TopicArn" parameters. TopicArn => StrThe 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. SEE ALSOThis class forms part of Paws, documenting arguments for method Publish in Paws::SNS BUGS and CONTRIBUTIONSThe source code is located here: <https://github.com/pplu/aws-sdk-perl> Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>
|