Skip to content

InAppTemplateRequest

Used by
Source code in docs_src/capo_pinpoint/types/in_app_template_request.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
class InAppTemplateRequest(TypedDict, closed=True):
    content: NotRequired[
        "capo_pinpoint.types.list_of_in_app_message_content.ListOfInAppMessageContent"
    ]
    """<p>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.</p>"""
    custom_config: NotRequired["capo_pinpoint.types.map_of__string.MapOf__string"]
    """<p>Custom config to be sent to client.</p>"""
    layout: NotRequired["capo_pinpoint.types.layout.Layout"]
    """<p>The layout of the message.</p>"""
    tags: NotRequired["capo_pinpoint.types.map_of__string.MapOf__string"]
    """<note><p>As of <b>22-05-2023</b> 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 <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html">Tags</a> in the <i>API Reference for Amazon Pinpoint</i>, <a href="https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html">resourcegroupstaggingapi</a> commands in the <i>AWS Command Line Interface Documentation</i> or <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html">resourcegroupstaggingapi</a> in the <i>AWS SDK</i>.</p></note> <p>(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.</p>"""
    template_description: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The description of the template.</p>"""

content instance-attribute 

content: NotRequired[ListOfInAppMessageContent]

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.

custom_config instance-attribute 

custom_config: NotRequired[MapOf__string]

Custom config to be sent to client.

layout instance-attribute 

layout: NotRequired[Layout]

The layout of the message.

tags instance-attribute 

tags: NotRequired[MapOf__string]

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.

template_description instance-attribute 

template_description: NotRequired[__string]

The description of the template.