Pinpoint

Table of Contents

Client

class Pinpoint.Client

A low-level client representing Amazon Pinpoint

Doc Engage API - Amazon Pinpoint API

import boto3

client = boto3.client('pinpoint')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_app(**kwargs)

Creates an application.

See also: AWS API Documentation

Request Syntax

response = client.create_app(
    CreateApplicationRequest={
        'Name': 'string',
        'tags': {
            'string': 'string'
        }
    }
)
Parameters
CreateApplicationRequest (dict) --

[REQUIRED]

Specifies the display name of an application and the tags to associate with the application.

  • Name (string) -- [REQUIRED]

    The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.

  • tags (dict) --

    A string-to-string map of key-value pairs that defines the tags to associate with the application. Each tag consists of a required tag key and an associated tag value.

    • (string) --
      • (string) --
Return type
dict
Returns
Response Syntax
{
    'ApplicationResponse': {
        'Arn': 'string',
        'Id': 'string',
        'Name': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    The request succeeded and the specified resource was created.

    • ApplicationResponse (dict) --

      Provides information about an application.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the application.

      • Id (string) --

        The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

      • Name (string) --

        The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.

      • tags (dict) --

        A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.

        • (string) --
          • (string) --

Exceptions

  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.PayloadTooLargeException
  • Pinpoint.Client.exceptions.ForbiddenException
  • Pinpoint.Client.exceptions.NotFoundException
  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
create_campaign(**kwargs)

Creates a new campaign for an application or updates the settings of an existing campaign for an application.

See also: AWS API Documentation

Request Syntax

response = client.create_campaign(
    ApplicationId='string',
    WriteCampaignRequest={
        'AdditionalTreatments': [
            {
                'CustomDeliveryConfiguration': {
                    'DeliveryUri': 'string',
                    'EndpointTypes': [
                        'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
                    ]
                },
                'MessageConfiguration': {
                    'ADMMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'APNSMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'BaiduMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'CustomMessage': {
                        'Data': 'string'
                    },
                    'DefaultMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'EmailMessage': {
                        'Body': 'string',
                        'FromAddress': 'string',
                        'HtmlBody': 'string',
                        'Title': 'string'
                    },
                    'GCMMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'SMSMessage': {
                        'Body': 'string',
                        'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                        'SenderId': 'string'
                    }
                },
                'Schedule': {
                    'EndTime': 'string',
                    'EventFilter': {
                        'Dimensions': {
                            'Attributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'EventType': {
                                'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                'Values': [
                                    'string',
                                ]
                            },
                            'Metrics': {
                                'string': {
                                    'ComparisonOperator': 'string',
                                    'Value': 123.0
                                }
                            }
                        },
                        'FilterType': 'SYSTEM'|'ENDPOINT'
                    },
                    'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
                    'IsLocalTime': True|False,
                    'QuietTime': {
                        'End': 'string',
                        'Start': 'string'
                    },
                    'StartTime': 'string',
                    'Timezone': 'string'
                },
                'SizePercent': 123,
                'TemplateConfiguration': {
                    'EmailTemplate': {
                        'Name': 'string',
                        'Version': 'string'
                    },
                    'PushTemplate': {
                        'Name': 'string',
                        'Version': 'string'
                    },
                    'SMSTemplate': {
                        'Name': 'string',
                        'Version': 'string'
                    },
                    'VoiceTemplate': {
                        'Name': 'string',
                        'Version': 'string'
                    }
                },
                'TreatmentDescription': 'string',
                'TreatmentName': 'string'
            },
        ],
        'CustomDeliveryConfiguration': {
            'DeliveryUri': 'string',
            'EndpointTypes': [
                'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
            ]
        },
        'Description': 'string',
        'HoldoutPercent': 123,
        'Hook': {
            'LambdaFunctionName': 'string',
            'Mode': 'DELIVERY'|'FILTER',
            'WebUrl': 'string'
        },
        'IsPaused': True|False,
        'Limits': {
            'Daily': 123,
            'MaximumDuration': 123,
            'MessagesPerSecond': 123,
            'Total': 123
        },
        'MessageConfiguration': {
            'ADMMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'APNSMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'BaiduMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'CustomMessage': {
                'Data': 'string'
            },
            'DefaultMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'EmailMessage': {
                'Body': 'string',
                'FromAddress': 'string',
                'HtmlBody': 'string',
                'Title': 'string'
            },
            'GCMMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'SMSMessage': {
                'Body': 'string',
                'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                'SenderId': 'string'
            }
        },
        'Name': 'string',
        'Schedule': {
            'EndTime': 'string',
            'EventFilter': {
                'Dimensions': {
                    'Attributes': {
                        'string': {
                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        }
                    },
                    'EventType': {
                        'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                        'Values': [
                            'string',
                        ]
                    },
                    'Metrics': {
                        'string': {
                            'ComparisonOperator': 'string',
                            'Value': 123.0
                        }
                    }
                },
                'FilterType': 'SYSTEM'|'ENDPOINT'
            },
            'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
            'IsLocalTime': True|False,
            'QuietTime': {
                'End': 'string',
                'Start': 'string'
            },
            'StartTime': 'string',
            'Timezone': 'string'
        },
        'SegmentId': 'string',
        'SegmentVersion': 123,
        'tags': {
            'string': 'string'
        },
        'TemplateConfiguration': {
            'EmailTemplate': {
                'Name': 'string',
                'Version': 'string'
            },
            'PushTemplate': {
                'Name': 'string',
                'Version': 'string'
            },
            'SMSTemplate': {
                'Name': 'string',
                'Version': 'string'
            },
            'VoiceTemplate': {
                'Name': 'string',
                'Version': 'string'
            }
        },
        'TreatmentDescription': 'string',
        'TreatmentName': 'string'
    }
)
Parameters
  • ApplicationId (string) --

    [REQUIRED]

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

  • WriteCampaignRequest (dict) --

    [REQUIRED]

    Specifies the configuration and other settings for a campaign.

    • AdditionalTreatments (list) --

      An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

      • (dict) --

        Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

        • CustomDeliveryConfiguration (dict) --

          The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.

          • DeliveryUri (string) -- [REQUIRED]

            The destination to send the campaign or treatment to. This value can be one of the following:

            • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
            • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
          • EndpointTypes (list) --

            The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

            • (string) --
        • MessageConfiguration (dict) --

          The message configuration settings for the treatment.

          • ADMMessage (dict) --

            The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.

            • Action (string) --

              The action to occur if a recipient taps the push notification. Valid values are:

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
            • Body (string) --

              The body of the notification message. The maximum number of characters is 200.

            • ImageIconUrl (string) --

              The URL of the image to display as the push-notification icon, such as the icon for the app.

            • ImageSmallIconUrl (string) --

              The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

            • ImageUrl (string) --

              The URL of an image to display in the push notification.

            • JsonBody (string) --

              The JSON payload to use for a silent push notification.

            • MediaUrl (string) --

              The URL of the image or video to display in the push notification.

            • RawContent (string) --

              The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

            • SilentPush (boolean) --

              Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

            • TimeToLive (integer) --

              The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

              This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

            • Title (string) --

              The title to display above the notification message on a recipient's device.

            • Url (string) --

              The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

          • APNSMessage (dict) --

            The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.

            • Action (string) --

              The action to occur if a recipient taps the push notification. Valid values are:

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
            • Body (string) --

              The body of the notification message. The maximum number of characters is 200.

            • ImageIconUrl (string) --

              The URL of the image to display as the push-notification icon, such as the icon for the app.

            • ImageSmallIconUrl (string) --

              The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

            • ImageUrl (string) --

              The URL of an image to display in the push notification.

            • JsonBody (string) --

              The JSON payload to use for a silent push notification.

            • MediaUrl (string) --

              The URL of the image or video to display in the push notification.

            • RawContent (string) --

              The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

            • SilentPush (boolean) --

              Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

            • TimeToLive (integer) --

              The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

              This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

            • Title (string) --

              The title to display above the notification message on a recipient's device.

            • Url (string) --

              The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

          • BaiduMessage (dict) --

            The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.

            • Action (string) --

              The action to occur if a recipient taps the push notification. Valid values are:

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
            • Body (string) --

              The body of the notification message. The maximum number of characters is 200.

            • ImageIconUrl (string) --

              The URL of the image to display as the push-notification icon, such as the icon for the app.

            • ImageSmallIconUrl (string) --

              The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

            • ImageUrl (string) --

              The URL of an image to display in the push notification.

            • JsonBody (string) --

              The JSON payload to use for a silent push notification.

            • MediaUrl (string) --

              The URL of the image or video to display in the push notification.

            • RawContent (string) --

              The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

            • SilentPush (boolean) --

              Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

            • TimeToLive (integer) --

              The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

              This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

            • Title (string) --

              The title to display above the notification message on a recipient's device.

            • Url (string) --

              The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

          • CustomMessage (dict) --

            The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.

            • Data (string) --

              The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.

          • DefaultMessage (dict) --

            The default message that the campaign sends through all the channels that are configured for the campaign.

            • Action (string) --

              The action to occur if a recipient taps the push notification. Valid values are:

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
            • Body (string) --

              The body of the notification message. The maximum number of characters is 200.

            • ImageIconUrl (string) --

              The URL of the image to display as the push-notification icon, such as the icon for the app.

            • ImageSmallIconUrl (string) --

              The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

            • ImageUrl (string) --

              The URL of an image to display in the push notification.

            • JsonBody (string) --

              The JSON payload to use for a silent push notification.

            • MediaUrl (string) --

              The URL of the image or video to display in the push notification.

            • RawContent (string) --

              The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

            • SilentPush (boolean) --

              Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

            • TimeToLive (integer) --

              The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

              This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

            • Title (string) --

              The title to display above the notification message on a recipient's device.

            • Url (string) --

              The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

          • EmailMessage (dict) --

            The message that the campaign sends through the email channel. If specified, this message overrides the default message.

            • Body (string) --

              The body of the email for recipients whose email clients don't render HTML content.

            • FromAddress (string) --

              The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.

            • HtmlBody (string) --

              The body of the email, in HTML format, for recipients whose email clients render HTML content.

            • Title (string) --

              The subject line, or title, of the email.

          • GCMMessage (dict) --

            The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.

            • Action (string) --

              The action to occur if a recipient taps the push notification. Valid values are:

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
            • Body (string) --

              The body of the notification message. The maximum number of characters is 200.

            • ImageIconUrl (string) --

              The URL of the image to display as the push-notification icon, such as the icon for the app.

            • ImageSmallIconUrl (string) --

              The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

            • ImageUrl (string) --

              The URL of an image to display in the push notification.

            • JsonBody (string) --

              The JSON payload to use for a silent push notification.

            • MediaUrl (string) --

              The URL of the image or video to display in the push notification.

            • RawContent (string) --

              The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

            • SilentPush (boolean) --

              Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

            • TimeToLive (integer) --

              The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

              This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

            • Title (string) --

              The title to display above the notification message on a recipient's device.

            • Url (string) --

              The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

          • SMSMessage (dict) --

            The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.

            • Body (string) --

              The body of the SMS message.

            • MessageType (string) --

              The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

            • SenderId (string) --

              The sender ID to display on recipients' devices when they receive the SMS message.

        • Schedule (dict) --

          The schedule settings for the treatment.

          • EndTime (string) --

            The scheduled time, in ISO 8601 format, when the campaign ended or will end.

          • EventFilter (dict) --

            The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

            • Dimensions (dict) -- [REQUIRED]

              The dimension settings of the event filter for the campaign.

              • Attributes (dict) --

                One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

                • (string) --
                  • (dict) --

                    Specifies attribute-based criteria for including or excluding endpoints from a segment.

                    • AttributeType (string) --

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    • Values (list) -- [REQUIRED]

                      The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                      • (string) --
              • EventType (dict) --

                The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .

                • DimensionType (string) --

                  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                • Values (list) -- [REQUIRED]

                  The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                  • (string) --
              • Metrics (dict) --

                One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

                • (string) --
                  • (dict) --

                    Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

                    • ComparisonOperator (string) -- [REQUIRED]

                      The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                    • Value (float) -- [REQUIRED]

                      The value to compare.

            • FilterType (string) -- [REQUIRED]

              The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.

          • Frequency (string) --

            Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

          • IsLocalTime (boolean) --

            Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

          • QuietTime (dict) --

            The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

            • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
            • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
            • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

            If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

            • End (string) --

              The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

            • Start (string) --

              The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

          • StartTime (string) -- [REQUIRED]

            The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.

          • Timezone (string) --

            The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

        • SizePercent (integer) -- [REQUIRED]

          The allocated percentage of users (segment members) to send the treatment to.

        • TemplateConfiguration (dict) --

          The message template to use for the treatment.

          • EmailTemplate (dict) --

            The email template to use for the message.

            • Name (string) --

              The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

            • Version (string) --

              The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

              If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

          • PushTemplate (dict) --

            The push notification template to use for the message.

            • Name (string) --

              The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

            • Version (string) --

              The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

              If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

          • SMSTemplate (dict) --

            The SMS template to use for the message.

            • Name (string) --

              The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

            • Version (string) --

              The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

              If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

          • VoiceTemplate (dict) --

            The voice template to use for the message. This object isn't supported for campaigns.

            • Name (string) --

              The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

            • Version (string) --

              The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

              If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

        • TreatmentDescription (string) --

          A custom description of the treatment.

        • TreatmentName (string) --

          A custom name for the treatment.

    • CustomDeliveryConfiguration (dict) --

      The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object.

      • DeliveryUri (string) -- [REQUIRED]

        The destination to send the campaign or treatment to. This value can be one of the following:

        • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
        • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
      • EndpointTypes (list) --

        The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

        • (string) --
    • Description (string) --

      A custom description of the campaign.

    • HoldoutPercent (integer) --

      The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

    • Hook (dict) --

      The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

      • LambdaFunctionName (string) --

        The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.

      • Mode (string) --

        The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:

        • FILTER - Invoke the function to customize the segment that's used by a campaign.
        • DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
      • WebUrl (string) --

        The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.

    • IsPaused (boolean) --

      Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.

    • Limits (dict) --

      The messaging limits for the campaign.

      • Daily (integer) --

        The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.

      • MaximumDuration (integer) --

        The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.

      • MessagesPerSecond (integer) --

        The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 50. The maximum value is 20,000.

      • Total (integer) --

        The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.

    • MessageConfiguration (dict) --

      The message configuration settings for the campaign.

      • ADMMessage (dict) --

        The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.

        • Action (string) --

          The action to occur if a recipient taps the push notification. Valid values are:

          • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
          • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
          • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
        • Body (string) --

          The body of the notification message. The maximum number of characters is 200.

        • ImageIconUrl (string) --

          The URL of the image to display as the push-notification icon, such as the icon for the app.

        • ImageSmallIconUrl (string) --

          The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

        • ImageUrl (string) --

          The URL of an image to display in the push notification.

        • JsonBody (string) --

          The JSON payload to use for a silent push notification.

        • MediaUrl (string) --

          The URL of the image or video to display in the push notification.

        • RawContent (string) --

          The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

        • SilentPush (boolean) --

          Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

        • TimeToLive (integer) --

          The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

          This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

        • Title (string) --

          The title to display above the notification message on a recipient's device.

        • Url (string) --

          The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

      • APNSMessage (dict) --

        The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.

        • Action (string) --

          The action to occur if a recipient taps the push notification. Valid values are:

          • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
          • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
          • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
        • Body (string) --

          The body of the notification message. The maximum number of characters is 200.

        • ImageIconUrl (string) --

          The URL of the image to display as the push-notification icon, such as the icon for the app.

        • ImageSmallIconUrl (string) --

          The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

        • ImageUrl (string) --

          The URL of an image to display in the push notification.

        • JsonBody (string) --

          The JSON payload to use for a silent push notification.

        • MediaUrl (string) --

          The URL of the image or video to display in the push notification.

        • RawContent (string) --

          The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

        • SilentPush (boolean) --

          Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

        • TimeToLive (integer) --

          The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

          This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

        • Title (string) --

          The title to display above the notification message on a recipient's device.

        • Url (string) --

          The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

      • BaiduMessage (dict) --

        The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.

        • Action (string) --

          The action to occur if a recipient taps the push notification. Valid values are:

          • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
          • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
          • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
        • Body (string) --

          The body of the notification message. The maximum number of characters is 200.

        • ImageIconUrl (string) --

          The URL of the image to display as the push-notification icon, such as the icon for the app.

        • ImageSmallIconUrl (string) --

          The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

        • ImageUrl (string) --

          The URL of an image to display in the push notification.

        • JsonBody (string) --

          The JSON payload to use for a silent push notification.

        • MediaUrl (string) --

          The URL of the image or video to display in the push notification.

        • RawContent (string) --

          The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

        • SilentPush (boolean) --

          Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

        • TimeToLive (integer) --

          The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

          This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

        • Title (string) --

          The title to display above the notification message on a recipient's device.

        • Url (string) --

          The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

      • CustomMessage (dict) --

        The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.

        • Data (string) --

          The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.

      • DefaultMessage (dict) --

        The default message that the campaign sends through all the channels that are configured for the campaign.

        • Action (string) --

          The action to occur if a recipient taps the push notification. Valid values are:

          • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
          • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
          • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
        • Body (string) --

          The body of the notification message. The maximum number of characters is 200.

        • ImageIconUrl (string) --

          The URL of the image to display as the push-notification icon, such as the icon for the app.

        • ImageSmallIconUrl (string) --

          The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

        • ImageUrl (string) --

          The URL of an image to display in the push notification.

        • JsonBody (string) --

          The JSON payload to use for a silent push notification.

        • MediaUrl (string) --

          The URL of the image or video to display in the push notification.

        • RawContent (string) --

          The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

        • SilentPush (boolean) --

          Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

        • TimeToLive (integer) --

          The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

          This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

        • Title (string) --

          The title to display above the notification message on a recipient's device.

        • Url (string) --

          The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

      • EmailMessage (dict) --

        The message that the campaign sends through the email channel. If specified, this message overrides the default message.

        • Body (string) --

          The body of the email for recipients whose email clients don't render HTML content.

        • FromAddress (string) --

          The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.

        • HtmlBody (string) --

          The body of the email, in HTML format, for recipients whose email clients render HTML content.

        • Title (string) --

          The subject line, or title, of the email.

      • GCMMessage (dict) --

        The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.

        • Action (string) --

          The action to occur if a recipient taps the push notification. Valid values are:

          • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
          • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
          • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
        • Body (string) --

          The body of the notification message. The maximum number of characters is 200.

        • ImageIconUrl (string) --

          The URL of the image to display as the push-notification icon, such as the icon for the app.

        • ImageSmallIconUrl (string) --

          The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

        • ImageUrl (string) --

          The URL of an image to display in the push notification.

        • JsonBody (string) --

          The JSON payload to use for a silent push notification.

        • MediaUrl (string) --

          The URL of the image or video to display in the push notification.

        • RawContent (string) --

          The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

        • SilentPush (boolean) --

          Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

        • TimeToLive (integer) --

          The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

          This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

        • Title (string) --

          The title to display above the notification message on a recipient's device.

        • Url (string) --

          The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

      • SMSMessage (dict) --

        The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.

        • Body (string) --

          The body of the SMS message.

        • MessageType (string) --

          The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

        • SenderId (string) --

          The sender ID to display on recipients' devices when they receive the SMS message.

    • Name (string) --

      A custom name for the campaign.

    • Schedule (dict) --

      The schedule settings for the campaign.

      • EndTime (string) --

        The scheduled time, in ISO 8601 format, when the campaign ended or will end.

      • EventFilter (dict) --

        The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

        • Dimensions (dict) -- [REQUIRED]

          The dimension settings of the event filter for the campaign.

          • Attributes (dict) --

            One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

            • (string) --
              • (dict) --

                Specifies attribute-based criteria for including or excluding endpoints from a segment.

                • AttributeType (string) --

                  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                • Values (list) -- [REQUIRED]

                  The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                  • (string) --
          • EventType (dict) --

            The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .

            • DimensionType (string) --

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

            • Values (list) -- [REQUIRED]

              The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

              • (string) --
          • Metrics (dict) --

            One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

            • (string) --
              • (dict) --

                Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

                • ComparisonOperator (string) -- [REQUIRED]

                  The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                • Value (float) -- [REQUIRED]

                  The value to compare.

        • FilterType (string) -- [REQUIRED]

          The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.

      • Frequency (string) --

        Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

      • IsLocalTime (boolean) --

        Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

      • QuietTime (dict) --

        The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

        • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
        • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
        • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

        If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

        • End (string) --

          The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

        • Start (string) --

          The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

      • StartTime (string) -- [REQUIRED]

        The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.

      • Timezone (string) --

        The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

    • SegmentId (string) --

      The unique identifier for the segment to associate with the campaign.

    • SegmentVersion (integer) --

      The version of the segment to associate with the campaign.

    • tags (dict) --

      A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.

      • (string) --
        • (string) --
    • TemplateConfiguration (dict) --

      The message template to use for the campaign.

      • EmailTemplate (dict) --

        The email template to use for the message.

        • Name (string) --

          The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

        • Version (string) --

          The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

          If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

      • PushTemplate (dict) --

        The push notification template to use for the message.

        • Name (string) --

          The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

        • Version (string) --

          The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

          If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

      • SMSTemplate (dict) --

        The SMS template to use for the message.

        • Name (string) --

          The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

        • Version (string) --

          The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

          If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

      • VoiceTemplate (dict) --

        The voice template to use for the message. This object isn't supported for campaigns.

        • Name (string) --

          The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

        • Version (string) --

          The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

          If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

    • TreatmentDescription (string) --

      A custom description of the default treatment for the campaign.

    • TreatmentName (string) --

      A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

Return type

dict

Returns

Response Syntax

{
    'CampaignResponse': {
        'AdditionalTreatments': [
            {
                'CustomDeliveryConfiguration': {
                    'DeliveryUri': 'string',
                    'EndpointTypes': [
                        'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
                    ]
                },
                'Id': 'string',
                'MessageConfiguration': {
                    'ADMMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'APNSMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'BaiduMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'CustomMessage': {
                        'Data': 'string'
                    },
                    'DefaultMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'EmailMessage': {
                        'Body': 'string',
                        'FromAddress': 'string',
                        'HtmlBody': 'string',
                        'Title': 'string'
                    },
                    'GCMMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'SMSMessage': {
                        'Body': 'string',
                        'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                        'SenderId': 'string'
                    }
                },
                'Schedule': {
                    'EndTime': 'string',
                    'EventFilter': {
                        'Dimensions': {
                            'Attributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'EventType': {
                                'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                'Values': [
                                    'string',
                                ]
                            },
                            'Metrics': {
                                'string': {
                                    'ComparisonOperator': 'string',
                                    'Value': 123.0
                                }
                            }
                        },
                        'FilterType': 'SYSTEM'|'ENDPOINT'
                    },
                    'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
                    'IsLocalTime': True|False,
                    'QuietTime': {
                        'End': 'string',
                        'Start': 'string'
                    },
                    'StartTime': 'string',
                    'Timezone': 'string'
                },
                'SizePercent': 123,
                'State': {
                    'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
                },
                'TemplateConfiguration': {
                    'EmailTemplate': {
                        'Name': 'string',
                        'Version': 'string'
                    },
                    'PushTemplate': {
                        'Name': 'string',
                        'Version': 'string'
                    },
                    'SMSTemplate': {
                        'Name': 'string',
                        'Version': 'string'
                    },
                    'VoiceTemplate': {
                        'Name': 'string',
                        'Version': 'string'
                    }
                },
                'TreatmentDescription': 'string',
                'TreatmentName': 'string'
            },
        ],
        'ApplicationId': 'string',
        'Arn': 'string',
        'CreationDate': 'string',
        'CustomDeliveryConfiguration': {
            'DeliveryUri': 'string',
            'EndpointTypes': [
                'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
            ]
        },
        'DefaultState': {
            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
        },
        'Description': 'string',
        'HoldoutPercent': 123,
        'Hook': {
            'LambdaFunctionName': 'string',
            'Mode': 'DELIVERY'|'FILTER',
            'WebUrl': 'string'
        },
        'Id': 'string',
        'IsPaused': True|False,
        'LastModifiedDate': 'string',
        'Limits': {
            'Daily': 123,
            'MaximumDuration': 123,
            'MessagesPerSecond': 123,
            'Total': 123
        },
        'MessageConfiguration': {
            'ADMMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'APNSMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'BaiduMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'CustomMessage': {
                'Data': 'string'
            },
            'DefaultMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'EmailMessage': {
                'Body': 'string',
                'FromAddress': 'string',
                'HtmlBody': 'string',
                'Title': 'string'
            },
            'GCMMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'SMSMessage': {
                'Body': 'string',
                'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                'SenderId': 'string'
            }
        },
        'Name': 'string',
        'Schedule': {
            'EndTime': 'string',
            'EventFilter': {
                'Dimensions': {
                    'Attributes': {
                        'string': {
                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        }
                    },
                    'EventType': {
                        'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                        'Values': [
                            'string',
                        ]
                    },
                    'Metrics': {
                        'string': {
                            'ComparisonOperator': 'string',
                            'Value': 123.0
                        }
                    }
                },
                'FilterType': 'SYSTEM'|'ENDPOINT'
            },
            'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
            'IsLocalTime': True|False,
            'QuietTime': {
                'End': 'string',
                'Start': 'string'
            },
            'StartTime': 'string',
            'Timezone': 'string'
        },
        'SegmentId': 'string',
        'SegmentVersion': 123,
        'State': {
            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
        },
        'tags': {
            'string': 'string'
        },
        'TemplateConfiguration': {
            'EmailTemplate': {
                'Name': 'string',
                'Version': 'string'
            },
            'PushTemplate': {
                'Name': 'string',
                'Version': 'string'
            },
            'SMSTemplate': {
                'Name': 'string',
                'Version': 'string'
            },
            'VoiceTemplate': {
                'Name': 'string',
                'Version': 'string'
            }
        },
        'TreatmentDescription': 'string',
        'TreatmentName': 'string',
        'Version': 123
    }
}

Response Structure

  • (dict) --

    The request succeeded and the specified resource was created.

    • CampaignResponse (dict) --

      Provides information about the status, configuration, and other settings for a campaign.

      • AdditionalTreatments (list) --

        An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.

        • (dict) --

          Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

          • CustomDeliveryConfiguration (dict) --

            The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.

            • DeliveryUri (string) --

              The destination to send the campaign or treatment to. This value can be one of the following:

              • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
              • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
            • EndpointTypes (list) --

              The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

              • (string) --
          • Id (string) --

            The unique identifier for the treatment.

          • MessageConfiguration (dict) --

            The message configuration settings for the treatment.

            • ADMMessage (dict) --

              The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.

              • Action (string) --

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
              • Body (string) --

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl (string) --

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl (string) --

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl (string) --

                The URL of an image to display in the push notification.

              • JsonBody (string) --

                The JSON payload to use for a silent push notification.

              • MediaUrl (string) --

                The URL of the image or video to display in the push notification.

              • RawContent (string) --

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush (boolean) --

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive (integer) --

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title (string) --

                The title to display above the notification message on a recipient's device.

              • Url (string) --

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • APNSMessage (dict) --

              The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.

              • Action (string) --

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
              • Body (string) --

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl (string) --

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl (string) --

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl (string) --

                The URL of an image to display in the push notification.

              • JsonBody (string) --

                The JSON payload to use for a silent push notification.

              • MediaUrl (string) --

                The URL of the image or video to display in the push notification.

              • RawContent (string) --

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush (boolean) --

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive (integer) --

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title (string) --

                The title to display above the notification message on a recipient's device.

              • Url (string) --

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • BaiduMessage (dict) --

              The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.

              • Action (string) --

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
              • Body (string) --

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl (string) --

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl (string) --

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl (string) --

                The URL of an image to display in the push notification.

              • JsonBody (string) --

                The JSON payload to use for a silent push notification.

              • MediaUrl (string) --

                The URL of the image or video to display in the push notification.

              • RawContent (string) --

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush (boolean) --

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive (integer) --

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title (string) --

                The title to display above the notification message on a recipient's device.

              • Url (string) --

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • CustomMessage (dict) --

              The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.

              • Data (string) --

                The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.

            • DefaultMessage (dict) --

              The default message that the campaign sends through all the channels that are configured for the campaign.

              • Action (string) --

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
              • Body (string) --

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl (string) --

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl (string) --

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl (string) --

                The URL of an image to display in the push notification.

              • JsonBody (string) --

                The JSON payload to use for a silent push notification.

              • MediaUrl (string) --

                The URL of the image or video to display in the push notification.

              • RawContent (string) --

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush (boolean) --

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive (integer) --

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title (string) --

                The title to display above the notification message on a recipient's device.

              • Url (string) --

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • EmailMessage (dict) --

              The message that the campaign sends through the email channel. If specified, this message overrides the default message.

              • Body (string) --

                The body of the email for recipients whose email clients don't render HTML content.

              • FromAddress (string) --

                The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.

              • HtmlBody (string) --

                The body of the email, in HTML format, for recipients whose email clients render HTML content.

              • Title (string) --

                The subject line, or title, of the email.

            • GCMMessage (dict) --

              The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.

              • Action (string) --

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
              • Body (string) --

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl (string) --

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl (string) --

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl (string) --

                The URL of an image to display in the push notification.

              • JsonBody (string) --

                The JSON payload to use for a silent push notification.

              • MediaUrl (string) --

                The URL of the image or video to display in the push notification.

              • RawContent (string) --

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush (boolean) --

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive (integer) --

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title (string) --

                The title to display above the notification message on a recipient's device.

              • Url (string) --

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • SMSMessage (dict) --

              The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.

              • Body (string) --

                The body of the SMS message.

              • MessageType (string) --

                The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

              • SenderId (string) --

                The sender ID to display on recipients' devices when they receive the SMS message.

          • Schedule (dict) --

            The schedule settings for the treatment.

            • EndTime (string) --

              The scheduled time, in ISO 8601 format, when the campaign ended or will end.

            • EventFilter (dict) --

              The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

              • Dimensions (dict) --

                The dimension settings of the event filter for the campaign.

                • Attributes (dict) --

                  One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

                  • (string) --

                    • (dict) --

                      Specifies attribute-based criteria for including or excluding endpoints from a segment.

                      • AttributeType (string) --

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      • Values (list) --

                        The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                        • (string) --
                • EventType (dict) --

                  The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .

                  • DimensionType (string) --

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  • Values (list) --

                    The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                    • (string) --
                • Metrics (dict) --

                  One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

                  • (string) --

                    • (dict) --

                      Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

                      • ComparisonOperator (string) --

                        The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                      • Value (float) --

                        The value to compare.

              • FilterType (string) --

                The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.

            • Frequency (string) --

              Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

            • IsLocalTime (boolean) --

              Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

            • QuietTime (dict) --

              The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

              • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
              • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
              • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

              If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

              • End (string) --

                The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

              • Start (string) --

                The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

            • StartTime (string) --

              The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.

            • Timezone (string) --

              The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

          • SizePercent (integer) --

            The allocated percentage of users (segment members) that the treatment is sent to.

          • State (dict) --

            The current status of the treatment.

            • CampaignStatus (string) --

              The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.

              If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.

          • TemplateConfiguration (dict) --

            The message template to use for the treatment.

            • EmailTemplate (dict) --

              The email template to use for the message.

              • Name (string) --

                The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

              • Version (string) --

                The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

                If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

            • PushTemplate (dict) --

              The push notification template to use for the message.

              • Name (string) --

                The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

              • Version (string) --

                The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

                If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

            • SMSTemplate (dict) --

              The SMS template to use for the message.

              • Name (string) --

                The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

              • Version (string) --

                The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

                If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

            • VoiceTemplate (dict) --

              The voice template to use for the message. This object isn't supported for campaigns.

              • Name (string) --

                The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

              • Version (string) --

                The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

                If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

          • TreatmentDescription (string) --

            The custom description of the treatment.

          • TreatmentName (string) --

            The custom name of the treatment.

      • ApplicationId (string) --

        The unique identifier for the application that the campaign applies to.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the campaign.

      • CreationDate (string) --

        The date, in ISO 8601 format, when the campaign was created.

      • CustomDeliveryConfiguration (dict) --

        The delivery configuration settings for sending the campaign through a custom channel.

        • DeliveryUri (string) --

          The destination to send the campaign or treatment to. This value can be one of the following:

          • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
          • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
        • EndpointTypes (list) --

          The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

          • (string) --
      • DefaultState (dict) --

        The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.

        • CampaignStatus (string) --

          The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.

          If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.

      • Description (string) --

        The custom description of the campaign.

      • HoldoutPercent (integer) --

        The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

      • Hook (dict) --

        The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

        • LambdaFunctionName (string) --

          The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.

        • Mode (string) --

          The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:

          • FILTER - Invoke the function to customize the segment that's used by a campaign.
          • DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
        • WebUrl (string) --

          The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.

      • Id (string) --

        The unique identifier for the campaign.

      • IsPaused (boolean) --

        Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.

      • LastModifiedDate (string) --

        The date, in ISO 8601 format, when the campaign was last modified.

      • Limits (dict) --

        The messaging limits for the campaign.

        • Daily (integer) --

          The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.

        • MaximumDuration (integer) --

          The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.

        • MessagesPerSecond (integer) --

          The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 50. The maximum value is 20,000.

        • Total (integer) --

          The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.

      • MessageConfiguration (dict) --

        The message configuration settings for the campaign.

        • ADMMessage (dict) --

          The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.

          • Action (string) --

            The action to occur if a recipient taps the push notification. Valid values are:

            • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
            • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
            • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
          • Body (string) --

            The body of the notification message. The maximum number of characters is 200.

          • ImageIconUrl (string) --

            The URL of the image to display as the push-notification icon, such as the icon for the app.

          • ImageSmallIconUrl (string) --

            The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

          • ImageUrl (string) --

            The URL of an image to display in the push notification.

          • JsonBody (string) --

            The JSON payload to use for a silent push notification.

          • MediaUrl (string) --

            The URL of the image or video to display in the push notification.

          • RawContent (string) --

            The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

          • SilentPush (boolean) --

            Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

          • TimeToLive (integer) --

            The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

            This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

          • Title (string) --

            The title to display above the notification message on a recipient's device.

          • Url (string) --

            The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

        • APNSMessage (dict) --

          The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.

          • Action (string) --

            The action to occur if a recipient taps the push notification. Valid values are:

            • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
            • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
            • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
          • Body (string) --

            The body of the notification message. The maximum number of characters is 200.

          • ImageIconUrl (string) --

            The URL of the image to display as the push-notification icon, such as the icon for the app.

          • ImageSmallIconUrl (string) --

            The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

          • ImageUrl (string) --

            The URL of an image to display in the push notification.

          • JsonBody (string) --

            The JSON payload to use for a silent push notification.

          • MediaUrl (string) --

            The URL of the image or video to display in the push notification.

          • RawContent (string) --

            The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

          • SilentPush (boolean) --

            Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

          • TimeToLive (integer) --

            The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

            This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

          • Title (string) --

            The title to display above the notification message on a recipient's device.

          • Url (string) --

            The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

        • BaiduMessage (dict) --

          The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.

          • Action (string) --

            The action to occur if a recipient taps the push notification. Valid values are:

            • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
            • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
            • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
          • Body (string) --

            The body of the notification message. The maximum number of characters is 200.

          • ImageIconUrl (string) --

            The URL of the image to display as the push-notification icon, such as the icon for the app.

          • ImageSmallIconUrl (string) --

            The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

          • ImageUrl (string) --

            The URL of an image to display in the push notification.

          • JsonBody (string) --

            The JSON payload to use for a silent push notification.

          • MediaUrl (string) --

            The URL of the image or video to display in the push notification.

          • RawContent (string) --

            The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

          • SilentPush (boolean) --

            Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

          • TimeToLive (integer) --

            The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

            This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

          • Title (string) --

            The title to display above the notification message on a recipient's device.

          • Url (string) --

            The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

        • CustomMessage (dict) --

          The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.

          • Data (string) --

            The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.

        • DefaultMessage (dict) --

          The default message that the campaign sends through all the channels that are configured for the campaign.

          • Action (string) --

            The action to occur if a recipient taps the push notification. Valid values are:

            • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
            • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
            • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
          • Body (string) --

            The body of the notification message. The maximum number of characters is 200.

          • ImageIconUrl (string) --

            The URL of the image to display as the push-notification icon, such as the icon for the app.

          • ImageSmallIconUrl (string) --

            The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

          • ImageUrl (string) --

            The URL of an image to display in the push notification.

          • JsonBody (string) --

            The JSON payload to use for a silent push notification.

          • MediaUrl (string) --

            The URL of the image or video to display in the push notification.

          • RawContent (string) --

            The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

          • SilentPush (boolean) --

            Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

          • TimeToLive (integer) --

            The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

            This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

          • Title (string) --

            The title to display above the notification message on a recipient's device.

          • Url (string) --

            The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

        • EmailMessage (dict) --

          The message that the campaign sends through the email channel. If specified, this message overrides the default message.

          • Body (string) --

            The body of the email for recipients whose email clients don't render HTML content.

          • FromAddress (string) --

            The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.

          • HtmlBody (string) --

            The body of the email, in HTML format, for recipients whose email clients render HTML content.

          • Title (string) --

            The subject line, or title, of the email.

        • GCMMessage (dict) --

          The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.

          • Action (string) --

            The action to occur if a recipient taps the push notification. Valid values are:

            • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
            • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
            • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
          • Body (string) --

            The body of the notification message. The maximum number of characters is 200.

          • ImageIconUrl (string) --

            The URL of the image to display as the push-notification icon, such as the icon for the app.

          • ImageSmallIconUrl (string) --

            The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

          • ImageUrl (string) --

            The URL of an image to display in the push notification.

          • JsonBody (string) --

            The JSON payload to use for a silent push notification.

          • MediaUrl (string) --

            The URL of the image or video to display in the push notification.

          • RawContent (string) --

            The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

          • SilentPush (boolean) --

            Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

          • TimeToLive (integer) --

            The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

            This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

          • Title (string) --

            The title to display above the notification message on a recipient's device.

          • Url (string) --

            The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

        • SMSMessage (dict) --

          The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.

          • Body (string) --

            The body of the SMS message.

          • MessageType (string) --

            The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

          • SenderId (string) --

            The sender ID to display on recipients' devices when they receive the SMS message.

      • Name (string) --

        The name of the campaign.

      • Schedule (dict) --

        The schedule settings for the campaign.

        • EndTime (string) --

          The scheduled time, in ISO 8601 format, when the campaign ended or will end.

        • EventFilter (dict) --

          The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

          • Dimensions (dict) --

            The dimension settings of the event filter for the campaign.

            • Attributes (dict) --

              One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

              • (string) --

                • (dict) --

                  Specifies attribute-based criteria for including or excluding endpoints from a segment.

                  • AttributeType (string) --

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  • Values (list) --

                    The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                    • (string) --
            • EventType (dict) --

              The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .

              • DimensionType (string) --

                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

              • Values (list) --

                The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                • (string) --
            • Metrics (dict) --

              One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

              • (string) --

                • (dict) --

                  Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

                  • ComparisonOperator (string) --

                    The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                  • Value (float) --

                    The value to compare.

          • FilterType (string) --

            The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.

        • Frequency (string) --

          Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

        • IsLocalTime (boolean) --

          Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

        • QuietTime (dict) --

          The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

          • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
          • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
          • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

          If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

          • End (string) --

            The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

          • Start (string) --

            The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

        • StartTime (string) --

          The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.

        • Timezone (string) --

          The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

      • SegmentId (string) --

        The unique identifier for the segment that's associated with the campaign.

      • SegmentVersion (integer) --

        The version number of the segment that's associated with the campaign.

      • State (dict) --

        The current status of the campaign.

        • CampaignStatus (string) --

          The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.

          If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.

      • tags (dict) --

        A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.

        • (string) --
          • (string) --
      • TemplateConfiguration (dict) --

        The message template that’s used for the campaign.

        • EmailTemplate (dict) --

          The email template to use for the message.

          • Name (string) --

            The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

          • Version (string) --

            The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

            If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

        • PushTemplate (dict) --

          The push notification template to use for the message.

          • Name (string) --

            The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

          • Version (string) --

            The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

            If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

        • SMSTemplate (dict) --

          The SMS template to use for the message.

          • Name (string) --

            The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

          • Version (string) --

            The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

            If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

        • VoiceTemplate (dict) --

          The voice template to use for the message. This object isn't supported for campaigns.

          • Name (string) --

            The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

          • Version (string) --

            The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

            If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

      • TreatmentDescription (string) --

        The custom description of the default treatment for the campaign.

      • TreatmentName (string) --

        The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

      • Version (integer) --

        The version number of the campaign.

Exceptions

  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.PayloadTooLargeException
  • Pinpoint.Client.exceptions.ForbiddenException
  • Pinpoint.Client.exceptions.NotFoundException
  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
create_email_template(**kwargs)

Creates a message template for messages that are sent through the email channel.

See also: AWS API Documentation

Request Syntax

response = client.create_email_template(
    EmailTemplateRequest={
        'DefaultSubstitutions': 'string',
        'HtmlPart': 'string',
        'RecommenderId': 'string',
        'Subject': 'string',
        'tags': {
            'string': 'string'
        },
        'TemplateDescription': 'string',
        'TextPart': 'string'
    },
    TemplateName='string'
)
Parameters
  • EmailTemplateRequest (dict) --

    [REQUIRED]

    Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.

    • DefaultSubstitutions (string) --

      A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

    • HtmlPart (string) --

      The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

    • RecommenderId (string) --

      The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

    • Subject (string) --

      The subject line, or title, to use in email messages that are based on the message template.

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

      A custom description of the message template.

    • TextPart (string) --

      The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.

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

Return type

dict

Returns

Response Syntax

{
    'CreateTemplateMessageBody': {
        'Arn': 'string',
        'Message': 'string',
        'RequestID': 'string'
    }
}

Response Structure

  • (dict) --

    The request succeeded and the specified resource was created.

    • CreateTemplateMessageBody (dict) --

      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.

Exceptions

  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.ForbiddenException
create_export_job(**kwargs)

Creates an export job for an application.

See also: AWS API Documentation

Request Syntax

response = client.create_export_job(
    ApplicationId='string',
    ExportJobRequest={
        'RoleArn': 'string',
        'S3UrlPrefix': 'string',
        'SegmentId': 'string',
        'SegmentVersion': 123
    }
)
Parameters
  • ApplicationId (string) --

    [REQUIRED]

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

  • ExportJobRequest (dict) --

    [REQUIRED]

    Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket.

    • RoleArn (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.

    • S3UrlPrefix (string) -- [REQUIRED]

      The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

    • SegmentId (string) --

      The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.

    • SegmentVersion (integer) --

      The version of the segment to export endpoint definitions from, if specified.

Return type

dict

Returns

Response Syntax

{
    'ExportJobResponse': {
        'ApplicationId': 'string',
        'CompletedPieces': 123,
        'CompletionDate': 'string',
        'CreationDate': 'string',
        'Definition': {
            'RoleArn': 'string',
            'S3UrlPrefix': 'string',
            'SegmentId': 'string',
            'SegmentVersion': 123
        },
        'FailedPieces': 123,
        'Failures': [
            'string',
        ],
        'Id': 'string',
        'JobStatus': 'CREATED'|'PREPARING_FOR_INITIALIZATION'|'INITIALIZING'|'PROCESSING'|'PENDING_JOB'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED',
        'TotalFailures': 123,
        'TotalPieces': 123,
        'TotalProcessed': 123,
        'Type': 'string'
    }
}

Response Structure

  • (dict) --

    The request was accepted for processing. Processing may not be complete.

    • ExportJobResponse (dict) --

      Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.

      • ApplicationId (string) --

        The unique identifier for the application that's associated with the export job.

      • CompletedPieces (integer) --

        The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.

      • CompletionDate (string) --

        The date, in ISO 8601 format, when the export job was completed.

      • CreationDate (string) --

        The date, in ISO 8601 format, when the export job was created.

      • Definition (dict) --

        The resource settings that apply to the export job.

        • RoleArn (string) --

          The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.

        • S3UrlPrefix (string) --

          The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

        • SegmentId (string) --

          The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.

        • SegmentVersion (integer) --

          The version of the segment that the endpoint definitions were exported from.

      • FailedPieces (integer) --

        The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.

      • Failures (list) --

        An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.

        • (string) --
      • Id (string) --

        The unique identifier for the export job.

      • JobStatus (string) --

        The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.

      • TotalFailures (integer) --

        The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.

      • TotalPieces (integer) --

        The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.

      • TotalProcessed (integer) --

        The total number of endpoint definitions that were processed by the export job.

      • Type (string) --

        The job type. This value is EXPORT for export jobs.

Exceptions

  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.PayloadTooLargeException
  • Pinpoint.Client.exceptions.ForbiddenException
  • Pinpoint.Client.exceptions.NotFoundException
  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
create_import_job(**kwargs)

Creates an import job for an application.

See also: AWS API Documentation

Request Syntax

response = client.create_import_job(
    ApplicationId='string',
    ImportJobRequest={
        'DefineSegment': True|False,
        'ExternalId': 'string',
        'Format': 'CSV'|'JSON',
        'RegisterEndpoints': True|False,
        'RoleArn': 'string',
        'S3Url': 'string',
        'SegmentId': 'string',
        'SegmentName': 'string'
    }
)
Parameters
  • ApplicationId (string) --

    [REQUIRED]

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

  • ImportJobRequest (dict) --

    [REQUIRED]

    Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket.

    • DefineSegment (boolean) --

      Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.

    • ExternalId (string) --

      (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

    • Format (string) -- [REQUIRED]

      The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

    • RegisterEndpoints (boolean) --

      Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

    • RoleArn (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

    • S3Url (string) -- [REQUIRED]

      The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.

      The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.

    • SegmentId (string) --

      The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.

    • SegmentName (string) --

      A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

Return type

dict

Returns

Response Syntax

{
    'ImportJobResponse': {
        'ApplicationId': 'string',
        'CompletedPieces': 123,
        'CompletionDate': 'string',
        'CreationDate': 'string',
        'Definition': {
            'DefineSegment': True|False,
            'ExternalId': 'string',
            'Format': 'CSV'|'JSON',
            'RegisterEndpoints': True|False,
            'RoleArn': 'string',
            'S3Url': 'string',
            'SegmentId': 'string',
            'SegmentName': 'string'
        },
        'FailedPieces': 123,
        'Failures': [
            'string',
        ],
        'Id': 'string',
        'JobStatus': 'CREATED'|'PREPARING_FOR_INITIALIZATION'|'INITIALIZING'|'PROCESSING'|'PENDING_JOB'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED',
        'TotalFailures': 123,
        'TotalPieces': 123,
        'TotalProcessed': 123,
        'Type': 'string'
    }
}

Response Structure

  • (dict) --

    The request succeeded and the specified resource was created.

    • ImportJobResponse (dict) --

      Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.

      • ApplicationId (string) --

        The unique identifier for the application that's associated with the import job.

      • CompletedPieces (integer) --

        The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.

      • CompletionDate (string) --

        The date, in ISO 8601 format, when the import job was completed.

      • CreationDate (string) --

        The date, in ISO 8601 format, when the import job was created.

      • Definition (dict) --

        The resource settings that apply to the import job.

        • DefineSegment (boolean) --

          Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.

        • ExternalId (string) --

          (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

        • Format (string) --

          The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

          If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

        • RegisterEndpoints (boolean) --

          Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

        • RoleArn (string) --

          The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

        • S3Url (string) --

          The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.

          The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.

        • SegmentId (string) --

          The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.

        • SegmentName (string) --

          The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

      • FailedPieces (integer) --

        The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.

      • Failures (list) --

        An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.

        • (string) --
      • Id (string) --

        The unique identifier for the import job.

      • JobStatus (string) --

        The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.

      • TotalFailures (integer) --

        The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.

      • TotalPieces (integer) --

        The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job.

      • TotalProcessed (integer) --

        The total number of endpoint definitions that were processed by the import job.

      • Type (string) --

        The job type. This value is IMPORT for import jobs.

Exceptions

  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.PayloadTooLargeException
  • Pinpoint.Client.exceptions.ForbiddenException
  • Pinpoint.Client.exceptions.NotFoundException
  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
create_journey(**kwargs)

Creates a journey for an application.

See also: AWS API Documentation

Request Syntax

response = client.create_journey(
    ApplicationId='string',
    WriteJourneyRequest={
        'Activities': {
            'string': {
                'CUSTOM': {
                    'DeliveryUri': 'string',
                    'EndpointTypes': [
                        'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
                    ],
                    'MessageConfig': {
                        'Data': 'string'
                    },
                    'NextActivity': 'string',
                    'TemplateName': 'string',
                    'TemplateVersion': 'string'
                },
                'ConditionalSplit': {
                    'Condition': {
                        'Conditions': [
                            {
                                'EventCondition': {
                                    'Dimensions': {
                                        'Attributes': {
                                            'string': {
                                                'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                                'Values': [
                                                    'string',
                                                ]
                                            }
                                        },
                                        'EventType': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Metrics': {
                                            'string': {
                                                'ComparisonOperator': 'string',
                                                'Value': 123.0
                                            }
                                        }
                                    },
                                    'MessageActivity': 'string'
                                },
                                'SegmentCondition': {
                                    'SegmentId': 'string'
                                },
                                'SegmentDimensions': {
                                    'Attributes': {
                                        'string': {
                                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        }
                                    },
                                    'Behavior': {
                                        'Recency': {
                                            'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                                            'RecencyType': 'ACTIVE'|'INACTIVE'
                                        }
                                    },
                                    'Demographic': {
                                        'AppVersion': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Channel': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'DeviceType': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Make': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Model': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Platform': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        }
                                    },
                                    'Location': {
                                        'Country': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'GPSPoint': {
                                            'Coordinates': {
                                                'Latitude': 123.0,
                                                'Longitude': 123.0
                                            },
                                            'RangeInKilometers': 123.0
                                        }
                                    },
                                    'Metrics': {
                                        'string': {
                                            'ComparisonOperator': 'string',
                                            'Value': 123.0
                                        }
                                    },
                                    'UserAttributes': {
                                        'string': {
                                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        }
                                    }
                                }
                            },
                        ],
                        'Operator': 'ALL'|'ANY'
                    },
                    'EvaluationWaitTime': {
                        'WaitFor': 'string',
                        'WaitUntil': 'string'
                    },
                    'FalseActivity': 'string',
                    'TrueActivity': 'string'
                },
                'Description': 'string',
                'EMAIL': {
                    'MessageConfig': {
                        'FromAddress': 'string'
                    },
                    'NextActivity': 'string',
                    'TemplateName': 'string',
                    'TemplateVersion': 'string'
                },
                'Holdout': {
                    'NextActivity': 'string',
                    'Percentage': 123
                },
                'MultiCondition': {
                    'Branches': [
                        {
                            'Condition': {
                                'EventCondition': {
                                    'Dimensions': {
                                        'Attributes': {
                                            'string': {
                                                'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                                'Values': [
                                                    'string',
                                                ]
                                            }
                                        },
                                        'EventType': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Metrics': {
                                            'string': {
                                                'ComparisonOperator': 'string',
                                                'Value': 123.0
                                            }
                                        }
                                    },
                                    'MessageActivity': 'string'
                                },
                                'SegmentCondition': {
                                    'SegmentId': 'string'
                                },
                                'SegmentDimensions': {
                                    'Attributes': {
                                        'string': {
                                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        }
                                    },
                                    'Behavior': {
                                        'Recency': {
                                            'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                                            'RecencyType': 'ACTIVE'|'INACTIVE'
                                        }
                                    },
                                    'Demographic': {
                                        'AppVersion': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Channel': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'DeviceType': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Make': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Model': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Platform': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        }
                                    },
                                    'Location': {
                                        'Country': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'GPSPoint': {
                                            'Coordinates': {
                                                'Latitude': 123.0,
                                                'Longitude': 123.0
                                            },
                                            'RangeInKilometers': 123.0
                                        }
                                    },
                                    'Metrics': {
                                        'string': {
                                            'ComparisonOperator': 'string',
                                            'Value': 123.0
                                        }
                                    },
                                    'UserAttributes': {
                                        'string': {
                                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        }
                                    }
                                }
                            },
                            'NextActivity': 'string'
                        },
                    ],
                    'DefaultActivity': 'string',
                    'EvaluationWaitTime': {
                        'WaitFor': 'string',
                        'WaitUntil': 'string'
                    }
                },
                'PUSH': {
                    'MessageConfig': {
                        'TimeToLive': 'string'
                    },
                    'NextActivity': 'string',
                    'TemplateName': 'string',
                    'TemplateVersion': 'string'
                },
                'RandomSplit': {
                    'Branches': [
                        {
                            'NextActivity': 'string',
                            'Percentage': 123
                        },
                    ]
                },
                'SMS': {
                    'MessageConfig': {
                        'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                        'SenderId': 'string'
                    },
                    'NextActivity': 'string',
                    'TemplateName': 'string',
                    'TemplateVersion': 'string'
                },
                'Wait': {
                    'NextActivity': 'string',
                    'WaitTime': {
                        'WaitFor': 'string',
                        'WaitUntil': 'string'
                    }
                }
            }
        },
        'CreationDate': 'string',
        'LastModifiedDate': 'string',
        'Limits': {
            'DailyCap': 123,
            'EndpointReentryCap': 123,
            'MessagesPerSecond': 123
        },
        'LocalTime': True|False,
        'Name': 'string',
        'QuietTime': {
            'End': 'string',
            'Start': 'string'
        },
        'RefreshFrequency': 'string',
        'Schedule': {
            'EndTime': datetime(2015, 1, 1),
            'StartTime': datetime(2015, 1, 1),
            'Timezone': 'string'
        },
        'StartActivity': 'string',
        'StartCondition': {
            'Description': 'string',
            'EventStartCondition': {
                'EventFilter': {
                    'Dimensions': {
                        'Attributes': {
                            'string': {
                                'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                'Values': [
                                    'string',
                                ]
                            }
                        },
                        'EventType': {
                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        },
                        'Metrics': {
                            'string': {
                                'ComparisonOperator': 'string',
                                'Value': 123.0
                            }
                        }
                    },
                    'FilterType': 'SYSTEM'|'ENDPOINT'
                },
                'SegmentId': 'string'
            },
            'SegmentStartCondition': {
                'SegmentId': 'string'
            }
        },
        'State': 'DRAFT'|'ACTIVE'|'COMPLETED'|'CANCELLED'|'CLOSED'
    }
)
Parameters
  • ApplicationId (string) --

    [REQUIRED]

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

  • WriteJourneyRequest (dict) --

    [REQUIRED]

    Specifies the configuration and other settings for a journey.

    • Activities (dict) --

      A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 100 characters. The characters must be alphanumeric characters.

      • (string) --
        • (dict) --

          Specifies the configuration and other settings for an activity in a journey.

          • CUSTOM (dict) --

            The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

            • DeliveryUri (string) --

              The destination to send the campaign or treatment to. This value can be one of the following:

              • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
              • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
            • EndpointTypes (list) --

              The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

              • (string) --
            • MessageConfig (dict) --

              Specifies the message data included in a custom channel message that's sent to participants in a journey.

              • Data (string) --

                The message content that's passed to an AWS Lambda function or to a web hook.

            • NextActivity (string) --

              The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.

            • TemplateName (string) --

              The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.

            • TemplateVersion (string) --

              The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

              If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

          • ConditionalSplit (dict) --

            The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.

            • Condition (dict) --

              The conditions that define the paths for the activity, and the relationship between the conditions.

              • Conditions (list) --

                The conditions to evaluate for the activity.

                • (dict) --

                  Specifies a condition to evaluate for an activity in a journey.

                  • EventCondition (dict) --

                    The dimension settings for the event that's associated with the activity.

                    • Dimensions (dict) --

                      The dimensions for the event filter to use for the activity.

                      • Attributes (dict) --

                        One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

                        • (string) --
                          • (dict) --

                            Specifies attribute-based criteria for including or excluding endpoints from a segment.

                            • AttributeType (string) --

                              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                            • Values (list) -- [REQUIRED]

                              The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                              • (string) --
                      • EventType (dict) --

                        The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .

                        • DimensionType (string) --

                          The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        • Values (list) -- [REQUIRED]

                          The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                          • (string) --
                      • Metrics (dict) --

                        One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

                        • (string) --
                          • (dict) --

                            Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

                            • ComparisonOperator (string) -- [REQUIRED]

                              The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                            • Value (float) -- [REQUIRED]

                              The value to compare.

                    • MessageActivity (string) --

                      The message identifier (message_id) for the message to use when determining whether message events meet the condition.

                  • SegmentCondition (dict) --

                    The segment that's associated with the activity.

                    • SegmentId (string) -- [REQUIRED]

                      The unique identifier for the segment to associate with the activity.

                  • SegmentDimensions (dict) --

                    The dimension settings for the segment that's associated with the activity.

                    • Attributes (dict) --

                      One or more custom attributes to use as criteria for the segment.

                      • (string) --
                        • (dict) --

                          Specifies attribute-based criteria for including or excluding endpoints from a segment.

                          • AttributeType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) -- [REQUIRED]

                            The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                            • (string) --
                    • Behavior (dict) --

                      The behavior-based criteria, such as how recently users have used your app, for the segment.

                      • Recency (dict) --

                        The dimension settings that are based on how recently an endpoint was active.

                        • Duration (string) -- [REQUIRED]

                          The duration to use when determining whether an endpoint is active or inactive.

                        • RecencyType (string) -- [REQUIRED]

                          The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

                    • Demographic (dict) --

                      The demographic-based criteria, such as device platform, for the segment.

                      • AppVersion (dict) --

                        The app version criteria for the segment.

                        • DimensionType (string) --

                          The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        • Values (list) -- [REQUIRED]

                          The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                          • (string) --
                      • Channel (dict) --

                        The channel criteria for the segment.

                        • DimensionType (string) --

                          The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        • Values (list) -- [REQUIRED]

                          The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                          • (string) --
                      • DeviceType (dict) --

                        The device type criteria for the segment.

                        • DimensionType (string) --

                          The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        • Values (list) -- [REQUIRED]

                          The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                          • (string) --
                      • Make (dict) --

                        The device make criteria for the segment.

                        • DimensionType (string) --

                          The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        • Values (list) -- [REQUIRED]

                          The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                          • (string) --
                      • Model (dict) --

                        The device model criteria for the segment.

                        • DimensionType (string) --

                          The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        • Values (list) -- [REQUIRED]

                          The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                          • (string) --
                      • Platform (dict) --

                        The device platform criteria for the segment.

                        • DimensionType (string) --

                          The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        • Values (list) -- [REQUIRED]

                          The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                          • (string) --
                    • Location (dict) --

                      The location-based criteria, such as region or GPS coordinates, for the segment.

                      • Country (dict) --

                        The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

                        • DimensionType (string) --

                          The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        • Values (list) -- [REQUIRED]

                          The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                          • (string) --
                      • GPSPoint (dict) --

                        The GPS location and range for the segment.

                        • Coordinates (dict) -- [REQUIRED]

                          The GPS coordinates to measure distance from.

                          • Latitude (float) -- [REQUIRED]

                            The latitude coordinate of the location.

                          • Longitude (float) -- [REQUIRED]

                            The longitude coordinate of the location.

                        • RangeInKilometers (float) --

                          The range, in kilometers, from the GPS coordinates.

                    • Metrics (dict) --

                      One or more custom metrics to use as criteria for the segment.

                      • (string) --
                        • (dict) --

                          Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

                          • ComparisonOperator (string) -- [REQUIRED]

                            The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                          • Value (float) -- [REQUIRED]

                            The value to compare.

                    • UserAttributes (dict) --

                      One or more custom user attributes to use as criteria for the segment.

                      • (string) --
                        • (dict) --

                          Specifies attribute-based criteria for including or excluding endpoints from a segment.

                          • AttributeType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) -- [REQUIRED]

                            The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                            • (string) --
              • Operator (string) --

                Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.

            • EvaluationWaitTime (dict) --

              The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.

              • WaitFor (string) --

                The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.

              • WaitUntil (string) --

                The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.

            • FalseActivity (string) --

              The unique identifier for the activity to perform if the conditions aren't met.

            • TrueActivity (string) --

              The unique identifier for the activity to perform if the conditions are met.

          • Description (string) --

            The custom description of the activity.

          • EMAIL (dict) --

            The settings for an email activity. This type of activity sends an email message to participants.

            • MessageConfig (dict) --

              Specifies the sender address for an email message that's sent to participants in the journey.

              • FromAddress (string) --

                The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.

            • NextActivity (string) --

              The unique identifier for the next activity to perform, after the message is sent.

            • TemplateName (string) --

              The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.

            • TemplateVersion (string) --

              The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

              If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

          • Holdout (dict) --

            The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.

            • NextActivity (string) --

              The unique identifier for the next activity to perform, after performing the holdout activity.

            • Percentage (integer) -- [REQUIRED]

              The percentage of participants who shouldn't continue the journey.

              To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.

          • MultiCondition (dict) --

            The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.

            • Branches (list) --

              The paths for the activity, including the conditions for entering each path and the activity to perform for each path.

              • (dict) --

                Specifies a condition to evaluate for an activity path in a journey.

                • Condition (dict) --

                  The condition to evaluate for the activity path.

                  • EventCondition (dict) --

                    The dimension settings for the event that's associated with the activity.

                    • Dimensions (dict) --

                      The dimensions for the event filter to use for the activity.

                      • Attributes (dict) --

                        One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

                        • (string) --
                          • (dict) --

                            Specifies attribute-based criteria for including or excluding endpoints from a segment.

                            • AttributeType (string) --

                              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                            • Values (list) -- [REQUIRED]

                              The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                              • (string) --
                      • EventType (dict) --

                        The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .

                        • DimensionType (string) --

                          The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        • Values (list) -- [REQUIRED]

                          The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                          • (string) --
                      • Metrics (dict) --

                        One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

                        • (string) --
                          • (dict) --

                            Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

                            • ComparisonOperator (string) -- [REQUIRED]

                              The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                            • Value (float) -- [REQUIRED]

                              The value to compare.

                    • MessageActivity (string) --

                      The message identifier (message_id) for the message to use when determining whether message events meet the condition.

                  • SegmentCondition (dict) --

                    The segment that's associated with the activity.

                    • SegmentId (string) -- [REQUIRED]

                      The unique identifier for the segment to associate with the activity.

                  • SegmentDimensions (dict) --

                    The dimension settings for the segment that's associated with the activity.

                    • Attributes (dict) --

                      One or more custom attributes to use as criteria for the segment.

                      • (string) --
                        • (dict) --

                          Specifies attribute-based criteria for including or excluding endpoints from a segment.

                          • AttributeType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) -- [REQUIRED]

                            The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                            • (string) --
                    • Behavior (dict) --

                      The behavior-based criteria, such as how recently users have used your app, for the segment.

                      • Recency (dict) --

                        The dimension settings that are based on how recently an endpoint was active.

                        • Duration (string) -- [REQUIRED]

                          The duration to use when determining whether an endpoint is active or inactive.

                        • RecencyType (string) -- [REQUIRED]

                          The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

                    • Demographic (dict) --

                      The demographic-based criteria, such as device platform, for the segment.

                      • AppVersion (dict) --

                        The app version criteria for the segment.

                        • DimensionType (string) --

                          The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        • Values (list) -- [REQUIRED]

                          The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                          • (string) --
                      • Channel (dict) --

                        The channel criteria for the segment.

                        • DimensionType (string) --

                          The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        • Values (list) -- [REQUIRED]

                          The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                          • (string) --
                      • DeviceType (dict) --

                        The device type criteria for the segment.

                        • DimensionType (string) --

                          The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        • Values (list) -- [REQUIRED]

                          The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                          • (string) --
                      • Make (dict) --

                        The device make criteria for the segment.

                        • DimensionType (string) --

                          The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        • Values (list) -- [REQUIRED]

                          The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                          • (string) --
                      • Model (dict) --

                        The device model criteria for the segment.

                        • DimensionType (string) --

                          The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        • Values (list) -- [REQUIRED]

                          The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                          • (string) --
                      • Platform (dict) --

                        The device platform criteria for the segment.

                        • DimensionType (string) --

                          The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        • Values (list) -- [REQUIRED]

                          The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                          • (string) --
                    • Location (dict) --

                      The location-based criteria, such as region or GPS coordinates, for the segment.

                      • Country (dict) --

                        The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

                        • DimensionType (string) --

                          The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        • Values (list) -- [REQUIRED]

                          The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                          • (string) --
                      • GPSPoint (dict) --

                        The GPS location and range for the segment.

                        • Coordinates (dict) -- [REQUIRED]

                          The GPS coordinates to measure distance from.

                          • Latitude (float) -- [REQUIRED]

                            The latitude coordinate of the location.

                          • Longitude (float) -- [REQUIRED]

                            The longitude coordinate of the location.

                        • RangeInKilometers (float) --

                          The range, in kilometers, from the GPS coordinates.

                    • Metrics (dict) --

                      One or more custom metrics to use as criteria for the segment.

                      • (string) --
                        • (dict) --

                          Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

                          • ComparisonOperator (string) -- [REQUIRED]

                            The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                          • Value (float) -- [REQUIRED]

                            The value to compare.

                    • UserAttributes (dict) --

                      One or more custom user attributes to use as criteria for the segment.

                      • (string) --
                        • (dict) --

                          Specifies attribute-based criteria for including or excluding endpoints from a segment.

                          • AttributeType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) -- [REQUIRED]

                            The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                            • (string) --
                • NextActivity (string) --

                  The unique identifier for the next activity to perform, after completing the activity for the path.

            • DefaultActivity (string) --

              The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.

            • EvaluationWaitTime (dict) --

              The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.

              • WaitFor (string) --

                The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.

              • WaitUntil (string) --

                The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.

          • PUSH (dict) --

            The settings for a push notification activity. This type of activity sends a push notification to participants.

            • MessageConfig (dict) --

              Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.

              • TimeToLive (string) --

                The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

            • NextActivity (string) --

              The unique identifier for the next activity to perform, after the message is sent.

            • TemplateName (string) --

              The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.

            • TemplateVersion (string) --

              The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

              If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

          • RandomSplit (dict) --

            The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.

            • Branches (list) --

              The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.

              • (dict) --

                Specifies the settings for a path in a random split activity in a journey.

                • NextActivity (string) --

                  The unique identifier for the next activity to perform, after completing the activity for the path.

                • Percentage (integer) --

                  The percentage of participants to send down the activity path.

                  To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.

          • SMS (dict) --

            The settings for an SMS activity. This type of activity sends a text message to participants.

            • MessageConfig (dict) --

              Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.

              • MessageType (string) --

                The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

              • SenderId (string) --

                The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.

            • NextActivity (string) --

              The unique identifier for the next activity to perform, after the message is sent.

            • TemplateName (string) --

              The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.

            • TemplateVersion (string) --

              The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

              If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

          • Wait (dict) --

            The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

            • NextActivity (string) --

              The unique identifier for the next activity to perform, after performing the wait activity.

            • WaitTime (dict) --

              The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.

              • WaitFor (string) --

                The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.

              • WaitUntil (string) --

                The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.

    • CreationDate (string) --

      The date, in ISO 8601 format, when the journey was created.

    • LastModifiedDate (string) --

      The date, in ISO 8601 format, when the journey was last modified.

    • Limits (dict) --

      The messaging and entry limits for the journey.

      • DailyCap (integer) --

        The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.

      • EndpointReentryCap (integer) --

        The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.

      • MessagesPerSecond (integer) --

        The maximum number of messages that the journey can send each second.

    • LocalTime (boolean) --

      Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.

    • Name (string) -- [REQUIRED]

      The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.

    • QuietTime (dict) --

      The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

      • The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
      • The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
      • The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

      If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

      • End (string) --

        The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

      • Start (string) --

        The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

    • RefreshFrequency (string) --

      The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

    • Schedule (dict) --

      The schedule settings for the journey.

      • EndTime (datetime) --

        The scheduled time, in ISO 8601 format, when the journey ended or will end.

      • StartTime (datetime) --

        The scheduled time, in ISO 8601 format, when the journey began or will begin.

      • Timezone (string) --

        The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.

    • StartActivity (string) --

      The unique identifier for the first activity in the journey. The identifier for this activity can contain a maximum of 128 characters. The characters must be alphanumeric characters.

    • StartCondition (dict) --

      The segment that defines which users are participants in the journey.

      • Description (string) --

        The custom description of the condition.

      • EventStartCondition (dict) --

        Specifies the settings for an event that causes a journey activity to start.

        • EventFilter (dict) --

          Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.

          • Dimensions (dict) -- [REQUIRED]

            The dimensions for the event filter to use for the campaign or the journey activity.

            • Attributes (dict) --

              One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

              • (string) --
                • (dict) --

                  Specifies attribute-based criteria for including or excluding endpoints from a segment.

                  • AttributeType (string) --

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  • Values (list) -- [REQUIRED]

                    The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                    • (string) --
            • EventType (dict) --

              The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .

              • DimensionType (string) --

                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

              • Values (list) -- [REQUIRED]

                The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                • (string) --
            • Metrics (dict) --

              One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

              • (string) --
                • (dict) --

                  Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

                  • ComparisonOperator (string) -- [REQUIRED]

                    The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                  • Value (float) -- [REQUIRED]

                    The value to compare.

          • FilterType (string) -- [REQUIRED]

            The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.

        • SegmentId (string) --
      • SegmentStartCondition (dict) --

        The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.

        • SegmentId (string) -- [REQUIRED]

          The unique identifier for the segment to associate with the activity.

    • State (string) --

      The status of the journey. Valid values are:

      • DRAFT - Saves the journey and doesn't publish it.
      • ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.

      The CANCELLED, COMPLETED, and CLOSED values are not supported in requests to create or update a journey. To cancel a journey, use the Journey Stateresource.

Return type

dict

Returns

Response Syntax

{
    'JourneyResponse': {
        'Activities': {
            'string': {
                'CUSTOM': {
                    'DeliveryUri': 'string',
                    'EndpointTypes': [
                        'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
                    ],
                    'MessageConfig': {
                        'Data': 'string'
                    },
                    'NextActivity': 'string',
                    'TemplateName': 'string',
                    'TemplateVersion': 'string'
                },
                'ConditionalSplit': {
                    'Condition': {
                        'Conditions': [
                            {
                                'EventCondition': {
                                    'Dimensions': {
                                        'Attributes': {
                                            'string': {
                                                'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                                'Values': [
                                                    'string',
                                                ]
                                            }
                                        },
                                        'EventType': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Metrics': {
                                            'string': {
                                                'ComparisonOperator': 'string',
                                                'Value': 123.0
                                            }
                                        }
                                    },
                                    'MessageActivity': 'string'
                                },
                                'SegmentCondition': {
                                    'SegmentId': 'string'
                                },
                                'SegmentDimensions': {
                                    'Attributes': {
                                        'string': {
                                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        }
                                    },
                                    'Behavior': {
                                        'Recency': {
                                            'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                                            'RecencyType': 'ACTIVE'|'INACTIVE'
                                        }
                                    },
                                    'Demographic': {
                                        'AppVersion': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Channel': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'DeviceType': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Make': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Model': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Platform': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        }
                                    },
                                    'Location': {
                                        'Country': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'GPSPoint': {
                                            'Coordinates': {
                                                'Latitude': 123.0,
                                                'Longitude': 123.0
                                            },
                                            'RangeInKilometers': 123.0
                                        }
                                    },
                                    'Metrics': {
                                        'string': {
                                            'ComparisonOperator': 'string',
                                            'Value': 123.0
                                        }
                                    },
                                    'UserAttributes': {
                                        'string': {
                                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        }
                                    }
                                }
                            },
                        ],
                        'Operator': 'ALL'|'ANY'
                    },
                    'EvaluationWaitTime': {
                        'WaitFor': 'string',
                        'WaitUntil': 'string'
                    },
                    'FalseActivity': 'string',
                    'TrueActivity': 'string'
                },
                'Description': 'string',
                'EMAIL': {
                    'MessageConfig': {
                        'FromAddress': 'string'
                    },
                    'NextActivity': 'string',
                    'TemplateName': 'string',
                    'TemplateVersion': 'string'
                },
                'Holdout': {
                    'NextActivity': 'string',
                    'Percentage': 123
                },
                'MultiCondition': {
                    'Branches': [
                        {
                            'Condition': {
                                'EventCondition': {
                                    'Dimensions': {
                                        'Attributes': {
                                            'string': {
                                                'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                                'Values': [
                                                    'string',
                                                ]
                                            }
                                        },
                                        'EventType': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Metrics': {
                                            'string': {
                                                'ComparisonOperator': 'string',
                                                'Value': 123.0
                                            }
                                        }
                                    },
                                    'MessageActivity': 'string'
                                },
                                'SegmentCondition': {
                                    'SegmentId': 'string'
                                },
                                'SegmentDimensions': {
                                    'Attributes': {
                                        'string': {
                                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        }
                                    },
                                    'Behavior': {
                                        'Recency': {
                                            'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                                            'RecencyType': 'ACTIVE'|'INACTIVE'
                                        }
                                    },
                                    'Demographic': {
                                        'AppVersion': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Channel': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'DeviceType': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Make': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Model': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Platform': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        }
                                    },
                                    'Location': {
                                        'Country': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'GPSPoint': {
                                            'Coordinates': {
                                                'Latitude': 123.0,
                                                'Longitude': 123.0
                                            },
                                            'RangeInKilometers': 123.0
                                        }
                                    },
                                    'Metrics': {
                                        'string': {
                                            'ComparisonOperator': 'string',
                                            'Value': 123.0
                                        }
                                    },
                                    'UserAttributes': {
                                        'string': {
                                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        }
                                    }
                                }
                            },
                            'NextActivity': 'string'
                        },
                    ],
                    'DefaultActivity': 'string',
                    'EvaluationWaitTime': {
                        'WaitFor': 'string',
                        'WaitUntil': 'string'
                    }
                },
                'PUSH': {
                    'MessageConfig': {
                        'TimeToLive': 'string'
                    },
                    'NextActivity': 'string',
                    'TemplateName': 'string',
                    'TemplateVersion': 'string'
                },
                'RandomSplit': {
                    'Branches': [
                        {
                            'NextActivity': 'string',
                            'Percentage': 123
                        },
                    ]
                },
                'SMS': {
                    'MessageConfig': {
                        'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                        'SenderId': 'string'
                    },
                    'NextActivity': 'string',
                    'TemplateName': 'string',
                    'TemplateVersion': 'string'
                },
                'Wait': {
                    'NextActivity': 'string',
                    'WaitTime': {
                        'WaitFor': 'string',
                        'WaitUntil': 'string'
                    }
                }
            }
        },
        'ApplicationId': 'string',
        'CreationDate': 'string',
        'Id': 'string',
        'LastModifiedDate': 'string',
        'Limits': {
            'DailyCap': 123,
            'EndpointReentryCap': 123,
            'MessagesPerSecond': 123
        },
        'LocalTime': True|False,
        'Name': 'string',
        'QuietTime': {
            'End': 'string',
            'Start': 'string'
        },
        'RefreshFrequency': 'string',
        'Schedule': {
            'EndTime': datetime(2015, 1, 1),
            'StartTime': datetime(2015, 1, 1),
            'Timezone': 'string'
        },
        'StartActivity': 'string',
        'StartCondition': {
            'Description': 'string',
            'EventStartCondition': {
                'EventFilter': {
                    'Dimensions': {
                        'Attributes': {
                            'string': {
                                'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                'Values': [
                                    'string',
                                ]
                            }
                        },
                        'EventType': {
                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        },
                        'Metrics': {
                            'string': {
                                'ComparisonOperator': 'string',
                                'Value': 123.0
                            }
                        }
                    },
                    'FilterType': 'SYSTEM'|'ENDPOINT'
                },
                'SegmentId': 'string'
            },
            'SegmentStartCondition': {
                'SegmentId': 'string'
            }
        },
        'State': 'DRAFT'|'ACTIVE'|'COMPLETED'|'CANCELLED'|'CLOSED',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    The request succeeded and the specified resource was created.

    • JourneyResponse (dict) --

      Provides information about the status, configuration, and other settings for a journey.

      • Activities (dict) --

        A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.

        • (string) --

          • (dict) --

            Specifies the configuration and other settings for an activity in a journey.

            • CUSTOM (dict) --

              The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

              • DeliveryUri (string) --

                The destination to send the campaign or treatment to. This value can be one of the following:

                • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
                • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
              • EndpointTypes (list) --

                The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

                • (string) --
              • MessageConfig (dict) --

                Specifies the message data included in a custom channel message that's sent to participants in a journey.

                • Data (string) --

                  The message content that's passed to an AWS Lambda function or to a web hook.

              • NextActivity (string) --

                The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.

              • TemplateName (string) --

                The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.

              • TemplateVersion (string) --

                The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

                If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

            • ConditionalSplit (dict) --

              The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.

              • Condition (dict) --

                The conditions that define the paths for the activity, and the relationship between the conditions.

                • Conditions (list) --

                  The conditions to evaluate for the activity.

                  • (dict) --

                    Specifies a condition to evaluate for an activity in a journey.

                    • EventCondition (dict) --

                      The dimension settings for the event that's associated with the activity.

                      • Dimensions (dict) --

                        The dimensions for the event filter to use for the activity.

                        • Attributes (dict) --

                          One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

                          • (string) --

                            • (dict) --

                              Specifies attribute-based criteria for including or excluding endpoints from a segment.

                              • AttributeType (string) --

                                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                              • Values (list) --

                                The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                                • (string) --
                        • EventType (dict) --

                          The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • Metrics (dict) --

                          One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

                          • (string) --

                            • (dict) --

                              Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

                              • ComparisonOperator (string) --

                                The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                              • Value (float) --

                                The value to compare.

                      • MessageActivity (string) --

                        The message identifier (message_id) for the message to use when determining whether message events meet the condition.

                    • SegmentCondition (dict) --

                      The segment that's associated with the activity.

                      • SegmentId (string) --

                        The unique identifier for the segment to associate with the activity.

                    • SegmentDimensions (dict) --

                      The dimension settings for the segment that's associated with the activity.

                      • Attributes (dict) --

                        One or more custom attributes to use as criteria for the segment.

                        • (string) --

                          • (dict) --

                            Specifies attribute-based criteria for including or excluding endpoints from a segment.

                            • AttributeType (string) --

                              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                            • Values (list) --

                              The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                              • (string) --
                      • Behavior (dict) --

                        The behavior-based criteria, such as how recently users have used your app, for the segment.

                        • Recency (dict) --

                          The dimension settings that are based on how recently an endpoint was active.

                          • Duration (string) --

                            The duration to use when determining whether an endpoint is active or inactive.

                          • RecencyType (string) --

                            The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

                      • Demographic (dict) --

                        The demographic-based criteria, such as device platform, for the segment.

                        • AppVersion (dict) --

                          The app version criteria for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • Channel (dict) --

                          The channel criteria for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • DeviceType (dict) --

                          The device type criteria for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • Make (dict) --

                          The device make criteria for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • Model (dict) --

                          The device model criteria for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • Platform (dict) --

                          The device platform criteria for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                      • Location (dict) --

                        The location-based criteria, such as region or GPS coordinates, for the segment.

                        • Country (dict) --

                          The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • GPSPoint (dict) --

                          The GPS location and range for the segment.

                          • Coordinates (dict) --

                            The GPS coordinates to measure distance from.

                            • Latitude (float) --

                              The latitude coordinate of the location.

                            • Longitude (float) --

                              The longitude coordinate of the location.

                          • RangeInKilometers (float) --

                            The range, in kilometers, from the GPS coordinates.

                      • Metrics (dict) --

                        One or more custom metrics to use as criteria for the segment.

                        • (string) --

                          • (dict) --

                            Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

                            • ComparisonOperator (string) --

                              The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                            • Value (float) --

                              The value to compare.

                      • UserAttributes (dict) --

                        One or more custom user attributes to use as criteria for the segment.

                        • (string) --

                          • (dict) --

                            Specifies attribute-based criteria for including or excluding endpoints from a segment.

                            • AttributeType (string) --

                              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                            • Values (list) --

                              The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                              • (string) --
                • Operator (string) --

                  Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.

              • EvaluationWaitTime (dict) --

                The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.

                • WaitFor (string) --

                  The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.

                • WaitUntil (string) --

                  The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.

              • FalseActivity (string) --

                The unique identifier for the activity to perform if the conditions aren't met.

              • TrueActivity (string) --

                The unique identifier for the activity to perform if the conditions are met.

            • Description (string) --

              The custom description of the activity.

            • EMAIL (dict) --

              The settings for an email activity. This type of activity sends an email message to participants.

              • MessageConfig (dict) --

                Specifies the sender address for an email message that's sent to participants in the journey.

                • FromAddress (string) --

                  The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.

              • NextActivity (string) --

                The unique identifier for the next activity to perform, after the message is sent.

              • TemplateName (string) --

                The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.

              • TemplateVersion (string) --

                The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

                If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

            • Holdout (dict) --

              The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.

              • NextActivity (string) --

                The unique identifier for the next activity to perform, after performing the holdout activity.

              • Percentage (integer) --

                The percentage of participants who shouldn't continue the journey.

                To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.

            • MultiCondition (dict) --

              The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.

              • Branches (list) --

                The paths for the activity, including the conditions for entering each path and the activity to perform for each path.

                • (dict) --

                  Specifies a condition to evaluate for an activity path in a journey.

                  • Condition (dict) --

                    The condition to evaluate for the activity path.

                    • EventCondition (dict) --

                      The dimension settings for the event that's associated with the activity.

                      • Dimensions (dict) --

                        The dimensions for the event filter to use for the activity.

                        • Attributes (dict) --

                          One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

                          • (string) --

                            • (dict) --

                              Specifies attribute-based criteria for including or excluding endpoints from a segment.

                              • AttributeType (string) --

                                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                              • Values (list) --

                                The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                                • (string) --
                        • EventType (dict) --

                          The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • Metrics (dict) --

                          One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

                          • (string) --

                            • (dict) --

                              Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

                              • ComparisonOperator (string) --

                                The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                              • Value (float) --

                                The value to compare.

                      • MessageActivity (string) --

                        The message identifier (message_id) for the message to use when determining whether message events meet the condition.

                    • SegmentCondition (dict) --

                      The segment that's associated with the activity.

                      • SegmentId (string) --

                        The unique identifier for the segment to associate with the activity.

                    • SegmentDimensions (dict) --

                      The dimension settings for the segment that's associated with the activity.

                      • Attributes (dict) --

                        One or more custom attributes to use as criteria for the segment.

                        • (string) --

                          • (dict) --

                            Specifies attribute-based criteria for including or excluding endpoints from a segment.

                            • AttributeType (string) --

                              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                            • Values (list) --

                              The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                              • (string) --
                      • Behavior (dict) --

                        The behavior-based criteria, such as how recently users have used your app, for the segment.

                        • Recency (dict) --

                          The dimension settings that are based on how recently an endpoint was active.

                          • Duration (string) --

                            The duration to use when determining whether an endpoint is active or inactive.

                          • RecencyType (string) --

                            The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

                      • Demographic (dict) --

                        The demographic-based criteria, such as device platform, for the segment.

                        • AppVersion (dict) --

                          The app version criteria for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • Channel (dict) --

                          The channel criteria for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • DeviceType (dict) --

                          The device type criteria for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • Make (dict) --

                          The device make criteria for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • Model (dict) --

                          The device model criteria for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • Platform (dict) --

                          The device platform criteria for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                      • Location (dict) --

                        The location-based criteria, such as region or GPS coordinates, for the segment.

                        • Country (dict) --

                          The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • GPSPoint (dict) --

                          The GPS location and range for the segment.

                          • Coordinates (dict) --

                            The GPS coordinates to measure distance from.

                            • Latitude (float) --

                              The latitude coordinate of the location.

                            • Longitude (float) --

                              The longitude coordinate of the location.

                          • RangeInKilometers (float) --

                            The range, in kilometers, from the GPS coordinates.

                      • Metrics (dict) --

                        One or more custom metrics to use as criteria for the segment.

                        • (string) --

                          • (dict) --

                            Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

                            • ComparisonOperator (string) --

                              The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                            • Value (float) --

                              The value to compare.

                      • UserAttributes (dict) --

                        One or more custom user attributes to use as criteria for the segment.

                        • (string) --

                          • (dict) --

                            Specifies attribute-based criteria for including or excluding endpoints from a segment.

                            • AttributeType (string) --

                              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                            • Values (list) --

                              The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                              • (string) --
                  • NextActivity (string) --

                    The unique identifier for the next activity to perform, after completing the activity for the path.

              • DefaultActivity (string) --

                The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.

              • EvaluationWaitTime (dict) --

                The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.

                • WaitFor (string) --

                  The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.

                • WaitUntil (string) --

                  The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.

            • PUSH (dict) --

              The settings for a push notification activity. This type of activity sends a push notification to participants.

              • MessageConfig (dict) --

                Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.

                • TimeToLive (string) --

                  The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                  This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • NextActivity (string) --

                The unique identifier for the next activity to perform, after the message is sent.

              • TemplateName (string) --

                The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.

              • TemplateVersion (string) --

                The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

                If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

            • RandomSplit (dict) --

              The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.

              • Branches (list) --

                The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.

                • (dict) --

                  Specifies the settings for a path in a random split activity in a journey.

                  • NextActivity (string) --

                    The unique identifier for the next activity to perform, after completing the activity for the path.

                  • Percentage (integer) --

                    The percentage of participants to send down the activity path.

                    To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.

            • SMS (dict) --

              The settings for an SMS activity. This type of activity sends a text message to participants.

              • MessageConfig (dict) --

                Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.

                • MessageType (string) --

                  The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

                • SenderId (string) --

                  The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.

              • NextActivity (string) --

                The unique identifier for the next activity to perform, after the message is sent.

              • TemplateName (string) --

                The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.

              • TemplateVersion (string) --

                The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

                If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

            • Wait (dict) --

              The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

              • NextActivity (string) --

                The unique identifier for the next activity to perform, after performing the wait activity.

              • WaitTime (dict) --

                The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.

                • WaitFor (string) --

                  The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.

                • WaitUntil (string) --

                  The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.

      • ApplicationId (string) --

        The unique identifier for the application that the journey applies to.

      • CreationDate (string) --

        The date, in ISO 8601 format, when the journey was created.

      • Id (string) --

        The unique identifier for the journey.

      • LastModifiedDate (string) --

        The date, in ISO 8601 format, when the journey was last modified.

      • Limits (dict) --

        The messaging and entry limits for the journey.

        • DailyCap (integer) --

          The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.

        • EndpointReentryCap (integer) --

          The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.

        • MessagesPerSecond (integer) --

          The maximum number of messages that the journey can send each second.

      • LocalTime (boolean) --

        Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.

      • Name (string) --

        The name of the journey.

      • QuietTime (dict) --

        The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

        • The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
        • The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
        • The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

        If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

        • End (string) --

          The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

        • Start (string) --

          The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

      • RefreshFrequency (string) --

        The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

      • Schedule (dict) --

        The schedule settings for the journey.

        • EndTime (datetime) --

          The scheduled time, in ISO 8601 format, when the journey ended or will end.

        • StartTime (datetime) --

          The scheduled time, in ISO 8601 format, when the journey began or will begin.

        • Timezone (string) --

          The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.

      • StartActivity (string) --

        The unique identifier for the first activity in the journey.

      • StartCondition (dict) --

        The segment that defines which users are participants in the journey.

        • Description (string) --

          The custom description of the condition.

        • EventStartCondition (dict) --

          Specifies the settings for an event that causes a journey activity to start.

          • EventFilter (dict) --

            Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.

            • Dimensions (dict) --

              The dimensions for the event filter to use for the campaign or the journey activity.

              • Attributes (dict) --

                One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

                • (string) --

                  • (dict) --

                    Specifies attribute-based criteria for including or excluding endpoints from a segment.

                    • AttributeType (string) --

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    • Values (list) --

                      The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                      • (string) --
              • EventType (dict) --

                The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .

                • DimensionType (string) --

                  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                • Values (list) --

                  The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                  • (string) --
              • Metrics (dict) --

                One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

                • (string) --

                  • (dict) --

                    Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

                    • ComparisonOperator (string) --

                      The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                    • Value (float) --

                      The value to compare.

            • FilterType (string) --

              The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.

          • SegmentId (string) --

        • SegmentStartCondition (dict) --

          The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.

          • SegmentId (string) --

            The unique identifier for the segment to associate with the activity.

      • State (string) --

        The current status of the journey. Possible values are:

        • DRAFT - The journey is being developed and hasn't been published yet.
        • ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
        • COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.
        • CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.
        • CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.
      • tags (dict) --

        This object is not used or supported.

        • (string) --
          • (string) --

Exceptions

  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.PayloadTooLargeException
  • Pinpoint.Client.exceptions.ForbiddenException
  • Pinpoint.Client.exceptions.NotFoundException
  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
create_push_template(**kwargs)

Creates a message template for messages that are sent through a push notification channel.

See also: AWS API Documentation

Request Syntax

response = client.create_push_template(
    PushNotificationTemplateRequest={
        'ADM': {
            'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
            'Body': 'string',
            'ImageIconUrl': 'string',
            'ImageUrl': 'string',
            'RawContent': 'string',
            'SmallImageIconUrl': 'string',
            'Sound': 'string',
            'Title': 'string',
            'Url': 'string'
        },
        'APNS': {
            'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
            'Body': 'string',
            'MediaUrl': 'string',
            'RawContent': 'string',
            'Sound': 'string',
            'Title': 'string',
            'Url': 'string'
        },
        'Baidu': {
            'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
            'Body': 'string',
            'ImageIconUrl': 'string',
            'ImageUrl': 'string',
            'RawContent': 'string',
            'SmallImageIconUrl': 'string',
            'Sound': 'string',
            'Title': 'string',
            'Url': 'string'
        },
        'Default': {
            'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
            'Body': 'string',
            'Sound': 'string',
            'Title': 'string',
            'Url': 'string'
        },
        'DefaultSubstitutions': 'string',
        'GCM': {
            'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
            'Body': 'string',
            'ImageIconUrl': 'string',
            'ImageUrl': 'string',
            'RawContent': 'string',
            'SmallImageIconUrl': 'string',
            'Sound': 'string',
            'Title': 'string',
            'Url': 'string'
        },
        'RecommenderId': 'string',
        'tags': {
            'string': 'string'
        },
        'TemplateDescription': 'string'
    },
    TemplateName='string'
)
Parameters
  • PushNotificationTemplateRequest (dict) --

    [REQUIRED]

    Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.

    • ADM (dict) --

      The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

      • Action (string) --

        The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

        • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
        • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
        • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
      • Body (string) --

        The message body to use in a push notification that's based on the message template.

      • ImageIconUrl (string) --

        The URL of the large icon image to display in the content view of a push notification that's based on the message template.

      • ImageUrl (string) --

        The URL of an image to display in a push notification that's based on the message template.

      • RawContent (string) --

        The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.

      • SmallImageIconUrl (string) --

        The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.

      • Sound (string) --

        The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

      • Title (string) --

        The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.

      • Url (string) --

        The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.

    • APNS (dict) --

      The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

      • Action (string) --

        The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

        • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
        • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
        • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
      • Body (string) --

        The message body to use in push notifications that are based on the message template.

      • MediaUrl (string) --

        The URL of an image or video to display in push notifications that are based on the message template.

      • RawContent (string) --

        The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template. If specified, this value overrides all other content for the message template.

      • Sound (string) --

        The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

      • Title (string) --

        The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.

      • Url (string) --

        The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.

    • Baidu (dict) --

      The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

      • Action (string) --

        The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

        • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
        • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
        • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
      • Body (string) --

        The message body to use in a push notification that's based on the message template.

      • ImageIconUrl (string) --

        The URL of the large icon image to display in the content view of a push notification that's based on the message template.

      • ImageUrl (string) --

        The URL of an image to display in a push notification that's based on the message template.

      • RawContent (string) --

        The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.

      • SmallImageIconUrl (string) --

        The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.

      • Sound (string) --

        The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

      • Title (string) --

        The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.

      • Url (string) --

        The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.

    • Default (dict) --

      The default message template to use for push notification channels.

      • Action (string) --

        The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

        • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
        • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
        • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
      • Body (string) --

        The message body to use in push notifications that are based on the message template.

      • Sound (string) --

        The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

        For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

      • Title (string) --

        The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.

      • Url (string) --

        The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.

    • DefaultSubstitutions (string) --

      A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

    • GCM (dict) --

      The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

      • Action (string) --

        The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

        • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
        • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
        • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
      • Body (string) --

        The message body to use in a push notification that's based on the message template.

      • ImageIconUrl (string) --

        The URL of the large icon image to display in the content view of a push notification that's based on the message template.

      • ImageUrl (string) --

        The URL of an image to display in a push notification that's based on the message template.

      • RawContent (string) --

        The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.

      • SmallImageIconUrl (string) --

        The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.

      • Sound (string) --

        The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

      • Title (string) --

        The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.

      • Url (string) --

        The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.

    • RecommenderId (string) --

      The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

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

      A custom description of the message template.

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

Return type

dict

Returns

Response Syntax

{
    'CreateTemplateMessageBody': {
        'Arn': 'string',
        'Message': 'string',
        'RequestID': 'string'
    }
}

Response Structure

  • (dict) --

    The request succeeded and the specified resource was created.

    • CreateTemplateMessageBody (dict) --

      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.

Exceptions

  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.ForbiddenException
create_recommender_configuration(**kwargs)

Creates an Amazon Pinpoint configuration for a recommender model.

See also: AWS API Documentation

Request Syntax

response = client.create_recommender_configuration(
    CreateRecommenderConfiguration={
        'Attributes': {
            'string': 'string'
        },
        'Description': 'string',
        'Name': 'string',
        'RecommendationProviderIdType': 'string',
        'RecommendationProviderRoleArn': 'string',
        'RecommendationProviderUri': 'string',
        'RecommendationTransformerUri': 'string',
        'RecommendationsDisplayName': 'string',
        'RecommendationsPerMessage': 123
    }
)
Parameters
CreateRecommenderConfiguration (dict) --

[REQUIRED]

Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.

  • Attributes (dict) --

    A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

    In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:

    • An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.
    • An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

    This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.

    • (string) --
      • (string) --
  • Description (string) --

    A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.

  • Name (string) --

    A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

  • RecommendationProviderIdType (string) --

    The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:

    • PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
    • PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.
  • RecommendationProviderRoleArn (string) -- [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.

  • RecommendationProviderUri (string) -- [REQUIRED]

    The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.

  • RecommendationTransformerUri (string) --

    The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.

  • RecommendationsDisplayName (string) --

    A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

    This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.

  • RecommendationsPerMessage (integer) --

    The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.

    To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

Return type
dict
Returns
Response Syntax
{
    'RecommenderConfigurationResponse': {
        'Attributes': {
            'string': 'string'
        },
        'CreationDate': 'string',
        'Description': 'string',
        'Id': 'string',
        'LastModifiedDate': 'string',
        'Name': 'string',
        'RecommendationProviderIdType': 'string',
        'RecommendationProviderRoleArn': 'string',
        'RecommendationProviderUri': 'string',
        'RecommendationTransformerUri': 'string',
        'RecommendationsDisplayName': 'string',
        'RecommendationsPerMessage': 123
    }
}

Response Structure

  • (dict) --

    The request succeeded and the specified resource was created.

    • RecommenderConfigurationResponse (dict) --

      Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.

      • Attributes (dict) --

        A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

        This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

        • (string) --
          • (string) --
      • CreationDate (string) --

        The date, in extended ISO 8601 format, when the configuration was created for the recommender model.

      • Description (string) --

        The custom description of the configuration for the recommender model.

      • Id (string) --

        The unique identifier for the recommender model configuration.

      • LastModifiedDate (string) --

        The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.

      • Name (string) --

        The custom name of the configuration for the recommender model.

      • RecommendationProviderIdType (string) --

        The type of Amazon Pinpoint ID that's associated with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Possible values are:

        • PINPOINT_ENDPOINT_ID - Each user in the model is associated with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
        • PINPOINT_USER_ID - Each user in the model is associated with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If this value is specified, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.
      • RecommendationProviderRoleArn (string) --

        The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.

      • RecommendationProviderUri (string) --

        The Amazon Resource Name (ARN) of the recommender model that Amazon Pinpoint retrieves the recommendation data from. This value is the ARN of an Amazon Personalize campaign.

      • RecommendationTransformerUri (string) --

        The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to perform additional processing of recommendation data that it retrieves from the recommender model.

      • RecommendationsDisplayName (string) --

        The custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console.

        This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

      • RecommendationsPerMessage (integer) --

        The number of recommended items that are retrieved from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables.

Exceptions

  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.PayloadTooLargeException
  • Pinpoint.Client.exceptions.ForbiddenException
  • Pinpoint.Client.exceptions.NotFoundException
  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
create_segment(**kwargs)

Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.

See also: AWS API Documentation

Request Syntax

response = client.create_segment(
    ApplicationId='string',
    WriteSegmentRequest={
        'Dimensions': {
            'Attributes': {
                'string': {
                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            },
            'Behavior': {
                'Recency': {
                    'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                    'RecencyType': 'ACTIVE'|'INACTIVE'
                }
            },
            'Demographic': {
                'AppVersion': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Channel': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'DeviceType': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Make': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Model': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Platform': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            },
            'Location': {
                'Country': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'GPSPoint': {
                    'Coordinates': {
                        'Latitude': 123.0,
                        'Longitude': 123.0
                    },
                    'RangeInKilometers': 123.0
                }
            },
            'Metrics': {
                'string': {
                    'ComparisonOperator': 'string',
                    'Value': 123.0
                }
            },
            'UserAttributes': {
                'string': {
                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            }
        },
        'Name': 'string',
        'SegmentGroups': {
            'Groups': [
                {
                    'Dimensions': [
                        {
                            'Attributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'Behavior': {
                                'Recency': {
                                    'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                                    'RecencyType': 'ACTIVE'|'INACTIVE'
                                }
                            },
                            'Demographic': {
                                'AppVersion': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Channel': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'DeviceType': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Make': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Model': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Platform': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'Location': {
                                'Country': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'GPSPoint': {
                                    'Coordinates': {
                                        'Latitude': 123.0,
                                        'Longitude': 123.0
                                    },
                                    'RangeInKilometers': 123.0
                                }
                            },
                            'Metrics': {
                                'string': {
                                    'ComparisonOperator': 'string',
                                    'Value': 123.0
                                }
                            },
                            'UserAttributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            }
                        },
                    ],
                    'SourceSegments': [
                        {
                            'Id': 'string',
                            'Version': 123
                        },
                    ],
                    'SourceType': 'ALL'|'ANY'|'NONE',
                    'Type': 'ALL'|'ANY'|'NONE'
                },
            ],
            'Include': 'ALL'|'ANY'|'NONE'
        },
        'tags': {
            'string': 'string'
        }
    }
)
Parameters
  • ApplicationId (string) --

    [REQUIRED]

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

  • WriteSegmentRequest (dict) --

    [REQUIRED]

    Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both.

    • Dimensions (dict) --

      The criteria that define the dimensions for the segment.

      • Attributes (dict) --

        One or more custom attributes to use as criteria for the segment.

        • (string) --
          • (dict) --

            Specifies attribute-based criteria for including or excluding endpoints from a segment.

            • AttributeType (string) --

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

            • Values (list) -- [REQUIRED]

              The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

              • (string) --
      • Behavior (dict) --

        The behavior-based criteria, such as how recently users have used your app, for the segment.

        • Recency (dict) --

          The dimension settings that are based on how recently an endpoint was active.

          • Duration (string) -- [REQUIRED]

            The duration to use when determining whether an endpoint is active or inactive.

          • RecencyType (string) -- [REQUIRED]

            The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

      • Demographic (dict) --

        The demographic-based criteria, such as device platform, for the segment.

        • AppVersion (dict) --

          The app version criteria for the segment.

          • DimensionType (string) --

            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

          • Values (list) -- [REQUIRED]

            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

            • (string) --
        • Channel (dict) --

          The channel criteria for the segment.

          • DimensionType (string) --

            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

          • Values (list) -- [REQUIRED]

            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

            • (string) --
        • DeviceType (dict) --

          The device type criteria for the segment.

          • DimensionType (string) --

            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

          • Values (list) -- [REQUIRED]

            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

            • (string) --
        • Make (dict) --

          The device make criteria for the segment.

          • DimensionType (string) --

            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

          • Values (list) -- [REQUIRED]

            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

            • (string) --
        • Model (dict) --

          The device model criteria for the segment.

          • DimensionType (string) --

            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

          • Values (list) -- [REQUIRED]

            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

            • (string) --
        • Platform (dict) --

          The device platform criteria for the segment.

          • DimensionType (string) --

            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

          • Values (list) -- [REQUIRED]

            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

            • (string) --
      • Location (dict) --

        The location-based criteria, such as region or GPS coordinates, for the segment.

        • Country (dict) --

          The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

          • DimensionType (string) --

            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

          • Values (list) -- [REQUIRED]

            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

            • (string) --
        • GPSPoint (dict) --

          The GPS location and range for the segment.

          • Coordinates (dict) -- [REQUIRED]

            The GPS coordinates to measure distance from.

            • Latitude (float) -- [REQUIRED]

              The latitude coordinate of the location.

            • Longitude (float) -- [REQUIRED]

              The longitude coordinate of the location.

          • RangeInKilometers (float) --

            The range, in kilometers, from the GPS coordinates.

      • Metrics (dict) --

        One or more custom metrics to use as criteria for the segment.

        • (string) --
          • (dict) --

            Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

            • ComparisonOperator (string) -- [REQUIRED]

              The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

            • Value (float) -- [REQUIRED]

              The value to compare.

      • UserAttributes (dict) --

        One or more custom user attributes to use as criteria for the segment.

        • (string) --
          • (dict) --

            Specifies attribute-based criteria for including or excluding endpoints from a segment.

            • AttributeType (string) --

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

            • Values (list) -- [REQUIRED]

              The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

              • (string) --
    • Name (string) --

      The name of the segment.

    • SegmentGroups (dict) --

      The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.

      • Groups (list) --

        An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.

        • (dict) --

          Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.

          • Dimensions (list) --

            An array that defines the dimensions for the segment.

            • (dict) --

              Specifies the dimension settings for a segment.

              • Attributes (dict) --

                One or more custom attributes to use as criteria for the segment.

                • (string) --
                  • (dict) --

                    Specifies attribute-based criteria for including or excluding endpoints from a segment.

                    • AttributeType (string) --

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    • Values (list) -- [REQUIRED]

                      The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                      • (string) --
              • Behavior (dict) --

                The behavior-based criteria, such as how recently users have used your app, for the segment.

                • Recency (dict) --

                  The dimension settings that are based on how recently an endpoint was active.

                  • Duration (string) -- [REQUIRED]

                    The duration to use when determining whether an endpoint is active or inactive.

                  • RecencyType (string) -- [REQUIRED]

                    The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

              • Demographic (dict) --

                The demographic-based criteria, such as device platform, for the segment.

                • AppVersion (dict) --

                  The app version criteria for the segment.

                  • DimensionType (string) --

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  • Values (list) -- [REQUIRED]

                    The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                    • (string) --
                • Channel (dict) --

                  The channel criteria for the segment.

                  • DimensionType (string) --

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  • Values (list) -- [REQUIRED]

                    The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                    • (string) --
                • DeviceType (dict) --

                  The device type criteria for the segment.

                  • DimensionType (string) --

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  • Values (list) -- [REQUIRED]

                    The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                    • (string) --
                • Make (dict) --

                  The device make criteria for the segment.

                  • DimensionType (string) --

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  • Values (list) -- [REQUIRED]

                    The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                    • (string) --
                • Model (dict) --

                  The device model criteria for the segment.

                  • DimensionType (string) --

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  • Values (list) -- [REQUIRED]

                    The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                    • (string) --
                • Platform (dict) --

                  The device platform criteria for the segment.

                  • DimensionType (string) --

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  • Values (list) -- [REQUIRED]

                    The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                    • (string) --
              • Location (dict) --

                The location-based criteria, such as region or GPS coordinates, for the segment.

                • Country (dict) --

                  The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

                  • DimensionType (string) --

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  • Values (list) -- [REQUIRED]

                    The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                    • (string) --
                • GPSPoint (dict) --

                  The GPS location and range for the segment.

                  • Coordinates (dict) -- [REQUIRED]

                    The GPS coordinates to measure distance from.

                    • Latitude (float) -- [REQUIRED]

                      The latitude coordinate of the location.

                    • Longitude (float) -- [REQUIRED]

                      The longitude coordinate of the location.

                  • RangeInKilometers (float) --

                    The range, in kilometers, from the GPS coordinates.

              • Metrics (dict) --

                One or more custom metrics to use as criteria for the segment.

                • (string) --
                  • (dict) --

                    Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

                    • ComparisonOperator (string) -- [REQUIRED]

                      The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                    • Value (float) -- [REQUIRED]

                      The value to compare.

              • UserAttributes (dict) --

                One or more custom user attributes to use as criteria for the segment.

                • (string) --
                  • (dict) --

                    Specifies attribute-based criteria for including or excluding endpoints from a segment.

                    • AttributeType (string) --

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    • Values (list) -- [REQUIRED]

                      The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                      • (string) --
          • SourceSegments (list) --

            The base segment to build the segment on. A base segment, also referred to as a source segment , defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.

            You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.

            • (dict) --

              Specifies the segment identifier and version of a segment.

              • Id (string) -- [REQUIRED]

                The unique identifier for the segment.

              • Version (integer) --

                The version number of the segment.

          • SourceType (string) --

            Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.

          • Type (string) --

            Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.

      • Include (string) --

        Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.

    • tags (dict) --

      A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.

      • (string) --
        • (string) --
Return type

dict

Returns

Response Syntax

{
    'SegmentResponse': {
        'ApplicationId': 'string',
        'Arn': 'string',
        'CreationDate': 'string',
        'Dimensions': {
            'Attributes': {
                'string': {
                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            },
            'Behavior': {
                'Recency': {
                    'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                    'RecencyType': 'ACTIVE'|'INACTIVE'
                }
            },
            'Demographic': {
                'AppVersion': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Channel': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'DeviceType': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Make': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Model': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Platform': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            },
            'Location': {
                'Country': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'GPSPoint': {
                    'Coordinates': {
                        'Latitude': 123.0,
                        'Longitude': 123.0
                    },
                    'RangeInKilometers': 123.0
                }
            },
            'Metrics': {
                'string': {
                    'ComparisonOperator': 'string',
                    'Value': 123.0
                }
            },
            'UserAttributes': {
                'string': {
                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            }
        },
        'Id': 'string',
        'ImportDefinition': {
            'ChannelCounts': {
                'string': 123
            },
            'ExternalId': 'string',
            'Format': 'CSV'|'JSON',
            'RoleArn': 'string',
            'S3Url': 'string',
            'Size': 123
        },
        'LastModifiedDate': 'string',
        'Name': 'string',
        'SegmentGroups': {
            'Groups': [
                {
                    'Dimensions': [
                        {
                            'Attributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'Behavior': {
                                'Recency': {
                                    'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                                    'RecencyType': 'ACTIVE'|'INACTIVE'
                                }
                            },
                            'Demographic': {
                                'AppVersion': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Channel': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'DeviceType': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Make': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Model': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Platform': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'Location': {
                                'Country': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'GPSPoint': {
                                    'Coordinates': {
                                        'Latitude': 123.0,
                                        'Longitude': 123.0
                                    },
                                    'RangeInKilometers': 123.0
                                }
                            },
                            'Metrics': {
                                'string': {
                                    'ComparisonOperator': 'string',
                                    'Value': 123.0
                                }
                            },
                            'UserAttributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            }
                        },
                    ],
                    'SourceSegments': [
                        {
                            'Id': 'string',
                            'Version': 123
                        },
                    ],
                    'SourceType': 'ALL'|'ANY'|'NONE',
                    'Type': 'ALL'|'ANY'|'NONE'
                },
            ],
            'Include': 'ALL'|'ANY'|'NONE'
        },
        'SegmentType': 'DIMENSIONAL'|'IMPORT',
        'tags': {
            'string': 'string'
        },
        'Version': 123
    }
}

Response Structure

  • (dict) --

    The request succeeded and the specified resource was created.

    • SegmentResponse (dict) --

      Provides information about the configuration, dimension, and other settings for a segment.

      • ApplicationId (string) --

        The unique identifier for the application that the segment is associated with.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the segment.

      • CreationDate (string) --

        The date and time when the segment was created.

      • Dimensions (dict) --

        The dimension settings for the segment.

        • Attributes (dict) --

          One or more custom attributes to use as criteria for the segment.

          • (string) --

            • (dict) --

              Specifies attribute-based criteria for including or excluding endpoints from a segment.

              • AttributeType (string) --

                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

              • Values (list) --

                The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                • (string) --
        • Behavior (dict) --

          The behavior-based criteria, such as how recently users have used your app, for the segment.

          • Recency (dict) --

            The dimension settings that are based on how recently an endpoint was active.

            • Duration (string) --

              The duration to use when determining whether an endpoint is active or inactive.

            • RecencyType (string) --

              The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

        • Demographic (dict) --

          The demographic-based criteria, such as device platform, for the segment.

          • AppVersion (dict) --

            The app version criteria for the segment.

            • DimensionType (string) --

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

            • Values (list) --

              The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

              • (string) --
          • Channel (dict) --

            The channel criteria for the segment.

            • DimensionType (string) --

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

            • Values (list) --

              The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

              • (string) --
          • DeviceType (dict) --

            The device type criteria for the segment.

            • DimensionType (string) --

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

            • Values (list) --

              The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

              • (string) --
          • Make (dict) --

            The device make criteria for the segment.

            • DimensionType (string) --

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

            • Values (list) --

              The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

              • (string) --
          • Model (dict) --

            The device model criteria for the segment.

            • DimensionType (string) --

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

            • Values (list) --

              The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

              • (string) --
          • Platform (dict) --

            The device platform criteria for the segment.

            • DimensionType (string) --

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

            • Values (list) --

              The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

              • (string) --
        • Location (dict) --

          The location-based criteria, such as region or GPS coordinates, for the segment.

          • Country (dict) --

            The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

            • DimensionType (string) --

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

            • Values (list) --

              The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

              • (string) --
          • GPSPoint (dict) --

            The GPS location and range for the segment.

            • Coordinates (dict) --

              The GPS coordinates to measure distance from.

              • Latitude (float) --

                The latitude coordinate of the location.

              • Longitude (float) --

                The longitude coordinate of the location.

            • RangeInKilometers (float) --

              The range, in kilometers, from the GPS coordinates.

        • Metrics (dict) --

          One or more custom metrics to use as criteria for the segment.

          • (string) --

            • (dict) --

              Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

              • ComparisonOperator (string) --

                The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

              • Value (float) --

                The value to compare.

        • UserAttributes (dict) --

          One or more custom user attributes to use as criteria for the segment.

          • (string) --

            • (dict) --

              Specifies attribute-based criteria for including or excluding endpoints from a segment.

              • AttributeType (string) --

                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

              • Values (list) --

                The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                • (string) --
      • Id (string) --

        The unique identifier for the segment.

      • ImportDefinition (dict) --

        The settings for the import job that's associated with the segment.

        • ChannelCounts (dict) --

          The number of channel types in the endpoint definitions that were imported to create the segment.

          • (string) --
            • (integer) --
        • ExternalId (string) --

          (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

        • Format (string) --

          The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

        • RoleArn (string) --

          The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

        • S3Url (string) --

          The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.

        • Size (integer) --

          The number of endpoint definitions that were imported successfully to create the segment.

      • LastModifiedDate (string) --

        The date and time when the segment was last modified.

      • Name (string) --

        The name of the segment.

      • SegmentGroups (dict) --

        A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.

        • Groups (list) --

          An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.

          • (dict) --

            Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.

            • Dimensions (list) --

              An array that defines the dimensions for the segment.

              • (dict) --

                Specifies the dimension settings for a segment.

                • Attributes (dict) --

                  One or more custom attributes to use as criteria for the segment.

                  • (string) --

                    • (dict) --

                      Specifies attribute-based criteria for including or excluding endpoints from a segment.

                      • AttributeType (string) --

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      • Values (list) --

                        The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                        • (string) --
                • Behavior (dict) --

                  The behavior-based criteria, such as how recently users have used your app, for the segment.

                  • Recency (dict) --

                    The dimension settings that are based on how recently an endpoint was active.

                    • Duration (string) --

                      The duration to use when determining whether an endpoint is active or inactive.

                    • RecencyType (string) --

                      The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

                • Demographic (dict) --

                  The demographic-based criteria, such as device platform, for the segment.

                  • AppVersion (dict) --

                    The app version criteria for the segment.

                    • DimensionType (string) --

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    • Values (list) --

                      The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                      • (string) --
                  • Channel (dict) --

                    The channel criteria for the segment.

                    • DimensionType (string) --

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    • Values (list) --

                      The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                      • (string) --
                  • DeviceType (dict) --

                    The device type criteria for the segment.

                    • DimensionType (string) --

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    • Values (list) --

                      The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                      • (string) --
                  • Make (dict) --

                    The device make criteria for the segment.

                    • DimensionType (string) --

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    • Values (list) --

                      The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                      • (string) --
                  • Model (dict) --

                    The device model criteria for the segment.

                    • DimensionType (string) --

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    • Values (list) --

                      The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                      • (string) --
                  • Platform (dict) --

                    The device platform criteria for the segment.

                    • DimensionType (string) --

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    • Values (list) --

                      The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                      • (string) --
                • Location (dict) --

                  The location-based criteria, such as region or GPS coordinates, for the segment.

                  • Country (dict) --

                    The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

                    • DimensionType (string) --

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    • Values (list) --

                      The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                      • (string) --
                  • GPSPoint (dict) --

                    The GPS location and range for the segment.

                    • Coordinates (dict) --

                      The GPS coordinates to measure distance from.

                      • Latitude (float) --

                        The latitude coordinate of the location.

                      • Longitude (float) --

                        The longitude coordinate of the location.

                    • RangeInKilometers (float) --

                      The range, in kilometers, from the GPS coordinates.

                • Metrics (dict) --

                  One or more custom metrics to use as criteria for the segment.

                  • (string) --

                    • (dict) --

                      Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

                      • ComparisonOperator (string) --

                        The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                      • Value (float) --

                        The value to compare.

                • UserAttributes (dict) --

                  One or more custom user attributes to use as criteria for the segment.

                  • (string) --

                    • (dict) --

                      Specifies attribute-based criteria for including or excluding endpoints from a segment.

                      • AttributeType (string) --

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      • Values (list) --

                        The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                        • (string) --
            • SourceSegments (list) --

              The base segment to build the segment on. A base segment, also referred to as a source segment , defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.

              You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.

              • (dict) --

                Specifies the segment identifier and version of a segment.

                • Id (string) --

                  The unique identifier for the segment.

                • Version (integer) --

                  The version number of the segment.

            • SourceType (string) --

              Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.

            • Type (string) --

              Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.

        • Include (string) --

          Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.

      • SegmentType (string) --

        The segment type. Valid values are:

        • DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.
        • IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.
      • tags (dict) --

        A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.

        • (string) --
          • (string) --
      • Version (integer) --

        The version number of the segment.

Exceptions

  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.PayloadTooLargeException
  • Pinpoint.Client.exceptions.ForbiddenException
  • Pinpoint.Client.exceptions.NotFoundException
  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
create_sms_template(**kwargs)

Creates a message template for messages that are sent through the SMS channel.

See also: AWS API Documentation

Request Syntax

response = client.create_sms_template(
    SMSTemplateRequest={
        'Body': 'string',
        'DefaultSubstitutions': 'string',
        'RecommenderId': 'string',
        'tags': {
            'string': 'string'
        },
        'TemplateDescription': 'string'
    },
    TemplateName='string'
)
Parameters
  • SMSTemplateRequest (dict) --

    [REQUIRED]

    Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.

    • Body (string) --

      The message body to use in text messages that are based on the message template.

    • DefaultSubstitutions (string) --

      A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

    • RecommenderId (string) --

      The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

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

      A custom description of the message template.

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

Return type

dict

Returns

Response Syntax

{
    'CreateTemplateMessageBody': {
        'Arn': 'string',
        'Message': 'string',
        'RequestID': 'string'
    }
}

Response Structure

  • (dict) --

    The request succeeded and the specified resource was created.

    • CreateTemplateMessageBody (dict) --

      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.

Exceptions

  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.ForbiddenException
create_voice_template(**kwargs)

Creates a message template for messages that are sent through the voice channel.

See also: AWS API Documentation

Request Syntax

response = client.create_voice_template(
    TemplateName='string',
    VoiceTemplateRequest={
        'Body': 'string',
        'DefaultSubstitutions': 'string',
        'LanguageCode': 'string',
        'tags': {
            'string': 'string'
        },
        'TemplateDescription': 'string',
        'VoiceId': '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.

  • VoiceTemplateRequest (dict) --

    [REQUIRED]

    Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.

    • Body (string) --

      The text of the script to use in messages that are based on the message template, in plain text format.

    • DefaultSubstitutions (string) --

      A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

    • LanguageCode (string) --

      The code for the language to use when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide .

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

      A custom description of the message template.

    • VoiceId (string) --

      The name of the voice to use when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide .

Return type

dict

Returns

Response Syntax

{
    'CreateTemplateMessageBody': {
        'Arn': 'string',
        'Message': 'string',
        'RequestID': 'string'
    }
}

Response Structure

  • (dict) --

    The request succeeded and the specified resource was created.

    • CreateTemplateMessageBody (dict) --

      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.

Exceptions

  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.ForbiddenException
delete_adm_channel(**kwargs)

Disables the ADM channel for an application and deletes any existing settings for the channel.

See also: AWS API Documentation

Request Syntax

response = client.delete_adm_channel(
    ApplicationId='string'
)
Parameters
ApplicationId (string) --

[REQUIRED]

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Return type
dict
Returns
Response Syntax
{
    'ADMChannelResponse': {
        'ApplicationId': 'string',
        'CreationDate': 'string',
        'Enabled': True|False,
        'HasCredential': True|False,
        'Id': 'string',
        'IsArchived': True|False,
        'LastModifiedBy': 'string',
        'LastModifiedDate': 'string',
        'Platform': 'string',
        'Version': 123
    }
}

Response Structure

  • (dict) --

    The request succeeded.

    • ADMChannelResponse (dict) --

      Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.

      • ApplicationId (string) --

        The unique identifier for the application that the ADM channel applies to.

      • CreationDate (string) --

        The date and time when the ADM channel was enabled.

      • Enabled (boolean) --

        Specifies whether the ADM channel is enabled for the application.

      • HasCredential (boolean) --

        (Not used) This property is retained only for backward compatibility.

      • Id (string) --

        (Deprecated) An identifier for the ADM channel. This property is retained only for backward compatibility.

      • IsArchived (boolean) --

        Specifies whether the ADM channel is archived.

      • LastModifiedBy (string) --

        The user who last modified the ADM channel.

      • LastModifiedDate (string) --

        The date and time when the ADM channel was last modified.

      • Platform (string) --

        The type of messaging or notification platform for the channel. For the ADM channel, this value is ADM.

      • Version (integer) --

        The current version of the ADM channel.

Exceptions

  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.PayloadTooLargeException
  • Pinpoint.Client.exceptions.ForbiddenException
  • Pinpoint.Client.exceptions.NotFoundException
  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
delete_apns_channel(**kwargs)

Disables the APNs channel for an application and deletes any existing settings for the channel.

See also: AWS API Documentation

Request Syntax

response = client.delete_apns_channel(
    ApplicationId='string'
)
Parameters
ApplicationId (string) --

[REQUIRED]

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Return type
dict
Returns
Response Syntax
{
    'APNSChannelResponse': {
        'ApplicationId': 'string',
        'CreationDate': 'string',
        'DefaultAuthenticationMethod': 'string',
        'Enabled': True|False,
        'HasCredential': True|False,
        'HasTokenKey': True|False,
        'Id': 'string',
        'IsArchived': True|False,
        'LastModifiedBy': 'string',
        'LastModifiedDate': 'string',
        'Platform': 'string',
        'Version': 123
    }
}

Response Structure

  • (dict) --

    The request succeeded.

    • APNSChannelResponse (dict) --

      Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.

      • ApplicationId (string) --

        The unique identifier for the application that the APNs channel applies to.

      • CreationDate (string) --

        The date and time when the APNs channel was enabled.

      • DefaultAuthenticationMethod (string) --

        The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.

      • Enabled (boolean) --

        Specifies whether the APNs channel is enabled for the application.

      • HasCredential (boolean) --

        (Not used) This property is retained only for backward compatibility.

      • HasTokenKey (boolean) --

        Specifies whether the APNs channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

      • Id (string) --

        (Deprecated) An identifier for the APNs channel. This property is retained only for backward compatibility.

      • IsArchived (boolean) --

        Specifies whether the APNs channel is archived.

      • LastModifiedBy (string) --

        The user who last modified the APNs channel.

      • LastModifiedDate (string) --

        The date and time when the APNs channel was last modified.

      • Platform (string) --

        The type of messaging or notification platform for the channel. For the APNs channel, this value is APNS.

      • Version (integer) --

        The current version of the APNs channel.

Exceptions

  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.PayloadTooLargeException
  • Pinpoint.Client.exceptions.ForbiddenException
  • Pinpoint.Client.exceptions.NotFoundException
  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
delete_apns_sandbox_channel(**kwargs)

Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.

See also: AWS API Documentation

Request Syntax

response = client.delete_apns_sandbox_channel(
    ApplicationId='string'
)
Parameters
ApplicationId (string) --

[REQUIRED]

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Return type
dict
Returns
Response Syntax
{
    'APNSSandboxChannelResponse': {
        'ApplicationId': 'string',
        'CreationDate': 'string',
        'DefaultAuthenticationMethod': 'string',
        'Enabled': True|False,
        'HasCredential': True|False,
        'HasTokenKey': True|False,
        'Id': 'string',
        'IsArchived': True|False,
        'LastModifiedBy': 'string',
        'LastModifiedDate': 'string',
        'Platform': 'string',
        'Version': 123
    }
}

Response Structure

  • (dict) --

    The request succeeded.

    • APNSSandboxChannelResponse (dict) --

      Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.

      • ApplicationId (string) --

        The unique identifier for the application that the APNs sandbox channel applies to.

      • CreationDate (string) --

        The date and time when the APNs sandbox channel was enabled.

      • DefaultAuthenticationMethod (string) --

        The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.

      • Enabled (boolean) --

        Specifies whether the APNs sandbox channel is enabled for the application.

      • HasCredential (boolean) --

        (Not used) This property is retained only for backward compatibility.

      • HasTokenKey (boolean) --

        Specifies whether the APNs sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

      • Id (string) --

        (Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility.

      • IsArchived (boolean) --

        Specifies whether the APNs sandbox channel is archived.

      • LastModifiedBy (string) --

        The user who last modified the APNs sandbox channel.

      • LastModifiedDate (string) --

        The date and time when the APNs sandbox channel was last modified.

      • Platform (string) --

        The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX.

      • Version (integer) --

        The current version of the APNs sandbox channel.

Exceptions

  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.PayloadTooLargeException
  • Pinpoint.Client.exceptions.ForbiddenException
  • Pinpoint.Client.exceptions.NotFoundException
  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
delete_apns_voip_channel(**kwargs)

Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.

See also: AWS API Documentation

Request Syntax

response = client.delete_apns_voip_channel(
    ApplicationId='string'
)
Parameters
ApplicationId (string) --

[REQUIRED]

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Return type
dict
Returns
Response Syntax
{
    'APNSVoipChannelResponse': {
        'ApplicationId': 'string',
        'CreationDate': 'string',
        'DefaultAuthenticationMethod': 'string',
        'Enabled': True|False,
        'HasCredential': True|False,
        'HasTokenKey': True|False,
        'Id': 'string',
        'IsArchived': True|False,
        'LastModifiedBy': 'string',
        'LastModifiedDate': 'string',
        'Platform': 'string',
        'Version': 123
    }
}

Response Structure

  • (dict) --

    The request succeeded.

    • APNSVoipChannelResponse (dict) --

      Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.

      • ApplicationId (string) --

        The unique identifier for the application that the APNs VoIP channel applies to.

      • CreationDate (string) --

        The date and time when the APNs VoIP channel was enabled.

      • DefaultAuthenticationMethod (string) --

        The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.

      • Enabled (boolean) --

        Specifies whether the APNs VoIP channel is enabled for the application.

      • HasCredential (boolean) --

        (Not used) This property is retained only for backward compatibility.

      • HasTokenKey (boolean) --

        Specifies whether the APNs VoIP channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

      • Id (string) --

        (Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.

      • IsArchived (boolean) --

        Specifies whether the APNs VoIP channel is archived.

      • LastModifiedBy (string) --

        The user who last modified the APNs VoIP channel.

      • LastModifiedDate (string) --

        The date and time when the APNs VoIP channel was last modified.

      • Platform (string) --

        The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP.

      • Version (integer) --

        The current version of the APNs VoIP channel.

Exceptions

  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.PayloadTooLargeException
  • Pinpoint.Client.exceptions.ForbiddenException
  • Pinpoint.Client.exceptions.NotFoundException
  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
delete_apns_voip_sandbox_channel(**kwargs)

Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.

See also: AWS API Documentation

Request Syntax

response = client.delete_apns_voip_sandbox_channel(
    ApplicationId='string'
)
Parameters
ApplicationId (string) --

[REQUIRED]

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Return type
dict
Returns
Response Syntax
{
    'APNSVoipSandboxChannelResponse': {
        'ApplicationId': 'string',
        'CreationDate': 'string',
        'DefaultAuthenticationMethod': 'string',
        'Enabled': True|False,
        'HasCredential': True|False,
        'HasTokenKey': True|False,
        'Id': 'string',
        'IsArchived': True|False,
        'LastModifiedBy': 'string',
        'LastModifiedDate': 'string',
        'Platform': 'string',
        'Version': 123
    }
}

Response Structure

  • (dict) --

    The request succeeded.

    • APNSVoipSandboxChannelResponse (dict) --

      Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.

      • ApplicationId (string) --

        The unique identifier for the application that the APNs VoIP sandbox channel applies to.

      • CreationDate (string) --

        The date and time when the APNs VoIP sandbox channel was enabled.

      • DefaultAuthenticationMethod (string) --

        The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.

      • Enabled (boolean) --

        Specifies whether the APNs VoIP sandbox channel is enabled for the application.

      • HasCredential (boolean) --

        (Not used) This property is retained only for backward compatibility.

      • HasTokenKey (boolean) --

        Specifies whether the APNs VoIP sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

      • Id (string) --

        (Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility.

      • IsArchived (boolean) --

        Specifies whether the APNs VoIP sandbox channel is archived.

      • LastModifiedBy (string) --

        The user who last modified the APNs VoIP sandbox channel.

      • LastModifiedDate (string) --

        The date and time when the APNs VoIP sandbox channel was last modified.

      • Platform (string) --

        The type of messaging or notification platform for the channel. For the APNs VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.

      • Version (integer) --

        The current version of the APNs VoIP sandbox channel.

Exceptions

  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.PayloadTooLargeException
  • Pinpoint.Client.exceptions.ForbiddenException
  • Pinpoint.Client.exceptions.NotFoundException
  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
delete_app(**kwargs)

Deletes an application.

See also: AWS API Documentation

Request Syntax

response = client.delete_app(
    ApplicationId='string'
)
Parameters
ApplicationId (string) --

[REQUIRED]

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Return type
dict
Returns
Response Syntax
{
    'ApplicationResponse': {
        'Arn': 'string',
        'Id': 'string',
        'Name': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    The request succeeded.

    • ApplicationResponse (dict) --

      Provides information about an application.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the application.

      • Id (string) --

        The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

      • Name (string) --

        The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.

      • tags (dict) --

        A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.

        • (string) --
          • (string) --

Exceptions

  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.PayloadTooLargeException
  • Pinpoint.Client.exceptions.ForbiddenException
  • Pinpoint.Client.exceptions.NotFoundException
  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
delete_baidu_channel(**kwargs)

Disables the Baidu channel for an application and deletes any existing settings for the channel.

See also: AWS API Documentation

Request Syntax

response = client.delete_baidu_channel(
    ApplicationId='string'
)
Parameters
ApplicationId (string) --

[REQUIRED]

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Return type
dict
Returns
Response Syntax
{
    'BaiduChannelResponse': {
        'ApplicationId': 'string',
        'CreationDate': 'string',
        'Credential': 'string',
        'Enabled': True|False,
        'HasCredential': True|False,
        'Id': 'string',
        'IsArchived': True|False,
        'LastModifiedBy': 'string',
        'LastModifiedDate': 'string',
        'Platform': 'string',
        'Version': 123
    }
}

Response Structure

  • (dict) --

    The request succeeded.

    • BaiduChannelResponse (dict) --

      Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.

      • ApplicationId (string) --

        The unique identifier for the application that the Baidu channel applies to.

      • CreationDate (string) --

        The date and time when the Baidu channel was enabled.

      • Credential (string) --

        The API key that you received from the Baidu Cloud Push service to communicate with the service.

      • Enabled (boolean) --

        Specifies whether the Baidu channel is enabled for the application.

      • HasCredential (boolean) --

        (Not used) This property is retained only for backward compatibility.

      • Id (string) --

        (Deprecated) An identifier for the Baidu channel. This property is retained only for backward compatibility.

      • IsArchived (boolean) --

        Specifies whether the Baidu channel is archived.

      • LastModifiedBy (string) --

        The user who last modified the Baidu channel.

      • LastModifiedDate (string) --

        The date and time when the Baidu channel was last modified.

      • Platform (string) --

        The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.

      • Version (integer) --

        The current version of the Baidu channel.

Exceptions

  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.PayloadTooLargeException
  • Pinpoint.Client.exceptions.ForbiddenException
  • Pinpoint.Client.exceptions.NotFoundException
  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
delete_campaign(**kwargs)

Deletes a campaign from an application.

See also: AWS API Documentation

Request Syntax

response = client.delete_campaign(
    ApplicationId='string',
    CampaignId='string'
)
Parameters
  • ApplicationId (string) --

    [REQUIRED]

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

  • CampaignId (string) --

    [REQUIRED]

    The unique identifier for the campaign.

Return type

dict

Returns

Response Syntax

{
    'CampaignResponse': {
        'AdditionalTreatments': [
            {
                'CustomDeliveryConfiguration': {
                    'DeliveryUri': 'string',
                    'EndpointTypes': [
                        'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
                    ]
                },
                'Id': 'string',
                'MessageConfiguration': {
                    'ADMMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'APNSMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'BaiduMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'CustomMessage': {
                        'Data': 'string'
                    },
                    'DefaultMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'EmailMessage': {
                        'Body': 'string',
                        'FromAddress': 'string',
                        'HtmlBody': 'string',
                        'Title': 'string'
                    },
                    'GCMMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'SMSMessage': {
                        'Body': 'string',
                        'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                        'SenderId': 'string'
                    }
                },
                'Schedule': {
                    'EndTime': 'string',
                    'EventFilter': {
                        'Dimensions': {
                            'Attributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'EventType': {
                                'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                'Values': [
                                    'string',
                                ]
                            },
                            'Metrics': {
                                'string': {
                                    'ComparisonOperator': 'string',
                                    'Value': 123.0
                                }
                            }
                        },
                        'FilterType': 'SYSTEM'|'ENDPOINT'
                    },
                    'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
                    'IsLocalTime': True|False,
                    'QuietTime': {
                        'End': 'string',
                        'Start': 'string'
                    },
                    'StartTime': 'string',
                    'Timezone': 'string'
                },
                'SizePercent': 123,
                'State': {
                    'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
                },
                'TemplateConfiguration': {
                    'EmailTemplate': {
                        'Name': 'string',
                        'Version': 'string'
                    },
                    'PushTemplate': {
                        'Name': 'string',
                        'Version': 'string'
                    },
                    'SMSTemplate': {
                        'Name': 'string',
                        'Version': 'string'
                    },
                    'VoiceTemplate': {
                        'Name': 'string',
                        'Version': 'string'
                    }
                },
                'TreatmentDescription': 'string',
                'TreatmentName': 'string'
            },
        ],
        'ApplicationId': 'string',
        'Arn': 'string',
        'CreationDate': 'string',
        'CustomDeliveryConfiguration': {
            'DeliveryUri': 'string',
            'EndpointTypes': [
                'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
            ]
        },
        'DefaultState': {
            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
        },
        'Description': 'string',
        'HoldoutPercent': 123,
        'Hook': {
            'LambdaFunctionName': 'string',
            'Mode': 'DELIVERY'|'FILTER',
            'WebUrl': 'string'
        },
        'Id': 'string',
        'IsPaused': True|False,
        'LastModifiedDate': 'string',
        'Limits': {
            'Daily': 123,
            'MaximumDuration': 123,
            'MessagesPerSecond': 123,
            'Total': 123
        },
        'MessageConfiguration': {
            'ADMMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'APNSMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'BaiduMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'CustomMessage': {
                'Data': 'string'
            },
            'DefaultMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'EmailMessage': {
                'Body': 'string',
                'FromAddress': 'string',
                'HtmlBody': 'string',
                'Title': 'string'
            },
            'GCMMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'SMSMessage': {
                'Body': 'string',
                'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                'SenderId': 'string'
            }
        },
        'Name': 'string',
        'Schedule': {
            'EndTime': 'string',
            'EventFilter': {
                'Dimensions': {
                    'Attributes': {
                        'string': {
                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        }
                    },
                    'EventType': {
                        'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                        'Values': [
                            'string',
                        ]
                    },
                    'Metrics': {
                        'string': {
                            'ComparisonOperator': 'string',
                            'Value': 123.0
                        }
                    }
                },
                'FilterType': 'SYSTEM'|'ENDPOINT'
            },
            'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
            'IsLocalTime': True|False,
            'QuietTime': {
                'End': 'string',
                'Start': 'string'
            },
            'StartTime': 'string',
            'Timezone': 'string'
        },
        'SegmentId': 'string',
        'SegmentVersion': 123,
        'State': {
            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
        },
        'tags': {
            'string': 'string'
        },
        'TemplateConfiguration': {
            'EmailTemplate': {
                'Name': 'string',
                'Version': 'string'
            },
            'PushTemplate': {
                'Name': 'string',
                'Version': 'string'
            },
            'SMSTemplate': {
                'Name': 'string',
                'Version': 'string'
            },
            'VoiceTemplate': {
                'Name': 'string',
                'Version': 'string'
            }
        },
        'TreatmentDescription': 'string',
        'TreatmentName': 'string',
        'Version': 123
    }
}

Response Structure

  • (dict) --

    The request succeeded.

    • CampaignResponse (dict) --

      Provides information about the status, configuration, and other settings for a campaign.

      • AdditionalTreatments (list) --

        An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.

        • (dict) --

          Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

          • CustomDeliveryConfiguration (dict) --

            The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.

            • DeliveryUri (string) --

              The destination to send the campaign or treatment to. This value can be one of the following:

              • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
              • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
            • EndpointTypes (list) --

              The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

              • (string) --
          • Id (string) --

            The unique identifier for the treatment.

          • MessageConfiguration (dict) --

            The message configuration settings for the treatment.

            • ADMMessage (dict) --

              The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.

              • Action (string) --

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
              • Body (string) --

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl (string) --

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl (string) --

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl (string) --

                The URL of an image to display in the push notification.

              • JsonBody (string) --

                The JSON payload to use for a silent push notification.

              • MediaUrl (string) --

                The URL of the image or video to display in the push notification.

              • RawContent (string) --

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush (boolean) --

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive (integer) --

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title (string) --

                The title to display above the notification message on a recipient's device.

              • Url (string) --

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • APNSMessage (dict) --

              The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.

              • Action (string) --

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
              • Body (string) --

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl (string) --

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl (string) --

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl (string) --

                The URL of an image to display in the push notification.

              • JsonBody (string) --

                The JSON payload to use for a silent push notification.

              • MediaUrl (string) --

                The URL of the image or video to display in the push notification.

              • RawContent (string) --

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush (boolean) --

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive (integer) --

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title (string) --

                The title to display above the notification message on a recipient's device.

              • Url (string) --

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • BaiduMessage (dict) --

              The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.

              • Action (string) --

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
              • Body (string) --

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl (string) --

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl (string) --

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl (string) --

                The URL of an image to display in the push notification.

              • JsonBody (string) --

                The JSON payload to use for a silent push notification.

              • MediaUrl (string) --

                The URL of the image or video to display in the push notification.

              • RawContent (string) --

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush (boolean) --

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive (integer) --

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title (string) --

                The title to display above the notification message on a recipient's device.

              • Url (string) --

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • CustomMessage (dict) --

              The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.

              • Data (string) --

                The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.

            • DefaultMessage (dict) --

              The default message that the campaign sends through all the channels that are configured for the campaign.

              • Action (string) --

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
              • Body (string) --

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl (string) --

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl (string) --

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl (string) --

                The URL of an image to display in the push notification.

              • JsonBody (string) --

                The JSON payload to use for a silent push notification.

              • MediaUrl (string) --

                The URL of the image or video to display in the push notification.

              • RawContent (string) --

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush (boolean) --

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive (integer) --

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title (string) --

                The title to display above the notification message on a recipient's device.

              • Url (string) --

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • EmailMessage (dict) --

              The message that the campaign sends through the email channel. If specified, this message overrides the default message.

              • Body (string) --

                The body of the email for recipients whose email clients don't render HTML content.

              • FromAddress (string) --

                The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.

              • HtmlBody (string) --

                The body of the email, in HTML format, for recipients whose email clients render HTML content.

              • Title (string) --

                The subject line, or title, of the email.

            • GCMMessage (dict) --

              The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.

              • Action (string) --

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
              • Body (string) --

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl (string) --

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl (string) --

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl (string) --

                The URL of an image to display in the push notification.

              • JsonBody (string) --

                The JSON payload to use for a silent push notification.

              • MediaUrl (string) --

                The URL of the image or video to display in the push notification.

              • RawContent (string) --

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush (boolean) --

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive (integer) --

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title (string) --

                The title to display above the notification message on a recipient's device.

              • Url (string) --

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • SMSMessage (dict) --

              The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.

              • Body (string) --

                The body of the SMS message.

              • MessageType (string) --

                The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

              • SenderId (string) --

                The sender ID to display on recipients' devices when they receive the SMS message.

          • Schedule (dict) --

            The schedule settings for the treatment.

            • EndTime (string) --

              The scheduled time, in ISO 8601 format, when the campaign ended or will end.

            • EventFilter (dict) --

              The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

              • Dimensions (dict) --

                The dimension settings of the event filter for the campaign.

                • Attributes (dict) --

                  One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

                  • (string) --

                    • (dict) --

                      Specifies attribute-based criteria for including or excluding endpoints from a segment.

                      • AttributeType (string) --

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      • Values (list) --

                        The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                        • (string) --
                • EventType (dict) --

                  The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .

                  • DimensionType (string) --

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  • Values (list) --

                    The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                    • (string) --
                • Metrics (dict) --

                  One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

                  • (string) --

                    • (dict) --

                      Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

                      • ComparisonOperator (string) --

                        The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                      • Value (float) --

                        The value to compare.

              • FilterType (string) --

                The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.

            • Frequency (string) --

              Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

            • IsLocalTime (boolean) --

              Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

            • QuietTime (dict) --

              The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

              • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
              • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
              • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

              If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

              • End (string) --

                The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

              • Start (string) --

                The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

            • StartTime (string) --

              The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.

            • Timezone (string) --

              The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

          • SizePercent (integer) --

            The allocated percentage of users (segment members) that the treatment is sent to.

          • State (dict) --

            The current status of the treatment.

            • CampaignStatus (string) --

              The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.

              If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.

          • TemplateConfiguration (dict) --

            The message template to use for the treatment.

            • EmailTemplate (dict) --

              The email template to use for the message.

              • Name (string) --

                The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

              • Version (string) --

                The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

                If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

            • PushTemplate (dict) --

              The push notification template to use for the message.

              • Name (string) --

                The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

              • Version (string) --

                The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

                If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

            • SMSTemplate (dict) --

              The SMS template to use for the message.

              • Name (string) --

                The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

              • Version (string) --

                The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

                If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

            • VoiceTemplate (dict) --

              The voice template to use for the message. This object isn't supported for campaigns.

              • Name (string) --

                The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

              • Version (string) --

                The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

                If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

          • TreatmentDescription (string) --

            The custom description of the treatment.

          • TreatmentName (string) --

            The custom name of the treatment.

      • ApplicationId (string) --

        The unique identifier for the application that the campaign applies to.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the campaign.

      • CreationDate (string) --

        The date, in ISO 8601 format, when the campaign was created.

      • CustomDeliveryConfiguration (dict) --

        The delivery configuration settings for sending the campaign through a custom channel.

        • DeliveryUri (string) --

          The destination to send the campaign or treatment to. This value can be one of the following:

          • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
          • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
        • EndpointTypes (list) --

          The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

          • (string) --
      • DefaultState (dict) --

        The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.

        • CampaignStatus (string) --

          The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.

          If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.

      • Description (string) --

        The custom description of the campaign.

      • HoldoutPercent (integer) --

        The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

      • Hook (dict) --

        The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

        • LambdaFunctionName (string) --

          The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.

        • Mode (string) --

          The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:

          • FILTER - Invoke the function to customize the segment that's used by a campaign.
          • DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
        • WebUrl (string) --

          The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.

      • Id (string) --

        The unique identifier for the campaign.

      • IsPaused (boolean) --

        Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.

      • LastModifiedDate (string) --

        The date, in ISO 8601 format, when the campaign was last modified.

      • Limits (dict) --

        The messaging limits for the campaign.

        • Daily (integer) --

          The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.

        • MaximumDuration (integer) --

          The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.

        • MessagesPerSecond (integer) --

          The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 50. The maximum value is 20,000.

        • Total (integer) --

          The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.

      • MessageConfiguration (dict) --

        The message configuration settings for the campaign.

        • ADMMessage (dict) --

          The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.

          • Action (string) --

            The action to occur if a recipient taps the push notification. Valid values are:

            • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
            • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
            • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
          • Body (string) --

            The body of the notification message. The maximum number of characters is 200.

          • ImageIconUrl (string) --

            The URL of the image to display as the push-notification icon, such as the icon for the app.

          • ImageSmallIconUrl (string) --

            The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

          • ImageUrl (string) --

            The URL of an image to display in the push notification.

          • JsonBody (string) --

            The JSON payload to use for a silent push notification.

          • MediaUrl (string) --

            The URL of the image or video to display in the push notification.

          • RawContent (string) --

            The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

          • SilentPush (boolean) --

            Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

          • TimeToLive (integer) --

            The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

            This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

          • Title (string) --

            The title to display above the notification message on a recipient's device.

          • Url (string) --

            The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

        • APNSMessage (dict) --

          The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.

          • Action (string) --

            The action to occur if a recipient taps the push notification. Valid values are:

            • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
            • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
            • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
          • Body (string) --

            The body of the notification message. The maximum number of characters is 200.

          • ImageIconUrl (string) --

            The URL of the image to display as the push-notification icon, such as the icon for the app.

          • ImageSmallIconUrl (string) --

            The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

          • ImageUrl (string) --

            The URL of an image to display in the push notification.

          • JsonBody (string) --

            The JSON payload to use for a silent push notification.

          • MediaUrl (string) --

            The URL of the image or video to display in the push notification.

          • RawContent (string) --

            The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

          • SilentPush (boolean) --

            Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

          • TimeToLive (integer) --

            The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

            This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

          • Title (string) --

            The title to display above the notification message on a recipient's device.

          • Url (string) --

            The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

        • BaiduMessage (dict) --

          The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.

          • Action (string) --

            The action to occur if a recipient taps the push notification. Valid values are:

            • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
            • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
            • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
          • Body (string) --

            The body of the notification message. The maximum number of characters is 200.

          • ImageIconUrl (string) --

            The URL of the image to display as the push-notification icon, such as the icon for the app.

          • ImageSmallIconUrl (string) --

            The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

          • ImageUrl (string) --

            The URL of an image to display in the push notification.

          • JsonBody (string) --

            The JSON payload to use for a silent push notification.

          • MediaUrl (string) --

            The URL of the image or video to display in the push notification.

          • RawContent (string) --

            The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

          • SilentPush (boolean) --

            Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

          • TimeToLive (integer) --

            The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

            This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

          • Title (string) --

            The title to display above the notification message on a recipient's device.

          • Url (string) --

            The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

        • CustomMessage (dict) --

          The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.

          • Data (string) --

            The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.

        • DefaultMessage (dict) --

          The default message that the campaign sends through all the channels that are configured for the campaign.

          • Action (string) --

            The action to occur if a recipient taps the push notification. Valid values are:

            • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
            • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
            • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
          • Body (string) --

            The body of the notification message. The maximum number of characters is 200.

          • ImageIconUrl (string) --

            The URL of the image to display as the push-notification icon, such as the icon for the app.

          • ImageSmallIconUrl (string) --

            The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

          • ImageUrl (string) --

            The URL of an image to display in the push notification.

          • JsonBody (string) --

            The JSON payload to use for a silent push notification.

          • MediaUrl (string) --

            The URL of the image or video to display in the push notification.

          • RawContent (string) --

            The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

          • SilentPush (boolean) --

            Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

          • TimeToLive (integer) --

            The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

            This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

          • Title (string) --

            The title to display above the notification message on a recipient's device.

          • Url (string) --

            The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

        • EmailMessage (dict) --

          The message that the campaign sends through the email channel. If specified, this message overrides the default message.

          • Body (string) --

            The body of the email for recipients whose email clients don't render HTML content.

          • FromAddress (string) --

            The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.

          • HtmlBody (string) --

            The body of the email, in HTML format, for recipients whose email clients render HTML content.

          • Title (string) --

            The subject line, or title, of the email.

        • GCMMessage (dict) --

          The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.

          • Action (string) --

            The action to occur if a recipient taps the push notification. Valid values are:

            • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
            • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
            • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
          • Body (string) --

            The body of the notification message. The maximum number of characters is 200.

          • ImageIconUrl (string) --

            The URL of the image to display as the push-notification icon, such as the icon for the app.

          • ImageSmallIconUrl (string) --

            The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

          • ImageUrl (string) --

            The URL of an image to display in the push notification.

          • JsonBody (string) --

            The JSON payload to use for a silent push notification.

          • MediaUrl (string) --

            The URL of the image or video to display in the push notification.

          • RawContent (string) --

            The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

          • SilentPush (boolean) --

            Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

          • TimeToLive (integer) --

            The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

            This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

          • Title (string) --

            The title to display above the notification message on a recipient's device.

          • Url (string) --

            The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

        • SMSMessage (dict) --

          The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.

          • Body (string) --

            The body of the SMS message.

          • MessageType (string) --

            The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

          • SenderId (string) --

            The sender ID to display on recipients' devices when they receive the SMS message.

      • Name (string) --

        The name of the campaign.

      • Schedule (dict) --

        The schedule settings for the campaign.

        • EndTime (string) --

          The scheduled time, in ISO 8601 format, when the campaign ended or will end.

        • EventFilter (dict) --

          The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

          • Dimensions (dict) --

            The dimension settings of the event filter for the campaign.

            • Attributes (dict) --

              One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

              • (string) --

                • (dict) --

                  Specifies attribute-based criteria for including or excluding endpoints from a segment.

                  • AttributeType (string) --

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  • Values (list) --

                    The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                    • (string) --
            • EventType (dict) --

              The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .

              • DimensionType (string) --

                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

              • Values (list) --

                The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                • (string) --
            • Metrics (dict) --

              One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

              • (string) --

                • (dict) --

                  Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

                  • ComparisonOperator (string) --

                    The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                  • Value (float) --

                    The value to compare.

          • FilterType (string) --

            The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.

        • Frequency (string) --

          Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

        • IsLocalTime (boolean) --

          Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

        • QuietTime (dict) --

          The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

          • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
          • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
          • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

          If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

          • End (string) --

            The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

          • Start (string) --

            The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

        • StartTime (string) --

          The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.

        • Timezone (string) --

          The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

      • SegmentId (string) --

        The unique identifier for the segment that's associated with the campaign.

      • SegmentVersion (integer) --

        The version number of the segment that's associated with the campaign.

      • State (dict) --

        The current status of the campaign.

        • CampaignStatus (string) --

          The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.

          If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.

      • tags (dict) --

        A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.

        • (string) --
          • (string) --
      • TemplateConfiguration (dict) --

        The message template that’s used for the campaign.

        • EmailTemplate (dict) --

          The email template to use for the message.

          • Name (string) --

            The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

          • Version (string) --

            The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

            If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

        • PushTemplate (dict) --

          The push notification template to use for the message.

          • Name (string) --

            The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

          • Version (string) --

            The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

            If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

        • SMSTemplate (dict) --

          The SMS template to use for the message.

          • Name (string) --

            The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

          • Version (string) --

            The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

            If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

        • VoiceTemplate (dict) --

          The voice template to use for the message. This object isn't supported for campaigns.

          • Name (string) --

            The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

          • Version (string) --

            The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

            If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

      • TreatmentDescription (string) --

        The custom description of the default treatment for the campaign.

      • TreatmentName (string) --

        The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

      • Version (integer) --

        The version number of the campaign.

Exceptions

  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.PayloadTooLargeException
  • Pinpoint.Client.exceptions.ForbiddenException
  • Pinpoint.Client.exceptions.NotFoundException
  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
delete_email_channel(**kwargs)

Disables the email channel for an application and deletes any existing settings for the channel.

See also: AWS API Documentation

Request Syntax

response = client.delete_email_channel(
    ApplicationId='string'
)
Parameters
ApplicationId (string) --

[REQUIRED]

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Return type
dict
Returns
Response Syntax
{
    'EmailChannelResponse': {
        'ApplicationId': 'string',
        'ConfigurationSet': 'string',
        'CreationDate': 'string',
        'Enabled': True|False,
        'FromAddress': 'string',
        'HasCredential': True|False,
        'Id': 'string',
        'Identity': 'string',
        'IsArchived': True|False,
        'LastModifiedBy': 'string',
        'LastModifiedDate': 'string',
        'MessagesPerSecond': 123,
        'Platform': 'string',
        'RoleArn': 'string',
        'Version': 123
    }
}

Response Structure

  • (dict) --

    The request succeeded.

    • EmailChannelResponse (dict) --

      Provides information about the status and settings of the email channel for an application.

      • ApplicationId (string) --

        The unique identifier for the application that the email channel applies to.

      • ConfigurationSet (string) --

        The Amazon SES configuration set that's applied to messages that are sent through the channel.

      • CreationDate (string) --

        The date and time, in ISO 8601 format, when the email channel was enabled.

      • Enabled (boolean) --

        Specifies whether the email channel is enabled for the application.

      • FromAddress (string) --

        The verified email address that email is sent from when you send email through the channel.

      • HasCredential (boolean) --

        (Not used) This property is retained only for backward compatibility.

      • Id (string) --

        (Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.

      • Identity (string) --

        The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that's used when you send email through the channel.

      • IsArchived (boolean) --

        Specifies whether the email channel is archived.

      • LastModifiedBy (string) --

        The user who last modified the email channel.

      • LastModifiedDate (string) --

        The date and time, in ISO 8601 format, when the email channel was last modified.

      • MessagesPerSecond (integer) --

        The maximum number of emails that can be sent through the channel each second.

      • Platform (string) --

        The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.

      • RoleArn (string) --

        The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.

      • Version (integer) --

        The current version of the email channel.

Exceptions

  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.PayloadTooLargeException
  • Pinpoint.Client.exceptions.ForbiddenException
  • Pinpoint.Client.exceptions.NotFoundException
  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
delete_email_template(**kwargs)

Deletes a message template for messages that were sent through the email channel.

See also: AWS API Documentation

Request Syntax

response = client.delete_email_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 Versionsresource.

    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

{
    'MessageBody': {
        'Message': 'string',
        'RequestID': 'string'
    }
}

Response Structure

  • (dict) --

    The request was accepted for processing. Processing may not be complete.

    • MessageBody (dict) --

      Provides information about an API request or response.

      • Message (string) --

        The message that's returned from the API.

      • RequestID (string) --

        The unique identifier for the request or response.

Exceptions

  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.PayloadTooLargeException
  • Pinpoint.Client.exceptions.ForbiddenException
  • Pinpoint.Client.exceptions.NotFoundException
  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
delete_endpoint(**kwargs)

Deletes an endpoint from an application.

See also: AWS API Documentation

Request Syntax

response = client.delete_endpoint(
    ApplicationId='string',
    EndpointId='string'
)
Parameters
  • ApplicationId (string) --

    [REQUIRED]

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

  • EndpointId (string) --

    [REQUIRED]

    The unique identifier for the endpoint.

Return type

dict

Returns

Response Syntax

{
    'EndpointResponse': {
        'Address': 'string',
        'ApplicationId': 'string',
        'Attributes': {
            'string': [
                'string',
            ]
        },
        'ChannelType': 'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
        'CohortId': 'string',
        'CreationDate': 'string',
        'Demographic': {
            'AppVersion': 'string',
            'Locale': 'string',
            'Make': 'string',
            'Model': 'string',
            'ModelVersion': 'string',
            'Platform': 'string',
            'PlatformVersion': 'string',
            'Timezone': 'string'
        },
        'EffectiveDate': 'string',
        'EndpointStatus': 'string',
        'Id': 'string',
        'Location': {
            'City': 'string',
            'Country': 'string',
            'Latitude': 123.0,
            'Longitude': 123.0,
            'PostalCode': 'string',
            'Region': 'string'
        },
        'Metrics': {
            'string': 123.0
        },
        'OptOut': 'string',
        'RequestId': 'string',
        'User': {
            'UserAttributes': {
                'string': [
                    'string',
                ]
            },
            'UserId': 'string'
        }
    }
}

Response Structure

  • (dict) --

    The request was accepted for processing. Processing may not be complete.

    • EndpointResponse (dict) --

      Provides information about the channel type and other settings for an endpoint.

      • Address (string) --

        The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.

      • ApplicationId (string) --

        The unique identifier for the application that's associated with the endpoint.

      • Attributes (dict) --

        One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments.

        • (string) --
          • (list) --
            • (string) --
      • ChannelType (string) --

        The channel that's used when sending messages or push notifications to the endpoint.

      • CohortId (string) --

        A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.

      • CreationDate (string) --

        The date and time, in ISO 8601 format, when the endpoint was created.

      • Demographic (dict) --

        The demographic information for the endpoint, such as the time zone and platform.

        • AppVersion (string) --

          The version of the app that's associated with the endpoint.

        • Locale (string) --

          The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.

        • Make (string) --

          The manufacturer of the endpoint device, such as apple or samsung.

        • Model (string) --

          The model name or number of the endpoint device, such as iPhone or SM-G900F.

        • ModelVersion (string) --

          The model version of the endpoint device.

        • Platform (string) --

          The platform of the endpoint device, such as ios.

        • PlatformVersion (string) --

          The platform version of the endpoint device.

        • Timezone (string) --

          The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.

      • EffectiveDate (string) --

        The date and time, in ISO 8601 format, when the endpoint was last updated.

      • EndpointStatus (string) --

        Specifies whether messages or push notifications are sent to the endpoint. Possible values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

        Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

      • Id (string) --

        The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.

      • Location (dict) --

        The geographic information for the endpoint.

        • City (string) --

          The name of the city where the endpoint is located.

        • Country (string) --

          The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.

        • Latitude (float) --

          The latitude coordinate of the endpoint location, rounded to one decimal place.

        • Longitude (float) --

          The longitude coordinate of the endpoint location, rounded to one decimal place.

        • PostalCode (string) --

          The postal or ZIP code for the area where the endpoint is located.

        • Region (string) --

          The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.

      • Metrics (dict) --

        One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

        • (string) --
          • (float) --
      • OptOut (string) --

        Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

      • RequestId (string) --

        The unique identifier for the most recent request to update the endpoint.

      • User (dict) --

        One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

        • UserAttributes (dict) --

          One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.

          An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.

          • (string) --
            • (list) --
              • (string) --
        • UserId (string) --

          The unique identifier for the user.

Exceptions

  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.PayloadTooLargeException
  • Pinpoint.Client.exceptions.ForbiddenException
  • Pinpoint.Client.exceptions.NotFoundException
  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
delete_event_stream(**kwargs)

Deletes the event stream for an application.

See also: AWS API Documentation

Request Syntax

response = client.delete_event_stream(
    ApplicationId='string'
)
Parameters
ApplicationId (string) --

[REQUIRED]

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Return type
dict
Returns
Response Syntax
{
    'EventStream': {
        'ApplicationId': 'string',
        'DestinationStreamArn': 'string',
        'ExternalId': 'string',
        'LastModifiedDate': 'string',
        'LastUpdatedBy': 'string',
        'RoleArn': 'string'
    }
}

Response Structure

  • (dict) --

    The request succeeded.

    • EventStream (dict) --

      Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.

      • ApplicationId (string) --

        The unique identifier for the application to publish event data for.

      • DestinationStreamArn (string) --

        The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.

        For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name

        For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name

      • ExternalId (string) --

        (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

      • LastModifiedDate (string) --

        The date, in ISO 8601 format, when the event stream was last modified.

      • LastUpdatedBy (string) --

        The IAM user who last modified the event stream.

      • RoleArn (string) --

        The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

Exceptions

  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.PayloadTooLargeException
  • Pinpoint.Client.exceptions.ForbiddenException
  • Pinpoint.Client.exceptions.NotFoundException
  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
delete_gcm_channel(**kwargs)

Disables the GCM channel for an application and deletes any existing settings for the channel.

See also: AWS API Documentation

Request Syntax

response = client.delete_gcm_channel(
    ApplicationId='string'
)
Parameters
ApplicationId (string) --

[REQUIRED]

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Return type
dict
Returns
Response Syntax
{
    'GCMChannelResponse': {
        'ApplicationId': 'string',
        'CreationDate': 'string',
        'Credential': 'string',
        'Enabled': True|False,
        'HasCredential': True|False,
        'Id': 'string',
        'IsArchived': True|False,
        'LastModifiedBy': 'string',
        'LastModifiedDate': 'string',
        'Platform': 'string',
        'Version': 123
    }
}

Response Structure

  • (dict) --

    The request succeeded.

    • GCMChannelResponse (dict) --

      Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

      • ApplicationId (string) --

        The unique identifier for the application that the GCM channel applies to.

      • CreationDate (string) --

        The date and time when the GCM channel was enabled.

      • Credential (string) --

        The Web API Key, also referred to as an API_KEY or server key , that you received from Google to communicate with Google services.

      • Enabled (boolean) --

        Specifies whether the GCM channel is enabled for the application.

      • HasCredential (boolean) --

        (Not used) This property is retained only for backward compatibility.

      • Id (string) --

        (Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.

      • IsArchived (boolean) --

        Specifies whether the GCM channel is archived.

      • LastModifiedBy (string) --

        The user who last modified the GCM channel.

      • LastModifiedDate (string) --

        The date and time when the GCM channel was last modified.

      • Platform (string) --

        The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.

      • Version (integer) --

        The current version of the GCM channel.

Exceptions

  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.PayloadTooLargeException
  • Pinpoint.Client.exceptions.ForbiddenException
  • Pinpoint.Client.exceptions.NotFoundException
  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
delete_journey(**kwargs)

Deletes a journey from an application.

See also: AWS API Documentation

Request Syntax

response = client.delete_journey(
    ApplicationId='string',
    JourneyId='string'
)
Parameters
  • ApplicationId (string) --

    [REQUIRED]

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

  • JourneyId (string) --

    [REQUIRED]

    The unique identifier for the journey.

Return type

dict

Returns

Response Syntax

{
    'JourneyResponse': {
        'Activities': {
            'string': {
                'CUSTOM': {
                    'DeliveryUri': 'string',
                    'EndpointTypes': [
                        'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
                    ],
                    'MessageConfig': {
                        'Data': 'string'
                    },
                    'NextActivity': 'string',
                    'TemplateName': 'string',
                    'TemplateVersion': 'string'
                },
                'ConditionalSplit': {
                    'Condition': {
                        'Conditions': [
                            {
                                'EventCondition': {
                                    'Dimensions': {
                                        'Attributes': {
                                            'string': {
                                                'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                                'Values': [
                                                    'string',
                                                ]
                                            }
                                        },
                                        'EventType': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Metrics': {
                                            'string': {
                                                'ComparisonOperator': 'string',
                                                'Value': 123.0
                                            }
                                        }
                                    },
                                    'MessageActivity': 'string'
                                },
                                'SegmentCondition': {
                                    'SegmentId': 'string'
                                },
                                'SegmentDimensions': {
                                    'Attributes': {
                                        'string': {
                                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        }
                                    },
                                    'Behavior': {
                                        'Recency': {
                                            'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                                            'RecencyType': 'ACTIVE'|'INACTIVE'
                                        }
                                    },
                                    'Demographic': {
                                        'AppVersion': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Channel': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'DeviceType': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Make': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Model': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Platform': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        }
                                    },
                                    'Location': {
                                        'Country': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'GPSPoint': {
                                            'Coordinates': {
                                                'Latitude': 123.0,
                                                'Longitude': 123.0
                                            },
                                            'RangeInKilometers': 123.0
                                        }
                                    },
                                    'Metrics': {
                                        'string': {
                                            'ComparisonOperator': 'string',
                                            'Value': 123.0
                                        }
                                    },
                                    'UserAttributes': {
                                        'string': {
                                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        }
                                    }
                                }
                            },
                        ],
                        'Operator': 'ALL'|'ANY'
                    },
                    'EvaluationWaitTime': {
                        'WaitFor': 'string',
                        'WaitUntil': 'string'
                    },
                    'FalseActivity': 'string',
                    'TrueActivity': 'string'
                },
                'Description': 'string',
                'EMAIL': {
                    'MessageConfig': {
                        'FromAddress': 'string'
                    },
                    'NextActivity': 'string',
                    'TemplateName': 'string',
                    'TemplateVersion': 'string'
                },
                'Holdout': {
                    'NextActivity': 'string',
                    'Percentage': 123
                },
                'MultiCondition': {
                    'Branches': [
                        {
                            'Condition': {
                                'EventCondition': {
                                    'Dimensions': {
                                        'Attributes': {
                                            'string': {
                                                'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                                'Values': [
                                                    'string',
                                                ]
                                            }
                                        },
                                        'EventType': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Metrics': {
                                            'string': {
                                                'ComparisonOperator': 'string',
                                                'Value': 123.0
                                            }
                                        }
                                    },
                                    'MessageActivity': 'string'
                                },
                                'SegmentCondition': {
                                    'SegmentId': 'string'
                                },
                                'SegmentDimensions': {
                                    'Attributes': {
                                        'string': {
                                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        }
                                    },
                                    'Behavior': {
                                        'Recency': {
                                            'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                                            'RecencyType': 'ACTIVE'|'INACTIVE'
                                        }
                                    },
                                    'Demographic': {
                                        'AppVersion': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Channel': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'DeviceType': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Make': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Model': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Platform': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        }
                                    },
                                    'Location': {
                                        'Country': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'GPSPoint': {
                                            'Coordinates': {
                                                'Latitude': 123.0,
                                                'Longitude': 123.0
                                            },
                                            'RangeInKilometers': 123.0
                                        }
                                    },
                                    'Metrics': {
                                        'string': {
                                            'ComparisonOperator': 'string',
                                            'Value': 123.0
                                        }
                                    },
                                    'UserAttributes': {
                                        'string': {
                                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        }
                                    }
                                }
                            },
                            'NextActivity': 'string'
                        },
                    ],
                    'DefaultActivity': 'string',
                    'EvaluationWaitTime': {
                        'WaitFor': 'string',
                        'WaitUntil': 'string'
                    }
                },
                'PUSH': {
                    'MessageConfig': {
                        'TimeToLive': 'string'
                    },
                    'NextActivity': 'string',
                    'TemplateName': 'string',
                    'TemplateVersion': 'string'
                },
                'RandomSplit': {
                    'Branches': [
                        {
                            'NextActivity': 'string',
                            'Percentage': 123
                        },
                    ]
                },
                'SMS': {
                    'MessageConfig': {
                        'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                        'SenderId': 'string'
                    },
                    'NextActivity': 'string',
                    'TemplateName': 'string',
                    'TemplateVersion': 'string'
                },
                'Wait': {
                    'NextActivity': 'string',
                    'WaitTime': {
                        'WaitFor': 'string',
                        'WaitUntil': 'string'
                    }
                }
            }
        },
        'ApplicationId': 'string',
        'CreationDate': 'string',
        'Id': 'string',
        'LastModifiedDate': 'string',
        'Limits': {
            'DailyCap': 123,
            'EndpointReentryCap': 123,
            'MessagesPerSecond': 123
        },
        'LocalTime': True|False,
        'Name': 'string',
        'QuietTime': {
            'End': 'string',
            'Start': 'string'
        },
        'RefreshFrequency': 'string',
        'Schedule': {
            'EndTime': datetime(2015, 1, 1),
            'StartTime': datetime(2015, 1, 1),
            'Timezone': 'string'
        },
        'StartActivity': 'string',
        'StartCondition': {
            'Description': 'string',
            'EventStartCondition': {
                'EventFilter': {
                    'Dimensions': {
                        'Attributes': {
                            'string': {
                                'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                'Values': [
                                    'string',
                                ]
                            }
                        },
                        'EventType': {
                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        },
                        'Metrics': {
                            'string': {
                                'ComparisonOperator': 'string',
                                'Value': 123.0
                            }
                        }
                    },
                    'FilterType': 'SYSTEM'|'ENDPOINT'
                },
                'SegmentId': 'string'
            },
            'SegmentStartCondition': {
                'SegmentId': 'string'
            }
        },
        'State': 'DRAFT'|'ACTIVE'|'COMPLETED'|'CANCELLED'|'CLOSED',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    The request succeeded.

    • JourneyResponse (dict) --

      Provides information about the status, configuration, and other settings for a journey.

      • Activities (dict) --

        A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.

        • (string) --

          • (dict) --

            Specifies the configuration and other settings for an activity in a journey.

            • CUSTOM (dict) --

              The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

              • DeliveryUri (string) --

                The destination to send the campaign or treatment to. This value can be one of the following:

                • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
                • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
              • EndpointTypes (list) --

                The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

                • (string) --
              • MessageConfig (dict) --

                Specifies the message data included in a custom channel message that's sent to participants in a journey.

                • Data (string) --

                  The message content that's passed to an AWS Lambda function or to a web hook.

              • NextActivity (string) --

                The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.

              • TemplateName (string) --

                The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.

              • TemplateVersion (string) --

                The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

                If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

            • ConditionalSplit (dict) --

              The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.

              • Condition (dict) --

                The conditions that define the paths for the activity, and the relationship between the conditions.

                • Conditions (list) --

                  The conditions to evaluate for the activity.

                  • (dict) --

                    Specifies a condition to evaluate for an activity in a journey.

                    • EventCondition (dict) --

                      The dimension settings for the event that's associated with the activity.

                      • Dimensions (dict) --

                        The dimensions for the event filter to use for the activity.

                        • Attributes (dict) --

                          One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

                          • (string) --

                            • (dict) --

                              Specifies attribute-based criteria for including or excluding endpoints from a segment.

                              • AttributeType (string) --

                                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                              • Values (list) --

                                The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                                • (string) --
                        • EventType (dict) --

                          The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • Metrics (dict) --

                          One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

                          • (string) --

                            • (dict) --

                              Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

                              • ComparisonOperator (string) --

                                The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                              • Value (float) --

                                The value to compare.

                      • MessageActivity (string) --

                        The message identifier (message_id) for the message to use when determining whether message events meet the condition.

                    • SegmentCondition (dict) --

                      The segment that's associated with the activity.

                      • SegmentId (string) --

                        The unique identifier for the segment to associate with the activity.

                    • SegmentDimensions (dict) --

                      The dimension settings for the segment that's associated with the activity.

                      • Attributes (dict) --

                        One or more custom attributes to use as criteria for the segment.

                        • (string) --

                          • (dict) --

                            Specifies attribute-based criteria for including or excluding endpoints from a segment.

                            • AttributeType (string) --

                              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                            • Values (list) --

                              The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                              • (string) --
                      • Behavior (dict) --

                        The behavior-based criteria, such as how recently users have used your app, for the segment.

                        • Recency (dict) --

                          The dimension settings that are based on how recently an endpoint was active.

                          • Duration (string) --

                            The duration to use when determining whether an endpoint is active or inactive.

                          • RecencyType (string) --

                            The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

                      • Demographic (dict) --

                        The demographic-based criteria, such as device platform, for the segment.

                        • AppVersion (dict) --

                          The app version criteria for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • Channel (dict) --

                          The channel criteria for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • DeviceType (dict) --

                          The device type criteria for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • Make (dict) --

                          The device make criteria for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • Model (dict) --

                          The device model criteria for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • Platform (dict) --

                          The device platform criteria for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                      • Location (dict) --

                        The location-based criteria, such as region or GPS coordinates, for the segment.

                        • Country (dict) --

                          The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • GPSPoint (dict) --

                          The GPS location and range for the segment.

                          • Coordinates (dict) --

                            The GPS coordinates to measure distance from.

                            • Latitude (float) --

                              The latitude coordinate of the location.

                            • Longitude (float) --

                              The longitude coordinate of the location.

                          • RangeInKilometers (float) --

                            The range, in kilometers, from the GPS coordinates.

                      • Metrics (dict) --

                        One or more custom metrics to use as criteria for the segment.

                        • (string) --

                          • (dict) --

                            Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

                            • ComparisonOperator (string) --

                              The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                            • Value (float) --

                              The value to compare.

                      • UserAttributes (dict) --

                        One or more custom user attributes to use as criteria for the segment.

                        • (string) --

                          • (dict) --

                            Specifies attribute-based criteria for including or excluding endpoints from a segment.

                            • AttributeType (string) --

                              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                            • Values (list) --

                              The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                              • (string) --
                • Operator (string) --

                  Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.

              • EvaluationWaitTime (dict) --

                The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.

                • WaitFor (string) --

                  The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.

                • WaitUntil (string) --

                  The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.

              • FalseActivity (string) --

                The unique identifier for the activity to perform if the conditions aren't met.

              • TrueActivity (string) --

                The unique identifier for the activity to perform if the conditions are met.

            • Description (string) --

              The custom description of the activity.

            • EMAIL (dict) --

              The settings for an email activity. This type of activity sends an email message to participants.

              • MessageConfig (dict) --

                Specifies the sender address for an email message that's sent to participants in the journey.

                • FromAddress (string) --

                  The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.

              • NextActivity (string) --

                The unique identifier for the next activity to perform, after the message is sent.

              • TemplateName (string) --

                The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.

              • TemplateVersion (string) --

                The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

                If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

            • Holdout (dict) --

              The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.

              • NextActivity (string) --

                The unique identifier for the next activity to perform, after performing the holdout activity.

              • Percentage (integer) --

                The percentage of participants who shouldn't continue the journey.

                To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.

            • MultiCondition (dict) --

              The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.

              • Branches (list) --

                The paths for the activity, including the conditions for entering each path and the activity to perform for each path.

                • (dict) --

                  Specifies a condition to evaluate for an activity path in a journey.

                  • Condition (dict) --

                    The condition to evaluate for the activity path.

                    • EventCondition (dict) --

                      The dimension settings for the event that's associated with the activity.

                      • Dimensions (dict) --

                        The dimensions for the event filter to use for the activity.

                        • Attributes (dict) --

                          One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

                          • (string) --

                            • (dict) --

                              Specifies attribute-based criteria for including or excluding endpoints from a segment.

                              • AttributeType (string) --

                                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                              • Values (list) --

                                The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                                • (string) --
                        • EventType (dict) --

                          The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • Metrics (dict) --

                          One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

                          • (string) --

                            • (dict) --

                              Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

                              • ComparisonOperator (string) --

                                The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                              • Value (float) --

                                The value to compare.

                      • MessageActivity (string) --

                        The message identifier (message_id) for the message to use when determining whether message events meet the condition.

                    • SegmentCondition (dict) --

                      The segment that's associated with the activity.

                      • SegmentId (string) --

                        The unique identifier for the segment to associate with the activity.

                    • SegmentDimensions (dict) --

                      The dimension settings for the segment that's associated with the activity.

                      • Attributes (dict) --

                        One or more custom attributes to use as criteria for the segment.

                        • (string) --

                          • (dict) --

                            Specifies attribute-based criteria for including or excluding endpoints from a segment.

                            • AttributeType (string) --

                              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                            • Values (list) --

                              The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                              • (string) --
                      • Behavior (dict) --

                        The behavior-based criteria, such as how recently users have used your app, for the segment.

                        • Recency (dict) --

                          The dimension settings that are based on how recently an endpoint was active.

                          • Duration (string) --

                            The duration to use when determining whether an endpoint is active or inactive.

                          • RecencyType (string) --

                            The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

                      • Demographic (dict) --

                        The demographic-based criteria, such as device platform, for the segment.

                        • AppVersion (dict) --

                          The app version criteria for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • Channel (dict) --

                          The channel criteria for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • DeviceType (dict) --

                          The device type criteria for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • Make (dict) --

                          The device make criteria for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • Model (dict) --

                          The device model criteria for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • Platform (dict) --

                          The device platform criteria for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                      • Location (dict) --

                        The location-based criteria, such as region or GPS coordinates, for the segment.

                        • Country (dict) --

                          The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

                          • DimensionType (string) --

                            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                          • Values (list) --

                            The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                            • (string) --
                        • GPSPoint (dict) --

                          The GPS location and range for the segment.

                          • Coordinates (dict) --

                            The GPS coordinates to measure distance from.

                            • Latitude (float) --

                              The latitude coordinate of the location.

                            • Longitude (float) --

                              The longitude coordinate of the location.

                          • RangeInKilometers (float) --

                            The range, in kilometers, from the GPS coordinates.

                      • Metrics (dict) --

                        One or more custom metrics to use as criteria for the segment.

                        • (string) --

                          • (dict) --

                            Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

                            • ComparisonOperator (string) --

                              The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                            • Value (float) --

                              The value to compare.

                      • UserAttributes (dict) --

                        One or more custom user attributes to use as criteria for the segment.

                        • (string) --

                          • (dict) --

                            Specifies attribute-based criteria for including or excluding endpoints from a segment.

                            • AttributeType (string) --

                              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                            • Values (list) --

                              The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                              • (string) --
                  • NextActivity (string) --

                    The unique identifier for the next activity to perform, after completing the activity for the path.

              • DefaultActivity (string) --

                The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.

              • EvaluationWaitTime (dict) --

                The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.

                • WaitFor (string) --

                  The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.

                • WaitUntil (string) --

                  The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.

            • PUSH (dict) --

              The settings for a push notification activity. This type of activity sends a push notification to participants.

              • MessageConfig (dict) --

                Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.

                • TimeToLive (string) --

                  The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                  This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • NextActivity (string) --

                The unique identifier for the next activity to perform, after the message is sent.

              • TemplateName (string) --

                The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.

              • TemplateVersion (string) --

                The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

                If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

            • RandomSplit (dict) --

              The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.

              • Branches (list) --

                The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.

                • (dict) --

                  Specifies the settings for a path in a random split activity in a journey.

                  • NextActivity (string) --

                    The unique identifier for the next activity to perform, after completing the activity for the path.

                  • Percentage (integer) --

                    The percentage of participants to send down the activity path.

                    To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.

            • SMS (dict) --

              The settings for an SMS activity. This type of activity sends a text message to participants.

              • MessageConfig (dict) --

                Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.

                • MessageType (string) --

                  The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

                • SenderId (string) --

                  The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.

              • NextActivity (string) --

                The unique identifier for the next activity to perform, after the message is sent.

              • TemplateName (string) --

                The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.

              • TemplateVersion (string) --

                The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.

                If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

            • Wait (dict) --

              The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

              • NextActivity (string) --

                The unique identifier for the next activity to perform, after performing the wait activity.

              • WaitTime (dict) --

                The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.

                • WaitFor (string) --

                  The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.

                • WaitUntil (string) --

                  The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.

      • ApplicationId (string) --

        The unique identifier for the application that the journey applies to.

      • CreationDate (string) --

        The date, in ISO 8601 format, when the journey was created.

      • Id (string) --

        The unique identifier for the journey.

      • LastModifiedDate (string) --

        The date, in ISO 8601 format, when the journey was last modified.

      • Limits (dict) --

        The messaging and entry limits for the journey.

        • DailyCap (integer) --

          The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.

        • EndpointReentryCap (integer) --

          The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.

        • MessagesPerSecond (integer) --

          The maximum number of messages that the journey can send each second.

      • LocalTime (boolean) --

        Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.

      • Name (string) --

        The name of the journey.

      • QuietTime (dict) --

        The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

        • The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
        • The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
        • The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

        If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

        • End (string) --

          The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

        • Start (string) --

          The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

      • RefreshFrequency (string) --

        The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

      • Schedule (dict) --

        The schedule settings for the journey.

        • EndTime (datetime) --

          The scheduled time, in ISO 8601 format, when the journey ended or will end.

        • StartTime (datetime) --

          The scheduled time, in ISO 8601 format, when the journey began or will begin.

        • Timezone (string) --

          The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.

      • StartActivity (string) --

        The unique identifier for the first activity in the journey.

      • StartCondition (dict) --

        The segment that defines which users are participants in the journey.

        • Description (string) --

          The custom description of the condition.

        • EventStartCondition (dict) --

          Specifies the settings for an event that causes a journey activity to start.

          • EventFilter (dict) --

            Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.

            • Dimensions (dict) --

              The dimensions for the event filter to use for the campaign or the journey activity.

              • Attributes (dict) --

                One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

                • (string) --

                  • (dict) --

                    Specifies attribute-based criteria for including or excluding endpoints from a segment.

                    • AttributeType (string) --

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    • Values (list) --

                      The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                      • (string) --
              • EventType (dict) --

                The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .

                • DimensionType (string) --

                  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                • Values (list) --

                  The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                  • (string) --
              • Metrics (dict) --

                One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

                • (string) --

                  • (dict) --

                    Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

                    • ComparisonOperator (string) --

                      The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                    • Value (float) --

                      The value to compare.

            • FilterType (string) --

              The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.

          • SegmentId (string) --

        • SegmentStartCondition (dict) --

          The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.

          • SegmentId (string) --

            The unique identifier for the segment to associate with the activity.

      • State (string) --

        The current status of the journey. Possible values are:

        • DRAFT - The journey is being developed and hasn't been published yet.
        • ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
        • COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.
        • CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.
        • CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.
      • tags (dict) --

        This object is not used or supported.

        • (string) --
          • (string) --

Exceptions

  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.PayloadTooLargeException
  • Pinpoint.Client.exceptions.ForbiddenException
  • Pinpoint.Client.exceptions.NotFoundException
  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
delete_push_template(**kwargs)

Deletes a message template for messages that were sent through a push notification channel.

See also: AWS API Documentation

Request Syntax

response = client.delete_push_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 Versionsresource.

    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

{
    'MessageBody': {
        'Message': 'string',
        'RequestID': 'string'
    }
}

Response Structure

  • (dict) --

    The request was accepted for processing. Processing may not be complete.

    • MessageBody (dict) --

      Provides information about an API request or response.

      • Message (string) --

        The message that's returned from the API.

      • RequestID (string) --

        The unique identifier for the request or response.

Exceptions

  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.PayloadTooLargeException
  • Pinpoint.Client.exceptions.ForbiddenException
  • Pinpoint.Client.exceptions.NotFoundException
  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
delete_recommender_configuration(**kwargs)

Deletes an Amazon Pinpoint configuration for a recommender model.

See also: AWS API Documentation

Request Syntax

response = client.delete_recommender_configuration(
    RecommenderId='string'
)
Parameters
RecommenderId (string) --

[REQUIRED]

The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console.

Return type
dict
Returns
Response Syntax
{
    'RecommenderConfigurationResponse': {
        'Attributes': {
            'string': 'string'
        },
        'CreationDate': 'string',
        'Description': 'string',
        'Id': 'string',
        'LastModifiedDate': 'string',
        'Name': 'string',
        'RecommendationProviderIdType': 'string',
        'RecommendationProviderRoleArn': 'string',
        'RecommendationProviderUri': 'string',
        'RecommendationTransformerUri': 'string',
        'RecommendationsDisplayName': 'string',
        'RecommendationsPerMessage': 123
    }
}

Response Structure

  • (dict) --

    The request succeeded.

    • RecommenderConfigurationResponse (dict) --

      Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.

      • Attributes (dict) --

        A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

        This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

        • (string) --
          • (string) --
      • CreationDate (string) --

        The date, in extended ISO 8601 format, when the configuration was created for the recommender model.

      • Description (string) --

        The custom description of the configuration for the recommender model.

      • Id (string) --

        The unique identifier for the recommender model configuration.

      • LastModifiedDate (string) --

        The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.

      • Name (string) --

        The custom name of the configuration for the recommender model.

      • RecommendationProviderIdType (string) --

        The type of Amazon Pinpoint ID that's associated with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Possible values are:

        • PINPOINT_ENDPOINT_ID - Each user in the model is associated with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
        • PINPOINT_USER_ID - Each user in the model is associated with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If this value is specified, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.
      • RecommendationProviderRoleArn (string) --

        The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.

      • RecommendationProviderUri (string) --

        The Amazon Resource Name (ARN) of the recommender model that Amazon Pinpoint retrieves the recommendation data from. This value is the ARN of an Amazon Personalize campaign.

      • RecommendationTransformerUri (string) --

        The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to perform additional processing of recommendation data that it retrieves from the recommender model.

      • RecommendationsDisplayName (string) --

        The custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console.

        This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

      • RecommendationsPerMessage (integer) --

        The number of recommended items that are retrieved from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables.

Exceptions

  • Pinpoint.Client.exceptions.BadRequestException
  • Pinpoint.Client.exceptions.InternalServerErrorException
  • Pinpoint.Client.exceptions.PayloadTooLargeException
  • Pinpoint.Client.exceptions.ForbiddenException
  • Pinpoint.Client.exceptions.NotFoundException
  • Pinpoint.Client.exceptions.MethodNotAllowedException
  • Pinpoint.Client.exceptions.TooManyRequestsException
delete_segment(**kwargs)

Deletes a segment from an application.

See also: AWS API Documentation

Request Syntax

response = client.delete_segment(
    ApplicationId='string',
    SegmentId='string'
)
Parameters
  • ApplicationId (string) --

    [REQUIRED]

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

  • SegmentId (string) --

    [REQUIRED]

    The unique identifier for the segment.

Return type

dict

Returns

Response Syntax

{
    'SegmentResponse': {
        'ApplicationId': 'string',
        'Arn': 'string',
        'CreationDate': 'string',
        'Dimensions': {
            'Attributes': {
                'string': {
                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            },
            'Behavior': {
                'Recency': {
                    'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                    'RecencyType': 'ACTIVE'|'INACTIVE'
                }
            },
            'Demographic': {
                'AppVersion': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Channel': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'DeviceType': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Make': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Model': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Platform': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            },
            'Location': {
                'Country': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'GPSPoint': {
                    'Coordinates': {
                        'Latitude': 123.0,
                        'Longitude': 123.0
                    },
                    'RangeInKilometers': 123.0
                }
            },
            'Metrics': {
                'string': {
                    'ComparisonOperator': 'string',
                    'Value': 123.0
                }
            },
            'UserAttributes': {
                'string': {
                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            }
        },
        'Id': 'string',
        'ImportDefinition': {
            'ChannelCounts': {
                'string': 123
            },
            'ExternalId': 'string',
            'Format': 'CSV'|'JSON',
            'RoleArn': 'string',
            'S3Url': 'string',
            'Size': 123
        },
        'LastModifiedDate': 'string',
        'Name': 'string',
        'SegmentGroups': {
            'Groups': [
                {
                    'Dimensions': [
                        {
                            'Attributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'Behavior': {
                                'Recency': {
                                    'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                                    'RecencyType': 'ACTIVE'|'INACTIVE'
                                }
                            },
                            'Demographic': {
                                'AppVersion': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Channel': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'DeviceType': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Make': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Model': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Platform': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'Location': {
                                'Country': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'GPSPoint': {
                                    'Coordinates': {
                                        'Latitude': 123.0,
                                        'Longitude': 123.0
                                    },
                                    'RangeInKilometers': 123.0
                                }
                            },
                            'Metrics': {
                                'string': {
                                    'ComparisonOperator': 'string',
                                    'Value': 123.0
                                }
                            },
                            'UserAttributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            }
                        },
                    ],
                    'SourceSegments': [
                        {
                            'Id': 'string',
                            'Version': 123
                        },
                    ],
                    'SourceType': 'ALL'|'ANY'|'NONE',
                    'Type': 'ALL'|'ANY'|'NONE'
                },
            ],
            'Include': 'ALL'|'ANY'|'NONE'
        },
        'SegmentType': 'DIMENSIONAL'|'IMPORT',
        'tags': {
            'string': 'string'
        },
        'Version': 123
    }
}

Response Structure

  • (dict) --

    The request succeeded.

    • SegmentResponse (dict) --

      Provides information about the configuration, dimension, and other settings for a segment.

      • ApplicationId (string) --

        The unique identifier for the application that the segment is associated with.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the segment.

      • CreationDate (string) --

        The date and time when the segment was created.

      • Dimensions (dict) --

        The dimension settings for the segment.

        • Attributes (dict) --

          One or more custom attributes to use as criteria for the segment.

          • (string) --

            • (dict) --

              Specifies attribute-based criteria for including or excluding endpoints from a segment.

              • AttributeType (string) --

                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

              • Values (list) --

                The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                • (string) --
        • Behavior (dict) --

          The behavior-based criteria, such as how recently users have used your app, for the segment.

          • Recency (dict) --

            The dimension settings that are based on how recently an endpoint was active.

            • Duration (string) --

              The duration to use when determining whether an endpoint is active or inactive.

            • RecencyType (string) --

              The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

        • Demographic (dict) --

          The demographic-based criteria, such as device platform, for the segment.

          • AppVersion (dict) --

            The app version criteria for the segment.

            • DimensionType (string) --

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

            • Values (list) --

              The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

              • (string) --
          • Channel (dict) --

            The channel criteria for the segment.

            • DimensionType (string) --

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

            • Values (list) --

              The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

              • (string) --
          • DeviceType (dict) --

            The device type criteria for the segment.

            • DimensionType (string) --

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

            • Values (list) --

              The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

              • (string) --
          • Make (dict) --

            The device make criteria for the segment.

            • DimensionType (string) --

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

            • Values (list) --

              The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

              • (string) --
          • Model (dict) --

            The device model criteria for the segment.

            • DimensionType (string) --

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

            • Values (list) --

              The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

              • (string) --
          • Platform (dict) --

            The device platform criteria for the segment.

            • DimensionType (string) --

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

            • Values (list) --

              The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

              • (string) --
        • Location (dict) --

          The location-based criteria, such as region or GPS coordinates, for the segment.

          • Country (dict) --

            The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

            • DimensionType (string) --

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

            • Values (list) --

              The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

              • (string) --
          • GPSPoint (dict) --

            The GPS location and range for the segment.

            • Coordinates (dict) --

              The GPS coordinates to measure distance from.

              • Latitude (float) --

                The latitude coordinate of the location.

              • Longitude (float) --

                The longitude coordinate of the location.

            • RangeInKilometers (float) --

              The range, in kilometers, from the GPS coordinates.

        • Metrics (dict) --

          One or more custom metrics to use as criteria for the segment.

          • (string) --

            • (dict) --

              Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

              • ComparisonOperator (string) --

                The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

              • Value (float) --

                The value to compare.

        • UserAttributes (dict) --

          One or more custom user attributes to use as criteria for the segment.

          • (string) --

            • (dict) --

              Specifies attribute-based criteria for including or excluding endpoints from a segment.

              • AttributeType (string) --

                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

              • Values (list) --

                The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                • (string) --
      • Id (string) --

        The unique identifier for the segment.

      • ImportDefinition (dict) --

        The settings for the import job that's associated with the segment.

        • ChannelCounts (dict) --

          The number of channel types in the endpoint definitions that were imported to create the segment.

          • (string) --
            • (integer) --
        • ExternalId (string) --

          (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

        • Format (string) --

          The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

        • RoleArn (string) --

          The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

        • S3Url (string) --

          The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.

        • Size (integer) --

          The number of endpoint definitions that were imported successfully to create the segment.

      • LastModifiedDate (string) --

        The date and time when the segment was last modified.

      • Name (string) --

        The name of the segment.

      • SegmentGroups (dict) --

        A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.

        • Groups (list) --

          An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.

          • (dict) --

            Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.

            • Dimensions (list) --

              An array that defines the dimensions for the segment.

              • (dict) --

                Specifies the dimension settings for a segment.

                • Attributes (dict) --

                  One or more custom attributes to use as criteria for the segment.

                  • (string) --

                    • (dict) --

                      Specifies attribute-based criteria for including or excluding endpoints from a segment.

                      • AttributeType (string) --

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      • Values (list) --

                        The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                        • (string) --
                • Behavior (dict) --

                  The behavior-based criteria, such as how recently users have used your app, for the segment.

                  • Recency (dict) --

                    The dimension settings that are based on how recently an endpoint was active.

                    • Duration (string) --

                      The duration to use when determining whether an endpoint is active or inactive.

                    • RecencyType (string) --

                      The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

                • Demographic (dict) --

                  The demographic-based criteria, such as device platform, for the segment.

                  • AppVersion (dict) --

                    The app version criteria for the segment.

                    • DimensionType (string) --

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    • Values (list) --

                      The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.