AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the UpdateInAppTemplate operation. Updates an existing message template for messages sent through the in-app message channel.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Pinpoint.AmazonPinpointRequest
      Amazon.Pinpoint.Model.UpdateInAppTemplateRequest

Namespace: Amazon.Pinpoint.Model
Assembly: AWSSDK.Pinpoint.dll
Version: 3.x.y.z

Syntax

C#
public class UpdateInAppTemplateRequest : AmazonPinpointRequest
         IAmazonWebServiceRequest

The UpdateInAppTemplateRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property CreateNewVersion System.Boolean

Gets and sets the property CreateNewVersion.

Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

Public Property InAppTemplateRequest Amazon.Pinpoint.Model.InAppTemplateRequest

Gets and sets the property InAppTemplateRequest.

Public Property TemplateName System.String

Gets and sets the property 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.

Public Property Version System.String

Gets and sets the property 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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5