Package software.amazon.awssdk.services.sns.model

Class PublishRequest

    • Method Detail

      • topicArn

        public final String 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.

        Returns:
        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.

      • targetArn

        public final String targetArn()

        If you don't specify a value for the TargetArn parameter, you must specify a value for the PhoneNumber or TopicArn parameters.

        Returns:
        If you don't specify a value for the TargetArn parameter, you must specify a value for the PhoneNumber or TopicArn parameters.

      • phoneNumber

        public final String 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.

        Returns:
        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.

      • message

        public final String 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:

        • With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).

        • For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.

          If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.

          The total size limit for a single SMS Publish action is 1,600 characters.

        JSON-specific constraints:

        • Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.

        • The values will be parsed (unescaped) before they are used in outgoing messages.

        • Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).

        • Values have a minimum length of 0 (the empty string, "", is allowed).

        • Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).

        • Non-string values will cause the key to be ignored.

        • Keys that do not correspond to supported transport protocols are ignored.

        • Duplicate keys are not allowed.

        • Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).

        Returns:
        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:

        • With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).

        • For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.

          If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.

          The total size limit for a single SMS Publish action is 1,600 characters.

        JSON-specific constraints:

        • Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.

        • The values will be parsed (unescaped) before they are used in outgoing messages.

        • Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).

        • Values have a minimum length of 0 (the empty string, "", is allowed).

        • Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).

        • Non-string values will cause the key to be ignored.

        • Keys that do not correspond to supported transport protocols are ignored.

        • Duplicate keys are not allowed.

        • Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).

      • subject

        public final String 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.

        Returns:
        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.

      • messageStructure

        public final String 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:

        • be a syntactically valid JSON object; and

        • contain at least a top-level JSON key of "default" with a value that is a string.

        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

        Returns:
        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:

        • be a syntactically valid JSON object; and

        • contain at least a top-level JSON key of "default" with a value that is a string.

        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

      • hasMessageAttributes

        public final boolean hasMessageAttributes()
        For responses, this returns true if the service returned a value for the MessageAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • messageAttributes

        public final Map<String,​MessageAttributeValue> messageAttributes()

        Message attributes for Publish action.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMessageAttributes() method.

        Returns:
        Message attributes for Publish action.

      • messageDeduplicationId

        public final String 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.

        Returns:
        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.

      • messageGroupId

        public final String 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.

        Returns:
        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.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object