/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace Pinpoint { namespace Model { /** *

Specifies the content and settings for a message template that can be used in * text messages that are sent through the SMS channel.

See Also:

* AWS * API Reference

*/ class SMSTemplateRequest { public: AWS_PINPOINT_API SMSTemplateRequest(); AWS_PINPOINT_API SMSTemplateRequest(Aws::Utils::Json::JsonView jsonValue); AWS_PINPOINT_API SMSTemplateRequest& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_PINPOINT_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The message body to use in text messages that are based on the message * template.

*/ inline const Aws::String& GetBody() const{ return m_body; } /** *

The message body to use in text messages that are based on the message * template.

*/ inline bool BodyHasBeenSet() const { return m_bodyHasBeenSet; } /** *

The message body to use in text messages that are based on the message * template.

*/ inline void SetBody(const Aws::String& value) { m_bodyHasBeenSet = true; m_body = value; } /** *

The message body to use in text messages that are based on the message * template.

*/ inline void SetBody(Aws::String&& value) { m_bodyHasBeenSet = true; m_body = std::move(value); } /** *

The message body to use in text messages that are based on the message * template.

*/ inline void SetBody(const char* value) { m_bodyHasBeenSet = true; m_body.assign(value); } /** *

The message body to use in text messages that are based on the message * template.

*/ inline SMSTemplateRequest& WithBody(const Aws::String& value) { SetBody(value); return *this;} /** *

The message body to use in text messages that are based on the message * template.

*/ inline SMSTemplateRequest& WithBody(Aws::String&& value) { SetBody(std::move(value)); return *this;} /** *

The message body to use in text messages that are based on the message * template.

*/ inline SMSTemplateRequest& WithBody(const char* value) { SetBody(value); return *this;} /** *

A JSON object that specifies the default values to use for message variables * in the message template. This object is a set of key-value pairs. Each key * defines a message variable in the template. The corresponding value defines the * default value for that variable. When you create a message that's based on the * template, you can override these defaults with message-specific and * address-specific variables and values.

*/ inline const Aws::String& GetDefaultSubstitutions() const{ return m_defaultSubstitutions; } /** *

A JSON object that specifies the default values to use for message variables * in the message template. This object is a set of key-value pairs. Each key * defines a message variable in the template. The corresponding value defines the * default value for that variable. When you create a message that's based on the * template, you can override these defaults with message-specific and * address-specific variables and values.

*/ inline bool DefaultSubstitutionsHasBeenSet() const { return m_defaultSubstitutionsHasBeenSet; } /** *

A JSON object that specifies the default values to use for message variables * in the message template. This object is a set of key-value pairs. Each key * defines a message variable in the template. The corresponding value defines the * default value for that variable. When you create a message that's based on the * template, you can override these defaults with message-specific and * address-specific variables and values.

*/ inline void SetDefaultSubstitutions(const Aws::String& value) { m_defaultSubstitutionsHasBeenSet = true; m_defaultSubstitutions = value; } /** *

A JSON object that specifies the default values to use for message variables * in the message template. This object is a set of key-value pairs. Each key * defines a message variable in the template. The corresponding value defines the * default value for that variable. When you create a message that's based on the * template, you can override these defaults with message-specific and * address-specific variables and values.

*/ inline void SetDefaultSubstitutions(Aws::String&& value) { m_defaultSubstitutionsHasBeenSet = true; m_defaultSubstitutions = std::move(value); } /** *

A JSON object that specifies the default values to use for message variables * in the message template. This object is a set of key-value pairs. Each key * defines a message variable in the template. The corresponding value defines the * default value for that variable. When you create a message that's based on the * template, you can override these defaults with message-specific and * address-specific variables and values.

*/ inline void SetDefaultSubstitutions(const char* value) { m_defaultSubstitutionsHasBeenSet = true; m_defaultSubstitutions.assign(value); } /** *

A JSON object that specifies the default values to use for message variables * in the message template. This object is a set of key-value pairs. Each key * defines a message variable in the template. The corresponding value defines the * default value for that variable. When you create a message that's based on the * template, you can override these defaults with message-specific and * address-specific variables and values.

*/ inline SMSTemplateRequest& WithDefaultSubstitutions(const Aws::String& value) { SetDefaultSubstitutions(value); return *this;} /** *

A JSON object that specifies the default values to use for message variables * in the message template. This object is a set of key-value pairs. Each key * defines a message variable in the template. The corresponding value defines the * default value for that variable. When you create a message that's based on the * template, you can override these defaults with message-specific and * address-specific variables and values.

*/ inline SMSTemplateRequest& WithDefaultSubstitutions(Aws::String&& value) { SetDefaultSubstitutions(std::move(value)); return *this;} /** *

A JSON object that specifies the default values to use for message variables * in the message template. This object is a set of key-value pairs. Each key * defines a message variable in the template. The corresponding value defines the * default value for that variable. When you create a message that's based on the * template, you can override these defaults with message-specific and * address-specific variables and values.

*/ inline SMSTemplateRequest& WithDefaultSubstitutions(const char* value) { SetDefaultSubstitutions(value); return *this;} /** *

The unique identifier for the recommender model to use for the message * template. Amazon Pinpoint uses this value to determine how to retrieve and * process data from a recommender model when it sends messages that use the * template, if the template contains message variables for recommendation * data.

*/ inline const Aws::String& GetRecommenderId() const{ return m_recommenderId; } /** *

The unique identifier for the recommender model to use for the message * template. Amazon Pinpoint uses this value to determine how to retrieve and * process data from a recommender model when it sends messages that use the * template, if the template contains message variables for recommendation * data.

*/ inline bool RecommenderIdHasBeenSet() const { return m_recommenderIdHasBeenSet; } /** *

The unique identifier for the recommender model to use for the message * template. Amazon Pinpoint uses this value to determine how to retrieve and * process data from a recommender model when it sends messages that use the * template, if the template contains message variables for recommendation * data.

*/ inline void SetRecommenderId(const Aws::String& value) { m_recommenderIdHasBeenSet = true; m_recommenderId = value; } /** *

The unique identifier for the recommender model to use for the message * template. Amazon Pinpoint uses this value to determine how to retrieve and * process data from a recommender model when it sends messages that use the * template, if the template contains message variables for recommendation * data.

*/ inline void SetRecommenderId(Aws::String&& value) { m_recommenderIdHasBeenSet = true; m_recommenderId = std::move(value); } /** *

The unique identifier for the recommender model to use for the message * template. Amazon Pinpoint uses this value to determine how to retrieve and * process data from a recommender model when it sends messages that use the * template, if the template contains message variables for recommendation * data.

*/ inline void SetRecommenderId(const char* value) { m_recommenderIdHasBeenSet = true; m_recommenderId.assign(value); } /** *

The unique identifier for the recommender model to use for the message * template. Amazon Pinpoint uses this value to determine how to retrieve and * process data from a recommender model when it sends messages that use the * template, if the template contains message variables for recommendation * data.

*/ inline SMSTemplateRequest& WithRecommenderId(const Aws::String& value) { SetRecommenderId(value); return *this;} /** *

The unique identifier for the recommender model to use for the message * template. Amazon Pinpoint uses this value to determine how to retrieve and * process data from a recommender model when it sends messages that use the * template, if the template contains message variables for recommendation * data.

*/ inline SMSTemplateRequest& WithRecommenderId(Aws::String&& value) { SetRecommenderId(std::move(value)); return *this;} /** *

The unique identifier for the recommender model to use for the message * template. Amazon Pinpoint uses this value to determine how to retrieve and * process data from a recommender model when it sends messages that use the * template, if the template contains message variables for recommendation * data.

*/ inline SMSTemplateRequest& WithRecommenderId(const char* value) { SetRecommenderId(value); return *this;} /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.

(Deprecated) A string-to-string map of * key-value pairs that defines the tags to associate with the message template. * Each tag consists of a required tag key and an associated tag value.

*/ inline const Aws::Map& GetTags() const{ return m_tags; } /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.

(Deprecated) A string-to-string map of * key-value pairs that defines the tags to associate with the message template. * Each tag consists of a required tag key and an associated tag value.

*/ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.

(Deprecated) A string-to-string map of * key-value pairs that defines the tags to associate with the message template. * Each tag consists of a required tag key and an associated tag value.

*/ inline void SetTags(const Aws::Map& value) { m_tagsHasBeenSet = true; m_tags = value; } /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.

(Deprecated) A string-to-string map of * key-value pairs that defines the tags to associate with the message template. * Each tag consists of a required tag key and an associated tag value.

*/ inline void SetTags(Aws::Map&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.

(Deprecated) A string-to-string map of * key-value pairs that defines the tags to associate with the message template. * Each tag consists of a required tag key and an associated tag value.

*/ inline SMSTemplateRequest& WithTags(const Aws::Map& value) { SetTags(value); return *this;} /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.

(Deprecated) A string-to-string map of * key-value pairs that defines the tags to associate with the message template. * Each tag consists of a required tag key and an associated tag value.

*/ inline SMSTemplateRequest& WithTags(Aws::Map&& value) { SetTags(std::move(value)); return *this;} /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.

(Deprecated) A string-to-string map of * key-value pairs that defines the tags to associate with the message template. * Each tag consists of a required tag key and an associated tag value.

*/ inline SMSTemplateRequest& AddTags(const Aws::String& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.

(Deprecated) A string-to-string map of * key-value pairs that defines the tags to associate with the message template. * Each tag consists of a required tag key and an associated tag value.

*/ inline SMSTemplateRequest& AddTags(Aws::String&& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.

(Deprecated) A string-to-string map of * key-value pairs that defines the tags to associate with the message template. * Each tag consists of a required tag key and an associated tag value.

*/ inline SMSTemplateRequest& AddTags(const Aws::String& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.

(Deprecated) A string-to-string map of * key-value pairs that defines the tags to associate with the message template. * Each tag consists of a required tag key and an associated tag value.

*/ inline SMSTemplateRequest& AddTags(Aws::String&& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), std::move(value)); return *this; } /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.

(Deprecated) A string-to-string map of * key-value pairs that defines the tags to associate with the message template. * Each tag consists of a required tag key and an associated tag value.

*/ inline SMSTemplateRequest& AddTags(const char* key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.

(Deprecated) A string-to-string map of * key-value pairs that defines the tags to associate with the message template. * Each tag consists of a required tag key and an associated tag value.

*/ inline SMSTemplateRequest& AddTags(Aws::String&& key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.

(Deprecated) A string-to-string map of * key-value pairs that defines the tags to associate with the message template. * Each tag consists of a required tag key and an associated tag value.

*/ inline SMSTemplateRequest& AddTags(const char* key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } /** *

A custom description of the message template.

*/ inline const Aws::String& GetTemplateDescription() const{ return m_templateDescription; } /** *

A custom description of the message template.

*/ inline bool TemplateDescriptionHasBeenSet() const { return m_templateDescriptionHasBeenSet; } /** *

A custom description of the message template.

*/ inline void SetTemplateDescription(const Aws::String& value) { m_templateDescriptionHasBeenSet = true; m_templateDescription = value; } /** *

A custom description of the message template.

*/ inline void SetTemplateDescription(Aws::String&& value) { m_templateDescriptionHasBeenSet = true; m_templateDescription = std::move(value); } /** *

A custom description of the message template.

*/ inline void SetTemplateDescription(const char* value) { m_templateDescriptionHasBeenSet = true; m_templateDescription.assign(value); } /** *

A custom description of the message template.

*/ inline SMSTemplateRequest& WithTemplateDescription(const Aws::String& value) { SetTemplateDescription(value); return *this;} /** *

A custom description of the message template.

*/ inline SMSTemplateRequest& WithTemplateDescription(Aws::String&& value) { SetTemplateDescription(std::move(value)); return *this;} /** *

A custom description of the message template.

*/ inline SMSTemplateRequest& WithTemplateDescription(const char* value) { SetTemplateDescription(value); return *this;} private: Aws::String m_body; bool m_bodyHasBeenSet = false; Aws::String m_defaultSubstitutions; bool m_defaultSubstitutionsHasBeenSet = false; Aws::String m_recommenderId; bool m_recommenderIdHasBeenSet = false; Aws::Map m_tags; bool m_tagsHasBeenSet = false; Aws::String m_templateDescription; bool m_templateDescriptionHasBeenSet = false; }; } // namespace Model } // namespace Pinpoint } // namespace Aws