/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace SNS { namespace Model { /** *

Input for Publish action.

See Also:

AWS * API Reference

*/ class PublishRequest : public SNSRequest { public: AWS_SNS_API PublishRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "Publish"; } AWS_SNS_API Aws::String SerializePayload() const override; protected: AWS_SNS_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

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.

*/ inline const Aws::String& GetTopicArn() const{ return m_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.

*/ inline bool TopicArnHasBeenSet() const { return m_topicArnHasBeenSet; } /** *

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.

*/ inline void SetTopicArn(const Aws::String& value) { m_topicArnHasBeenSet = true; m_topicArn = value; } /** *

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.

*/ inline void SetTopicArn(Aws::String&& value) { m_topicArnHasBeenSet = true; m_topicArn = std::move(value); } /** *

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.

*/ inline void SetTopicArn(const char* value) { m_topicArnHasBeenSet = true; m_topicArn.assign(value); } /** *

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.

*/ inline PublishRequest& WithTopicArn(const Aws::String& value) { SetTopicArn(value); return *this;} /** *

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.

*/ inline PublishRequest& WithTopicArn(Aws::String&& value) { SetTopicArn(std::move(value)); return *this;} /** *

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.

*/ inline PublishRequest& WithTopicArn(const char* value) { SetTopicArn(value); return *this;} /** *

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

*/ inline const Aws::String& GetTargetArn() const{ return m_targetArn; } /** *

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

*/ inline bool TargetArnHasBeenSet() const { return m_targetArnHasBeenSet; } /** *

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

*/ inline void SetTargetArn(const Aws::String& value) { m_targetArnHasBeenSet = true; m_targetArn = value; } /** *

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

*/ inline void SetTargetArn(Aws::String&& value) { m_targetArnHasBeenSet = true; m_targetArn = std::move(value); } /** *

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

*/ inline void SetTargetArn(const char* value) { m_targetArnHasBeenSet = true; m_targetArn.assign(value); } /** *

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

*/ inline PublishRequest& WithTargetArn(const Aws::String& value) { SetTargetArn(value); return *this;} /** *

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

*/ inline PublishRequest& WithTargetArn(Aws::String&& value) { SetTargetArn(std::move(value)); return *this;} /** *

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

*/ inline PublishRequest& WithTargetArn(const char* value) { SetTargetArn(value); return *this;} /** *

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.

*/ inline const Aws::String& GetPhoneNumber() const{ return m_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.

*/ inline bool PhoneNumberHasBeenSet() const { return m_phoneNumberHasBeenSet; } /** *

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.

*/ inline void SetPhoneNumber(const Aws::String& value) { m_phoneNumberHasBeenSet = true; m_phoneNumber = value; } /** *

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.

*/ inline void SetPhoneNumber(Aws::String&& value) { m_phoneNumberHasBeenSet = true; m_phoneNumber = std::move(value); } /** *

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.

*/ inline void SetPhoneNumber(const char* value) { m_phoneNumberHasBeenSet = true; m_phoneNumber.assign(value); } /** *

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.

*/ inline PublishRequest& WithPhoneNumber(const Aws::String& value) { SetPhoneNumber(value); return *this;} /** *

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.

*/ inline PublishRequest& WithPhoneNumber(Aws::String&& value) { SetPhoneNumber(std::move(value)); return *this;} /** *

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.

*/ inline PublishRequest& WithPhoneNumber(const char* value) { SetPhoneNumber(value); return *this;} /** *

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).

*/ inline const Aws::String& GetMessage() const{ return m_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).

*/ inline bool MessageHasBeenSet() const { return m_messageHasBeenSet; } /** *

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).

*/ inline void SetMessage(const Aws::String& value) { m_messageHasBeenSet = true; m_message = value; } /** *

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).

*/ inline void SetMessage(Aws::String&& value) { m_messageHasBeenSet = true; m_message = std::move(value); } /** *

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).

*/ inline void SetMessage(const char* value) { m_messageHasBeenSet = true; m_message.assign(value); } /** *

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).

*/ inline PublishRequest& WithMessage(const Aws::String& value) { SetMessage(value); return *this;} /** *

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).

*/ inline PublishRequest& WithMessage(Aws::String&& value) { SetMessage(std::move(value)); return *this;} /** *

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).

*/ inline PublishRequest& WithMessage(const char* value) { SetMessage(value); return *this;} /** *

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.

*/ inline const Aws::String& GetSubject() const{ return m_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.

*/ inline bool SubjectHasBeenSet() const { return m_subjectHasBeenSet; } /** *

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.

*/ inline void SetSubject(const Aws::String& value) { m_subjectHasBeenSet = true; m_subject = value; } /** *

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.

*/ inline void SetSubject(Aws::String&& value) { m_subjectHasBeenSet = true; m_subject = std::move(value); } /** *

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.

*/ inline void SetSubject(const char* value) { m_subjectHasBeenSet = true; m_subject.assign(value); } /** *

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.

*/ inline PublishRequest& WithSubject(const Aws::String& value) { SetSubject(value); return *this;} /** *

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.

*/ inline PublishRequest& WithSubject(Aws::String&& value) { SetSubject(std::move(value)); return *this;} /** *

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.

*/ inline PublishRequest& WithSubject(const char* value) { SetSubject(value); return *this;} /** *

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

*/ inline const Aws::String& GetMessageStructure() const{ return m_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

*/ inline bool MessageStructureHasBeenSet() const { return m_messageStructureHasBeenSet; } /** *

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

*/ inline void SetMessageStructure(const Aws::String& value) { m_messageStructureHasBeenSet = true; m_messageStructure = value; } /** *

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

*/ inline void SetMessageStructure(Aws::String&& value) { m_messageStructureHasBeenSet = true; m_messageStructure = std::move(value); } /** *

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

*/ inline void SetMessageStructure(const char* value) { m_messageStructureHasBeenSet = true; m_messageStructure.assign(value); } /** *

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

*/ inline PublishRequest& WithMessageStructure(const Aws::String& value) { SetMessageStructure(value); return *this;} /** *

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

*/ inline PublishRequest& WithMessageStructure(Aws::String&& value) { SetMessageStructure(std::move(value)); return *this;} /** *

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

*/ inline PublishRequest& WithMessageStructure(const char* value) { SetMessageStructure(value); return *this;} /** *

Message attributes for Publish action.

*/ inline const Aws::Map& GetMessageAttributes() const{ return m_messageAttributes; } /** *

Message attributes for Publish action.

*/ inline bool MessageAttributesHasBeenSet() const { return m_messageAttributesHasBeenSet; } /** *

Message attributes for Publish action.

*/ inline void SetMessageAttributes(const Aws::Map& value) { m_messageAttributesHasBeenSet = true; m_messageAttributes = value; } /** *

Message attributes for Publish action.

*/ inline void SetMessageAttributes(Aws::Map&& value) { m_messageAttributesHasBeenSet = true; m_messageAttributes = std::move(value); } /** *

Message attributes for Publish action.

*/ inline PublishRequest& WithMessageAttributes(const Aws::Map& value) { SetMessageAttributes(value); return *this;} /** *

Message attributes for Publish action.

*/ inline PublishRequest& WithMessageAttributes(Aws::Map&& value) { SetMessageAttributes(std::move(value)); return *this;} /** *

Message attributes for Publish action.

*/ inline PublishRequest& AddMessageAttributes(const Aws::String& key, const MessageAttributeValue& value) { m_messageAttributesHasBeenSet = true; m_messageAttributes.emplace(key, value); return *this; } /** *

Message attributes for Publish action.

*/ inline PublishRequest& AddMessageAttributes(Aws::String&& key, const MessageAttributeValue& value) { m_messageAttributesHasBeenSet = true; m_messageAttributes.emplace(std::move(key), value); return *this; } /** *

Message attributes for Publish action.

*/ inline PublishRequest& AddMessageAttributes(const Aws::String& key, MessageAttributeValue&& value) { m_messageAttributesHasBeenSet = true; m_messageAttributes.emplace(key, std::move(value)); return *this; } /** *

Message attributes for Publish action.

*/ inline PublishRequest& AddMessageAttributes(Aws::String&& key, MessageAttributeValue&& value) { m_messageAttributesHasBeenSet = true; m_messageAttributes.emplace(std::move(key), std::move(value)); return *this; } /** *

Message attributes for Publish action.

*/ inline PublishRequest& AddMessageAttributes(const char* key, MessageAttributeValue&& value) { m_messageAttributesHasBeenSet = true; m_messageAttributes.emplace(key, std::move(value)); return *this; } /** *

Message attributes for Publish action.

*/ inline PublishRequest& AddMessageAttributes(const char* key, const MessageAttributeValue& value) { m_messageAttributesHasBeenSet = true; m_messageAttributes.emplace(key, value); return *this; } /** *

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.

*/ inline const Aws::String& GetMessageDeduplicationId() const{ return m_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.

*/ inline bool MessageDeduplicationIdHasBeenSet() const { return m_messageDeduplicationIdHasBeenSet; } /** *

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.

*/ inline void SetMessageDeduplicationId(const Aws::String& value) { m_messageDeduplicationIdHasBeenSet = true; m_messageDeduplicationId = value; } /** *

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.

*/ inline void SetMessageDeduplicationId(Aws::String&& value) { m_messageDeduplicationIdHasBeenSet = true; m_messageDeduplicationId = std::move(value); } /** *

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.

*/ inline void SetMessageDeduplicationId(const char* value) { m_messageDeduplicationIdHasBeenSet = true; m_messageDeduplicationId.assign(value); } /** *

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.

*/ inline PublishRequest& WithMessageDeduplicationId(const Aws::String& value) { SetMessageDeduplicationId(value); return *this;} /** *

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.

*/ inline PublishRequest& WithMessageDeduplicationId(Aws::String&& value) { SetMessageDeduplicationId(std::move(value)); return *this;} /** *

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.

*/ inline PublishRequest& WithMessageDeduplicationId(const char* value) { SetMessageDeduplicationId(value); return *this;} /** *

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.

*/ inline const Aws::String& GetMessageGroupId() const{ return m_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.

*/ inline bool MessageGroupIdHasBeenSet() const { return m_messageGroupIdHasBeenSet; } /** *

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.

*/ inline void SetMessageGroupId(const Aws::String& value) { m_messageGroupIdHasBeenSet = true; m_messageGroupId = value; } /** *

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.

*/ inline void SetMessageGroupId(Aws::String&& value) { m_messageGroupIdHasBeenSet = true; m_messageGroupId = std::move(value); } /** *

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.

*/ inline void SetMessageGroupId(const char* value) { m_messageGroupIdHasBeenSet = true; m_messageGroupId.assign(value); } /** *

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.

*/ inline PublishRequest& WithMessageGroupId(const Aws::String& value) { SetMessageGroupId(value); return *this;} /** *

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.

*/ inline PublishRequest& WithMessageGroupId(Aws::String&& value) { SetMessageGroupId(std::move(value)); return *this;} /** *

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.

*/ inline PublishRequest& WithMessageGroupId(const char* value) { SetMessageGroupId(value); return *this;} private: Aws::String m_topicArn; bool m_topicArnHasBeenSet = false; Aws::String m_targetArn; bool m_targetArnHasBeenSet = false; Aws::String m_phoneNumber; bool m_phoneNumberHasBeenSet = false; Aws::String m_message; bool m_messageHasBeenSet = false; Aws::String m_subject; bool m_subjectHasBeenSet = false; Aws::String m_messageStructure; bool m_messageStructureHasBeenSet = false; Aws::Map m_messageAttributes; bool m_messageAttributesHasBeenSet = false; Aws::String m_messageDeduplicationId; bool m_messageDeduplicationIdHasBeenSet = false; Aws::String m_messageGroupId; bool m_messageGroupIdHasBeenSet = false; }; } // namespace Model } // namespace SNS } // namespace Aws