[ aws . pinpoint ]

create-in-app-template

Description

Creates a new message template for messages using the in-app message channel.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-in-app-template
--in-app-template-request <value>
--template-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--in-app-template-request (structure)

InApp Template Request.

Content -> (list)

The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.

(structure)

The configuration for the message content.

BackgroundColor -> (string)

The background color for the message.

BodyConfig -> (structure)

The configuration for the message body.

Alignment -> (string)

The alignment of the text. Valid values: LEFT, CENTER, RIGHT.

Body -> (string)

Message Body.

TextColor -> (string)

The text color.

HeaderConfig -> (structure)

The configuration for the message header.

Alignment -> (string)

The alignment of the text. Valid values: LEFT, CENTER, RIGHT.

Header -> (string)

Message Header.

TextColor -> (string)

The text color.

ImageUrl -> (string)

The image url for the background of message.

PrimaryBtn -> (structure)

The first button inside the message.

Android -> (structure)

Default button content.

ButtonAction -> (string)

Action triggered by the button.

Link -> (string)

Button destination.

DefaultConfig -> (structure)

Default button content.

BackgroundColor -> (string)

The background color of the button.

BorderRadius -> (integer)

The border radius of the button.

ButtonAction -> (string)

Action triggered by the button.

Link -> (string)

Button destination.

Text -> (string)

Button text.

TextColor -> (string)

The text color of the button.

IOS -> (structure)

Default button content.

ButtonAction -> (string)

Action triggered by the button.

Link -> (string)

Button destination.

Web -> (structure)

Default button content.

ButtonAction -> (string)

Action triggered by the button.

Link -> (string)

Button destination.

SecondaryBtn -> (structure)

The second button inside message.

Android -> (structure)

Default button content.

ButtonAction -> (string)

Action triggered by the button.

Link -> (string)

Button destination.

DefaultConfig -> (structure)

Default button content.

BackgroundColor -> (string)

The background color of the button.

BorderRadius -> (integer)

The border radius of the button.

ButtonAction -> (string)

Action triggered by the button.

Link -> (string)

Button destination.

Text -> (string)

Button text.

TextColor -> (string)

The text color of the button.

IOS -> (structure)

Default button content.

ButtonAction -> (string)

Action triggered by the button.

Link -> (string)

Button destination.

Web -> (structure)

Default button content.

ButtonAction -> (string)

Action triggered by the button.

Link -> (string)

Button destination.

CustomConfig -> (map)

Custom config to be sent to client.

key -> (string)

value -> (string)

Layout -> (string)

The layout of the message.

tags -> (map)

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.

key -> (string)

value -> (string)

TemplateDescription -> (string)

The description of the template.

JSON Syntax:

{
  "Content": [
    {
      "BackgroundColor": "string",
      "BodyConfig": {
        "Alignment": "LEFT"|"CENTER"|"RIGHT",
        "Body": "string",
        "TextColor": "string"
      },
      "HeaderConfig": {
        "Alignment": "LEFT"|"CENTER"|"RIGHT",
        "Header": "string",
        "TextColor": "string"
      },
      "ImageUrl": "string",
      "PrimaryBtn": {
        "Android": {
          "ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
          "Link": "string"
        },
        "DefaultConfig": {
          "BackgroundColor": "string",
          "BorderRadius": integer,
          "ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
          "Link": "string",
          "Text": "string",
          "TextColor": "string"
        },
        "IOS": {
          "ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
          "Link": "string"
        },
        "Web": {
          "ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
          "Link": "string"
        }
      },
      "SecondaryBtn": {
        "Android": {
          "ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
          "Link": "string"
        },
        "DefaultConfig": {
          "BackgroundColor": "string",
          "BorderRadius": integer,
          "ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
          "Link": "string",
          "Text": "string",
          "TextColor": "string"
        },
        "IOS": {
          "ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
          "Link": "string"
        },
        "Web": {
          "ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
          "Link": "string"
        }
      }
    }
    ...
  ],
  "CustomConfig": {"string": "string"
    ...},
  "Layout": "BOTTOM_BANNER"|"TOP_BANNER"|"OVERLAYS"|"MOBILE_FEED"|"MIDDLE_BANNER"|"CAROUSEL",
  "tags": {"string": "string"
    ...},
  "TemplateDescription": "string"
}

--template-name (string)

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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

TemplateCreateMessageBody -> (structure)

Provides information about a request to create a message template.

Arn -> (string)

The Amazon Resource Name (ARN) of the message template that was created.

Message -> (string)

The message that’s returned from the API for the request to create the message template.

RequestID -> (string)

The unique identifier for the request to create the message template.