Pinpoint / Client / get_in_app_template

get_in_app_template#

Pinpoint.Client.get_in_app_template(**kwargs)#

Retrieves the content and settings of a message template for messages sent through the in-app channel.

See also: AWS API Documentation

Request Syntax

response = client.get_in_app_template(
    TemplateName='string',
    Version='string'
)
Parameters:

  • TemplateName (string) –

    [REQUIRED]

    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.

  • Version (string) –

    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.

Return type:

dict

Returns:

Response Syntax

{
    'InAppTemplateResponse': {
        'Arn': 'string',
        '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': 123,
                        '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': 123,
                        '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'
                    }
                }
            },
        ],
        'CreationDate': 'string',
        'CustomConfig': {
            'string': 'string'
        },
        'LastModifiedDate': 'string',
        'Layout': 'BOTTOM_BANNER'|'TOP_BANNER'|'OVERLAYS'|'MOBILE_FEED'|'MIDDLE_BANNER'|'CAROUSEL',
        'tags': {
            'string': 'string'
        },
        'TemplateDescription': 'string',
        'TemplateName': 'string',
        'TemplateType': 'EMAIL'|'SMS'|'VOICE'|'PUSH'|'INAPP',
        'Version': 'string'
    }
}

Response Structure

  • (dict) –

    The request succeeded.

    • InAppTemplateResponse (dict) –

      In-App Template Response.

      • Arn (string) –

        The resource arn of the template.

      • 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.

        • (dict) –

          The configuration for the message content.

          • BackgroundColor (string) –

            The background color for the message.

          • BodyConfig (dict) –

            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 (dict) –

            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 (dict) –

            The first button inside the message.

            • Android (dict) –

              Default button content.

              • ButtonAction (string) –

                Action triggered by the button.

              • Link (string) –

                Button destination.

            • DefaultConfig (dict) –

              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 (dict) –

              Default button content.

              • ButtonAction (string) –

                Action triggered by the button.

              • Link (string) –

                Button destination.

            • Web (dict) –

              Default button content.

              • ButtonAction (string) –

                Action triggered by the button.

              • Link (string) –

                Button destination.

          • SecondaryBtn (dict) –

            The second button inside message.

            • Android (dict) –

              Default button content.

              • ButtonAction (string) –

                Action triggered by the button.

              • Link (string) –

                Button destination.

            • DefaultConfig (dict) –

              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 (dict) –

              Default button content.

              • ButtonAction (string) –

                Action triggered by the button.

              • Link (string) –

                Button destination.

            • Web (dict) –

              Default button content.

              • ButtonAction (string) –

                Action triggered by the button.

              • Link (string) –

                Button destination.

      • CreationDate (string) –

        The creation date of the template.

      • CustomConfig (dict) –

        Custom config to be sent to client.

        • (string) –

          • (string) –

      • LastModifiedDate (string) –

        The last modified date of the template.

      • Layout (string) –

        The layout of the message.

      • tags (dict) –

        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.

        • (string) –

          • (string) –

      • TemplateDescription (string) –

        The description of the template.

      • TemplateName (string) –

        The name of the template.

      • TemplateType (string) –

        The type of the template.

      • Version (string) –

        The version id of the template.

Exceptions