/** * 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 Http { class URI; } //namespace Http namespace Pinpoint { namespace Model { /** */ class GetEmailTemplateRequest : public PinpointRequest { public: AWS_PINPOINT_API GetEmailTemplateRequest(); // 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 "GetEmailTemplate"; } AWS_PINPOINT_API Aws::String SerializePayload() const override; AWS_PINPOINT_API void AddQueryStringParameters(Aws::Http::URI& uri) const override; /** *

The name of the message template. A template name must start with an * alphanumeric character and can contain a maximum of 128 characters. The * characters can be alphanumeric characters, underscores (_), or hyphens (-). * Template names are case sensitive.

*/ inline const Aws::String& GetTemplateName() const{ return m_templateName; } /** *

The name of the message template. A template name must start with an * alphanumeric character and can contain a maximum of 128 characters. The * characters can be alphanumeric characters, underscores (_), or hyphens (-). * Template names are case sensitive.

*/ inline bool TemplateNameHasBeenSet() const { return m_templateNameHasBeenSet; } /** *

The name of the message template. A template name must start with an * alphanumeric character and can contain a maximum of 128 characters. The * characters can be alphanumeric characters, underscores (_), or hyphens (-). * Template names are case sensitive.

*/ inline void SetTemplateName(const Aws::String& value) { m_templateNameHasBeenSet = true; m_templateName = value; } /** *

The name of the message template. A template name must start with an * alphanumeric character and can contain a maximum of 128 characters. The * characters can be alphanumeric characters, underscores (_), or hyphens (-). * Template names are case sensitive.

*/ inline void SetTemplateName(Aws::String&& value) { m_templateNameHasBeenSet = true; m_templateName = std::move(value); } /** *

The name of the message template. A template name must start with an * alphanumeric character and can contain a maximum of 128 characters. The * characters can be alphanumeric characters, underscores (_), or hyphens (-). * Template names are case sensitive.

*/ inline void SetTemplateName(const char* value) { m_templateNameHasBeenSet = true; m_templateName.assign(value); } /** *

The name of the message template. A template name must start with an * alphanumeric character and can contain a maximum of 128 characters. The * characters can be alphanumeric characters, underscores (_), or hyphens (-). * Template names are case sensitive.

*/ inline GetEmailTemplateRequest& WithTemplateName(const Aws::String& value) { SetTemplateName(value); return *this;} /** *

The name of the message template. A template name must start with an * alphanumeric character and can contain a maximum of 128 characters. The * characters can be alphanumeric characters, underscores (_), or hyphens (-). * Template names are case sensitive.

*/ inline GetEmailTemplateRequest& WithTemplateName(Aws::String&& value) { SetTemplateName(std::move(value)); return *this;} /** *

The name of the message template. A template name must start with an * alphanumeric character and can contain a maximum of 128 characters. The * characters can be alphanumeric characters, underscores (_), or hyphens (-). * Template names are case sensitive.

*/ inline GetEmailTemplateRequest& WithTemplateName(const char* value) { SetTemplateName(value); return *this;} /** *

The unique identifier for the version of the message template to update, * retrieve information about, or delete. To retrieve identifiers and other * information for all the versions of a template, use the Template * Versions resource.

If specified, this value must match the * identifier for an existing template version. If specified for an update * operation, this value must match the identifier for the latest existing version * of the template. This restriction helps ensure that race conditions don't * occur.

If you don't specify a value for this parameter, Amazon Pinpoint * does the following:

  • For a get operation, retrieves information * about the active version of the template.

  • For an update * operation, saves the updates to (overwrites) the latest existing version of the * template, if the create-new-version parameter isn't used or is set to * false.

  • For a delete operation, deletes the template, including * all versions of the template.

*/ inline const Aws::String& GetVersion() const{ return m_version; } /** *

The unique identifier for the version of the message template to update, * retrieve information about, or delete. To retrieve identifiers and other * information for all the versions of a template, use the Template * Versions resource.

If specified, this value must match the * identifier for an existing template version. If specified for an update * operation, this value must match the identifier for the latest existing version * of the template. This restriction helps ensure that race conditions don't * occur.

If you don't specify a value for this parameter, Amazon Pinpoint * does the following:

  • For a get operation, retrieves information * about the active version of the template.

  • For an update * operation, saves the updates to (overwrites) the latest existing version of the * template, if the create-new-version parameter isn't used or is set to * false.

  • For a delete operation, deletes the template, including * all versions of the template.

*/ inline bool VersionHasBeenSet() const { return m_versionHasBeenSet; } /** *

The unique identifier for the version of the message template to update, * retrieve information about, or delete. To retrieve identifiers and other * information for all the versions of a template, use the Template * Versions resource.

If specified, this value must match the * identifier for an existing template version. If specified for an update * operation, this value must match the identifier for the latest existing version * of the template. This restriction helps ensure that race conditions don't * occur.

If you don't specify a value for this parameter, Amazon Pinpoint * does the following:

  • For a get operation, retrieves information * about the active version of the template.

  • For an update * operation, saves the updates to (overwrites) the latest existing version of the * template, if the create-new-version parameter isn't used or is set to * false.

  • For a delete operation, deletes the template, including * all versions of the template.

*/ inline void SetVersion(const Aws::String& value) { m_versionHasBeenSet = true; m_version = value; } /** *

The unique identifier for the version of the message template to update, * retrieve information about, or delete. To retrieve identifiers and other * information for all the versions of a template, use the Template * Versions resource.

If specified, this value must match the * identifier for an existing template version. If specified for an update * operation, this value must match the identifier for the latest existing version * of the template. This restriction helps ensure that race conditions don't * occur.

If you don't specify a value for this parameter, Amazon Pinpoint * does the following:

  • For a get operation, retrieves information * about the active version of the template.

  • For an update * operation, saves the updates to (overwrites) the latest existing version of the * template, if the create-new-version parameter isn't used or is set to * false.

  • For a delete operation, deletes the template, including * all versions of the template.

*/ inline void SetVersion(Aws::String&& value) { m_versionHasBeenSet = true; m_version = std::move(value); } /** *

The unique identifier for the version of the message template to update, * retrieve information about, or delete. To retrieve identifiers and other * information for all the versions of a template, use the Template * Versions resource.

If specified, this value must match the * identifier for an existing template version. If specified for an update * operation, this value must match the identifier for the latest existing version * of the template. This restriction helps ensure that race conditions don't * occur.

If you don't specify a value for this parameter, Amazon Pinpoint * does the following:

  • For a get operation, retrieves information * about the active version of the template.

  • For an update * operation, saves the updates to (overwrites) the latest existing version of the * template, if the create-new-version parameter isn't used or is set to * false.

  • For a delete operation, deletes the template, including * all versions of the template.

*/ inline void SetVersion(const char* value) { m_versionHasBeenSet = true; m_version.assign(value); } /** *

The unique identifier for the version of the message template to update, * retrieve information about, or delete. To retrieve identifiers and other * information for all the versions of a template, use the Template * Versions resource.

If specified, this value must match the * identifier for an existing template version. If specified for an update * operation, this value must match the identifier for the latest existing version * of the template. This restriction helps ensure that race conditions don't * occur.

If you don't specify a value for this parameter, Amazon Pinpoint * does the following:

  • For a get operation, retrieves information * about the active version of the template.

  • For an update * operation, saves the updates to (overwrites) the latest existing version of the * template, if the create-new-version parameter isn't used or is set to * false.

  • For a delete operation, deletes the template, including * all versions of the template.

*/ inline GetEmailTemplateRequest& WithVersion(const Aws::String& value) { SetVersion(value); return *this;} /** *

The unique identifier for the version of the message template to update, * retrieve information about, or delete. To retrieve identifiers and other * information for all the versions of a template, use the Template * Versions resource.

If specified, this value must match the * identifier for an existing template version. If specified for an update * operation, this value must match the identifier for the latest existing version * of the template. This restriction helps ensure that race conditions don't * occur.

If you don't specify a value for this parameter, Amazon Pinpoint * does the following:

  • For a get operation, retrieves information * about the active version of the template.

  • For an update * operation, saves the updates to (overwrites) the latest existing version of the * template, if the create-new-version parameter isn't used or is set to * false.

  • For a delete operation, deletes the template, including * all versions of the template.

*/ inline GetEmailTemplateRequest& WithVersion(Aws::String&& value) { SetVersion(std::move(value)); return *this;} /** *

The unique identifier for the version of the message template to update, * retrieve information about, or delete. To retrieve identifiers and other * information for all the versions of a template, use the Template * Versions resource.

If specified, this value must match the * identifier for an existing template version. If specified for an update * operation, this value must match the identifier for the latest existing version * of the template. This restriction helps ensure that race conditions don't * occur.

If you don't specify a value for this parameter, Amazon Pinpoint * does the following:

  • For a get operation, retrieves information * about the active version of the template.

  • For an update * operation, saves the updates to (overwrites) the latest existing version of the * template, if the create-new-version parameter isn't used or is set to * false.

  • For a delete operation, deletes the template, including * all versions of the template.

*/ inline GetEmailTemplateRequest& WithVersion(const char* value) { SetVersion(value); return *this;} private: Aws::String m_templateName; bool m_templateNameHasBeenSet = false; Aws::String m_version; bool m_versionHasBeenSet = false; }; } // namespace Model } // namespace Pinpoint } // namespace Aws